Merge pull request #495 from turkeylurkey/issue-1963

Pass the generateToSrc option when generating features

Author: turkeylurkey

src/main/java/io/openliberty/tools/common/plugins/util/DevUtil.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corporation 2019, 2026.
+ * (C) Copyright IBM Corporation 2019, 2026
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -1942,12 +1942,13 @@ private void addUserId(List<String> commandElements) {
      * 
      * @param classes class file paths features should be generated for (can be null if no modified classes)
      * @param optimize if true, generate optimized feature list
+     * @param generateToSrc if true, generate feature list into file in src/main/liberty
      * @param useTmpDirOut if true, generate feature file in a hidden directory named in BinaryScannerUtil
      * @param useTmpDirIn if true, the hidden directory named in BinaryScannerUtil will be used as the
      *                    context or input values to generate features
      * @return true if feature generation was successful
      */
-    public abstract boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean useTmpDirOut, boolean useTmpDirIn);
+    public abstract boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean generateToSrc, boolean useTmpDirOut, boolean useTmpDirIn);
 
     /**
      * Install features in regular dev mode. This method should not be used in container mode.
@@ -2672,13 +2673,11 @@ private void toggleGenerateToSrc() {
         generateToSrc = !generateToSrc;
         logGenerateToSrcStatus();
         initGenerationContext();
-        if (!generateToSrc) { // when you toggle off generate to src, delete the generated file in src
-            File srcGenFeaturesFile = new File(configDirectory, BinaryScannerUtil.GENERATED_FEATURES_FILE_PATH);
-            if (srcGenFeaturesFile.exists()) {
-                if (!srcGenFeaturesFile.delete()) {
-                    debug("Error trying to delete the generated features file:" + srcGenFeaturesFile.getAbsolutePath());
-                }
-            }
+        // When you toggle generateToSrc delete the old file you no longer need
+        if (generateToSrc) {
+            deleteGenFeaturesFile(generateFeaturesTmpDir); // delete the old gen file in tmpdir
+        } else {
+            deleteGenFeaturesFile(configDirectory); // delete the old gen file in src/main/liberty/config
         }
         if (generateFeatures) {
             if (generateToSrc) {
@@ -2689,6 +2688,16 @@ private void toggleGenerateToSrc() {
         }
     }
 
+    private void deleteGenFeaturesFile(File dir) {
+        // N.B. processConfigFileChange() will be called upon deletion of generated features file, it should be ignored
+        File oldGenFeaturesFile = new File(dir, BinaryScannerUtil.GENERATED_FEATURES_FILE_PATH);
+        if (oldGenFeaturesFile.exists()) {
+            if (!oldGenFeaturesFile.delete()) {
+                debug("Error trying to delete the generated features file:" + oldGenFeaturesFile.getAbsolutePath());
+            }
+        }
+    }
+
     private void logGenerateToSrcStatus() {
         info("Setting generation of features in src directory to: " + getFormattedBooleanString(generateToSrc));
     }
@@ -2720,7 +2729,7 @@ private boolean optimizeGenerateFeatures(boolean useTmpDir) {
     private boolean optimizeGenerateFeatures(boolean useTmpDirOut, boolean useTmpDirIn) {
         debug("Generating optimized features list...use temp directory for output=" + useTmpDirOut + " use temp directory for input=" + useTmpDirIn);
         // scan all class files and provide only user specified features
-        boolean generatedFeatures = libertyGenerateFeatures(null, true, useTmpDirOut, useTmpDirIn);
+        boolean generatedFeatures = libertyGenerateFeatures(null, true, generateToSrc, useTmpDirOut, useTmpDirIn);
         if (generatedFeatures) {
             modifiedClasses.clear();
             failedToGenerateClasses.clear();
@@ -2739,7 +2748,7 @@ private boolean incrementGenerateFeatures(boolean useTmpDir) {
         boolean generatedFeatures = false;
         try {
             Collection<String> classPaths = getClassPaths(modifiedClasses);
-            generatedFeatures = libertyGenerateFeatures(classPaths, false, useTmpDir, false);
+            generatedFeatures = libertyGenerateFeatures(classPaths, false, generateToSrc, useTmpDir, false);
             if (generatedFeatures) {
                 modifiedClasses.clear();
                 failedToGenerateClasses.clear();
@@ -4673,8 +4682,11 @@ private void processConfigFileChange(File fileChanged, ChangeType changeType, Th
             // generateFeaturesTmpDir in the process of handling an xml config modicifcation.
             // Deleting that directory could cause generated-features.xml to be deleted and we
             // need to be careful how to handle that event e.g. don't call optimizeGenerateFeatures().
+            // Another scenario, when we toggle generateToSrc option we delete the old file and change the
+            // value of generateFeaturesFile. Therefore we must only use the base name of generateFeaturesFile
+            // in this file name check.
             if (generateFeatures && (fileChanged.getName().endsWith(".xml")
-                    && !fileChanged.equals(generateFeaturesFile))
+                    && !fileChanged.getName().equals(generateFeaturesFile.getName()))
                     && serverFeaturesModified()) {
                 optimizeGenerateFeatures(!generateToSrc);
             }

src/test/java/io/openliberty/tools/common/plugins/util/BaseDevUtilTest.java

@@ -197,7 +197,7 @@ public void libertyInstallFeature() {
         }
 
         @Override
-        public boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean useTempOut, boolean useTempIn) {
+        public boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean generateToSrc, boolean useTempOut, boolean useTempIn) {
             // not needed for tests
             return true;
         }