Merge pull request #30 from nebula-plugins/kts-support

wakingrufus · web-flow · commit 629ec2239be9 · 2025-10-24T14:38:28.000-05:00
add API to ContactsExtension that can be used from kts buildscripts
diff --git a/.github/workflows/nebula.yml b/.github/workflows/nebula.yml
@@ -2,7 +2,7 @@ name: Nebula Build
 on:
   push:
     branches:
-      - '*'
+      - 'main'
     tags:
       - v*.*.*
       - v*.*.*-rc.*
@@ -38,20 +38,10 @@ jobs:
             17
             ${{ matrix.java }}
           java-package: jdk
-      - uses: actions/cache@v4
-        id: gradle-cache
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
         with:
-          path: ~/.gradle/caches
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradle-
-      - uses: actions/cache@v4
-        id: gradle-wrapper-cache
-        with:
-          path: ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradlewrapper-
+          cache-overwrite-existing: true
       - name: Gradle build
         run: ./gradlew --info --stacktrace build
         env:
@@ -78,20 +68,10 @@ jobs:
             17
             21
           java-package: jdk
-      - uses: actions/cache@v4
-        id: gradle-cache
-        with:
-          path: ~/.gradle/caches
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradle-
-      - uses: actions/cache@v4
-        id: gradle-wrapper-cache
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
         with:
-          path: ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradlewrapper-
+          cache-overwrite-existing: true
       - name: Verify plugin publication
         if: |
           startsWith(github.ref, 'refs/tags/v') &&
@@ -123,20 +103,10 @@ jobs:
             17
             21
           java-package: jdk
-      - uses: actions/cache@v4
-        id: gradle-cache
-        with:
-          path: ~/.gradle/caches
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradle-
-      - uses: actions/cache@v4
-        id: gradle-wrapper-cache
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
         with:
-          path: ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }}
-          restore-keys: |
-            - ${{ runner.os }}-gradlewrapper-
+          cache-overwrite-existing: true
       - name: Publish candidate
         if: |
           startsWith(github.ref, 'refs/tags/v') &&
diff --git a/.java-version b/.java-version
diff --git a/build.gradle b/build.gradle
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 plugins {
-    id 'com.netflix.nebula.plugin-plugin' version '22.0.2'
+    id("com.netflix.nebula.plugin-plugin") version ("23.+")
 }
 
 description 'Plugin to specify and publish who the owner of a project is'
@@ -26,6 +26,12 @@ contacts {
     }
 }
 
