✨ Add compatibility with Java modules

.github/workflows/build.yml

@@ -7,21 +7,28 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - name: "Set up JDK 11"
-        uses: actions/setup-java@v2
+      - uses: actions/checkout@v3
+      - name: Set up JDKs 8, 11, 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11'
-          distribution: 'adopt'
+          distribution: 'temurin'
+          java-version: |
+            8
+            17
+            11
 
-      - name: "Build with Maven"
-        run: mvn -Pci verify
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Execute Gradle build
+        run: ./gradlew build
 
       - name: "Generate Coverage Badge"
         id: jacoco
         uses: cicirello/jacoco-badge-generator@v2
         with:
           generate-branches-badge: true
+          jacoco-csv-file: build/reports/jacoco/test/jacocoTestReport.csv
 
       - name: "Log coverage percentage"
         run: |
@@ -40,4 +47,4 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: jacoco-report
-          path: target/site/jacoco/
+          path: build/reports/jacoco/test/html/

.github/workflows/publish.yml

@@ -10,43 +10,34 @@ jobs:
     runs-on: "ubuntu-latest"
 
     steps:
-      - uses: actions/checkout@v2
-
-      - name: "Setup Java"
-        uses: actions/setup-java@v2
+      - uses: actions/checkout@v3
+      - name: Set up JDKs 8, 11, 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11'
-          distribution: 'adopt'
-          server-id: ossrh
-          server-username: MAVEN_USERNAME
-          server-password: MAVEN_PASSWORD
-          gpg-private-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
-          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+          distribution: 'temurin'
+          java-version: |
+            8
+            17
+            11
 
-      - name: "Build with Maven"
-        run: mvn -Pci verify
-        env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Execute Gradle build
+        run: ./gradlew build
 
       - name: "Create release"
         uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
           prerelease: false
           files: |
-            target/java-security-*.jar
+            build/libs/java-security-*.jar
 
       - name: "Publish to Maven Central"
-        run: |
-          mvn \
-            -Prelease \
-            -X \
-            --no-transfer-progress \
-            --batch-mode \
-            clean \
-            deploy
+        run: ./gradlew publish
         env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
-          MAVEN_GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSPHRASE }}
+          ORG_GRADLE_PROJECT_signingKey: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
+          ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSPHRASE }}
+          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.OSSRH_USERNAME }}
+          ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.OSSRH_TOKEN }}

.gitignore

@@ -1,6 +1,7 @@
 # Compiled class file
 *.class
-
+build
+.gradle
 # Log file
 *.log
 
@@ -12,6 +13,7 @@
 
 # Package Files #
 *.jar
+!gradle/wrapper/gradle-wrapper.jar
 *.war
 *.nar
 *.ear

build.gradle.kts

