Introduce QuarkusProject in codegen to reduce ProjectWriter and Build…

…Tool coupling This is part of quarkusio#8178 This is a good one :-), things starts to get nicer and cleaner (but not quite there yet ^^)..
ia3andy · May 27, 2020 · 1dc58e9 · 1dc58e9
1 parent cee1b75
commit 1dc58e9
Show file tree

Hide file tree

Showing 35 changed files with 334 additions and 467 deletions.
diff --git a/devtools/aesh/src/main/java/io/quarkus/cli/commands/AddExtensionCommand.java b/devtools/aesh/src/main/java/io/quarkus/cli/commands/AddExtensionCommand.java
@@ -1,6 +1,7 @@
 package io.quarkus.cli.commands;
 
-import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Collections;
 import java.util.List;
 
@@ -13,7 +14,7 @@
 import org.aesh.command.option.Option;
 import org.aesh.io.Resource;
 
-import io.quarkus.cli.commands.writer.FileProjectWriter;
+import io.quarkus.cli.commands.project.QuarkusProject;
 import io.quarkus.dependencies.Extension;
 import io.quarkus.platform.descriptor.QuarkusPlatformDescriptor;
 import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
@@ -30,8 +31,8 @@ public class AddExtensionCommand implements Command<CommandInvocation> {
     @Option(shortName = 'e', required = true, description = "Name of the extension that will be added to the project")
     private String extension;
 
-    @Argument(required = true, description = "Path to the project pom the extension will be added")
-    private Resource pom;
+    @Argument(description = "path to the project", required = true)
+    private Resource path;
 
     @Override
     public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
@@ -45,20 +46,17 @@ public CommandResult execute(CommandInvocation commandInvocation) throws Command
                 commandInvocation.println("Can not find any extension named: " + extension);
                 return CommandResult.SUCCESS;
             }