+dependencies {
+    testImplementation("org.assertj:assertj-core:3.27.6")
+    testImplementation("org.spockframework:spock-core:2.3-groovy-4.0")
+    testImplementation("org.junit.vintage:junit-vintage-engine:5.+")
+}
+
 gradlePlugin {
     plugins {
         contacts {
@@ -45,3 +51,10 @@ gradlePlugin {
     }
 }
 
+testing {
+    suites {
+        test {
+            useJUnitJupiter()
+        }
+    }
+}
diff --git a/gradle.lockfile b/gradle.lockfile
@@ -2,17 +2,24 @@
 # 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=integTestRuntimeClasspath,testRuntimeClasspath
-com.netflix.nebula:nebula-test:11.0.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+com.netflix.nebula:nebula-test:11.6.3=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 junit:junit:4.13.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+net.bytebuddy:byte-buddy:1.17.7=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.apache.groovy:groovy:4.0.4=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.apiguardian:apiguardian-api:1.1.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.assertj:assertj-core:3.27.6=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.hamcrest:hamcrest-core:1.3=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.hamcrest:hamcrest:2.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.junit.platform:junit-platform-commons:1.13.1=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.junit.platform:junit-platform-engine:1.13.1=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.junit.platform:junit-platform-launcher:1.13.1=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.jspecify:jspecify:1.0.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.jupiter:junit-jupiter-api:5.12.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.jupiter:junit-jupiter-engine:5.12.2=integTestRuntimeClasspath,testRuntimeClasspath
+org.junit.jupiter:junit-jupiter-params:5.12.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.jupiter:junit-jupiter:5.12.2=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.platform:junit-platform-commons:1.14.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.platform:junit-platform-engine:1.14.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.platform:junit-platform-launcher:1.14.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.junit.vintage:junit-vintage-engine:5.14.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.objenesis:objenesis:2.4=integTestRuntimeClasspath,testRuntimeClasspath
 org.opentest4j:opentest4j:1.3.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.spockframework:spock-core:2.3-groovy-4.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.spockframework:spock-junit4:2.3-groovy-4.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 empty=annotationProcessor,compileClasspath,integTestAnnotationProcessor,runtimeClasspath,testAnnotationProcessor
diff --git a/src/main/groovy/nebula/plugin/contacts/Contact.groovy b/src/main/groovy/nebula/plugin/contacts/Contact.groovy
@@ -8,7 +8,7 @@ import org.gradle.api.Named
  */
 @Canonical
 class Contact implements Named {
-    final String email
+    String email
 
     /**
      * Aka name, but Named interface won't let us call it that
@@ -53,19 +53,19 @@ class Contact implements Named {
 
     // Temporary until we can find a annotation to do this for us
     void moniker(String moniker) {
-        if(!moniker)
+        if (!moniker)
             return
         this.moniker = moniker
     }
 
     void github(String github) {
-        if(!github)
+        if (!github)
             return
         this.github = github
     }
 
     void twitter(String twitter) {
-        if(!twitter)
+        if (!twitter)
             return
         this.twitter = twitter
     }
diff --git a/src/main/groovy/nebula/plugin/contacts/ContactsExtension.groovy b/src/main/groovy/nebula/plugin/contacts/ContactsExtension.groovy
@@ -1,5 +1,8 @@
 package nebula.plugin.contacts
 
+import org.gradle.api.Action
+import org.gradle.api.NamedDomainObjectContainer
+
 /**
  * Holds Person for a project.
  * TODO repeat a name and guarantee uniqueness
@@ -8,6 +11,7 @@ class ContactsExtension {
 
     private final String emailPattern = /[_A-Za-z0-9-]+(.[_A-Za-z0-9-]+)*@[A-Za-z0-9]+(.[A-Za-z0-9]+)*(.[A-Za-z]{2,})/
 
+    NamedDomainObjectContainer<Contact> peopleContainer
     final LinkedHashMap<String, Contact> people
     boolean validateEmails
 
@@ -65,6 +69,15 @@ class ContactsExtension {
         return person
     }
 
+    Contact addPerson(String email, Action<Contact> closure) {
+        if(validateEmails)
+            validateEmail(email)
+        def person = people.containsKey(email) ? BaseContactsPlugin.cloneContact(people.get(email)) : new Contact(email)
+        closure.execute(person)
+        people.put(email, person)
+        return person
+    }
+
     private validateEmail(String email) {
         if(!(email ==~  emailPattern)) {
             throw new ContactsPluginException("$email is not a valid email")
diff --git a/src/test/groovy/nebula/plugin/contacts/BaseContactsPluginSpec.groovy b/src/test/groovy/nebula/plugin/contacts/BaseContactsPluginSpec.groovy
@@ -15,13 +15,22 @@
  */
 package nebula.plugin.contacts
 
-import nebula.test.PluginProjectSpec
+import org.gradle.api.Project
 import org.gradle.testfixtures.ProjectBuilder
+import org.junit.Before
 
-class BaseContactsPluginSpec extends PluginProjectSpec {
-    @Override
-    String getPluginName() {
-        'com.netflix.nebula.contacts'
+import spock.lang.Specification
+import spock.lang.TempDir
+
+class BaseContactsPluginSpec extends Specification {
+
+    @TempDir
+    File projectDir
+    Project project
+
+    @Before
+    void setup() {
+        project = ProjectBuilder.builder().build()
     }
 
     def 'extension accessible'() {
diff --git a/src/test/groovy/nebula/plugin/contacts/ContactsPluginSpec.groovy b/src/test/groovy/nebula/plugin/contacts/ContactsPluginSpec.groovy
diff --git a/src/test/java/nebula/plugin/contacts/ContactsPluginTest.java b/src/test/java/nebula/plugin/contacts/ContactsPluginTest.java
@@ -0,0 +1,70 @@
+package nebula.plugin.contacts;
+
+import nebula.test.dsl.BuildscriptLanguage;
+import nebula.test.dsl.TestProjectBuilder;
+import org.gradle.testkit.runner.BuildResult;
+import org.gradle.testkit.runner.GradleRunner;
+import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+
+import java.io.File;
+
+import static nebula.test.dsl.TestKitAssertions.assertThat;
+
+class ContactsPluginTest {
+    @TempDir
+    File projectDir;
+
+    @ParameterizedTest
+    @EnumSource(SupportedGradleVersion.class)
+    void test_kotlin(SupportedGradleVersion gradleVersion) {
+        final TestProjectBuilder builder = TestProjectBuilder.testProject(projectDir);
+        builder.rootProject().plugins().id("com.netflix.nebula.contacts");
+        builder.rootProject()
+                .rawBuildScript(
+                        //language=kotlin
+                        """
+                                contacts {
+                                    addPerson("example@example.com") {
+                                        moniker = "Nebula-Plugins maintainers"
+                                        github = "nebula-plugins"
+                                        role("owner")
+                                    }
+                                }
+                                """);
+        final var runner = builder.build(BuildscriptLanguage.KOTLIN);
+
+
+        BuildResult result = runner.run(GradleRunner.create().withGradleVersion(gradleVersion.version), "build");
+        assertThat(result)
+                .hasNoDeprecationWarnings()
+                .hasNoMutableStateWarnings();
+    }
+
+    @ParameterizedTest
+    @EnumSource(SupportedGradleVersion.class)
+    void test_groovy(SupportedGradleVersion gradleVersion) {
+        final TestProjectBuilder builder = TestProjectBuilder.testProject(projectDir);
+        builder.rootProject().plugins().id("com.netflix.nebula.contacts");
+        builder.rootProject()
+                .rawBuildScript(
+                        //language=groovy
+                        """
+                                contacts {
+                                    "example@example.com" {
+                                        moniker = "Nebula-Plugins maintainers"
+                                        github = "nebula-plugins"
+                                        role("owner")
+                                    }
+                                }
+                                """);
+        final var runner = builder.build(BuildscriptLanguage.GROOVY);
+
+
+        BuildResult result = runner.run(GradleRunner.create().withGradleVersion(gradleVersion.version), "build");
+        assertThat(result)
+                .hasNoDeprecationWarnings()
+                .hasNoMutableStateWarnings();
+    }
+}
diff --git a/src/test/java/nebula/plugin/contacts/SupportedGradleVersion.java b/src/test/java/nebula/plugin/contacts/SupportedGradleVersion.java
@@ -0,0 +1,10 @@
+package nebula.plugin.contacts;
+
+enum SupportedGradleVersion {
+    MIN("9.0.0"), MAX("9.1.0");
+    public final String version;
+
+    SupportedGradleVersion(String version) {
+        this.version = version;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`* limitations under the License.`
`15`	`15`	`*/`
`16`	`16`	`plugins {`
`17`		`- id 'com.netflix.nebula.plugin-plugin' version '22.0.2'`
	`17`	`+ id("com.netflix.nebula.plugin-plugin") version ("23.+")`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`description 'Plugin to specify and publish who the owner of a project is'`
`@@ -26,6 +26,12 @@ contacts {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
	`29`	`+dependencies {`
	`30`	`+ testImplementation("org.assertj:assertj-core:3.27.6")`
	`31`	`+ testImplementation("org.spockframework:spock-core:2.3-groovy-4.0")`
	`32`	`+ testImplementation("org.junit.vintage:junit-vintage-engine:5.+")`
	`33`	`+}`
	`34`	`+`
`29`	`35`	`gradlePlugin {`
`30`	`36`	`plugins {`
`31`	`37`	`contacts {`
`@@ -45,3 +51,10 @@ gradlePlugin {`
`45`	`51`	`}`
`46`	`52`	`}`
`47`	`53`
	`54`	`+testing {`
	`55`	`+ suites {`
	`56`	`+ test {`
	`57`	`+ useJUnitJupiter()`
	`58`	`+ }`
	`59`	`+ }`
	`60`	`+}`