[Backport 2.x] Backport codegen implementation

.github/workflows/code-generation.yml

@@ -0,0 +1,89 @@
+name: Code Generation
+
+on:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 1' # 00:00 UTC Weekly on Mondays
+
+jobs:
+  up_to_date:
+    name: Ensure Generated Code Is Up To Date
+    # if: github.event_name == 'pull_request'
+    if: false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Java Client
+        uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 11
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Run Code Generator
+        run: ./gradlew :java-codegen:run
+
+      - name: Check For Uncommitted Changes
+        shell: bash -eo pipefail {0}
+        run: |
+          output=$(git status --porcelain)
+          if [ -z "$output" ]; then
+            echo "Clean working directory"
+            exit 0
+          else
+            echo "Dirty working directory"
+            echo "$output"
+            exit 1
+          fi
+
+
+  update_spec:
+    name: Update Specification and Re-generate Code
+    if: github.event_name == 'workflow_dispatch' || (github.event_name == 'schedule' && github.repository == 'opensearch-project/opensearch-java')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout Java Client
+        uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 11
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Download Latest Spec && Run Code Generator
+        run: ./gradlew :java-codegen:downloadLatestSpec :java-codegen:run
+
+      - name: Get Current Date
+        id: date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
+      - name: Generate GitHub App Token
+        if: github.repository == 'opensearch-project/opensearch-java'
+        id: github_app_token
+        uses: tibdex/github-app-token@v1.5.0
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          installation_id: 22958780
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ steps.github_app_token.outputs.token || secrets.GITHUB_TOKEN }}
+          commit-message: Re-generate client code using latest OpenSearch API specification (${{ steps.date.outputs.date }})
+          title: Re-generated client code using latest OpenSearch API specification
+          body: |
+            Re-generated client code using latest OpenSearch API specification.
+            Date: ${{ steps.date.outputs.date }}
+          branch: code-gen/${{ github.ref_name }}/update
+          signoff: true
+          labels: |
+            autocut

java-client/src/main/java/org/opensearch/client/util/ApiTypeHelper.java

@@ -39,6 +39,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
 /**
@@ -134,6 +135,7 @@ public static <T> boolean isDefined(List<T> list) {
     /**
      * Returns an unmodifiable view of a list. If {@code list} is {@code null}, an {@link #undefinedList()} is returned.
      */
