sdk-platform-java-ci.yaml

on:
  push:
    branches:
      - main
  pull_request:
name: sdk-platform-java-ci
jobs:
  filter:
    runs-on: ubuntu-latest
    outputs:
      library: ${{ steps.filter.outputs.library }}
    steps:
    - uses: actions/checkout@v4
    - uses: dorny/paths-filter@v3
      id: filter
      with:
        filters: |
          library:
            - 'sdk-platform-java/**'
  build:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        java: [ 11, 17 ]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: ${{ matrix.java }}
          distribution: temurin
          cache: maven
      - run: java -version
      - name: Unit Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage
        working-directory: sdk-platform-java
      # The `envVarTest` profile runs tests that require an environment variable
      - name: Env Var Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage -PenvVarTest
        # Set the Env Var for this step only
        env:
          GOOGLE_CLOUD_UNIVERSE_DOMAIN: random.com
          GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS: true
          GOOGLE_SDK_JAVA_LOGGING: true
        working-directory: sdk-platform-java
      - run: bazelisk version
      - name: Install Maven modules
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
        working-directory: sdk-platform-java
      - name: Integration Tests
        run: |
          bazelisk --batch test //sdk-platform-java/test/integration/...
      - name: Gradle Build Generated Storage Client Library
        run: |
          echo "Building Storage lib from generated source..."
          mkdir /tmp/java-storage
          bazelisk --batch build @com_google_googleapis//google/storage/v2:google-cloud-storage-v2-java
          tar zxvf bazel-bin/external/com_google_googleapis/google/storage/v2/google-cloud-storage-v2-java.tar.gz -C /tmp/java-storage
          pushd /tmp/java-storage/google-cloud-storage-v2-java
          ./gradlew clean build publishToMavenLocal sourcesJar allJars
          popd
      - name: Gradle Build Generated Compute Client Library
        run: |
          echo "Building Compute lib from generated source..."
          mkdir /tmp/java-compute
          bazelisk --batch build @com_google_googleapis//google/cloud/compute/v1small:google-cloud-compute-small-v1-java
          tar zxvf bazel-bin/external/com_google_googleapis/google/cloud/compute/v1small/google-cloud-compute-small-v1-java.tar.gz -C /tmp/java-compute
          pushd /tmp/java-compute/google-cloud-compute-small-v1-java
          ./gradlew clean build publishToMavenLocal sourcesJar allJars
          popd
  build-java-21:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    name: "build(21) except self-service clients"
    # Support for Java 21 is available for all use cases except self-service clients.
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: 21
          distribution: temurin
          cache: maven
      - run: java -version
      - name: Unit Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage
        working-directory: sdk-platform-java
      # The `envVarTest` profile runs tests that require an environment variable
      - name: Env Var Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage -PenvVarTest
        # Set the Env Var for this step only
        env:
          GOOGLE_CLOUD_UNIVERSE_DOMAIN: random.com
          GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS: true
          GOOGLE_SDK_JAVA_LOGGING: true
        working-directory: sdk-platform-java
      - run: bazelisk version
      - name: Install Maven modules
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip
        working-directory: sdk-platform-java
      - name: Integration Tests
        run: |
          bazelisk --batch test //sdk-platform-java/test/integration/...
  build-java-25:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    name: "build(25) except self-service clients"
    # Support for Java 25 is available for all use cases except self-service clients.
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: 25
          distribution: temurin
          cache: maven
      - run: java -version
      - name: Unit Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage
        working-directory: sdk-platform-java
      # The `envVarTest` profile runs tests that require an environment variable
      - name: Env Var Tests
        run: |
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage -PenvVarTest
        # Set the Env Var for this step only
        env:
          GOOGLE_CLOUD_UNIVERSE_DOMAIN: random.com
          GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS: true
          GOOGLE_SDK_JAVA_LOGGING: true
        working-directory: sdk-platform-java
      - run: bazelisk version
      - name: Install Maven modules
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
        working-directory: sdk-platform-java
      - name: Integration Tests
        # note need to set shouldInstallTestSecurityManager=false due to https://github.com/bazelbuild/bazel/issues/24354
        run: |
          bazelisk --batch test //sdk-platform-java/test/integration/... --jvmopt=-Dcom.google.testing.junit.runner.shouldInstallTestSecurityManager=false
  build-java8-except-gapic-generator-java:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    name: "build(8) except for gapic-generator-java"
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      # Java 8 tests uses JDK 17 to compile and JDK 8 to run tests.
      - uses: actions/setup-java@v4
        with:
          java-version: 8
          distribution: temurin
          cache: maven
      - run: echo "JAVA8_HOME=${JAVA_HOME}" >> $GITHUB_ENV
      - uses: actions/setup-java@v3
        with:
          java-version: 17
          distribution: temurin
      - name: Compile with Java 17 and run tests with Java 8
        shell: bash
        run: |
          set -x
          export JAVA_HOME=$JAVA_HOME
          export PATH=${JAVA_HOME}/bin:$PATH
          # Maven surefire plugin lets us to specify the JVM when running tests via
          # the "jvm" system property.
          mvn verify --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip \
              -Djvm="${JAVA8_HOME}/bin/java"
        working-directory: sdk-platform-java
      # The `envVarTest` profile runs tests that require an environment variable
      - name: Compile with Java 17 and run tests with Java 8 (Env Var Tests)
        shell: bash
        run: |
          set -x
          export JAVA_HOME=$JAVA_HOME
          export PATH=${JAVA_HOME}/bin:$PATH
          # Maven surefire plugin lets us to specify the JVM when running tests via
          # the "jvm" system property.
          export GOOGLE_CLOUD_UNIVERSE_DOMAIN=random.com
          mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
              -Dfmt.skip -DenableTestCoverage -Dsurefire.failIfNoSpecifiedTests=false \
              -PenvVarTest
        # Set the Env Var for this step only
        env:
          GOOGLE_CLOUD_UNIVERSE_DOMAIN: random.com
          GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS: true
          GOOGLE_SDK_JAVA_LOGGING: true
        working-directory: sdk-platform-java

  build-java8-gapic-generator-java:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    name: "build(8) for gapic-generator-java"
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: 11
          distribution: temurin
          cache: maven
      - name: Install all modules using Java 11
        shell: bash
        run: |
          mvn -V -B -ntp clean install -DskipTests -Dfmt.skip -Dcheckstyle.skip
        working-directory: sdk-platform-java
      - uses: actions/setup-java@v3
        with:
          java-version: 8
          distribution: temurin
      - run: java -version
      - name: Run tests in Java 8 with the source compiled in Java 11 for gapic-generator-java
        shell: bash
        run: |
          mvn -V -B -ntp surefire:test --projects 'gapic-generator-java'
        working-directory: sdk-platform-java
      - run: bazelisk version
      - name: Integration Tests
        run: |
          bazelisk --batch test //sdk-platform-java/test/integration/...
      - name: Gradle Build Generated Storage Client Library
        run: |
          echo "Building Storage lib from generated source..."
          mkdir /tmp/java-storage
          bazelisk --batch build @com_google_googleapis//google/storage/v2:google-cloud-storage-v2-java
          tar zxvf bazel-bin/external/com_google_googleapis/google/storage/v2/google-cloud-storage-v2-java.tar.gz -C /tmp/java-storage
          pushd /tmp/java-storage/google-cloud-storage-v2-java
          ./gradlew clean build publishToMavenLocal sourcesJar allJars
          popd
      - name: Gradle Build Generated Compute Client Library
        run: |
          echo "Building Compute lib from generated source..."
          mkdir /tmp/java-compute
          bazelisk --batch build @com_google_googleapis//google/cloud/compute/v1small:google-cloud-compute-small-v1-java
          tar zxvf bazel-bin/external/com_google_googleapis/google/cloud/compute/v1small/google-cloud-compute-small-v1-java.tar.gz -C /tmp/java-compute
          pushd /tmp/java-compute/google-cloud-compute-small-v1-java
          ./gradlew clean build publishToMavenLocal sourcesJar allJars
          popd

  build-java8-showcase:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    name: "build(8) for showcase"
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: 11
          distribution: temurin
          cache: maven
      - name: Install all modules using Java 11
        shell: bash
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
        working-directory: sdk-platform-java
      - uses: actions/setup-java@v3
        with:
          java-version: 8
          distribution: temurin
      - run: java -version
      - name: Parse showcase version
        working-directory: sdk-platform-java/java-showcase/gapic-showcase
        run: echo "SHOWCASE_VERSION=$(mvn help:evaluate -Dexpression=gapic-showcase.version -q -DforceStdout)" >> "$GITHUB_ENV"
      - name: Install showcase server
        run: |
                sudo mkdir -p /usr/src/showcase
                sudo chown -R ${USER} /usr/src/
                curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${{env.SHOWCASE_VERSION}}/gapic-showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz --output /usr/src/showcase/showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz
                cd /usr/src/showcase/
                tar -xf showcase-*
                ./gapic-showcase run &
                cd -
      - name: Showcase integration tests
        working-directory: sdk-platform-java/java-showcase
        run: |
              mvn verify \
                -P enable-integration-tests \
                --batch-mode \
                --no-transfer-progress
        # The `slf4j1_logback` profile brings logging dependency and compiles logging tests, require env var to be set
      - name: Showcase integration tests - Logging SLF4J 1.x
        working-directory: sdk-platform-java/java-showcase
        run: |
             mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j1_logback' \
              --batch-mode \
              --no-transfer-progress
        # Set the Env Var for this step only
        env:
            GOOGLE_SDK_JAVA_LOGGING: true
        # The `disabledLogging` profile tests logging disabled when logging dependency present,
        # do not set env var for this step
      - name: Showcase integration tests - Logging disabed
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,disabledLogging'  \
            --batch-mode \
            --no-transfer-progress
      - name: Showcase integration tests - Protobuf gen code 3.25.8
        working-directory: sdk-platform-java/java-showcase-3.25.8
        run: |
          mvn verify \
            -P enable-integration-tests \
            --batch-mode \
            --no-transfer-progress
      - name: Showcase integration tests - Protobuf gen code 3.21.0
        working-directory: sdk-platform-java/java-showcase-3.21.0
        run: |
          mvn verify \
            -P enable-integration-tests \
            --batch-mode \
            --no-transfer-progress
  showcase:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        java: [ 11, 17, 21, 25 ]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: ${{ matrix.java }}
          distribution: temurin
      - run: mvn -version
      - name: Install Maven modules
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
        working-directory: sdk-platform-java        
      - name: Showcase golden tests
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn test \
            -P enable-golden-tests \
            --batch-mode \
            --no-transfer-progress
      - name: Parse showcase version
        working-directory: sdk-platform-java/java-showcase/gapic-showcase
        run: echo "SHOWCASE_VERSION=$(mvn help:evaluate -Dexpression=gapic-showcase.version -q -DforceStdout)" >> "$GITHUB_ENV"
      - name: Install showcase server
        run: |
          sudo mkdir -p /usr/src/showcase
          sudo chown -R ${USER} /usr/src/
          curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${{env.SHOWCASE_VERSION}}/gapic-showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz --output /usr/src/showcase/showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz
          cd /usr/src/showcase/
          tar -xf showcase-*
          ./gapic-showcase run &
          cd -
      - name: Showcase integration tests
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn verify \
            -P enable-integration-tests \
            --batch-mode \
            --no-transfer-progress
      # The `slf4j2_logback` profile brings logging dependency and compiles logging tests, require env var to be set
      - name: Showcase integration tests - Logging SLF4J 2.x
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j2_logback' \
            --batch-mode \
            --no-transfer-progress
        # Set the Env Var for this step only
        env:
          GOOGLE_SDK_JAVA_LOGGING: true
    # The `slf4j1_logback` profile brings logging dependency and compiles logging tests, require env var to be set
      - name: Showcase integration tests - Logging SLF4J 1.x
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j1_logback' \
            --batch-mode \
            --no-transfer-progress
        # Set the Env Var for this step only
        env:
          GOOGLE_SDK_JAVA_LOGGING: true
    # The `disabledLogging` profile tests logging disabled when logging dependency present,
    # do not set env var for this step
      - name: Showcase integration tests - Logging disabed
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,disabledLogging'  \
            --batch-mode \
            --no-transfer-progress
      - name: Showcase integration tests - Protobuf 3 compatibility with third party library Tensorflow
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn clean verify -P 'enable-integration-tests,protobuf3,showcase'  \
            --batch-mode \
            --no-transfer-progress

  showcase-clirr:
    needs: filter
    if: ${{ (needs.filter.outputs.library == 'true') && github.base_ref != '' }} # Only execute on pull_request trigger event
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout @ target branch
        uses: actions/checkout@v4
        with:
          ref: ${{ github.base_ref }}
      - uses: actions/setup-java@v4
        with:
          java-version: 17
          distribution: temurin
          cache: maven
      - name: Install Maven modules
        run: |
          mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
        working-directory: sdk-platform-java
      - name: Install showcase to local maven repository
        run: |
          mvn install -B -ntp -T 1C -DskipTests
          SHOWCASE_CLIENT_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
          echo "SHOWCASE_CLIENT_VERSION=$SHOWCASE_CLIENT_VERSION" >> "$GITHUB_ENV"
        working-directory: sdk-platform-java/java-showcase
      - name: Checkout sdk-platform-java @ PR merge commit
        uses: actions/checkout@v3
      - name: Install sdk-platform-java @ PR merge commit
        run: mvn install -B -ntp -T 1C -DskipTests
        working-directory: sdk-platform-java
        # Showcase golden test ensures that src changes are already reflected in the PR.
      - name: Clirr check
        working-directory: sdk-platform-java/java-showcase
        run: |
          mvn versions:set -B -ntp -DnewVersion=local
          mvn clirr:check -B -ntp -DcomparisonVersion=$SHOWCASE_CLIENT_VERSION

  gapic-generator-java-bom:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-java@v4
      with:
        java-version: 11
        distribution: temurin
        cache: maven
    - name: Install Maven modules to local Maven repository
      run: |
        mvn install \
          -B -ntp \
          -Dorg.slf4j.simpleLogger.showDateTime=true \
          -Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss:SSS \
          -DskipTests \
          -Dclirr.skip=true \
          -Denforcer.skip=true \
          -Dcheckstyle.skip=true \
          -Dflatten.skip=true \
          -Danimal.sniffer.skip=true \
          -Dmaven.wagon.http.retryHandler.count=5 \
          -T 1C
      working-directory: sdk-platform-java
    - name: Validate gapic-generator-java-bom
      uses: googleapis/java-cloud-bom/tests/validate-bom@47ad868794c5d38ee7eb95d69371a7a79f84d890
      with:
        bom-path: sdk-platform-java/gapic-generator-java-bom/pom.xml

  unmanaged_dependency_check:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        ref: ${{ github.event.pull_request.head.sha }}
    - uses: actions/setup-java@v4
      with:
        java-version: 11
        distribution: temurin
    - run: mvn -version
    - name: Unit Tests
      run: |
        mvn test --batch-mode --no-transfer-progress
      working-directory: sdk-platform-java/java-shared-dependencies/unmanaged-dependency-check
    - name: Install Maven modules
      run: |
        mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip
      working-directory: sdk-platform-java
    - name: Unmanaged dependency check
      uses: ./sdk-platform-java/java-shared-dependencies/unmanaged-dependency-check
      with:
        bom-path: sdk-platform-java/gapic-generator-java-bom/pom.xml

  dependency_analyzer_unit_test:
    needs: filter
    if: ${{ needs.filter.outputs.library == 'true' }}
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        ref: ${{ github.event.pull_request.head.sha }}
    - uses: actions/setup-java@v4
      with:
        java-version: 17
        distribution: temurin
    - run: mvn -version
    - name: Unit Tests
      run: |
        mvn test --batch-mode --no-transfer-progress
      working-directory: sdk-platform-java/java-shared-dependencies/dependency-analyzer