ValueSource exclusionList

Author: TheGoesen

src/main/java/org/gradlex/javamodule/dependencies/initialization/Directory.java

@@ -23,6 +23,7 @@
 
 import javax.inject.Inject;
 import java.io.File;
+import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
@@ -41,14 +42,18 @@ public abstract class Directory {
      */
     public abstract ListProperty<String> getPlugins();
 
-    @Inject
-    protected abstract ObjectFactory getObjects();
 
     @Inject
     public Directory(File root) {
         this.root = root;
+        getExclusions().convention(Arrays.asList("build", "\\..*"));
     }
 
+    @Inject
+    protected abstract ObjectFactory getObjects();
+
+    public abstract ListProperty<String> getExclusions();
+
     /**
      * {@link Module#plugin(String)}
      */
@@ -63,6 +68,7 @@ public void module(String subDirectory) {
         module(subDirectory, m -> {});
     }
 
+
     /**
      * Configure details of a Module in a subdirectory of this directory.
      * Note that Modules that are located in direct children of this directory are discovered automatically and

src/main/java/org/gradlex/javamodule/dependencies/initialization/JavaModulesExtension.java

@@ -27,6 +27,9 @@
 import org.gradle.api.plugins.JavaApplication;
 import org.gradle.api.plugins.JavaPlatformExtension;
 import org.gradle.api.plugins.JavaPlatformPlugin;
+import org.gradle.api.provider.Provider;
+import org.gradle.api.provider.ProviderFactory;
+import org.gradle.api.provider.ValueSourceSpec;
 import org.gradlex.javamodule.dependencies.JavaModuleDependenciesExtension;
 import org.gradlex.javamodule.dependencies.JavaModuleDependenciesPlugin;
 import org.gradlex.javamodule.dependencies.JavaModuleVersionsPlugin;
@@ -47,6 +50,9 @@ public abstract class JavaModulesExtension {
     @Inject
     public abstract ObjectFactory getObjects();
 
+    @Inject
+    public abstract ProviderFactory getProviders();
+
     @Inject
     public JavaModulesExtension(Settings settings) {
         this.settings = settings;
@@ -85,22 +91,24 @@ public void directory(String directory, Action<Directory> action) {
         Directory moduleDirectory = getObjects().newInstance(Directory.class, modulesDirectory);
         action.execute(moduleDirectory);
 
-        File[] projectDirs = modulesDirectory.listFiles();
-        if (projectDirs == null) {
-            throw new RuntimeException("Failed to inspect: " + modulesDirectory);
-        }
 
         for (Module module : moduleDirectory.customizedModules.values()) {
             includeModule(module, new File(modulesDirectory, module.getDirectory().get()));
         }
+        Provider<List<String>> listProvider = getProviders().of(ValueSourceDirectoryListing.class, new Action<ValueSourceSpec<ValueSourceDirectoryListing.DirectoryListingParameter>>() {
+            @Override
+            public void execute(ValueSourceSpec<ValueSourceDirectoryListing.DirectoryListingParameter> spec) {
+                spec.getParameters().getRegexExclusions().set(moduleDirectory.getExclusions());
+                spec.getParameters().getExclusions().set(moduleDirectory.customizedModules.keySet());
+                spec.getParameters().getDir().set(modulesDirectory);
+            }
+        });
 
-        for (File projectDir : projectDirs) {
-            if (!moduleDirectory.customizedModules.containsKey(projectDir.getName())) {
-                Module module = moduleDirectory.addModule(projectDir.getName());
-                if (!module.getModuleInfoPaths().get().isEmpty()) {
-                    // only auto-include if there is at least one module-info.java
-                    includeModule(module, projectDir);
-                }
+        for (String projectDir : listProvider.get()) {
+            Module module = moduleDirectory.addModule(projectDir);
+            if (!module.getModuleInfoPaths().get().isEmpty()) {
+                // only auto-include if there is at least one module-info.java
+                includeModule(module, new File(modulesDirectory, projectDir));
             }
         }
     }

src/main/java/org/gradlex/javamodule/dependencies/initialization/ValueSourceDirectoryListing.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright the GradleX team.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.gradlex.javamodule.dependencies.initialization;
+
+import org.gradle.api.provider.Property;
+import org.gradle.api.provider.SetProperty;
+import org.gradle.api.provider.ValueSource;
+import org.gradle.api.provider.ValueSourceParameters;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public abstract class ValueSourceDirectoryListing implements ValueSource<List<String>, ValueSourceDirectoryListing.DirectoryListingParameter> {
+
+
+    @Override
+    public List<String> obtain() {
+        File file = getParameters().getDir().get();
+        String[] list = file.list();
+        if (list == null) {
+            throw new RuntimeException("Failed to inspect: " + file.getAbsolutePath());
+        }
+        return Arrays.stream(list)
+                .filter(x -> !getParameters().getExclusions().get().contains(x))
+                .filter(x -> getParameters().getRegexExclusions().get().stream().noneMatch(x::matches))
+                .sorted()
+                .collect(Collectors.toList());
+
+
+    }
+
+    interface DirectoryListingParameter extends ValueSourceParameters {
+
+        Property<File> getDir();
+
+        SetProperty<String> getExclusions();
+
+        SetProperty<String> getRegexExclusions();
+
+    }
+}

src/test/groovy/org/gradlex/javamodule/dependencies/test/initialization/SettingsPluginTest.groovy

@@ -90,13 +90,75 @@ class SettingsPluginTest extends Specification {
         result.getOutput().contains("Calculating task graph as no cached configuration is available for tasks: :app:compileJava")
 
         when:
-        runner.build() // https://github.com/gradlex-org/java-module-dependencies/issues/128
         result = runner.build()
 
         then:
         result.getOutput().contains("Reusing configuration cache.")
     }
 
+    def "configurationCacheHitExtraDir"() {
+        given:
+        settingsFile << '''
+            javaModules {
+                directory(".") { plugin("java-library") }
+            }
+        '''
+        libModuleInfoFile << 'module abc.lib { }'
+        appModuleInfoFile << '''
+            module org.gradlex.test.app {
+                requires abc.lib;
+            }
+        '''
+
+
+        def runner = runner(':app:compileJava')
+        when:
+        def result = runner.build()
+
+        then:
+        result.getOutput().contains("Calculating task graph as no cached configuration is available for tasks: :app:compileJava")
+
+        when:
+        new File(settingsFile.parentFile, ".thisShallBeIgnored").mkdir()
+
+        result = runner.build()
+
+        then:
+        result.getOutput().contains("Reusing configuration cache.")
+    }
+
+    def "configurationCacheHitExtraNotIgnored"() {
+        given:
+        settingsFile << '''
+            javaModules {
+                directory(".") { plugin("java-library") }
+            }
+        '''
+        libModuleInfoFile << 'module abc.lib { }'
+        appModuleInfoFile << '''
+            module org.gradlex.test.app {
+                requires abc.lib;
+            }
+        '''
+
+
+        def runner = runner(':app:compileJava')
+        when:
+        def result = runner.build()
+
+        then:
+        result.getOutput().contains("Calculating task graph as no cached configuration is available for tasks: :app:compileJava")
+
+        when:
+        new File(settingsFile.parentFile, "thisShallNotBeIgnored").mkdir()
+
+        result = runner.build()
+
+        then:
+        result.getOutput().contains("Calculating task graph as configuration cache cannot be reused because a build logic input of type 'ValueSourceDirectoryListing' has changed.")
+    }
+
+
     def "configurationCacheHitIrrelevantChange"() {
         given:
         settingsFile << '''
@@ -119,7 +181,6 @@ class SettingsPluginTest extends Specification {
         result.getOutput().contains("Calculating task graph as no cached configuration is available for tasks: :app:compileJava")
 
         when:
-        runner.build() // https://github.com/gradlex-org/java-module-dependencies/issues/128
         appModuleInfoFile.write('''
             module org.gradlex.test.app {
                 requires abc.lib; //This is a comment and should not break the configurationCache
@@ -153,7 +214,6 @@ class SettingsPluginTest extends Specification {
         result.getOutput().contains("Calculating task graph as no cached configuration is available for tasks: :app:compileJava")
 
         when:
-        runner.build() // https://github.com/gradlex-org/java-module-dependencies/issues/128
         appModuleInfoFile.write('''
             module org.gradlex.test.app {
                //dependency removed; so thats indeed a configuration change