@@ -0,0 +1,236 @@
+import org.javamodularity.moduleplugin.extensions.ModularityExtension
+
+plugins {
+    `java-library`
+    `maven-publish`
+    signing
+    jacoco
+    `jvm-test-suite`
+    id("com.netflix.nebula.contacts") version "7.0.1"
+    id("com.netflix.nebula.source-jar") version "20.3.0"
+    id("com.netflix.nebula.javadoc-jar") version "20.3.0"
+    id("com.netflix.nebula.maven-publish") version "20.3.0"
+    id("com.netflix.nebula.publish-verification") version "20.3.0"
+    id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
+    id("org.javamodularity.moduleplugin") version "1.8.12"
+}
+
+tasks.named<Jar>("javadocJar") {
+    exclude("module-info.class")
+}
+
+tasks.named<Jar>("sourcesJar") {
+    dependsOn("compileModuleInfoJava")
+    exclude("module-info.class")
+}
+
+tasks.named<JavaCompile>("compileJava") {
+    options.release.set(null as Int?)
+}
+
+configure<ModularityExtension> {
+    mixedJavaRelease(8)
+}
+
+tasks.named<JavaCompile>("compileModuleInfoJava") {
+    options.release.set(null as Int?)
+}
+
+repositories {
+   mavenCentral()
+}
+
+val java11SourceSet = sourceSets.create("java11") {
+    java.srcDir("src/java11/main")
+    compileClasspath += sourceSets.main.get().output
+}
+
+java {
+    withSourcesJar()
+    withJavadocJar()
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(11))
+    }
+
+    registerFeature("java11") {
+        capability("io.github.pixee", "java11-support", version.toString())
+        usingSourceSet(java11SourceSet)
+    }
+}
+
+dependencies {
+    api("com.martiansoftware:jsap:2.1")
+    api("commons-io:commons-io:2.11.0")
+    java11SourceSet.apiConfigurationName("commons-io:commons-io:2.11.0")
+    testImplementation("org.junit.jupiter:junit-jupiter:5.8.1")
+    testImplementation("org.junit.jupiter:junit-jupiter-params")
+    testImplementation("commons-fileupload:commons-fileupload:1.3.3")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+    testImplementation("org.hamcrest:hamcrest-all:1.3")
+    testImplementation("org.mockito:mockito-core:4.0.0")
+}
+
+tasks.named<JavaCompile>(java11SourceSet.compileJavaTaskName) {
+    options.release.set(9)
+}
+
+tasks.jar {
+    into("META-INF/versions/11") {
+        from(java11SourceSet.output)
+    }
+    manifest.attributes(
+        Pair("Multi-Release", "true")
+    )
+
+    inputs.files(tasks.named(java11SourceSet.compileJavaTaskName).map { it.outputs.files })
+}
+
+tasks.named(java11SourceSet.jarTaskName) {
+    // disabled because we don't want to publish this separately
+    enabled = false
+}
+
+group = "io.github.pixee"
+version = "1.0.7"
+description = "java-security-toolkit"
+
+
+extensions.getByType<nebula.plugin.contacts.ContactsExtension>().run {
+    addPerson(
+        "[email protected]",
+        delegateClosureOf<nebula.plugin.contacts.Contact> {
+            moniker("Pixee")
+            github("pixee")
+        },
+    )
+}
+
+val publicationName = "nebula"
+signing {
+    if (providers.environmentVariable("CI").isPresent) {
+        val signingKey: String? by project
+        val signingPassword: String? by project
+        useInMemoryPgpKeys(signingKey, signingPassword)
+    }
+    sign(extensions.getByType<PublishingExtension>().publications.getByName(publicationName))
+}
+
+nexusPublishing {
+    repositories {
+        sonatype {
+            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
+            snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
+        }
+    }
+}
+
+publishing {
+    publications {
+        named<MavenPublication>(publicationName) {
+            pom {
+                licenses {
+                    license {
+                        name.set("MIT License")
+                        url.set("http://www.opensource.org/licenses/mit-license.php")
+                    }
+                }
+                val scmHost = "github.com"
+                val scmProject = "pixee/java-security-toolkit"
+                val projectUrl = "https://$scmHost/$scmProject"
+                url.set(projectUrl)
+                scm {
+                    url.set(projectUrl)
+                    connection.set("scm:git:git@$scmHost:$scmProject")
+                    developerConnection.set(connection)
+                }
+            }
+        }
+    }
+}
+
+tasks.jacocoTestReport {
+    dependsOn(tasks.test)
+    reports {
+        csv.required.set(true)
+    }
+}
+
+tasks.test {
+    useJUnitPlatform()
+    finalizedBy(tasks.jacocoTestReport)
+    extensions.configure(org.javamodularity.moduleplugin.extensions.TestModuleOptions::class) {
+        // Avoid modules in tests so we can test against Java/JDK 8.
+        setRunOnClasspath(true)
+    }
+
+    javaLauncher.set(javaToolchains.launcherFor {
+        languageVersion.set(JavaLanguageVersion.of(8))
+    })
+}
+
+testing {
+    suites {
+        @Suppress("UnstableApiUsage")
+        register<JvmTestSuite>("java11Test") {
+            useJUnitJupiter()
+            dependencies {
+                runtimeOnly(project())
+                implementation(project()) {
+                    capabilities {
+                        requireCapabilities("io.github.pixee:java11-support")
+                    }
+                }
+                implementation("org.hamcrest:hamcrest-all:1.3")
+                implementation("org.mockito:mockito-core:4.0.0")
+                implementation("commons-fileupload:commons-fileupload:1.3.3")
+            }
+        }
+
+        register<JvmTestSuite>("integrationTest") {
+            useJUnitJupiter()
+            dependencies {
+                implementation("org.junit.jupiter:junit-jupiter-params")
+                implementation("org.testcontainers:testcontainers:1.19.0")
+                implementation("ch.qos.logback:logback-classic:1.2.6")
+            }
+        }
+    }
+}
+
+tasks.named<Test>("java11Test") {
+    systemProperty("org.apache.commons.fileupload.disk.DiskFileItem.serializable", "true")
+}
+
+val java11Test = tasks.register<Test>("testOn11") {
+    useJUnitPlatform()
+    javaLauncher.set(javaToolchains.launcherFor {
+        languageVersion.set(JavaLanguageVersion.of(11))
+    })
+}
+
+val java17Test = tasks.register<Test>("testOn17") {
+    useJUnitPlatform()
+    javaLauncher.set(javaToolchains.launcherFor {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    })
+}
+
+tasks.named<Test>("integrationTest") {
+    this.inputs.file(tasks.jar.map { it.archiveFile} )
+    dependsOn(":test-apps:hello-world:jibDockerBuild")
+    dependsOn(":test-apps:hello-world-modules:jibDockerBuild")
+    systemProperty("securityToolkitJarPath", tasks.jar.get().archiveFile.get().asFile.relativeTo(projectDir).path)
+}
+
+tasks.check {
+    @Suppress("UnstableApiUsage")
+    dependsOn(java11Test, java17Test, testing.suites.named("java11Test"), testing.suites.named("integrationTest"))
+}
+
+tasks.compileTestJava {
+    extensions.configure(org.javamodularity.moduleplugin.extensions.CompileTestModuleOptions::class) {
+        // Avoid modules in tests so we can test against Java/JDK 8.
+        setCompileOnClasspath(true)
+    }
+    options.release.set(8)
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists