jprdonnelly/kestra
1
0
Fork 0
mirror of https://github.com/kestra-io/kestra.git synced 2025-12-19 18:05:41 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): no-args will properly return help (#12980)

Browse Source 
closes https://github.com/kestra-io/kestra-ee/issues/5842
This commit is contained in:
brian-mulier-p
2025-11-18 11:23:30 +01:00
committed by GitHub
parent 735697ac71
commit 816a1bb543
19 changed files with 105 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
cli/src/main/java/io/kestra/cli/App.java
View File

@@ -8,11 +8,10 @@ import io.kestra.cli.commands.plugins.PluginCommand;
import io.kestra.cli.commands.servers.ServerCommand;
import io.kestra.cli.commands.sys.SysCommand;
import io.kestra.cli.commands.templates.TemplateCommand;
import io.kestra.cli.services.EnvironmentProvider;
import io.micronaut.configuration.picocli.MicronautFactory;
import io.micronaut.configuration.picocli.PicocliRunner;
import io.micronaut.context.ApplicationContext;
import io.micronaut.context.ApplicationContextBuilder;
import io.micronaut.context.env.Environment;
import io.micronaut.core.annotation.Introspected;
import org.slf4j.bridge.SLF4JBridgeHandler;
import picocli.CommandLine;
@@ -20,11 +19,9 @@ import picocli.CommandLine;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.*;
import java.util.concurrent.Callable;
import java.util.stream.Stream;
@CommandLine.Command(
name = "kestra",
@@ -49,24 +46,50 @@ import java.util.concurrent.Callable;
@Introspected
public class App implements Callable<Integer> {
public static void main(String[] args) {
execute(App.class, new String [] { Environment.CLI }, args);
System.exit(runCli(args));
}
public static int runCli(String[] args, String... extraEnvironments) {
return runCli(App.class, args, extraEnvironments);
}
public static int runCli(Class<?> cls, String[] args, String... extraEnvironments) {
ServiceLoader<EnvironmentProvider> environmentProviders = ServiceLoader.load(EnvironmentProvider.class);
String[] baseEnvironments = environmentProviders.findFirst().map(EnvironmentProvider::getCliEnvironments).orElseGet(() -> new String[0]);
return execute(
cls,
Stream.concat(
Arrays.stream(baseEnvironments),
Arrays.stream(extraEnvironments)
).toArray(String[]::new),
args
);
}
@Override
public Integer call() throws Exception {
return PicocliRunner.call(App.class, "--help");
return runCli(new String[0]);
}
protected static void execute(Class<?> cls, String[] environments, String... args) {
protected static int execute(Class<?> cls, String[] environments, String... args) {
// Log Bridge
SLF4JBridgeHandler.removeHandlersForRootLogger();
SLF4JBridgeHandler.install();
// Init ApplicationContext
ApplicationContext applicationContext = App.applicationContext(cls, environments, args);
CommandLine commandLine = getCommandLine(cls, args);
ApplicationContext applicationContext = App.applicationContext(cls, commandLine, environments);
Class<?> targetCommand = commandLine.getCommandSpec().userObject().getClass();
if (!AbstractCommand.class.isAssignableFrom(targetCommand) && args.length == 0) {
// if no command provided, show help
args = new String[]{"--help"};
}
// Call Picocli command
int exitCode = 0;
int exitCode;
try {
exitCode = new CommandLine(cls, new MicronautFactory(applicationContext)).execute(args);
} catch (CommandLine.InitializationException e){
@@ -77,7 +100,23 @@ public class App implements Callable<Integer> {
applicationContext.close();
// exit code
System.exit(Objects.requireNonNullElse(exitCode, 0));
return exitCode;
}
private static CommandLine getCommandLine(Class<?> cls, String[] args) {
CommandLine cmd = new CommandLine(cls, CommandLine.defaultFactory());
continueOnParsingErrors(cmd);
CommandLine.ParseResult parseResult = cmd.parseArgs(args);
List<CommandLine> parsedCommands = parseResult.asCommandLineList();
return parsedCommands.getLast();
}
public static ApplicationContext applicationContext(Class<?> mainClass,
String[] environments,
String... args) {
return App.applicationContext(mainClass, getCommandLine(mainClass, args), environments);
}
@@ -85,25 +124,17 @@ public class App implements Callable<Integer> {
* Create an {@link ApplicationContext} with additional properties based on configuration files (--config) and
* forced Properties from current command.
*
* @param args args passed to java app
* @return the application context created
*/
protected static ApplicationContext applicationContext(Class<?> mainClass,
String[] environments,
String[] args) {
CommandLine commandLine,
String[] environments) {
ApplicationContextBuilder builder = ApplicationContext
.builder()
.mainClass(mainClass)
.environments(environments);
CommandLine cmd = new CommandLine(mainClass, CommandLine.defaultFactory());
continueOnParsingErrors(cmd);
CommandLine.ParseResult parseResult = cmd.parseArgs(args);
List<CommandLine> parsedCommands = parseResult.asCommandLineList();
CommandLine commandLine = parsedCommands.getLast();
Class<?> cls = commandLine.getCommandSpec().userObject().getClass();
if (AbstractCommand.class.isAssignableFrom(cls)) {

5
cli/src/main/java/io/kestra/cli/commands/configs/sys/ConfigCommand.java
View File

@@ -1,6 +1,5 @@
package io.kestra.cli.commands.configs.sys;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.extern.slf4j.Slf4j;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
@@ -20,8 +19,6 @@ public class ConfigCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "configs", "--help");
return 0;
return App.runCli(new String[]{"configs", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/flows/FlowCommand.java
View File

@@ -1,6 +1,5 @@
package io.kestra.cli.commands.flows;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import io.kestra.cli.AbstractCommand;
@@ -29,8 +28,6 @@ public class FlowCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "flow", "--help");
return 0;
return App.runCli(new String[]{"flow", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/flows/namespaces/FlowNamespaceCommand.java
View File

@@ -1,7 +1,6 @@
package io.kestra.cli.commands.flows.namespaces;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import io.kestra.cli.AbstractCommand;
@@ -22,8 +21,6 @@ public class FlowNamespaceCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "flow", "namespace", "--help");
return 0;
return App.runCli(new String[]{"flow", "namespace", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/migrations/MigrationCommand.java
View File

@@ -3,7 +3,6 @@ package io.kestra.cli.commands.migrations;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.kestra.cli.commands.migrations.metadata.MetadataMigrationCommand;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -24,8 +23,6 @@ public class MigrationCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "migrate", "--help");
return 0;
return App.runCli(new String[]{"migrate", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/namespaces/NamespaceCommand.java
View File

@@ -4,7 +4,6 @@ import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.kestra.cli.commands.namespaces.files.NamespaceFilesCommand;
import io.kestra.cli.commands.namespaces.kv.KvCommand;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -25,8 +24,6 @@ public class NamespaceCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "namespace", "--help");
return 0;
return App.runCli(new String[]{"namespace", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/namespaces/files/NamespaceFilesCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.namespaces.files;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -22,8 +21,6 @@ public class NamespaceFilesCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "namespace", "files", "--help");
return 0;
return App.runCli(new String[]{"namespace", "files", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/namespaces/kv/KvCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.namespaces.kv;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -22,8 +21,6 @@ public class KvCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "namespace", "kv", "--help");
return 0;
return App.runCli(new String[]{"namespace", "kv", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/plugins/PluginCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.plugins;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import picocli.CommandLine.Command;
@@ -25,9 +24,7 @@ public class PluginCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "plugins", "--help");
return 0;
return App.runCli(new String[]{"plugins", "--help"});
}
@Override

5
cli/src/main/java/io/kestra/cli/commands/servers/ServerCommand.java
View File

@@ -1,6 +1,5 @@
package io.kestra.cli.commands.servers;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import io.kestra.cli.AbstractCommand;
@@ -28,8 +27,6 @@ public class ServerCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "server", "--help");
return 0;
return App.runCli(new String[]{"server", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/sys/SysCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.sys;
import io.kestra.cli.commands.sys.database.DatabaseCommand;
import io.kestra.cli.commands.sys.statestore.StateStoreCommand;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.extern.slf4j.Slf4j;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
@@ -25,8 +24,6 @@ public class SysCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "sys", "--help");
return 0;
return App.runCli(new String[]{"sys", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/sys/database/DatabaseCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.sys.database;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import picocli.CommandLine;
@@ -20,8 +19,6 @@ public class DatabaseCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "sys", "database", "--help");
return 0;
return App.runCli(new String[]{"sys", "database", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/sys/statestore/StateStoreCommand.java
View File

@@ -2,7 +2,6 @@ package io.kestra.cli.commands.sys.statestore;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import picocli.CommandLine;
@@ -20,8 +19,6 @@ public class StateStoreCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "sys", "state-store", "--help");
return 0;
return App.runCli(new String[]{"sys", "state-store", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/templates/TemplateCommand.java
View File

@@ -4,7 +4,6 @@ import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.kestra.cli.commands.templates.namespaces.TemplateNamespaceCommand;
import io.kestra.core.models.templates.TemplateEnabled;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -27,8 +26,6 @@ public class TemplateCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "template", "--help");
return 0;
return App.runCli(new String[]{"template", "--help"});
}
}

5
cli/src/main/java/io/kestra/cli/commands/templates/namespaces/TemplateNamespaceCommand.java
View File

@@ -3,7 +3,6 @@ package io.kestra.cli.commands.templates.namespaces;
import io.kestra.cli.AbstractCommand;
import io.kestra.cli.App;
import io.kestra.core.models.templates.TemplateEnabled;
import io.micronaut.configuration.picocli.PicocliRunner;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import picocli.CommandLine;
@@ -24,8 +23,6 @@ public class TemplateNamespaceCommand extends AbstractCommand {
public Integer call() throws Exception {
super.call();
PicocliRunner.call(App.class, "template", "namespace", "--help");
return 0;
return App.runCli(new String[]{"template", "namespace", "--help"});
}
}

16
cli/src/main/java/io/kestra/cli/services/DefaultEnvironmentProvider.java Normal file
View File

@@ -0,0 +1,16 @@
package io.kestra.cli.services;
import io.micronaut.context.env.Environment;
import java.util.Arrays;
import java.util.stream.Stream;
public class DefaultEnvironmentProvider implements EnvironmentProvider {
@Override
public String[] getCliEnvironments(String... extraEnvironments) {
return Stream.concat(
Stream.of(Environment.CLI),
Arrays.stream(extraEnvironments)
).toArray(String[]::new);
}
}

5
cli/src/main/java/io/kestra/cli/services/EnvironmentProvider.java Normal file
View File

@@ -0,0 +1,5 @@
package io.kestra.cli.services;
public interface EnvironmentProvider {
String[] getCliEnvironments(String... extraEnvironments);
}

1
cli/src/main/resources/META-INF/services/io.kestra.cli.services.EnvironmentProvider Normal file
View File

@@ -0,0 +1 @@
io.kestra.cli.services.DefaultEnvironmentProvider

32
cli/src/test/java/io/kestra/cli/AppTest.java
View File

@@ -1,14 +1,11 @@
package io.kestra.cli;
import io.kestra.core.models.ServerType;
import io.micronaut.configuration.picocli.MicronautFactory;
import io.micronaut.configuration.picocli.PicocliRunner;
import io.micronaut.context.ApplicationContext;
import io.micronaut.context.env.Environment;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import picocli.CommandLine;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
@@ -22,11 +19,15 @@ class AppTest {
ByteArrayOutputStream out = new ByteArrayOutputStream();
System.setOut(new PrintStream(out));
try (ApplicationContext ctx = ApplicationContext.run(Environment.CLI, Environment.TEST)) {
PicocliRunner.call(App.class, ctx, "--help");
// No arg will print help
assertThat(App.runCli(new String[0])).isZero();
assertThat(out.toString()).contains("kestra");
assertThat(out.toString()).contains("kestra");
}
out.reset();
// Explicit help command
assertThat(App.runCli(new String[]{"--help"})).isZero();
assertThat(out.toString()).contains("kestra");
}
@ParameterizedTest
@@ -38,11 +39,12 @@ class AppTest {
final String[] args = new String[]{"server", serverType, "--help"};
try (ApplicationContext ctx = App.applicationContext(App.class, new String [] { Environment.CLI }, args)) {
new CommandLine(App.class, new MicronautFactory(ctx)).execute(args);
assertTrue(ctx.getProperty("kestra.server-type", ServerType.class).isEmpty());
assertThat(out.toString()).startsWith("Usage: kestra server " + serverType);
}
assertThat(App.runCli(args)).isZero();
assertThat(out.toString()).startsWith("Usage: kestra server " + serverType);
}
@Test
@@ -52,12 +54,10 @@ class AppTest {
final String[] argsWithMissingParams = new String[]{"flow", "namespace", "update"};
try (ApplicationContext ctx = App.applicationContext(App.class, new String [] { Environment.CLI }, argsWithMissingParams)) {
new CommandLine(App.class, new MicronautFactory(ctx)).execute(argsWithMissingParams);
assertThat(App.runCli(argsWithMissingParams)).isEqualTo(2);
assertThat(out.toString()).startsWith("Missing required parameters: ");
assertThat(out.toString()).contains("Usage: kestra flow namespace update ");
assertThat(out.toString()).doesNotContain("MissingParameterException: ");
}
assertThat(out.toString()).startsWith("Missing required parameters: ");
assertThat(out.toString()).contains("Usage: kestra flow namespace update ");
assertThat(out.toString()).doesNotContain("MissingParameterException: ");
}
}