add support for non-java sources to TestKitDsl

add support for configuration cache property in TestKitDsl

Author: John Burns

gradle.lockfile

@@ -2,7 +2,7 @@
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
 cglib:cglib-nodep:3.2.2=archRulesTestRuntimeClasspath,integTestRuntimeClasspath,runtimeClasspath,testRuntimeClasspath
-com.netflix.nebula:nebula-archrules-core:0.5.2=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+com.netflix.nebula:nebula-archrules-core:0.5.3=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 junit:junit:4.13.2=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy-agent:1.11.13=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath

gradle.properties

@@ -1,3 +1,4 @@
 systemProp.nebula.features.coreLockingSupport=true
-
+org.gradle.configuration-cache=true
 org.gradle.caching=true
+org.gradle.parallel=true

src/main/groovy/nebula/test/dsl/GroovyDsl.groovy

@@ -71,10 +71,6 @@ class GroovyDsl {
         self.test().with(config)
     }
 
-    static void java(SourceSetBuilder self, String name, Supplier<String> source) {
-        self.java(name, source.get())
-    }
-
     /**
      * Run a build with expectation of success.
      * This method will throw an exception if the build fails.

src/main/java/nebula/test/TestKitOutputUtil.java

@@ -1,11 +1,14 @@
 package nebula.test;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+@NullMarked
 public class TestKitOutputUtil {
     private TestKitOutputUtil() {
     }

src/main/java/nebula/test/dsl/BuildscriptLanguage.java

@@ -1,5 +1,8 @@
 package nebula.test.dsl;
 
+import org.jspecify.annotations.NullMarked;
+
+@NullMarked
 public enum BuildscriptLanguage {
     GROOVY, KOTLIN
 }

src/main/java/nebula/test/dsl/ProjectProperties.java

@@ -1,6 +1,7 @@
 package nebula.test.dsl;
 
 import org.jetbrains.annotations.Contract;
+import org.jspecify.annotations.NullMarked;
 
 import java.io.File;
 import java.io.IOException;
@@ -11,6 +12,7 @@
 import java.util.List;
 
 @NebulaTestKitDsl
+@NullMarked
 public class ProjectProperties {
     private final File projectDir;
 
@@ -27,12 +29,29 @@ public ProjectProperties property(String property, String value) {
         return this;
     }
 
+    /**
+     *
+     * @deprecated Use {@link #buildCache(boolean)} instead
+     */
     @NebulaTestKitDsl
     @Contract("_ -> this")
+    @Deprecated
     public ProjectProperties gradleCache(boolean enabled) {
         return property("org.gradle.caching", String.valueOf(enabled).toLowerCase());
     }
 
