Merge feature branch for auto-generation of Liberty features GA update

.gitignore

@@ -5,7 +5,8 @@ target/
 .classpath
 .factorypath
 .idea/
+.vscode/
 .DS_Store
 *.versionsBackup
 /.metadata/
-*.jar
+*.jar

liberty-maven-plugin/pom.xml

@@ -100,7 +100,7 @@
         <dependency>
             <groupId>io.openliberty.tools</groupId>
             <artifactId>ci.common</artifactId>
-            <version>1.8.41</version>
+            <version>1.8.42-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>

liberty-maven-plugin/src/it/dev-it/src/test/java/net/wasdev/wlp/test/dev/it/BaseDevTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2019, 2023.
+ * (c) Copyright IBM Corporation 2019, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ public class BaseDevTest {
    final static String RUNNING_GENERATE_FEATURES = "Running liberty:generate-features";
    final static String REGENERATE_FEATURES = "Regenerated the following features:";
    final static String GENERATE_FEATURES = "Generated the following features:";
-   final static String SERVER_XML_COMMENT = "Plugin has generated Liberty features"; // the explanation added to server.xml
+   // final static String SERVER_XML_COMMENT = "Plugin has generated Liberty features"; // the explanation added to server.xml
    final static String NEW_FILE_INFO_MESSAGE = "This file was generated by the Liberty Maven Plugin and will be overwritten"; // the explanation added to the generated features file
    final static String SERVER_CONFIG_SUCCESS = "CWWKZ0003I:";// CWWKZ0003I: The application xxx updated in y.yyy seconds.
    final static String SERVER_UPDATE_COMPLETE = "CWWKF0008I:"; // Feature update completed in 0.649 seconds.

liberty-maven-plugin/src/it/dev-it/src/test/java/net/wasdev/wlp/test/dev/it/DevGenerateFeaturesDependenciesTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2022.
+ * (c) Copyright IBM Corporation 2022, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,13 +30,13 @@
 public class DevGenerateFeaturesDependenciesTest extends BaseDevTest {
 
     @BeforeClass
-   public static void setUpBeforeClass() throws Exception {
-      setUpBeforeClass(null, "../resources/basic-dev-project-umbrella-deps");
-   }
+    public static void setUpBeforeClass() throws Exception {
+        setUpBeforeClass(null, "../resources/basic-dev-project-umbrella-deps");
+    }
 
     @AfterClass
     public static void cleanUpAfterClass() throws Exception {
-       BaseDevTest.cleanUpAfterClass();
+        BaseDevTest.cleanUpAfterClass();
     }
 
     @Test
@@ -45,16 +45,17 @@ public void updateDependencyTest() throws Exception {
        assertTrue(verifyLogMessageExists("Listening for transport dt_socket at address: 8077", 20000) || verifyLogMessageExists("The debug port 8077 is not available.",20000));
        assertTrue(verifyLogMessageExists("Liberty is running in dev mode.", 10000));
 
-       File generatedFeaturesFile = getGeneratedFeaturesFile();
+       //File generatedFeaturesFile = getGeneratedFeaturesFile();
        File targetGeneratedFeaturesFile = getTargetGeneratedFeaturesFile();
        assertTrue(pom.exists());
-       assertTrue(generatedFeaturesFile.exists());
+       //assertTrue(generatedFeaturesFile.exists());
        assertTrue(targetGeneratedFeaturesFile.exists());
-       long lastModified = generatedFeaturesFile.lastModified();
+       // long lastModified = generatedFeaturesFile.lastModified();
+       long lastModified = targetGeneratedFeaturesFile.lastModified();
        waitLongEnough();
 
        // verify mpHealth-2.2 is in generated features file
-       assertTrue(verifyLogMessageExists("mpHealth-2.2", 10000, generatedFeaturesFile));
+       assertTrue(verifyLogMessageExists("mpHealth-2.2", 10000, targetGeneratedFeaturesFile));
        assertTrue(verifyLogMessageExists("mpHealth-2.2", 10000)); // should appear in the message "CWWKF0012I: The server installed the following features:"
 
        int generateFeaturesCount = countOccurrences("Running liberty:generate-features", logFile);
@@ -77,16 +78,20 @@ public void updateDependencyTest() throws Exception {
 
        // Dev mode should now run the generate features mojo
        assertTrue(getLogTail(), verifyLogMessageExists("Generated the following features:", 15000, logFile, ++generateFeaturesCount)); // mojo ran
-       assertTrue(generatedFeaturesFile.exists());
-       assertTrue(getLogTail(), lastModified < generatedFeaturesFile.lastModified());
+       // assertTrue(generatedFeaturesFile.exists());
+       // assertTrue(getLogTail(), lastModified < generatedFeaturesFile.lastModified());
        assertTrue(targetGeneratedFeaturesFile.exists());
+       assertTrue(getLogTail(), lastModified < targetGeneratedFeaturesFile.lastModified());
+       //assertTrue(targetGeneratedFeaturesFile.exists());
 
        // verify that mpHealth-3.0 is now in the generated features file
-       assertTrue(getLogTail(), verifyLogMessageExists("mpHealth-3.1", 10000, generatedFeaturesFile));
+       // assertTrue(getLogTail(), verifyLogMessageExists("mpHealth-3.1", 10000, generatedFeaturesFile));
+       assertTrue(getLogTail(), verifyLogMessageExists("mpHealth-3.1", 10000, targetGeneratedFeaturesFile));
        assertTrue(getLogTail(), verifyLogMessageExists("mpHealth-3.1", 10000)); // should appear in the message "CWWKF0012I: The server installed the following features:"
 
        // verify that mpHealth-2.2 is no longer in the generated features file
-       assertFalse(getLogTail(), verifyLogMessageExists("mpHealth-2.2", 10000, generatedFeaturesFile));
+       // assertFalse(getLogTail(), verifyLogMessageExists("mpHealth-2.2", 10000, generatedFeaturesFile));
+       assertFalse(getLogTail(), verifyLogMessageExists("mpHealth-2.2", 10000, targetGeneratedFeaturesFile));
     }
 
 }

liberty-maven-plugin/src/it/dev-it/src/test/java/net/wasdev/wlp/test/dev/it/DevTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2019, 2022.
+ * (c) Copyright IBM Corporation 2019, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -276,7 +276,7 @@ public void generateFeatureTest() throws Exception {
       int runGenerateFeaturesCount = countOccurrences(RUNNING_GENERATE_FEATURES, logFile);
       int installedFeaturesCount = countOccurrences(SERVER_INSTALLED_FEATURES, logFile);
 
-      File newFeatureFile = getGeneratedFeaturesFile();
+      // File newFeatureFile = getGeneratedFeaturesFile();
       File newTargetFeatureFile = getTargetGeneratedFeaturesFile();
       File serverXmlFile = new File(tempProj, "/src/main/liberty/config/server.xml");
       assertTrue(serverXmlFile.exists());
@@ -293,11 +293,11 @@ public void generateFeatureTest() throws Exception {
       verifyFileExists(helloBatchObj, 15000);
       // ... and run the proper mojo.
       assertTrue(verifyLogMessageExists(RUNNING_GENERATE_FEATURES, 10000, ++runGenerateFeaturesCount)); // mojo ran
-      assertTrue(verifyFileExists(newFeatureFile, 5000)); // mojo created file
+      // assertTrue(verifyFileExists(newFeatureFile, 5000)); // mojo created file
       assertTrue(verifyFileExists(newTargetFeatureFile, 5000)); // dev mode copied file
-      assertTrue(verifyLogMessageExists("batch-1.0", 10000, newFeatureFile));
-      assertTrue(verifyLogMessageExists(NEW_FILE_INFO_MESSAGE, 10000, newFeatureFile));
-      assertTrue(verifyLogMessageExists(SERVER_XML_COMMENT, 10000, serverXmlFile));
+      assertTrue(verifyLogMessageExists("batch-1.0", 10000, newTargetFeatureFile));
+      assertTrue(verifyLogMessageExists(NEW_FILE_INFO_MESSAGE, 10000, newTargetFeatureFile));
+      // assertTrue(verifyLogMessageExists(SERVER_XML_COMMENT, 10000, serverXmlFile));
       // "CWWKF0012I: The server installed the following features:" assume batch-1.0 is in there
       // batch-1.0 pulls in other features that can take a long time to download.
       assertTrue(verifyLogMessageExists(SERVER_INSTALLED_FEATURES, 123000, ++installedFeaturesCount));
@@ -345,7 +345,7 @@ public void generateFeatureTest() throws Exception {
       writer.write("o\n"); // on optimize regenerate
       writer.flush();
       assertTrue(verifyLogMessageExists(GENERATE_FEATURES, 10000, logFile, ++generateFeaturesCount));
-      assertTrue(verifyLogMessageExists("batch-1.0", 10000, newFeatureFile, 0)); // exist 0 times
+      assertTrue(verifyLogMessageExists("batch-1.0", 10000, newTargetFeatureFile, 0)); // exist 0 times
       // Check for server response to newly generated feature list.
       assertTrue(verifyLogMessageExists(SERVER_UPDATE_COMPLETE, 10000, serverUpdateCount+1));
       // Need to ensure server finished updating before the next test starts.

liberty-maven-plugin/src/it/dev-it/src/test/java/net/wasdev/wlp/test/dev/it/MultiModuleUpdatePomsTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2022.
+ * (c) Copyright IBM Corporation 2022, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,7 +55,8 @@ public void updatePomsTest() throws Exception {
       int earTestsCount = countOccurrences("guide-maven-multimodules-ear tests compilation was successful.", logFile);
 
       // verify that generated-features.xml file exists
-      File newFeatureFile = getGeneratedFeaturesFile("ear");
+      // File newFeatureFile = getGeneratedFeaturesFile("ear");
+      File newFeatureFile = getTargetGeneratedFeaturesFile("ear");
       assertTrue(getLogTail(), verifyFileExists(newFeatureFile, 1000));
       long newFeatureFileLastModified = newFeatureFile.lastModified();
       waitLongEnough();

liberty-maven-plugin/src/it/generate-features-it/src/test/java/net/wasdev/wlp/test/dev/it/BaseGenerateFeaturesTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2022.
+ * (c) Copyright IBM Corporation 2022, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,11 +63,14 @@ public class BaseGenerateFeaturesTest {
     static File targetDir;
     static String processOutput = "";
     static File newFeatureFile;
+    static File newFeatureFileSrc;
     static File pom;
     static File serverXmlFile;
 
     static final String GENERATED_FEATURES_FILE_NAME = "generated-features.xml";
-    static final String GENERATED_FEATURES_FILE_PATH = "/src/main/liberty/config/configDropins/overrides/" + GENERATED_FEATURES_FILE_NAME;
+    static final String GENERATED_FEATURES_FILE_PATH = "/target/liberty/wlp/usr/servers/defaultServer/configDropins/overrides/" + GENERATED_FEATURES_FILE_NAME;
+    static final String GENERATED_FEATURES_FILE_PATH_SRC = "/src/main/liberty/config/configDropins/overrides/" + GENERATED_FEATURES_FILE_NAME;
+    static final String SERVER_MISSING_MESSAGE = "The 'generate-features' goal requires an existing Liberty server";
 
     protected static void setUpBeforeTest(String projectRoot) throws IOException, InterruptedException {
         basicProj = new File(projectRoot);
@@ -81,6 +84,7 @@ protected static void setUpBeforeTest(String projectRoot) throws IOException, In
         assertTrue(logFile.createNewFile());
 
         newFeatureFile = new File(tempProj, GENERATED_FEATURES_FILE_PATH);
+        newFeatureFileSrc = new File(tempProj, GENERATED_FEATURES_FILE_PATH_SRC);
         pom = new File(tempProj, "pom.xml");
         assertTrue(pom.exists());
         replaceVersion(tempProj);
@@ -223,7 +227,12 @@ protected static Set<String> readFeatures(File configurationFile) throws Excepti
     }
 
     protected void runCompileAndGenerateFeatures() throws IOException, InterruptedException {
-        runProcess("compile liberty:generate-features");
+        runProcess("clean compile liberty:create liberty:generate-features");
+    }
+
+    protected void runCompileAndGenerateFeaturesToSrc() throws IOException, InterruptedException {
+        // do not create liberty when generating to src
+        runProcess("clean compile liberty:generate-features -DgenerateToSrc=true");
     }
 
     protected void runGenerateFeaturesGoal() throws IOException, InterruptedException {

liberty-maven-plugin/src/it/generate-features-it/src/test/java/net/wasdev/wlp/test/dev/it/GenerateFeaturesTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2022.
+ * (c) Copyright IBM Corporation 2022, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,15 +52,26 @@ public void cleanUp() throws Exception {
 
     @Test
     public void basicTest() throws Exception {
-        runCompileAndGenerateFeatures();
-        // verify that the target directory was created
+        executeBasicTests(false);
+    }
+
+    private void executeBasicTests(boolean generateToSrc) throws Exception {
+        File featureFile;
+        if (generateToSrc) {
+            featureFile = newFeatureFileSrc;
+            runCompileAndGenerateFeaturesToSrc();
+        } else {
+            featureFile = newFeatureFile;
+            runCompileAndGenerateFeatures();
+        }
+        // verify that the target directory was created by compile goal
         assertTrue(targetDir.exists());
 
         // verify that the generated features file was created
-        assertTrue(formatOutput(processOutput), newFeatureFile.exists());
+        assertTrue(formatOutput(processOutput), featureFile.exists());
 
         // verify that the correct features are in the generated-features.xml
-        Set<String> features = readFeatures(newFeatureFile);
+        Set<String> features = readFeatures(featureFile);
         Set<String> expectedFeatures = getExpectedGeneratedFeaturesSet();
         assertEquals(expectedFeatures.size(), features.size());
         assertEquals(expectedFeatures, features);
@@ -72,11 +83,26 @@ public void basicTest() throws Exception {
                         "</featureManager>\n",
                 serverXmlFile);
 
-        runGenerateFeaturesGoal();
         // no additional features should be generated
-        assertTrue(newFeatureFile.exists());
-        features = readFeatures(newFeatureFile);
-        assertEquals(0, features.size());
+        if (generateToSrc) {
+            // In src dir the generated file is preserved and contains no new features
+            runCompileAndGenerateFeaturesToSrc();
+            assertTrue(featureFile.exists());
+            features = readFeatures(featureFile);
+            assertEquals(formatOutput(processOutput), 0, features.size());
+        } else {
+            // the server dir is in target directory and a mvn clean is performed so it has been removed
+            runCompileAndGenerateFeatures();
+            assertFalse(featureFile.exists()); // after clean no feature file is created
+        }
+    }
+
+    @Test
+    public void generateToSrcTest() throws Exception {
+        newFeatureFile.delete(); // delete file if it exists but do not assert
+        assertFalse(newFeatureFileSrc.exists()); // assuming no other test creates this file
+        executeBasicTests(true);
+        assertTrue(newFeatureFileSrc.delete()); // clean up the generated file
     }
 
     @Test
@@ -91,6 +117,18 @@ public void noClassFiles() throws Exception {
         assertTrue(processOutput.contains(GenerateFeaturesMojo.NO_CLASSES_DIR_WARNING));
     }
 
+    @Test
+    public void noServer() throws Exception {
+        // do not create the server before running generate-features
+        runGenerateFeaturesGoal();
+
+        // verify that generated features file was not created
+        assertFalse(newFeatureFile.exists());
+
+        // verify server not found warning message
+        assertTrue(processOutput.contains(SERVER_MISSING_MESSAGE));
+    }
+
     @Test
     public void customFeaturesTest() throws Exception {
         // complete the setup of the test
@@ -115,7 +153,7 @@ public void customFeaturesTest() throws Exception {
     @Test
     public void serverXmlCommentNoFMTest() throws Exception {
         // initially the expected comment is not found in server.xml
-        assertFalse(verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 10, serverXmlFile));
+        // assertFalse(verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 10, serverXmlFile));
         // also we wish to test behaviour when there is no <featureManager> element so test that
         assertFalse(verifyLogMessageExists("<featureManager>", 10, serverXmlFile));
 
@@ -128,8 +166,8 @@ public void serverXmlCommentNoFMTest() throws Exception {
         Charset charset = StandardCharsets.UTF_8;
         String serverXmlContents = new String(Files.readAllBytes(serverXmlFile.toPath()), charset);
         serverXmlContents = "\n" + serverXmlContents;
-        assertTrue(serverXmlContents,
-            verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 100, serverXmlFile));
+        // assertTrue(serverXmlContents,
+        //     verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 100, serverXmlFile));
     }
 
     @Test
@@ -142,7 +180,7 @@ public void serverXmlCommentFMTest() throws Exception {
                 serverXmlFile);
 
         // initially the expected comment is not found in server.xml
-        assertFalse(verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 10, serverXmlFile));
+        // assertFalse(verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 10, serverXmlFile));
 
         runCompileAndGenerateFeatures();
 
@@ -153,8 +191,8 @@ public void serverXmlCommentFMTest() throws Exception {
         Charset charset = StandardCharsets.UTF_8;
         String serverXmlContents = new String(Files.readAllBytes(serverXmlFile.toPath()), charset);
         serverXmlContents = "\n" + serverXmlContents;
-        assertTrue(serverXmlContents,
-            verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 100, serverXmlFile));
+        // assertTrue(serverXmlContents,
+        //     verifyLogMessageExists(GenerateFeaturesMojo.FEATURES_FILE_MESSAGE, 100, serverXmlFile));
     }
 
     /**

liberty-maven-plugin/src/it/generate-features-it/src/test/java/net/wasdev/wlp/test/dev/it/MultiModuleGenerateFeaturesTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * (c) Copyright IBM Corporation 2022.
+ * (c) Copyright IBM Corporation 2022, 2025
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,6 +40,7 @@ public void setUp() throws Exception {
         assertTrue(pom.exists());
         replaceVersion(new File(tempProj, "pom")); // "pom" module is liberty configuration module
         newFeatureFile = new File(tempProj, "pom" + GENERATED_FEATURES_FILE_PATH);
+        newFeatureFileSrc = new File(tempProj, "pom" + GENERATED_FEATURES_FILE_PATH_SRC);
         serverXmlFile = new File(tempProj, "pom/src/main/liberty/config/server.xml");
         targetDir = new File(tempProj, "war/target");
         runProcess("install");
@@ -48,14 +49,20 @@ public void setUp() throws Exception {
 
     @Override
     protected void runCompileAndGenerateFeatures() throws IOException, InterruptedException {
-        runProcess("compile io.openliberty.tools:liberty-maven-plugin:" + System.getProperty("mavenPluginVersion")
-                + ":generate-features");
+        String lmp = "io.openliberty.tools:liberty-maven-plugin:" + System.getProperty("mavenPluginVersion");
+        runProcess("clean compile " + lmp + ":create " + lmp + ":generate-features");
+    }
+
+    @Override
+    protected void runCompileAndGenerateFeaturesToSrc() throws IOException, InterruptedException {
+        String lmp = "io.openliberty.tools:liberty-maven-plugin:" + System.getProperty("mavenPluginVersion");
+        runProcess("clean compile " + lmp + ":generate-features -DgenerateToSrc=true");
     }
 
     @Override
     protected void runGenerateFeaturesGoal() throws IOException, InterruptedException {
         runProcess("io.openliberty.tools:liberty-maven-plugin:" + System.getProperty("mavenPluginVersion")
-                + ":generate-features");
+                + ":generate-features ");
     }
 
     @Override