From 295a900d2e9b46f5de97ffb181b54231ae161004 Mon Sep 17 00:00:00 2001 From: Cheryl King Date: Mon, 19 Feb 2024 16:18:00 -0600 Subject: [PATCH 1/3] Detect install config changes during dev mode --- .../tools/maven/server/DevMojo.java | 71 ++++++++++++++++++- .../maven/server/PluginConfigSupport.java | 8 ++- 2 files changed, 74 insertions(+), 5 deletions(-) diff --git a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java index 3e958ce8e..f9297b306 100644 --- a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java +++ b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java @@ -589,12 +589,25 @@ private boolean dependencyEquals(Dependency dep1, Dependency dep2) { return true; } + private static final String LIBERTY_RUNTIME_PROP = "liberty.runtime."; private static final String LIBERTY_BOOTSTRAP_PROP = "liberty.bootstrap."; private static final String LIBERTY_JVM_PROP = "liberty.jvm."; private static final String LIBERTY_ENV_PROP = "liberty.env."; private static final String LIBERTY_VAR_PROP = "liberty.var."; private static final String LIBERTY_DEFAULT_VAR_PROP = "liberty.defaultVar."; + private boolean hasInstallationPropChanged(MavenProject project, MavenProject backupProject) { + Properties projProp = project.getProperties(); + Properties backupProjProp = backupProject.getProperties(); + + if (!Objects.equals(getPropertiesWithKeyPrefix(projProp, LIBERTY_RUNTIME_PROP), + getPropertiesWithKeyPrefix(backupProjProp, LIBERTY_RUNTIME_PROP))) { + return true; + } + + return false; + } + private boolean hasServerPropertyChanged(MavenProject project, MavenProject backupProject) { Properties projProp = project.getProperties(); Properties backupProjProp = backupProject.getProperties(); @@ -651,6 +664,39 @@ private boolean restartForLibertyMojoConfigChanged(Xpp3Dom config, Xpp3Dom oldCo return false; } + private boolean hasInstallationConfigChanged(Xpp3Dom config, Xpp3Dom oldConfig) { + if (!Objects.equals(config.getChild("installDirectory"), oldConfig.getChild("installDirectory"))) { + return true; + } else if (!Objects.equals(config.getChild("runtimeArchive"), oldConfig.getChild("runtimeArchive"))) { + return true; + } else if (!Objects.equals(config.getChild("runtimeArtifact"), oldConfig.getChild("runtimeArtifact"))) { + return true; + } else if (!Objects.equals(config.getChild("assemblyArchive"), oldConfig.getChild("assemblyArchive"))) { + return true; + } else if (!Objects.equals(config.getChild("assemblyArtifact"), oldConfig.getChild("assemblyArtifact"))) { + return true; + } else if (!Objects.equals(config.getChild("libertyRuntimeGroupId"), oldConfig.getChild("libertyRuntimeGroupId"))) { + return true; + } else if (!Objects.equals(config.getChild("libertyRuntimeArtifactId"), oldConfig.getChild("libertyRuntimeArtifactId"))) { + return true; + } else if (!Objects.equals(config.getChild("libertyRuntimeVersion"), oldConfig.getChild("libertyRuntimeVersion"))) { + return true; + } else if (!Objects.equals(config.getChild("serverName"), oldConfig.getChild("serverName"))) { + return true; + } else if (!Objects.equals(config.getChild("userDirectory"), oldConfig.getChild("userDirectory"))) { + return true; + } else if (!Objects.equals(config.getChild("outputDirectory"), oldConfig.getChild("outputDirectory"))) { + return true; + } else if (!Objects.equals(config.getChild("runtimeInstallDirectory"), oldConfig.getChild("runtimeInstallDirectory"))) { + return true; + } else if (!Objects.equals(config.getChild("assemblyInstallDirectory"), oldConfig.getChild("assemblyInstallDirectory"))) { + return true; + } else if (!Objects.equals(config.getChild("install"), oldConfig.getChild("install"))) { + return true; + } + return false; + } + @Override public boolean updateArtifactPaths(ProjectModule projectModule, boolean redeployCheck, boolean generateFeatures, ThreadPoolExecutor executor) throws PluginExecutionException { @@ -913,6 +959,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat // - liberty.* properties in project properties section // - changes in liberty plugin configuration in the build plugin section // - project dependencies changes + boolean reinstallLiberty = false; // if this gets set to true, need to throw PluginExecutionException so user can run 'clean' boolean restartServer = false; boolean createServer = false; boolean installFeature = false; @@ -949,6 +996,13 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat } // Monitoring liberty properties in the pom.xml + if (hasInstallationPropChanged(project, backupProject)) { + // Note that a change in some config values requires a 'clean' because the install location is the same, but the + // artifact that gets installed would be different. This can happen when using 'libertyRuntime' for example and + // only changing the 'version'. + reinstallLiberty = true; + getLog().error("A change in Liberty runtime installation configuration requires a 'clean'. Stopping dev mode."); + } if (hasServerPropertyChanged(project, backupProject)) { restartServer = true; } @@ -967,6 +1021,14 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat if (restartForLibertyMojoConfigChanged(config, oldConfig)) { restartServer = true; } + if (hasInstallationConfigChanged(config, oldConfig)) { + // Note that a change in some config values requires a 'clean' because the install location is the same, but the + // artifact that gets installed would be different. This can happen when using 'runtimeArtifact' for example and + // only changing the 'version'. + //throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a 'clean'. After running the 'clean' goal, please run the 'dev' goal again for the change to take effect."); + reinstallLiberty = true; + getLog().error("A change in Liberty runtime installation configuration requires a 'clean'. Stopping dev mode."); + } } } config = ExecuteMojoUtil.getPluginGoalConfig(libertyPlugin, "install-feature", getLog()); @@ -1054,7 +1116,12 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat getLog().warn("Change detected in the set of resource directories, since dev mode was first launched. Adding/deleting a resource directory has no change on the set of directories monitored by dev mode. Changing the watch list will require a dev mode restart"); } - if (restartServer) { + if (reinstallLiberty) { + project = backupProject; + session.setCurrentProject(backupProject); + util.stopServer(); + throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a 'clean'. After running the 'clean' goal, please run the 'dev' goal again for the change to take effect."); + } else if (restartServer) { // - stop Server // - create server or runBoostMojo // - install feature @@ -1077,7 +1144,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat runLibertyMojoInstallFeature(null, null, super.getContainerName()); } } - if (!(restartServer || createServer || redeployApp || installFeature || runBoostPackage)) { + if (!(reinstallLiberty || restartServer || createServer || redeployApp || installFeature || runBoostPackage)) { // pom.xml is changed but not affecting liberty:dev mode. return true with the // updated project set in the session getLog().debug("changes in the pom.xml are not monitored by dev mode"); diff --git a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/PluginConfigSupport.java b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/PluginConfigSupport.java index 1b4c88ce4..389693304 100644 --- a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/PluginConfigSupport.java +++ b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/PluginConfigSupport.java @@ -131,9 +131,11 @@ protected File exportParametersToXml(boolean includeServerInfo) throws IOExcepti // install related info (common parameters) configDocument.createElement("installDirectory", installDirectory); - configDocument.createElement("assemblyArtifact", assemblyArtifact); - configDocument.createElement("assemblyArchive", assemblyArchive); - configDocument.createElement("assemblyInstallDirectory", assemblyInstallDirectory); + if (installType != InstallType.ALREADY_EXISTS) { + configDocument.createElement("assemblyArtifact", assemblyArtifact); + configDocument.createElement("assemblyArchive", assemblyArchive); + configDocument.createElement("assemblyInstallDirectory", assemblyInstallDirectory); + } configDocument.createElement("refresh", refresh); configDocument.createElement("install", install); From f0d36c499ec2bf374a155bbfe1b27c790d9a75d8 Mon Sep 17 00:00:00 2001 From: Cheryl King Date: Wed, 21 Feb 2024 09:45:15 -0600 Subject: [PATCH 2/3] Update message to not say clean is required --- .../java/io/openliberty/tools/maven/server/DevMojo.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java index f9297b306..575148f6c 100644 --- a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java +++ b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java @@ -1001,7 +1001,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat // artifact that gets installed would be different. This can happen when using 'libertyRuntime' for example and // only changing the 'version'. reinstallLiberty = true; - getLog().error("A change in Liberty runtime installation configuration requires a 'clean'. Stopping dev mode."); + getLog().error("A change in Liberty runtime installation configuration requires a restart of dev mode. Stopping dev mode."); } if (hasServerPropertyChanged(project, backupProject)) { restartServer = true; @@ -1027,7 +1027,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat // only changing the 'version'. //throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a 'clean'. After running the 'clean' goal, please run the 'dev' goal again for the change to take effect."); reinstallLiberty = true; - getLog().error("A change in Liberty runtime installation configuration requires a 'clean'. Stopping dev mode."); + getLog().error("A change in Liberty runtime installation configuration requires a restart of dev mode. Stopping dev mode."); } } } @@ -1120,7 +1120,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat project = backupProject; session.setCurrentProject(backupProject); util.stopServer(); - throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a 'clean'. After running the 'clean' goal, please run the 'dev' goal again for the change to take effect."); + throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a restart of dev mode. Please run the 'dev' goal again for the change to take effect."); } else if (restartServer) { // - stop Server // - create server or runBoostMojo From 5975d42990291de46c79a5d4791ee7458ca040c6 Mon Sep 17 00:00:00 2001 From: Cheryl King Date: Wed, 21 Feb 2024 17:53:52 -0600 Subject: [PATCH 3/3] review comments --- .../java/io/openliberty/tools/maven/server/DevMojo.java | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java index 575148f6c..69cdfd1ea 100644 --- a/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java +++ b/liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java @@ -997,9 +997,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat // Monitoring liberty properties in the pom.xml if (hasInstallationPropChanged(project, backupProject)) { - // Note that a change in some config values requires a 'clean' because the install location is the same, but the - // artifact that gets installed would be different. This can happen when using 'libertyRuntime' for example and - // only changing the 'version'. + // Note that a change in installation config values requires a restart of dev mode. reinstallLiberty = true; getLog().error("A change in Liberty runtime installation configuration requires a restart of dev mode. Stopping dev mode."); } @@ -1022,10 +1020,7 @@ public boolean recompileBuildFile(File buildFile, Set compileArtifactPat restartServer = true; } if (hasInstallationConfigChanged(config, oldConfig)) { - // Note that a change in some config values requires a 'clean' because the install location is the same, but the - // artifact that gets installed would be different. This can happen when using 'runtimeArtifact' for example and - // only changing the 'version'. - //throw new PluginExecutionException("A change in Liberty runtime installation configuration requires a 'clean'. After running the 'clean' goal, please run the 'dev' goal again for the change to take effect."); + // Note that a change in installation config values requires a restart of dev mode. reinstallLiberty = true; getLog().error("A change in Liberty runtime installation configuration requires a restart of dev mode. Stopping dev mode."); }