Migrate to Gradle 9 and the Kotlin DSL

Author: lesserwhirls

.gitignore

@@ -32,8 +32,13 @@ bin/
 
 # Ignore the Gradle cache directory.
 .gradle/
+
+# Ignore .kotlin directories
+.kotlin/
+
 # Ignore the output that Gradle generates in the "build/" directories...
 build/
+
 # ...but not the source code in the "edu.ucar.build" package inside buildSrc
 !**/src/**/edu/ucar/build/
 

bufr/build.gradle

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins {
+  id("java-library-conventions")
+  id("protobuf-conventions")
+}
+
+description = "Reading BUFR files with the NetCDF-java library."
+
+extra["project.title"] = "BUFR IOSP"
+
+dependencies {
+  implementation(platform(project(":netcdf-java-platform")))
+
+  api(project(":cdm-core"))
+
+  implementation(libs.beust.jcommander)
+  implementation(libs.findbugs.jsr305)
+  implementation(libs.guava)
+  implementation(libs.jdom2)
+  implementation(libs.protobuf)
+  implementation(libs.re2j)
+  implementation(libs.slf4j.api)
+
+  testImplementation(platform(project(":netcdf-java-testing-platform")))
+
+  testImplementation(project(":cdm-test-utils"))
+
+  testImplementation(libs.google.truth)
+  testImplementation(libs.junit4)
+  testImplementation(libs.junit5.vintageEngine)
+
+  testRuntimeOnly(libs.junit5.platformLauncher)
+}

bufr/build.gradle.kts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins {
+  `kotlin-dsl`
+  alias(libs.plugins.protobuf)
+  alias(libs.plugins.spotless)
+}
+
+dependencies {
+  implementation(plugin(libs.plugins.protobuf))
+  implementation(plugin(libs.plugins.spotless))
+}
+
+spotless {
+  kotlinGradle {
+    target("*.gradle.kts", "**/*.gradle.kts")
+    ktfmt().googleStyle()
+  }
+}
+
+// Helper function that transforms a plugin alias from the version catalog
+// into a valid dependency notation
+fun plugin(plugin: Provider<PluginDependency>) =
+  plugin.map { "${it.pluginId}:${it.pluginId}.gradle.plugin:${it.version}" }

build-logic/build.gradle.kts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+dependencyResolutionManagement {
+  repositoriesMode = RepositoriesMode.FAIL_ON_PROJECT_REPOS
+  repositories {
+    mavenCentral()
+    gradlePluginPortal()
+  }
+  versionCatalogs { create("libs") { from(files("../gradle/libs.versions.toml")) } }
+}
+
+rootProject.name = "build-logic"

build-logic/settings.gradle.kts

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins { `maven-publish` }
+
+publishing {
+  repositories {
+    maven {
+      if ((project.extra.get("project.isRelease") as? Boolean ?: false)) {
+        name = "releases"
+        url = uri("https://artifacts.unidata.ucar.edu/repository/unidata-releases/")
+      } else {
+        name = "snapshots"
+        url = uri("https://artifacts.unidata.ucar.edu/repository/unidata-snapshots/")
+      }
+      credentials {
+        username = extra.properties["nexus.username"] as? String
+        password = extra.properties["nexus.password"] as? String
+      }
+    }
+  }
+}
+
+tasks.withType<GenerateModuleMetadata> { enabled = false }
+
+val augmentPom =
+  tasks.register("augmentPom") {
+    publishing.publications.filterIsInstance<MavenPublication>().forEach { pub ->
+      pub.pom {
+        name.set("${project.group}:${project.name}")
+        url.set("${project.extra.get("project.url")}")
+        description.set("${project.description}")
+        licenses {
+          license {
+            name.set("BSD 3-Clause License")
+            url.set("https://github.com/Unidata/netcdf-java/blob/maint-5.x/LICENSE")
+          }
+        }
+        developers {
+          developer {
+            name.set("netCDF-Java Developers")
+            email.set("support-netcdf-java@unidata.ucar.edu")
+            organization.set("NSF Unidata")
+            organizationUrl.set("https://unidata.ucar.edu")
+          }
+        }
+        scm {
+          connection.set("scm:git:https://github.com/unidata/netcdf-java.git")
+          developerConnection.set("scm:git:https://github.com/unidata/netcdf-java.git")
+          url.set("https://github.com/unidata/netcdf-java")
+        }
+      }
+    }
+  }
+
+tasks.withType<GenerateMavenPom>().configureEach { dependsOn(augmentPom) }