+    @NebulaTestKitDsl
+    @Contract("_ -> this")
+    public ProjectProperties buildCache(boolean enabled) {
+        return property("org.gradle.caching", String.valueOf(enabled).toLowerCase());
+    }
+
+    @NebulaTestKitDsl
+    @Contract("_ -> this")
+    public ProjectProperties configurationCache(boolean enabled) {
+        return property("org.gradle.configuration-cache", String.valueOf(enabled).toLowerCase());
+    }
+
     void build() {
         Path propsFile = projectDir.toPath().resolve("gradle.properties");
         String fileContents = String.join("\n", properties);

src/main/java/nebula/test/dsl/SourceSetBuilder.java

@@ -1,11 +1,15 @@
 package nebula.test.dsl;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.function.Supplier;
 
+@NullMarked
 public class SourceSetBuilder {
     private final File sourcesDir;
 
@@ -19,8 +23,84 @@ public class SourceSetBuilder {
      * @param file     the relative path to the java file
      * @param contents the contents of the file
      */
+    @NebulaTestKitDsl
     public void java(String file, String contents) {
-        final Path pathToSourceFile = sourcesDir.toPath().resolve("java").resolve(file);
+        language("java", file, contents);
+    }
+
+    /**
+     * write a java file
+     *
+     * @param file     the relative path to the java file
+     * @param contents the contents of the file. uses a supplier for more ideomatic DSL usage in groovy and kotlin
+     */
+    @NebulaTestKitDsl
+    public void java(String file, Supplier<String> contents) {
+        language("java", file, contents.get());
+    }
+
+    /**
+     * write a groovy file
+     *
+     * @param file     the relative path to the groovy file
+     * @param contents the contents of the file
+     */
+    @NebulaTestKitDsl
+    public void groovy(String file, String contents) {
+        language("groovy", file, contents);
+    }
+
+    /**
+     * write a groovy file
+     *
+     * @param file     the relative path to the groovy file
+     * @param contents the contents of the file. uses a supplier for more ideomatic DSL usage in groovy and kotlin
+     */
+    @NebulaTestKitDsl
+    public void groovy(String file, Supplier<String> contents) {
+        language("groovy", file, contents.get());
+    }
+
+    /**
+     * write a kotlin file
+     *
+     * @param file     the relative path to the kotlin file
+     * @param contents the contents of the file
+     */
+    public void kotlin(String file, String contents) {
+        language("kotlin", file, contents);
+    }
+
+    /**
+     * write a kotlin file
+     *
+     * @param file     the relative path to the kotlin file
+     * @param contents the contents of the file. uses a supplier for more ideomatic DSL usage in groovy and kotlin
+     */
+    @NebulaTestKitDsl
+    public void kotlin(String file, Supplier<String> contents) {
+        language("kotlin", file, contents.get());
+    }
+
+    /**
+     * write a file for specified language
+     *
+     * @param file     the relative path to the java file
+     * @param contents the contents of the file. uses a supplier for more ideomatic DSL usage in groovy and kotlin
+     */
+    @NebulaTestKitDsl
+    public void language(String language, String file, Supplier<String> contents) {
+        language(language, file, contents.get());
+    }
+
+    /**
+     * write a file for specified language
+     *
+     * @param file     the relative path to the file
+     * @param contents the contents of the file
+     */
+    public void language(String language, String file, String contents) {
+        final Path pathToSourceFile = sourcesDir.toPath().resolve(language).resolve(file);
         pathToSourceFile.getParent().toFile().mkdirs();
         try {
             Files.write(pathToSourceFile, contents.getBytes(StandardCharsets.UTF_8));

src/main/kotlin/nebula/test/dsl/KotlinDsl.kt

@@ -88,11 +88,6 @@ fun TestProjectBuilder.subProject(name: String, config: ProjectBuilder.() -> Uni
     subProject(name).apply(config)
 }
 
-@NebulaTestKitDsl
-fun SourceSetBuilder.java(fileName: String, source: () -> String) {
-    java(fileName, source())
-}
-
 /**
  * Run a build with expectation of success.
  * This method will throw an exception if the build fails.

src/test/java/nebula/test/SupportedGradleVersion.java

@@ -1,7 +1,7 @@
 package nebula.test;
 
 public enum SupportedGradleVersion {
-    MIN("8.14.3"), MAX("9.2.0");
+    MIN("8.14.3"), MAX("9.2.1");
     public final String version;
     SupportedGradleVersion(String version) {
         this.version = version;

src/test/java/nebula/test/dsl/ProjectPropertiesTest.java

@@ -7,7 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-public class ProjectPropertiesTest {
+class ProjectPropertiesTest {
     @Test
     public void testProjectProperty(@TempDir File testProjectDir) {
         final var instance = new ProjectProperties(testProjectDir);
@@ -31,4 +31,28 @@ public void testGradleCache(@TempDir File testProjectDir) {
                 .content()
                 .contains("org.gradle.caching=true");
     }
+
+    @Test
+    public void testBuildCache(@TempDir File testProjectDir) {
+        final var instance = new ProjectProperties(testProjectDir);
+        instance.buildCache(true);
+        instance.build();
+
+        assertThat(testProjectDir.toPath().resolve("gradle.properties"))
+                .exists()
+                .content()
+                .contains("org.gradle.caching=true");
+    }
+
+    @Test
+    public void testConfigurationCache(@TempDir File testProjectDir) {
+        final var instance = new ProjectProperties(testProjectDir);
+        instance.configurationCache(true);
+        instance.build();
+
+        assertThat(testProjectDir.toPath().resolve("gradle.properties"))
+                .exists()
+                .content()
+                .contains("org.gradle.configuration-cache=true");
+    }
 }