-            if (pom.isLeaf()) {
-                try {
-                    final File pomFile = new File(pom.getAbsolutePath());
-                    AddExtensions project = new AddExtensions(new FileProjectWriter(pomFile.getParentFile()), platformDescr)
-                            .extensions(Collections.singleton(extension));
-                    QuarkusCommandOutcome result = project.execute();
-                    if (!result.isSuccess()) {
-                        throw new CommandException("Unable to add an extension matching " + extension);
-                    }
-                } catch (Exception e) {
-                    throw new CommandException("Unable to add an extension matching " + extension, e);
+            try {
+                final Path projectPath = Paths.get(path.getAbsolutePath());
+                AddExtensions project = new AddExtensions(QuarkusProject.resolveExistingProject(projectPath,
+                        platformDescr)).extensions(Collections.singleton(extension));
+                QuarkusCommandOutcome result = project.execute();
+                if (!result.isSuccess()) {
+                    throw new CommandException("Unable to add an extension matching " + extension);
                 }
+            } catch (Exception e) {
+                throw new CommandException("Unable to add an extension matching " + extension, e);
             }
-
         }
 
         return CommandResult.SUCCESS;

diff --git a/devtools/aesh/src/main/java/io/quarkus/cli/commands/CreateProjectCommand.java b/devtools/aesh/src/main/java/io/quarkus/cli/commands/CreateProjectCommand.java
@@ -1,7 +1,7 @@
 package io.quarkus.cli.commands;
 
-import java.io.File;
 import java.io.IOException;
+import java.nio.file.Paths;
 import java.util.HashMap;
 
 import org.aesh.command.Command;
@@ -11,7 +11,6 @@
 import org.aesh.command.option.Option;
 import org.aesh.io.Resource;
 
-import io.quarkus.cli.commands.writer.FileProjectWriter;
 import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
 
 /**
@@ -43,7 +42,7 @@ public CommandResult execute(CommandInvocation commandInvocation) {
 
         if (path != null) {
             try {
-                boolean status = new CreateProject(new FileProjectWriter(new File(path.getAbsolutePath())),
+                boolean status = new CreateProject(Paths.get(path.getAbsolutePath()),
                         QuarkusPlatformConfig.getGlobalDefault().getPlatformDescriptor())
                                 .groupId(groupid)
                                 .artifactId(artifactid)

diff --git a/devtools/aesh/src/main/java/io/quarkus/cli/commands/ListExtensionsCommand.java b/devtools/aesh/src/main/java/io/quarkus/cli/commands/ListExtensionsCommand.java
@@ -1,21 +1,17 @@
 package io.quarkus.cli.commands;
 
-import java.io.File;
-import java.io.IOException;
+import java.nio.file.Paths;
 
 import org.aesh.command.Command;
 import org.aesh.command.CommandDefinition;
 import org.aesh.command.CommandException;
 import org.aesh.command.CommandResult;
 import org.aesh.command.invocation.CommandInvocation;
+import org.aesh.command.option.Argument;
 import org.aesh.command.option.Option;
 import org.aesh.io.Resource;
 
-import io.quarkus.cli.commands.file.BuildFile;
-import io.quarkus.cli.commands.file.GradleBuildFile;
-import io.quarkus.cli.commands.file.MavenBuildFile;
-import io.quarkus.cli.commands.writer.FileProjectWriter;
-import io.quarkus.cli.commands.writer.ProjectWriter;
+import io.quarkus.cli.commands.project.QuarkusProject;
 import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
 
 /**
@@ -36,29 +32,18 @@ public class ListExtensionsCommand implements Command<CommandInvocation> {
     @Option(shortName = 's', hasValue = true, description = "Search filter on extension list. The format is based on Java Pattern.")
     private String searchPattern;
 
-    @Option(shortName = 'p', description = "path to the project")
+    @Argument(description = "path to the project", required = true)
     private Resource path;
 
     public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
         if (help) {
             commandInvocation.println(commandInvocation.getHelpInfo("quarkus list-extensions"));
         } else {
             try {
-                BuildFile buildFile = null;
-                ProjectWriter writer = null;
-                if (path != null) {
-                    File projectDirectory = new File(path.getAbsolutePath());
-                    writer = new FileProjectWriter(projectDirectory);
-                    if (new File(projectDirectory, "build.gradle").exists()
-                            || new File(projectDirectory, "build.gradle.kts").exists()) {
-                        buildFile = new GradleBuildFile(writer);
-                    } else {
-                        buildFile = new MavenBuildFile(writer);
-                    }
-                }
-                new ListExtensions(writer, buildFile, QuarkusPlatformConfig.getGlobalDefault().getPlatformDescriptor())
-                        .all(all).format(format).search(searchPattern);
-            } catch (IOException e) {
+                new ListExtensions(QuarkusProject.resolveExistingProject(Paths.get(path.getAbsolutePath()),
+                        QuarkusPlatformConfig.getGlobalDefault().getPlatformDescriptor()))
+                                .all(all).format(format).search(searchPattern);
+            } catch (Exception e) {
                 throw new CommandException("Unable to list extensions", e);
             }
         }

diff --git a/devtools/aesh/src/main/java/io/quarkus/cli/commands/RemoveExtensionCommand.java b/devtools/aesh/src/main/java/io/quarkus/cli/commands/RemoveExtensionCommand.java
@@ -1,6 +1,7 @@
 package io.quarkus.cli.commands;
 
-import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Collections;
 import java.util.List;
 
@@ -13,7 +14,7 @@
 import org.aesh.command.option.Option;
 import org.aesh.io.Resource;
 
-import io.quarkus.cli.commands.writer.FileProjectWriter;
+import io.quarkus.cli.commands.project.QuarkusProject;
 import io.quarkus.dependencies.Extension;
 import io.quarkus.platform.descriptor.QuarkusPlatformDescriptor;
 import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
@@ -27,8 +28,8 @@ public class RemoveExtensionCommand implements Command<CommandInvocation> {
     @Option(shortName = 'e', required = true, description = "Name of the extension that will be removed from the project")
     private String extension;
 
-    @Argument(required = true, description = "Path to the project pom the extension will be removed from")
-    private Resource pom;
+    @Argument(description = "path to the project", required = true)
+    private Resource path;
 
     @Override
     public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
@@ -42,21 +43,17 @@ public CommandResult execute(CommandInvocation commandInvocation) throws Command
                 commandInvocation.println("Can not find any extension named: " + extension);
                 return CommandResult.SUCCESS;
             }
-            if (pom.isLeaf()) {
-                try {
-                    final File pomFile = new File(pom.getAbsolutePath());
-                    RemoveExtensions project = new RemoveExtensions(new FileProjectWriter(pomFile.getParentFile()),
-                            platformDescr)
-                                    .extensions(Collections.singleton(extension));
-                    QuarkusCommandOutcome result = project.execute();
-                    if (!result.isSuccess()) {
-                        throw new CommandException("Unable to remove an extension matching " + extension);
-                    }
-                } catch (Exception e) {
-                    throw new CommandException("Unable to remove an extension matching " + extension, e);
+            try {
+                final Path projectPath = Paths.get(path.getAbsolutePath());
+                RemoveExtensions project = new RemoveExtensions(QuarkusProject.resolveExistingProject(projectPath,
+                        platformDescr)).extensions(Collections.singleton(extension));
+                QuarkusCommandOutcome result = project.execute();
+                if (!result.isSuccess()) {
+                    throw new CommandException("Unable to remove an extension matching " + extension);
                 }
+            } catch (Exception e) {
+                throw new CommandException("Unable to remove an extension matching " + extension, e);
             }
-
         }
 
         return CommandResult.SUCCESS;

diff --git a/devtools/gradle/src/functionalTest/java/io/quarkus/gradle/QuarkusPluginFunctionalTest.java b/devtools/gradle/src/functionalTest/java/io/quarkus/gradle/QuarkusPluginFunctionalTest.java
@@ -6,18 +6,10 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import com.google.common.collect.ImmutableMap;
-import io.quarkus.deployment.util.FileUtil;
-import io.quarkus.platform.descriptor.QuarkusPlatformDescriptor;
-import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
-import io.quarkus.test.devmode.util.DevModeTestUtils;
 import org.gradle.testkit.runner.BuildResult;
 import org.gradle.testkit.runner.GradleRunner;
 import org.gradle.testkit.runner.TaskOutcome;
@@ -27,10 +19,13 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
 
+import com.google.common.collect.ImmutableMap;
+
 import io.quarkus.cli.commands.CreateProject;
-import io.quarkus.cli.commands.writer.FileProjectWriter;
-import io.quarkus.generators.BuildTool;
+import io.quarkus.cli.commands.project.BuildTool;
 import io.quarkus.generators.SourceType;
+import io.quarkus.platform.tools.config.QuarkusPlatformConfig;
+import io.quarkus.test.devmode.util.DevModeTestUtils;
 
 public class QuarkusPluginFunctionalTest extends QuarkusGradleTestBase {
 
@@ -155,7 +150,7 @@ private BuildResult runTask(List<String> arguments) {
     private void createProject(SourceType sourceType) throws IOException {
         Map<String, Object> context = new HashMap<>();
         context.put("path", "/greeting");
-        assertThat(new CreateProject(new FileProjectWriter(projectRoot),
+        assertThat(new CreateProject(projectRoot.toPath(),
                                      QuarkusPlatformConfig.getGlobalDefault().getPlatformDescriptor())
                 .groupId("com.acme.foo")
                 .artifactId("foo")

diff --git a/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusAddExtension.java b/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusAddExtension.java
@@ -40,7 +40,7 @@ public void addExtension() {
                 .collect(toSet());
 
         try {
-            new AddExtensions(getWriter(), getGradleBuildFile(), platformDescriptor())
+            new AddExtensions(getQuarkusProject())
                     .extensions(extensionsSet)
                     .execute();
         } catch (Exception e) {

diff --git a/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusListExtensions.java b/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusListExtensions.java
@@ -7,6 +7,8 @@
 import org.gradle.api.tasks.options.Option;
 
 import io.quarkus.cli.commands.ListExtensions;
+import io.quarkus.cli.commands.project.QuarkusProject;
+import io.quarkus.cli.commands.writer.FileProjectWriter;
 import io.quarkus.gradle.GradleBuildFileFromConnector;
 
 public class QuarkusListExtensions extends QuarkusPlatformTask {
@@ -56,12 +58,15 @@ public QuarkusListExtensions() {
     @TaskAction
     public void listExtensions() {
         try {
-            new ListExtensions(getWriter(), new GradleBuildFileFromConnector(getWriter()),
-                    platformDescriptor())
-                            .all(isAll())
-                            .format(getFormat())
-                            .search(getSearchPattern())
-                            .execute();
+            final GradleBuildFileFromConnector buildFileFromConnector = new GradleBuildFileFromConnector(
+                    new FileProjectWriter(getProject().getProjectDir()));
+            QuarkusProject quarkusProject = QuarkusProject.of(getProject().getProjectDir().toPath(), platformDescriptor(),
+                    buildFileFromConnector);
+            new ListExtensions(quarkusProject)
+                    .all(isAll())
+                    .format(getFormat())
+                    .search(getSearchPattern())
+                    .execute();
         } catch (Exception e) {
             throw new GradleException("Unable to list extensions", e);
         }

diff --git a/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusPlatformTask.java b/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusPlatformTask.java
@@ -11,7 +11,9 @@
 import org.gradle.api.tasks.Internal;
 
 import io.quarkus.cli.commands.file.GradleBuildFile;
+import io.quarkus.cli.commands.project.QuarkusProject;
 import io.quarkus.cli.commands.writer.FileProjectWriter;
+import io.quarkus.cli.commands.writer.ProjectWriter;
 import io.quarkus.platform.descriptor.CombinedQuarkusPlatformDescriptor;
 import io.quarkus.platform.descriptor.QuarkusPlatformDescriptor;
 import io.quarkus.platform.descriptor.resolver.json.QuarkusJsonPlatformDescriptorResolver;
@@ -65,14 +67,15 @@ protected QuarkusPlatformDescriptor platformDescriptor() {
 
     @Internal
     protected GradleBuildFile getGradleBuildFile() {
+        final ProjectWriter writer = new FileProjectWriter(getProject().getProjectDir());
         return getProject().getParent() == null
-                ? new GradleBuildFile(getWriter())
-                : new GradleBuildFile(getWriter(),
+                ? new GradleBuildFile(writer)
+                : new GradleBuildFile(writer,
                         new FileProjectWriter(getProject().getRootProject().getProjectDir()));
     }
 
     @Internal
-    protected FileProjectWriter getWriter() {
-        return new FileProjectWriter(getProject().getProjectDir());
+    protected QuarkusProject getQuarkusProject() {
+        return QuarkusProject.of(getProject().getProjectDir().toPath(), platformDescriptor(), getGradleBuildFile());
     }
 }
diff --git a/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusRemoveExtension.java b/devtools/gradle/src/main/java/io/quarkus/gradle/tasks/QuarkusRemoveExtension.java
@@ -39,7 +39,7 @@ public void removeExtension() {
                 .map(String::trim)
                 .collect(toSet());
         try {
-            new RemoveExtensions(getWriter(), getGradleBuildFile(), platformDescriptor())
+            new RemoveExtensions(getQuarkusProject())
                     .extensions(extensionsSet)
                     .execute();
         } catch (Exception e) {

diff --git a/devtools/maven/src/main/java/io/quarkus/maven/AddExtensionMojo.java b/devtools/maven/src/main/java/io/quarkus/maven/AddExtensionMojo.java
@@ -1,6 +1,5 @@
 package io.quarkus.maven;
 
-import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
@@ -13,10 +12,7 @@
 
 import io.quarkus.cli.commands.AddExtensions;
 import io.quarkus.cli.commands.QuarkusCommandOutcome;
-import io.quarkus.cli.commands.file.BuildFile;
-import io.quarkus.cli.commands.writer.ProjectWriter;
-import io.quarkus.generators.BuildTool;
-import io.quarkus.platform.descriptor.QuarkusPlatformDescriptor;
+import io.quarkus.cli.commands.project.QuarkusProject;
 import io.quarkus.platform.tools.MessageWriter;
 
 /**
@@ -49,15 +45,8 @@ protected void validateParameters() throws MojoExecutionException {
     }
 
     @Override
-    public void doExecute(ProjectWriter writer, BuildFile buildFile, QuarkusPlatformDescriptor platformDescr, MessageWriter log)
+    public void doExecute(final QuarkusProject quarkusProject, final MessageWriter log)
             throws MojoExecutionException {
-        if (buildFile == null) {
-            try {
-                buildFile = BuildTool.MAVEN.createBuildFile(writer);
-            } catch (IOException e) {
-                throw new MojoExecutionException("Failed to initialize the project's build descriptor", e);
-            }
-        }
         Set<String> ext = new HashSet<>();
         if (extensions != null && !extensions.isEmpty()) {
             ext.addAll(extensions);
@@ -68,7 +57,7 @@ public void doExecute(ProjectWriter writer, BuildFile buildFile, QuarkusPlatform
         }
 
         try {
-            final QuarkusCommandOutcome outcome = new AddExtensions(writer, buildFile, platformDescr)
+            final QuarkusCommandOutcome outcome = new AddExtensions(quarkusProject)
                     .extensions(ext.stream().map(String::trim).collect(Collectors.toSet()))
                     .execute();
             if (!outcome.isSuccess()) {