tests: Use fixed copyright year in tests. (#4036)

The generator use the current year to generate copyright headers, so
there are multiple tests failing when a new year comes. The general fix
is to introduce an environment variable `TEST_CURRENT_YEAR` so that we
can override it in tests. See below for the exact fix for each scenario:

- Java generator golden unit tests
- [Override it with
Maven](https://github.com/googleapis/sdk-platform-java/blob/9ac79fc6c856a0b71111e28e2f69eeb0c01b4fc9/gapic-generator-java/pom.xml#L326-L328).
- Java generator golden integration tests
- Updated the golden files. These tests are generated from Bazel rules.
Bazel builds are pretty hermetic and I couldn't find a way to override
the environment variable. This is because the Bazel rule
`java_gapic_library` [calls the
generator](https://github.com/googleapis/sdk-platform-java/blob/b43f77c66d93d2423744d0f6d6a0a2a53a06e6d9/rules_java_gapic/java_gapic.bzl#L224-L235)
through `proto_custom_library` which does not pass any environment
variables.
- Python hermetic build scripts unit tests.
- Override it with
[mocks](https://github.com/googleapis/sdk-platform-java/blob/9ac79fc6c856a0b71111e28e2f69eeb0c01b4fc9/hermetic_build/library_generation/tests/owlbot/java_unit_tests.py#L176).
This requires a small refactoring in java.py.
- Hermetic build scripts integration tests.
- Changed these tests to non-required for now. These tests use a
[hardcoded generator
version](https://github.com/googleapis/sdk-platform-java/blob/b43f77c66d93d2423744d0f6d6a0a2a53a06e6d9/.cloudbuild/library_generation/cloudbuild-library-generation-integration-test.yaml#L69-L74)
that does not recognize the environment variable. Once the generator is
released, we can update the generator version and override the
environment variable in CloudBuild yamls.
- SpringCodeGen unit tests.
- Once the generator is released, we can override the same environment
variable with Maven in spring-cloud-gcp.

Separately, updated zlib version in Bazel build because there is a known
incompatibility between old zlib library and the latest macOS version.

fixes: #3547

---------

Co-authored-by: cloud-java-bot <[email protected]>

Author: blakeli0

.bazeliskrc

@@ -1,3 +1,3 @@
 # See https://github.com/bazelbuild/bazelisk
 # Version required for Java 24 support (https://github.com/bazelbuild/bazel/commit/806a6e82320956b63f1351ebe2b0da8483f36f19).
-USE_BAZEL_VERSION=7.6.1
+USE_BAZEL_VERSION=7.7.0

WORKSPACE

@@ -24,6 +24,15 @@ com_google_api_gax_java_repositories()
 
 _googleapis_commit = "7438480b2a1bc6371d748e974f7a3647f90c4e8d"
 
+# This is required for local testing on macOS. There is known incompatibility between old zlib and the latest macOS (Sequoia 15.7.3 as of writing)
+http_archive(
+    name = "zlib",
+    build_file = "@com_google_protobuf//:third_party/zlib.BUILD",
+    sha256 = "9a93b2b7dfdac77ceba5a558a580e74667dd6fede4585b91eefb60f03b72df23",
+    strip_prefix = "zlib-1.3.1",
+    urls = ["https://github.com/madler/zlib/releases/download/v1.3.1/zlib-1.3.1.tar.gz"],
+)
+
 http_archive(
     name = "com_google_googleapis",
     strip_prefix = "googleapis-%s" % _googleapis_commit,

gapic-generator-java/pom.xml

@@ -17,6 +17,7 @@
     <googleapis.commit>9fcfbea0aa5b50fa22e190faceb073d74504172b</googleapis.commit>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+    <currentYearOverride>2025</currentYearOverride>
   </properties>
 
   <parent>
@@ -323,6 +324,10 @@
               target/generated-test-resources/protobuf/descriptor-sets
             </additionalClasspathElement>
           </additionalClasspathElements>
+          <!-- Set CURRENT_YEAR_OVERRIDE to a fixed year so the unit test result is consistent -->
+          <environmentVariables>
+            <CURRENT_YEAR_OVERRIDE>${currentYearOverride}</CURRENT_YEAR_OVERRIDE>
+          </environmentVariables>
         </configuration>
       </plugin>
 

gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java

@@ -18,6 +18,7 @@
 import com.google.api.generator.engine.ast.CommentStatement;
 import com.google.api.generator.engine.ast.LineComment;
 import com.google.api.generator.engine.ast.Statement;
+import com.google.common.base.Strings;
 import java.util.Arrays;
 import java.util.Calendar;
 import java.util.List;
@@ -35,7 +36,7 @@ public class CommentComposer {
               + "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
               + "See the License for the specific language governing permissions and\n"
               + "limitations under the License.",
-          Calendar.getInstance().get(Calendar.YEAR));
+          getCurrentYear());
 
   private static final String AUTO_GENERATED_CLASS_DISCLAIMER_STRING =
       "AUTO-GENERATED DOCUMENTATION AND CLASS.";
@@ -78,4 +79,20 @@ public class CommentComposer {
           CommentStatement.withComment(
               LineComment.withComment(
                   "https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library")));
+
+  // This environment variable is mainly used to override the current year to a fixed year in tests
+  // so we don't have to update golden tests every year.
+  // This does not work for golden integration tests that are generated from Bazel rules. Because
+  // the Bazel rule java_gapic_library calls the generator through proto_custom_library which does
+  // not pass any environment variables. Golden integration tests still need to be updated every
+  // year.
+  private static final String CURRENT_YEAR_OVERRIDE = "CURRENT_YEAR_OVERRIDE";
+
+  private static String getCurrentYear() {
+    String testCurrentYear = System.getenv(CURRENT_YEAR_OVERRIDE);
+    int currentYearFromCalendar = Calendar.getInstance().get(Calendar.YEAR);
+    return Strings.isNullOrEmpty(testCurrentYear)
+        ? String.valueOf(currentYearFromCalendar)
+        : testCurrentYear;
+  }
 }

hermetic_build/library_generation/owlbot/synthtool/languages/java.py

@@ -27,26 +27,9 @@
 logger = logging.getLogger()
 logger.setLevel(logging.DEBUG)
 
-
 JAR_DOWNLOAD_URL = "https://github.com/google/google-java-format/releases/download/google-java-format-{version}/google-java-format-{version}-all-deps.jar"
 DEFAULT_FORMAT_VERSION = "1.7"
-CURRENT_YEAR = date.today().year
-GOOD_LICENSE = f"""/*
- * Copyright {CURRENT_YEAR} Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-"""
+
 PROTOBUF_HEADER = "// Generated by the protocol buffer compiler.  DO NOT EDIT!"
 BAD_LICENSE = """/\\*
  \\* Copyright \\d{4} Google LLC
@@ -71,6 +54,27 @@
 LIBRARY_VERSION_ENV_KEY = "SYNTHTOOL_LIBRARY_VERSION"
 
 
+def _get_good_license():
+    current_year = int(os.getenv("CURRENT_YEAR_OVERRIDE", date.today().year))
+    good_license = f"""/*
+ * Copyright {current_year} Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+"""
+    return good_license
+
+
 def _file_has_header(path: Path) -> bool:
     """Return true if the file already contains a license header."""
     with open(path, "rt") as fp:
@@ -100,13 +104,13 @@ def fix_proto_headers(proto_root: Path) -> None:
     s.replace(
         _filter_no_header([proto_root / "src/**/*.java"]),
         PROTOBUF_HEADER,
-        f"{GOOD_LICENSE}{PROTOBUF_HEADER}",
+        f"{_get_good_license()}{PROTOBUF_HEADER}",
     )
     # https://github.com/googleapis/gapic-generator/issues/3074
     s.replace(
         [proto_root / "src/**/*Name.java", proto_root / "src/**/*Names.java"],
         BAD_LICENSE,
-        GOOD_LICENSE,
+        _get_good_license(),
     )
 
 
@@ -118,7 +122,7 @@ def fix_grpc_headers(grpc_root: Path, package_name: str = "unused") -> None:
     s.replace(
         _filter_no_header([grpc_root / "src/**/*.java"]),
         "^package (.*);",
-        f"{GOOD_LICENSE}package \\1;",
+        f"{_get_good_license()}package \\1;",
     )
 
 

hermetic_build/library_generation/tests/owlbot/java_unit_tests.py

@@ -27,6 +27,7 @@
 TEST_OWLBOT = Path(__file__).parent.parent / "resources" / "test-owlbot"
 FIXTURES = Path(__file__).parent.parent / "resources" / "test-owlbot" / "fixtures"
 TEMPLATES_PATH = Path(__file__).parent.parent.parent / "owlbot" / "templates"
+CURRENT_YEAR_OVERRIDE = "2025"
 
 SAMPLE_METADATA = """
 <metadata>
@@ -172,6 +173,7 @@ def test_deprecate_method(self):
             )
             os.chdir(cwd)
 
+    @mock.patch.dict(os.environ, {"CURRENT_YEAR_OVERRIDE": CURRENT_YEAR_OVERRIDE})
     def test_fix_proto_license(self):
         with tempfile.TemporaryDirectory() as tempdir:
             cwd = os.getcwd()
@@ -188,6 +190,7 @@ def test_fix_proto_license(self):
             )
             os.chdir(cwd)
 
+    @mock.patch.dict(os.environ, {"CURRENT_YEAR_OVERRIDE": CURRENT_YEAR_OVERRIDE})
     def test_fix_proto_license_idempotent(self):
         with tempfile.TemporaryDirectory() as tempdir:
             cwd = os.getcwd()
@@ -206,6 +209,7 @@ def test_fix_proto_license_idempotent(self):
             )
             os.chdir(cwd)
 
+    @mock.patch.dict(os.environ, {"CURRENT_YEAR_OVERRIDE": CURRENT_YEAR_OVERRIDE})
     def test_fix_grpc_license(self):
         with tempfile.TemporaryDirectory() as tempdir:
             cwd = os.getcwd()
@@ -222,6 +226,7 @@ def test_fix_grpc_license(self):
             )
             os.chdir(cwd)
 
+    @mock.patch.dict(os.environ, {"CURRENT_YEAR_OVERRIDE": CURRENT_YEAR_OVERRIDE})
     def test_fix_grpc_license_idempotent(self):
         with tempfile.TemporaryDirectory() as tempdir:
             cwd = os.getcwd()

java-common-protos/grpc-google-common-protos/src/main/java/com/google/cloud/location/LocationsGrpc.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Google LLC
+ * Copyright 2026 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

java-common-protos/grpc-google-common-protos/src/main/java/com/google/longrunning/OperationsGrpc.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Google LLC
+ * Copyright 2026 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

java-common-protos/proto-google-common-protos/src/main/java/com/google/api/Advice.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Google LLC
+ * Copyright 2026 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

java-common-protos/proto-google-common-protos/src/main/java/com/google/api/AdviceOrBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Google LLC
+ * Copyright 2026 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.