[WFMP-295] Allow the jboss.home property to be used in the dev goal. Deprecated the provisioningDir parameter in the dev, run, and start goals as we should just use jboss.home.

jamezp · jamezp · commit 5f3c4dc04eda · 2025-04-10T19:30:31.000-07:00
https://issues.redhat.com/browse/WFMP-295 Signed-off-by: James R. Perkins <jperkins@redhat.com>
diff --git a/plugin/src/main/java/org/wildfly/plugin/dev/DevMojo.java b/plugin/src/main/java/org/wildfly/plugin/dev/DevMojo.java
@@ -67,7 +67,6 @@
 import org.jboss.galleon.maven.plugin.util.MavenArtifactRepositoryManager;
 import org.jboss.galleon.maven.plugin.util.MvnMessageWriter;
 import org.jboss.galleon.universe.maven.repo.MavenRepoManager;
-import org.jboss.galleon.util.IoUtils;
 import org.jboss.logging.Logger;
 import org.twdata.maven.mojoexecutor.MojoExecutor;
 import org.wildfly.channel.UnresolvedMavenArtifactException;
@@ -305,7 +304,7 @@ public class DevMojo extends AbstractServerStartMojo {
     private boolean offlineProvisioning;
 
     /**
-     * Set to {@code true} if you want to delete the existing server referenced from the {@code provisioningDir} and provision a
+     * Set to {@code true} if you want to delete the existing server referenced from the {@code jbossHome} and provision a
      * new one,
      * otherwise {@code false}. When { @code discover-provisioning-info } is set to {@code true}, this option is enforced to be
      * {@code true}.
@@ -401,7 +400,6 @@ public class DevMojo extends AbstractServerStartMojo {
 
     private String warGoal = MAVEN_EXPLODED_GOAL;
     private ScanResults results;
-    private Path installDir;
     private boolean requiresWarDeletion;
     private Logger mavenJBossLogger;
 
@@ -413,6 +411,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
         mavenJBossLogger = new MavenJBossLogger(getLog());
         serverConfig = serverConfig == null ? "standalone.xml" : serverConfig;
+        boolean startServer = false;
         ServerContext context = null;
         if (remote) {
             init();
@@ -424,7 +423,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                     getLog().info("Layer discovery has been enabled, overwriteProvisionedServer has been set to true");
                 }
             } else {
-                context = startServer(ServerType.STANDALONE);
+                startServer = true;
             }
         }
         try {
@@ -439,7 +438,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 requiresWarDeletion = !remote;
             }
             // We must start the server after compilation occurred to get a deployment to scan
-            if (!remote && isDiscoveryEnabled()) {
+            if (startServer) {
                 context = startServer(ServerType.STANDALONE);
             }
             try (final WatchService watcher = FileSystems.getDefault().newWatchService()) {
@@ -593,17 +592,18 @@ boolean reprovisionAndStart()
         if (newConfig == null) {
             return false;
         }
+        final Path jbossHome = resolveJBossHome();
         debug("Changes in layers detected, must re-provision the server");
         try (ModelControllerClient client = createClient()) {
             ServerManager.builder().client(client).standalone().shutdown();
-            debug("Deleting existing installation " + installDir);
-            IoUtils.recursiveDelete(installDir);
+            debug("Deleting existing installation " + jbossHome);
+            deleteRecursively(jbossHome);
         }
         GalleonBuilder galleonBuilder = new GalleonBuilder();
         galleonBuilder.addArtifactResolver(mavenRepoManager);
         ProvisioningBuilder builder = galleonBuilder.newProvisioningBuilder(newConfig);
         try (Provisioning pm = builder
-                .setInstallationHome(installDir)
+                .setInstallationHome(jbossHome)
                 .setMessageWriter(new MvnMessageWriter(getLog()))
                 .build()) {
             provisionServer(pm, newConfig);
@@ -614,15 +614,21 @@ boolean reprovisionAndStart()
 
     @Override
     protected Path provisionIfRequired(final Path installDir) throws MojoFailureException, MojoExecutionException {
+        if (!isAllowProvisioning()) {
+            return installDir;
+        }
         // This is called for the initial start of the server.
-        this.installDir = installDir;
         if (!overwriteProvisionedServer && Files.exists(installDir)) {
             getLog().info(String.format("A server already exists in %s, provisioning for %s:%s", installDir,
                     project.getGroupId(), project.getArtifactId()));
             return installDir;
         }
         if (Files.exists(installDir)) {
-            IoUtils.recursiveDelete(installDir);
+            try {
+                deleteRecursively(installDir);
+            } catch (IOException ex) {
+                throw new MojoExecutionException("Failed to delete directory " + installDir, ex);
+            }
         }
         try {
             GalleonBuilder provider = new GalleonBuilder();
@@ -659,6 +665,11 @@ protected Path provisionIfRequired(final Path installDir) throws MojoFailureExce
         return installDir;
     }
 
+    @Override
+    protected boolean isAllowProvisioning() {
+        return overwriteProvisionedServer || super.isAllowProvisioning();
+    }
+
     private ScanResults scanDeployment(GalleonBuilder pm) throws Exception {
         List<Path> lst = new ArrayList<>();
         lst.add(resolveWarLocation());
@@ -675,6 +686,7 @@ private ScanResults scanDeployment(GalleonBuilder pm) throws Exception {
 
     private void provisionServer(Provisioning pm, GalleonProvisioningConfig config)
             throws ProvisioningException, MojoExecutionException {
+        final Path installDir = resolveJBossHome();
         getLog().info("Provisioning server in " + installDir);
         PluginProgressTracker.initTrackers(pm, mavenJBossLogger);
         pm.provision(config);
diff --git a/plugin/src/main/java/org/wildfly/plugin/server/AbstractServerStartMojo.java b/plugin/src/main/java/org/wildfly/plugin/server/AbstractServerStartMojo.java
@@ -36,10 +36,11 @@ public abstract class AbstractServerStartMojo extends AbstractStartMojo {
     protected File targetDir;
 
     /**
-     * The WildFly Application Server's home directory. If not used, WildFly will be downloaded.
+     * The WildFly Application Server's home directory. If not set, a server will be provisioned in the
+     * <code>${project.build.directory}/server</code>.
      */
     @Parameter(alias = "jboss-home", property = PropertyNames.JBOSS_HOME)
-    protected String jbossHome;
+    private String jbossHome;
 
     /**
      * The feature pack location. See the <a href="https://docs.wildfly.org/galleon/#_feature_pack_location">documentation</a>
@@ -64,11 +65,17 @@ public abstract class AbstractServerStartMojo extends AbstractStartMojo {
 
     /**
      * The directory name inside the buildDir where to provision the default server.
-     * By default the server is provisioned into the 'server' directory.
+     * By default, the server is provisioned into the 'server' directory.
+     * <p>
+     * This parameter has been deprecated in favor of using the {@code <jbossHome/>} parameter. If both are defined,
+     * this parameter will be ignored.
+     * </p>
      *
      * @since 3.0
+     * @deprecated use jbossHome setting
      */
-    @Parameter(alias = "provisioning-dir", property = PropertyNames.WILDFLY_PROVISIONING_DIR, defaultValue = Utils.WILDFLY_DEFAULT_DIR)
+    @Deprecated(forRemoval = true)
+    @Parameter(alias = "provisioning-dir", property = PropertyNames.WILDFLY_PROVISIONING_DIR)
     private String provisioningDir;
 
     /**
@@ -91,10 +98,12 @@ public abstract class AbstractServerStartMojo extends AbstractStartMojo {
     @Parameter(alias = "add-user", property = "wildfly.add-user")
     private AddUser addUser;
 
+    private Path cachedJBossHome;
+    private boolean allowProvisioning;
+
     @Override
     protected Path getServerHome() throws MojoExecutionException, MojoFailureException {
-        // Validate the environment
-        final Path jbossHome = provisionIfRequired(targetDir.toPath().resolve(provisioningDir));
+        final Path jbossHome = provisionIfRequired(resolveJBossHome());
         if (!ServerManager.isValidHomeDirectory(jbossHome)) {
             throw new MojoExecutionException(String.format("JBOSS_HOME '%s' is not a valid directory.", jbossHome));
         }
@@ -211,19 +220,18 @@ protected DomainCommandBuilder createDomainCommandBuilder(final Path jbossHome,
     }
 
     protected Path provisionIfRequired(final Path installDir) throws MojoFailureException, MojoExecutionException {
-        if (jbossHome != null) {
-            // we do not need to download WildFly
-            return Paths.get(jbossHome);
-        }
-        try {
-            if (!Files.exists(installDir)) {
-                getLog().info("Provisioning default server in " + installDir);
-                GalleonUtils.provision(installDir, resolveFeaturePackLocation(), version, mavenRepoManager);
+        if (isAllowProvisioning()) {
+            try {
+                if (!Files.exists(installDir)) {
+                    getLog().info("Provisioning default server in " + installDir);
+                    GalleonUtils.provision(installDir, resolveFeaturePackLocation(), version, mavenRepoManager);
+                }
+                return installDir;
+            } catch (ProvisioningException ex) {
+                throw new MojoFailureException(ex.getLocalizedMessage(), ex);
             }
-            return installDir;
-        } catch (ProvisioningException ex) {
-            throw new MojoFailureException(ex.getLocalizedMessage(), ex);
         }
+        return resolveJBossHome();
     }
 
     private void addUsers(final Path wildflyHome, final Path javaHome) throws IOException {
@@ -245,4 +253,39 @@ private String resolveFeaturePackLocation() {
     protected String getDefaultFeaturePackLocation() {
         return "wildfly@maven(org.jboss.universe:community-universe)";
     }
+
+    /**
+     * Indicates if provisioning should be allowed or not.
+     * <p>
+     * Provisioning is said to be allowed if the JBoss Home directory does not exist and does not already have a server
+     * provisioned in it.
+     * </p>
+     *
+     * @return {@code true} if provisioning is allowed, otherwise {@code false}
+     */
+    protected boolean isAllowProvisioning() {
+        resolveJBossHome();
+        return allowProvisioning;
+    }
+
+    /**
+     * Resolves the JBoss Home directory.
+     *
+     * @return the JBoss Home directory
+     */
+    protected Path resolveJBossHome() {
+        if (cachedJBossHome == null) {
+            if (jbossHome == null) {
+                if (provisioningDir == null) {
+                    cachedJBossHome = Path.of(project.getBuild().getDirectory(), Utils.WILDFLY_DEFAULT_DIR);
+                } else {
+                    cachedJBossHome = Path.of(project.getBuild().getDirectory(), provisioningDir);
+                }
+            } else {
+                cachedJBossHome = Path.of(jbossHome);
+            }
+            allowProvisioning = !ServerManager.isValidHomeDirectory(cachedJBossHome);
+        }
+        return cachedJBossHome;
+    }
 }
