Merge pull request #18122 from stuartwdouglas/gradle-dev

Improve the Gradle dev experience from the CLI

devtools/cli/src/main/java/io/quarkus/cli/Dev.java

@@ -5,6 +5,7 @@
 import java.util.Map;
 import java.util.TreeMap;
 import java.util.concurrent.Callable;
+import java.util.function.Supplier;
 
 import io.quarkus.cli.build.BaseBuildCommand;
 import io.quarkus.cli.build.BuildSystemRunner;
@@ -37,15 +38,22 @@ public Integer call() {
             output.throwIfUnmatchedArguments(spec.commandLine());
 
             BuildSystemRunner runner = getRunner();
-            BuildSystemRunner.BuildCommandArgs commandArgs = runner.prepareDevMode(devOptions, propertiesOptions, debugOptions,
+            List<Supplier<BuildSystemRunner.BuildCommandArgs>> commandArgs = runner.prepareDevMode(devOptions,
+                    propertiesOptions, debugOptions,
                     params);
 
             if (devOptions.isDryRun()) {
-                dryRunDev(spec.commandLine().getHelp(), runner.getBuildTool(), commandArgs);
+                dryRunDev(spec.commandLine().getHelp(), runner.getBuildTool(), commandArgs.iterator().next().get());
                 return CommandLine.ExitCode.OK;
             }
-
-            return runner.run(commandArgs);
+            Integer ret = 1;
+            for (Supplier<BuildSystemRunner.BuildCommandArgs> i : commandArgs) {
+                ret = runner.run(i.get());
+                if (ret != 0) {
+                    return ret;
+                }
+            }
+            return ret;
         } catch (Exception e) {
             return output.handleCommandException(e,
                     "Unable to launch project in dev mode: " + e.getMessage());

devtools/cli/src/main/java/io/quarkus/cli/build/BuildSystemRunner.java

@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Supplier;
 
 import io.quarkus.cli.common.BuildOptions;
 import io.quarkus.cli.common.CategoryListFormatOptions;
@@ -97,7 +98,8 @@ Integer listExtensions(RunModeOption runMode, ListFormatOptions format, boolean
     BuildCommandArgs prepareBuild(BuildOptions buildOptions, PropertiesOptions propertiesOptions, RunModeOption runMode,
             List<String> params);
 
-    BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions, DebugOptions debugOptions,
+    List<Supplier<BuildCommandArgs>> prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
+            DebugOptions debugOptions,
             List<String> params);
 
     Path getProjectRoot();

devtools/cli/src/main/java/io/quarkus/cli/build/GradleRunner.java

@@ -1,10 +1,15 @@
 package io.quarkus.cli.build;
 
 import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayDeque;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Supplier;
+import java.util.stream.Collectors;
 
 import io.quarkus.cli.common.BuildOptions;
 import io.quarkus.cli.common.CategoryListFormatOptions;
@@ -142,7 +147,7 @@ public BuildCommandArgs prepareBuild(BuildOptions buildOptions, PropertiesOption
     }
 
     @Override
-    public BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
+    public List<Supplier<BuildCommandArgs>> prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
             DebugOptions debugOptions, List<String> params) {
         ArrayDeque<String> args = new ArrayDeque<>();
         setGradleProperties(args, false);
@@ -162,7 +167,33 @@ public BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions
         args.addAll(flattenMappedProperties(propertiesOptions.properties));
         // Add any other unmatched arguments
         args.addAll(params);
-        return prependExecutable(args);
+        try {
+            Path outputFile = Files.createTempFile("quarkus-dev", ".txt");
+            args.add("-Dio.quarkus.devmode-args=" + outputFile.toAbsolutePath().toString());
+            BuildCommandArgs buildCommandArgs = prependExecutable(args);
+            return Arrays.asList(new Supplier<BuildCommandArgs>() {
+                @Override
+                public BuildCommandArgs get() {
+                    return buildCommandArgs;
+                }
+            }, new Supplier<BuildCommandArgs>() {
+                @Override
+                public BuildCommandArgs get() {
+                    try {
+                        List<String> lines = Files.readAllLines(outputFile).stream().filter(s -> !s.isBlank())
+                                .collect(Collectors.toList());
+                        BuildCommandArgs cmd = new BuildCommandArgs();
+                        cmd.arguments = lines.toArray(new String[0]);
+                        cmd.targetDirectory = buildCommandArgs.targetDirectory;
+                        return cmd;
+                    } catch (IOException e) {
+                        throw new RuntimeException(e);
+                    }
+                }
+            });
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
     }
 
     void setSkipTests(ArrayDeque<String> args) {

devtools/cli/src/main/java/io/quarkus/cli/build/JBangRunner.java

@@ -5,6 +5,7 @@
 import java.util.ArrayDeque;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Supplier;
 
 import io.quarkus.cli.common.BuildOptions;
 import io.quarkus.cli.common.CategoryListFormatOptions;
@@ -86,7 +87,7 @@ public BuildCommandArgs prepareBuild(BuildOptions buildOptions, PropertiesOption
     }
 
     @Override
-    public BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
+    public List<Supplier<BuildCommandArgs>> prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
             DebugOptions debugOptions, List<String> params) {
         throw new UnsupportedOperationException("Not there yet. ;)");
     }

devtools/cli/src/main/java/io/quarkus/cli/build/MavenRunner.java

@@ -3,8 +3,10 @@
 import java.io.File;
 import java.nio.file.Path;
 import java.util.ArrayDeque;
+import java.util.Collections;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Supplier;
 
 import io.quarkus.cli.Version;
 import io.quarkus.cli.common.BuildOptions;
@@ -149,7 +151,7 @@ public BuildCommandArgs prepareBuild(BuildOptions buildOptions, PropertiesOption
     }
 
     @Override
-    public BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
+    public List<Supplier<BuildCommandArgs>> prepareDevMode(DevOptions devOptions, PropertiesOptions propertiesOptions,
             DebugOptions debugOptions, List<String> params) {
         ArrayDeque<String> args = new ArrayDeque<>();
         setMavenProperties(args, false);
@@ -168,7 +170,13 @@ public BuildCommandArgs prepareDevMode(DevOptions devOptions, PropertiesOptions
         args.addAll(flattenMappedProperties(propertiesOptions.properties));
         // Add any other unmatched arguments
         args.addAll(params);
-        return prependExecutable(args);
+        BuildCommandArgs buildCommandArgs = prependExecutable(args);
+        return Collections.singletonList(new Supplier<BuildCommandArgs>() {
+            @Override
+            public BuildCommandArgs get() {
+                return buildCommandArgs;
+            }
+        });
     }
 
     void setSkipTests(ArrayDeque<String> args) {

devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java

@@ -1,5 +1,6 @@
 package io.quarkus.gradle.tasks;
 
+import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -55,6 +56,7 @@
 
 public class QuarkusDev extends QuarkusTask {
 
+    public static final String IO_QUARKUS_DEVMODE_ARGS = "io.quarkus.devmode-args";
     private Set<File> filesIncludedInClasspath = new HashSet<>();
 
     private File buildDir;
@@ -186,12 +188,22 @@ public void startDev() {
 
         try {
             QuarkusDevModeLauncher runner = newLauncher();
-            getProject().exec(action -> {
-                action.commandLine(runner.args()).workingDir(getWorkingDir());
-                action.setStandardInput(System.in)
-                        .setErrorOutput(System.out)
-                        .setStandardOutput(System.out);
-            });
+            String outputFile = System.getProperty(IO_QUARKUS_DEVMODE_ARGS);
+            if (outputFile == null) {
+                getProject().exec(action -> {
+                    action.commandLine(runner.args()).workingDir(getWorkingDir());
+                    action.setStandardInput(System.in)
+                            .setErrorOutput(System.out)
+                            .setStandardOutput(System.out);
+                });
+            } else {
+                try (BufferedWriter is = Files.newBufferedWriter(Paths.get(outputFile))) {
+                    for (String i : runner.args()) {
+                        is.write(i);
+                        is.newLine();
+                    }
+                }
+            }
 
         } catch (Exception e) {
             throw new GradleException("Failed to run", e);
@@ -218,9 +230,11 @@ private QuarkusDevModeLauncher newLauncher() throws Exception {
                 .outputDir(getBuildDir())
                 .debug(System.getProperty("debug"))
                 .debugHost(System.getProperty("debugHost", "localhost"))
-                .suspend(System.getProperty("suspend"))
-                .jvmArgs("-Dquarkus.test.basic-console=true")
-                .jvmArgs("-Dio.quarkus.launched-from-ide=true");
+                .suspend(System.getProperty("suspend"));
+        if (System.getProperty(IO_QUARKUS_DEVMODE_ARGS) == null) {
+            builder.jvmArgs("-Dquarkus.test.basic-console=true")
+                    .jvmArgs("-Dio.quarkus.launched-from-ide=true");
+        }
 
         if (getJvmArgs() != null) {
             builder.jvmArgs(getJvmArgs());

docs/src/main/asciidoc/gradle-tooling.adoc

@@ -163,14 +163,24 @@ You can install all extensions which match a globbing pattern:
 [[dev-mode]]
 == Development mode
 
-Quarkus comes with a built-in development mode.
+Quarkus comes with a built-in development mode. The best way to run this is via the link:cli-tooling.adoc[Quarkus CLI]
 Run your application with:
 
 [source,bash]
 ----
-./gradlew quarkusDev
+quarkus dev
 ----
 
+If you don't want to install the Quarkus CLI you can run development mode directly from gradle:
+
+[source,bash]
+----
+./gradlew --console=plain quarkusDev
+----
+
+Note that if you run it this way the continuous testing experience will not be as nice, as gradle runs as a daemon
+Quarkus can't draw the 'pretty' test output so falls back to just logging the output.
+
 You can then update the application sources, resources and configurations.
 The changes are automatically reflected in your running application.
 This is great to do development spanning UI and database as you see changes reflected immediately.