Merge branch 'main' into release-please--branches--main

Author: JoeWang1127

.github/release-please.yml

@@ -3,4 +3,4 @@ bumpMinorPreMajor: true
 handleGHRelease: true
 primaryBranch: main
 manifest: true
-extraFiles: ["WORKSPACE", ".cloudbuild/graalvm/cloudbuild.yaml", ".cloudbuild/graalvm/cloudbuild-test-a.yaml", ".cloudbuild/graalvm/cloudbuild-test-b.yaml", ".cloudbuild/library_generation/cloudbuild-library-generation-release.yaml" ]
+extraFiles: ["WORKSPACE", ".cloudbuild/graalvm/cloudbuild.yaml", ".cloudbuild/graalvm/cloudbuild-test-a.yaml", ".cloudbuild/graalvm/cloudbuild-test-b.yaml", ".cloudbuild/library_generation/cloudbuild-library-generation-release.yaml", "generation_config.yaml"]

.github/workflows/ci.yaml

@@ -22,6 +22,14 @@ jobs:
         run: |
           mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
               -Dfmt.skip -DenableTestCoverage
+      # 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
       - run: bazelisk version
       - name: Install Maven modules
         run: |
@@ -63,7 +71,15 @@ jobs:
       - name: Unit Tests
         run: |
           mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
-
+              -Dfmt.skip -DenableTestCoverage
+      # 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
       - run: bazelisk version
       - name: Install Maven modules
         run: |
@@ -95,14 +111,25 @@ jobs:
           export PATH=${JAVA_HOME}/bin:$PATH
           # Maven surefire plugin lets us to specify the JVM when running tests via
           # the "jvm" system property.
-          mvn org.apache.maven.plugins:maven-surefire-plugin:test \
-              verify \
-              --batch-mode \
-              --no-transfer-progress \
-              -Dcheckstyle.skip \
+          mvn verify --batch-mode --no-transfer-progress -Dcheckstyle.skip \
               -Dfmt.skip \
-              -Djvm="${JAVA8_HOME}/bin/java" \
-              -DargLine="-Djava.util.logging.SimpleFormatter.format='%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n'"
+              -Djvm="${JAVA8_HOME}/bin/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
 
   build-java8-gapic-generator-java:
     name: "build(8) for gapic-generator-java"

.github/workflows/sonar.yaml

@@ -47,6 +47,10 @@ jobs:
             tar -xf showcase-*
             ./gapic-showcase run &
             cd -
+      # Intentionally do not run the Env Var Tests (no -PenvVarTests) as setting the Env Var
+      # may alter the results for other tests that use Env Var in the logic. Adding a Sonar
+      # step for a few tests (env var tests) may be overkill and should be better covered
+      # when we can upgrade to JUnit 5 (https://github.com/googleapis/sdk-platform-java/issues/1611#issuecomment-1970079325)
       - name: Build and analyze for full test coverage
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any

gapic-generator-java-pom-parent/pom.xml

@@ -182,6 +182,23 @@
         </plugins>
       </build>
     </profile>