+    @Nonnull
     public static <T> List<T> unmodifiable(@Nullable List<T> list) {
         if (list == null) {
             return undefinedList();

java-codegen/build.gradle.kts

@@ -0,0 +1,277 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/*
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+import com.github.jk1.license.ProjectData
+import com.github.jk1.license.render.ReportRenderer
+import de.undercouch.gradle.tasks.download.Download
+import java.io.FileWriter
+
+buildscript {
+    repositories {
+        mavenLocal()
+        maven(url = "https://aws.oss.sonatype.org/content/repositories/snapshots")
+        mavenCentral()
+        maven(url = "https://plugins.gradle.org/m2/")
+    }
+    dependencies {
+        "classpath"(group = "org.opensearch.gradle", name = "build-tools", version = "3.0.0-SNAPSHOT")
+    }
+}
+
+plugins {
+    application
+    id("com.github.jk1.dependency-license-report") version "2.9"
+    id("org.owasp.dependencycheck") version "10.0.2"
+    id("com.diffplug.spotless") version "6.25.0"
+    id("de.undercouch.download") version "5.6.0"
+}
+apply(plugin = "opensearch.repositories")
+apply(plugin = "org.owasp.dependencycheck")
+
+val runtimeJavaVersion = (System.getProperty("runtime.java")?.toInt())?.let(JavaVersion::toVersion) ?: JavaVersion.current()
+logger.quiet("=======================================")
+logger.quiet("  Runtime JDK Version   : $runtimeJavaVersion")
+logger.quiet("  Gradle JDK Version    : " + JavaVersion.current())
+logger.quiet("=======================================")
+
+java {
+    targetCompatibility = JavaVersion.VERSION_11
+    sourceCompatibility = JavaVersion.VERSION_11
+
+    withJavadocJar()
+    withSourcesJar()
+
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(runtimeJavaVersion.majorVersion)
+        vendor = JvmVendorSpec.ADOPTIUM
+    }
+}
+
+application {
+    mainClass.set("org.opensearch.client.codegen.CodeGenerator")
+    applicationDefaultJvmArgs = listOf(
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"
+    )
+}
+
+val localSpecification = "$projectDir/opensearch-openapi.yaml"
+
+tasks.create<Download>("downloadLatestSpec") {
+    src("https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml")
+    dest(localSpecification)
+}
+
+tasks.named<JavaExec>("run") {
+    args = listOf(
+        "--input", localSpecification,
+        "--eclipse-config", "$rootDir/buildSrc/formatterConfig-generated.xml",
+        "--output", "${project(":java-client").projectDir}/src/generated/java/"
+    )
+}
+
+tasks.withType<ProcessResources> {
+    expand(
+        "version" to version,
+        "git_revision" to (if (rootProject.extra.has("gitHashFull")) rootProject.extra["gitHashFull"] else "unknown")
+    )
+}
+
+tasks.withType<Javadoc>().configureEach{
+    options {
+        encoding = "UTF-8"
+    }
+}
+
+tasks.withType<Jar> {
+    doFirst {
+        if (rootProject.extra.has("gitHashFull")) {
+            val jar = this as Jar
+            jar.manifest.attributes["X-Git-Revision"] = rootProject.extra["gitHashFull"]
+            jar.manifest.attributes["X-Git-Commit-Time"] = rootProject .extra["gitCommitTime"]
+        } else {
+            throw GradleException("No git information available")
+        }
+    }
+
+    manifest {
+        attributes["Implementation-Title"] = "OpenSearch Java client code generator"
+        attributes["Implementation-Vendor"] = "OpenSearch"
+        attributes["Implementation-URL"] = "https://github.com/opensearch-project/opensearch-java/"
+        attributes["Build-Date"] = rootProject.extra["buildTime"]
+    }
+
+    metaInf {
+        from("../LICENSE.txt")
+        from("../NOTICE.txt")
+    }
+}
+
+tasks.withType<Test> {
+    useJUnitPlatform()
+    testLogging {
+        events("passed", "skipped", "failed")
+    }
+}
+
+tasks.build {
+    dependsOn("spotlessJavaCheck")
+}
+
+dependencies {
+    // Apache 2.0
+    implementation("io.swagger.parser.v3", "swagger-parser", "2.1.22")
+
+    // (New) BSD
+    implementation("com.samskivert", "jmustache", "1.16")
+
+    // Apache 2.0
+    implementation("commons-cli", "commons-cli", "1.8.0")
+    implementation("commons-codec", "commons-codec", "1.17.0")
+    implementation("commons-logging", "commons-logging", "1.3.2")
+    implementation("org.apache.commons", "commons-lang3", "3.14.0")
+    implementation("org.apache.commons", "commons-text", "1.12.0")
+    implementation("org.apache.logging.log4j", "log4j-api", "[2.17.1,3.0)")
+    implementation("org.apache.logging.log4j", "log4j-core", "[2.17.1,3.0)")
+    implementation("org.apache.logging.log4j", "log4j-slf4j2-impl", "[2.17.1,3.0)")
+
+    // Apache 2.0
+    implementation("com.fasterxml.jackson.core", "jackson-core", "2.17.1")
+    implementation("com.fasterxml.jackson.core", "jackson-databind", "2.17.1")
+
+    // Apache 2.0
+    implementation("com.diffplug.spotless", "spotless-lib", "2.45.0")
+    implementation("com.diffplug.spotless", "spotless-lib-extra", "2.45.0")
+
+    // Apache 2.0
+    // https://search.maven.org/artifact/com.google.code.findbugs/jsr305
+    implementation("com.google.code.findbugs", "jsr305", "3.0.2")
+
+    // Apache 2.0
+    compileOnly("org.jetbrains", "annotations", "24.1.0")
+
+    // Apache 2.0
+    implementation("org.apache.maven.resolver", "maven-resolver-api", "1.9.20")
+    implementation("org.apache.maven.resolver", "maven-resolver-supplier", "1.9.20")
+
+    // MIT
+    implementation("org.semver4j", "semver4j", "5.3.0")
+
+    // EPL-2.0
+    testImplementation(platform("org.junit:junit-bom:5.10.3"))
+    testImplementation("org.junit.jupiter", "junit-jupiter")
+    testRuntimeOnly("org.junit.platform", "junit-platform-launcher")
+}
+
+licenseReport {
+    renderers = arrayOf(SpdxReporter(rootProject.layout.buildDirectory.file("release/codegen-dependencies.csv").get().getAsFile()))
+    excludeGroups = arrayOf()
+}
+
+class SpdxReporter(val dest: File) : ReportRenderer {
+    // License names to their SPDX identifier
+    val spdxIds = mapOf(
+        "Apache 2" to "Apache-2.0",
+        "Apache 2.0" to "Apache-2.0",
+        "Apache-2.0" to "Apache-2.0",
+        "\"Apache-2.0\";link=\"https://www.apache.org/licenses/LICENSE-2.0.txt\"" to "Apache-2.0",
+        "\"Apache 2.0\";link=\"http://www.apache.org/licenses/LICENSE-2.0.txt\"" to "Apache-2.0",
+        "\"Apache License 2.0\";link=\"http://www.apache.org/licenses/LICENSE-2.0.html\"" to "Apache-2.0",
+        "Apache License 2.0" to "Apache-2.0",
+        "Apache License, version 2.0" to "Apache-2.0",
+        "Apache License, Version 2.0" to "Apache-2.0",
+        "Apache Software License, version 2.0" to "Apache-2.0",
+        "The Apache License, Version 2.0" to "Apache-2.0",
+        "The Apache Software License, Version 2.0" to "Apache-2.0",
+        "BSD Zero Clause License" to "0BSD",
+        "The (New) BSD License" to "BSD-3-Clause",
+        "EDL 1.0" to "BSD-3-Clause",
+        "Eclipse Distribution License - v 1.0" to "BSD-3-Clause",
+        "Eclipse Distribution License (New BSD License)" to "BSD-3-Clause",
+        "Eclipse Public License 2.0" to "EPL-2.0",
+        "Eclipse Public License v. 2.0" to "EPL-2.0",
+        "Eclipse Public License - v 2.0" to "EPL-2.0",
+        "GNU General Public License, version 2 with the GNU Classpath Exception" to "GPL-2.0 WITH Classpath-exception-2.0",
+        "COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0" to "CDDL-1.0",
+        "Lesser General Public License, version 3 or greater" to "LGPL-3.0+",
+        "MIT" to "MIT",
+        "MIT License" to "MIT",
+        "The MIT License" to "MIT",
+        "Mozilla Public License, Version 2.0" to "MPL-2.0",
+        "Public Domain" to "PUBLIC-DOMAIN"
+    )
+
+    private fun quote(str: String) : String {
+        return if (str.contains(',') || str.contains("\"")) {
+            "\"" + str.replace("\"", "\"\"") + "\""
+        } else {
+            str
+        }
+    }
+
+    override fun render(data: ProjectData?) {
+        dest.parentFile.mkdirs()
+        FileWriter(dest).use { out ->
+            out.append("name,url,version,revision,license\n")
+            data?.allDependencies?.forEach { dep ->
+                val info = com.github.jk1.license.render.LicenseDataCollector.multiModuleLicenseInfo(dep)
+
+                val depVersion = dep.version
+                val depName = dep.group + ":" + dep.name
+                val depUrl = if (info.moduleUrls.isNotEmpty()) { info.moduleUrls.first() } else { "<NO MODULE URL>" }
+
+                val licenseIds = info.licenses.mapNotNull { license ->
+                    license.name?.let {
+                        checkNotNull(spdxIds[it]) { "No SPDX identifier for $license" }
+                    }
+                }.toSet()
+
+                // Combine multiple licenses.
+                // See https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/#composite-license-expressions
+                val licenseId = licenseIds.joinToString(" OR ")
+                out.append("${quote(depName)},${quote(depUrl)},${quote(depVersion)},,${quote(licenseId)}\n")
+            }
+        }
+    }
+}
+
+tasks.withType<Jar> {
+    doLast {
+        ant.withGroovyBuilder {
+            "checksum"("algorithm" to "md5", "file" to archiveFile.get())
+            "checksum"("algorithm" to "sha1", "file" to archiveFile.get())
+            "checksum"("algorithm" to "sha-256", "file" to archiveFile.get(), "fileext" to ".sha256")
+            "checksum"("algorithm" to "sha-512", "file" to archiveFile.get(), "fileext" to ".sha512")
+        }
+    }
+}
+
+spotless {
+    java {
+        target("**/*.java")
+
+        licenseHeaderFile("../LICENSE_HEADER.txt")
+
+        // Use the default importOrder configuration
+        importOrder()
+        removeUnusedImports()
+
+        eclipse().configFile("../buildSrc/formatterConfig-generated.xml")
+
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}