build-logic/src/main/kotlin/artifact-publishing-conventions.gradle.kts

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins { base }
+
+val catalogs = extensions.getByType<VersionCatalogsExtension>()
+
+group = "edu.ucar"
+
+version = catalogs.named("libs").findVersion("netcdf-java").get().requiredVersion
+
+description = "A component to the Unidata netCDF-Java library (aka CDM)."
+
+extra["project.isRelease"] = !version.toString().endsWith("SNAPSHOT")
+
+extra["project.title"] = "CDM modules"
+
+extra["project.vendor"] = "UCAR/Unidata"
+
+extra["project.url"] = "https://www.unidata.ucar.edu/software/netcdf-java/"
+
+val docVersionParts = version.toString().split("-")[0].split(".")
+
+assert(docVersionParts.size == 3)
+
+extra["docVersion"] = docVersionParts[0] + "." + docVersionParts[1]
+
+// list of subprojects that are intended for public use and make up the netCDF-Java project
+// this is used by the netcdf-java-bom, docs, and code-coverage-report
+// subprojects
+val publicArtifacts =
+  listOf(
+    ":bufr",
+    ":cdm-core",
+    ":cdm-image",
+    ":cdm-mcidas",
+    ":cdm-misc",
+    ":cdm-radial",
+    ":cdm-s3",
+    ":cdm-vis5d",
+    ":cdm-zarr",
+    ":dap4",
+    ":gcdm",
+    ":grib",
+    ":httpservices",
+    ":legacy",
+    ":libaec-jna",
+    ":libaec-native",
+    ":netcdf4",
+    ":opendap",
+    ":udunits",
+    ":waterml",
+  )
+
+project.extra["public.artifacts"] = publicArtifacts
+
+// the minimumVersion of java supported
+// will be the bytecode produced by the project for all java compilation
+// will be used to run the tests (test, not testWithJdkX), generate code coverage reports, etc.
+// other versions of java can be used to run the tests, but this is configured in
+// testing-conventions.gradle.kts
+project.extra["project.minimumJdkVersion"] = "8"

build-logic/src/main/kotlin/base-conventions.gradle.kts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins {
+  id("base-conventions")
+  id("testing-conventions")
+}
+
+tasks {
+  // everything gets compiled to the minimum supported version byte code
+  withType<JavaCompile>().configureEach {
+    options.release = project.extra["project.minimumJdkVersion"].toString().toInt()
+  }
+
+  withType<Javadoc>().configureEach {
+    group = "documentation"
+    options {
+      encoding = "UTF-8"
+      // options past here require the standard java doclet
+      require(this is StandardJavadocDocletOptions)
+      charSet = "UTF-8"
+      docEncoding = "UTF-8"
+      addStringOption("-release", "8")
+      // so many invalid HTML errors...need to add this for now to
+      // generate javadocs
+      addBooleanOption("Xdoclint:none", true)
+    }
+  }
+}

build-logic/src/main/kotlin/java-base-conventions.gradle.kts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+plugins {
+  id("java-base-conventions")
+  `java-library`
+  id("artifact-publishing-conventions")
+  id("com.diffplug.spotless")
+}
+
+java { withSourcesJar() }
+
+tasks.withType<Jar>().configureEach {
+  duplicatesStrategy = DuplicatesStrategy.FAIL
+  manifest {
+    attributes["Implementation-Title"] = project.extra.get("project.title")
+    attributes["Implementation-Version"] = "${project.version}"
+    attributes["Implementation-Vendor-Id"] = "${project.group}"
+    attributes["Implementation-Vendor"] = project.extra.get("project.vendor")
+    attributes["Implementation-URL"] = project.extra.get("project.url")
+    attributes["Created-By"] = "Gradle ${gradle.gradleVersion}"
+    System.getProperty("java.version")?.let { attributes["Build-Jdk"] = it }
+    System.getProperty("user.name")?.let { attributes["Built-By"] = it }
+  }
+
+  from(rootDir.absolutePath) {
+    include("LICENSE")
+    into("META-INF/")
+  }
+}
+
+publishing {
+  publications {
+    create<MavenPublication>("mavenJava") {
+      from(components["java"])
+      versionMapping {
+        usage("java-api") { fromResolutionOf("runtimeClasspath") }
+        usage("java-runtime") { fromResolutionResult() }
+      }
+    }
+  }
+}
+
+spotless {
+  java {
+    target("src/*/java/**/*.java")
+    eclipse().configFile("$rootDir/project-files/code-styles/eclipse-style-guide.xml")
+    encoding("UTF-8")
+  }
+}

build-logic/src/main/kotlin/java-library-conventions.gradle.kts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 University Corporation for Atmospheric Research/Unidata
+ * See LICENSE for license information.
+ */
+
+import org.gradle.api.publish.maven.MavenPublication
+import org.gradle.kotlin.dsl.create
+
+plugins {
+  id("base-conventions")
+  `java-platform`
+  id("artifact-publishing-conventions")
+}
+
+publishing {
+  publications { create<MavenPublication>("platform") { from(components["javaPlatform"]) } }
+}