+    <profile>
+      <id>envVarTest</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <!-- Unless overriden in the submodules, this profile run no tests in a submodule -->
+              <excludes>
+                <exclude>**/*.java</exclude>
+              </excludes>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
   <repositories>
     <repository>

gax-java/dependencies.properties

@@ -88,4 +88,3 @@ maven.net_bytebuddy_byte_buddy=net.bytebuddy:byte-buddy:1.14.16
 maven.org_objenesis_objenesis=org.objenesis:objenesis:2.6
 maven.org_junit_jupiter_junit_jupiter_api=org.junit.jupiter:junit-jupiter-api:5.10.2
 maven.org_junit_jupiter_junit_jupiter_params=org.junit.jupiter:junit-jupiter-params:5.10.2
-maven.org_junit_pioneer_junit_pioneer=org.junit-pioneer:junit-pioneer:2.2.0

gax-java/gax/BUILD.bazel

@@ -41,7 +41,6 @@ _TEST_COMPILE_DEPS = [
     "@net_bytebuddy_byte_buddy//jar",
     "@org_objenesis_objenesis//jar",
     "@com_googlecode_java_diff_utils_diffutils//jar",
-    "@org_junit_pioneer_junit_pioneer//jar",
 ]
 
 java_library(

gax-java/gax/pom.xml

@@ -99,18 +99,32 @@
         </configuration>
       </plugin>
       <plugin>
+        <!-- Troubleshooting a flaky test in https://github.com/googleapis/sdk-platform-java/issues/1931 -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>
-          <argLine>
-            -Djava.util.logging.SimpleFormatter.format="%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n"
-            <!-- workaround setup for using junit-pioneer with Java 17 or above,
-            see https://junit-pioneer.org/docs/environment-variables/#warnings-for-reflective-access -->
-            --add-opens java.base/java.util=ALL-UNNAMED
-            --add-opens java.base/java.lang=ALL-UNNAMED
-          </argLine>
+          <argLine>-Djava.util.logging.SimpleFormatter.format="%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n"</argLine>
+          <!-- These tests require an Env Var to be set. Use -PenvVarTest to ONLY run these tests -->
+          <test>!EndpointContextTest#endpointContextBuild_universeDomainEnvVarSet+endpointContextBuild_multipleUniverseDomainConfigurations_clientSettingsHasPriority</test>
         </configuration>
       </plugin>
     </plugins>
   </build>
-</project>
+
+  <profiles>
+    <profile>
+      <id>envVarTest</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <test>EndpointContextTest#endpointContextBuild_universeDomainEnvVarSet+endpointContextBuild_multipleUniverseDomainConfigurations_clientSettingsHasPriority</test>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+</project>

gax-java/gax/src/test/java/com/google/api/gax/rpc/EndpointContextTest.java

@@ -40,7 +40,6 @@
 import java.io.IOException;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junitpioneer.jupiter.SetEnvironmentVariable;
 import org.mockito.Mockito;
 
 class EndpointContextTest {
@@ -338,8 +337,8 @@ void endpointContextBuild_gdchFlow_noUniverseDomain_customEndpoint() throws IOEx
 
   // This Universe Domain should match the `GOOGLE_CLOUD_UNIVERSE_DOMAIN` Env Var
   // For this test running locally or in CI, check that the Env Var is set properly.
+  // This test should only run when the maven profile `EnvVarTest` is enabled.
   @Test
-  @SetEnvironmentVariable(key = EndpointContext.GOOGLE_CLOUD_UNIVERSE_DOMAIN, value = "random.com")
   void endpointContextBuild_universeDomainEnvVarSet() throws IOException {
     String envVarUniverseDomain = "random.com";
     EndpointContext endpointContext =
@@ -353,10 +352,11 @@ void endpointContextBuild_universeDomainEnvVarSet() throws IOException {
 
   // This Universe Domain should match the `GOOGLE_CLOUD_UNIVERSE_DOMAIN` Env Var
   // For this test running locally or in CI, check that the Env Var is set properly.
+  // This test should only run when the maven profile `EnvVarTest` is enabled.
   @Test
-  @SetEnvironmentVariable(key = EndpointContext.GOOGLE_CLOUD_UNIVERSE_DOMAIN, value = "random.com")
   void endpointContextBuild_multipleUniverseDomainConfigurations_clientSettingsHasPriority()
       throws IOException {
+    // This test has `GOOGLE_CLOUD_UNIVERSE_DOMAIN` = `random.com`
     String clientSettingsUniverseDomain = "clientSettingsUniverseDomain.com";
     EndpointContext endpointContext =
         defaultEndpointContextBuilder

gax-java/pom.xml

@@ -205,12 +205,6 @@
       </exclusions>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.junit-pioneer</groupId>
-      <artifactId>junit-pioneer</artifactId>
-      <version>2.2.0</version>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 
   <build>

generation_config.yaml

@@ -1,4 +1,4 @@
-gapic_generator_version: 2.40.2-SNAPSHOT
+gapic_generator_version: 2.40.2-SNAPSHOT # {x-version-update:gapic-generator-java:current}
 googleapis_commitish: 3d50414a7ff3f0b8ffe8ad7858257396e4f18131
 template_excludes:
 - .github/*

library_generation/generate_pr_description.py

@@ -22,6 +22,8 @@
 from library_generation.utils.commit_message_formatter import format_commit_message
 from library_generation.utils.commit_message_formatter import wrap_override_commit
 
+EMPTY_MESSAGE = ""
+
 
 def generate_pr_descriptions(
     config: GenerationConfig,
@@ -62,6 +64,10 @@ def generate_pr_descriptions(
         is_monorepo=config.is_monorepo(),
     )
 
+    if description == EMPTY_MESSAGE:
+        print("Empty commit messages, skip creating pull request description.")
+        return
+
     description_file = f"{description_path}/pr_description.txt"
     print(f"Writing pull request description to {description_file}")
     with open(description_file, "w+") as f:
@@ -115,6 +121,9 @@ def get_commit_messages(
             break
         commit = commit_parents[0]
     shutil.rmtree(tmp_dir, ignore_errors=True)
+    if len(qualified_commits) == 0:
+        return EMPTY_MESSAGE
+
     return __combine_commit_messages(
         current_commit=current_commit,
         baseline_commit=baseline_commit,

library_generation/test/generate_pr_description_unit_tests.py

@@ -70,3 +70,28 @@ def test_generate_pr_description_with_same_googleapis_commits(self):
             description_path=cwd,
         )
         self.assertFalse(os.path.isfile(f"{cwd}/pr_description.txt"))
+
+    def test_generate_pr_description_does_not_create_pr_description_without_qualified_commit(
+        self,
+    ):
+        # committed on May 22nd, 2024
+        old_commit_sha = "30717c0b0c9966906880703208a4c820411565c4"
+        # committed on May 23rd, 2024
+        new_commit_sha = "eeed69d446a90eb4a4a2d1762c49d637075390c1"
+        cwd = os.getcwd()
+        generate_pr_descriptions(
+            config=GenerationConfig(
+                gapic_generator_version="",
+                googleapis_commitish=new_commit_sha,
+                libraries_bom_version="",
+                template_excludes=[],
+                grpc_version="",
+                protoc_version="",
+                # use empty libraries to make sure no qualified commit between
+                # two commit sha.
+                libraries=[],
+            ),
+            baseline_commit=old_commit_sha,
+            description_path=cwd,
+        )
+        self.assertFalse(os.path.isfile(f"{cwd}/pr_description.txt"))

release-please-config.json

@@ -5,7 +5,14 @@
   "group-pull-request-title-pattern": "chore(${branch}): release ${version}",
   "packages": {
     ".": {
-      "extra-files": ["WORKSPACE", ".cloudbuild/graalvm/cloudbuild.yaml", ".cloudbuild/graalvm/cloudbuild-test-a.yaml", ".cloudbuild/graalvm/cloudbuild-test-b.yaml", ".cloudbuild/library_generation/cloudbuild-library-generation-release.yaml"]
+      "extra-files": [
+        "WORKSPACE",
+        ".cloudbuild/graalvm/cloudbuild.yaml",
+        ".cloudbuild/graalvm/cloudbuild-test-a.yaml",
+        ".cloudbuild/graalvm/cloudbuild-test-b.yaml",
+        ".cloudbuild/library_generation/cloudbuild-library-generation-release.yaml",
+        "generation_config.yaml"
+      ]
     }
   }
 }