-
Notifications
You must be signed in to change notification settings - Fork 69
tests: Use fixed copyright year in tests. #4036
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @blakeli0, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the robustness of the test suite by introducing a configurable copyright year for generated code. By allowing the copyright year to be set via an environment variable, particularly for tests, it ensures that test outcomes remain consistent and independent of the actual calendar year, thereby preventing potential test failures caused by year transitions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a mechanism to use a fixed copyright year for tests by using an environment variable. The changes in pom.xml set this environment variable for the test execution, and CommentComposer.java is updated to read this variable. This is a good approach for making tests deterministic.
I've added one comment with a suggestion to refactor the new getCurrentYear method to improve maintainability by extracting the magic string into a constant and to use the modern java.time API instead of Calendar.
...ator-java/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java
Outdated
Show resolved
Hide resolved
This reverts commit 31c4de6.
...ator-java/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java
Outdated
Show resolved
Hide resolved
gapic-generator-java/pom.xml
Outdated
| </additionalClasspathElement> | ||
| </additionalClasspathElements> | ||
| <environmentVariables> | ||
| <TEST_CURRENT_YEAR>2025</TEST_CURRENT_YEAR> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
qq, would this override the value of an env var I set locally on my computer? Do you know which one has precendence?
If this takes precedence, maybe we can set this as a maven property so that we can configure this (if we need to ever test locally) with something like -DoverrideYear=YEAR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion! I made it a Maven property since it's generally a better practice. I tested that this override does take precedence.
.cloudbuild/library_generation/cloudbuild-library-generation-integration-test.yaml
Outdated
Show resolved
Hide resolved
zhumin8
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LTGM. I'd be great if you could add a bit of documentation:
- Document this new env variable perhaps in https://github.com/googleapis/sdk-platform-java/blob/main/hermetic_build/README.md
- Make a note that env var does not apply to "Java generator golden integration tests" as you explained in the description, so this nuance is not lost.
I added more comments to CommentComposer, including nuances of the golden integration tests as well. |
|
|





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_YEARso that we can override it in tests. See below for the exact fix for each scenario:java_gapic_librarycalls the generator throughproto_custom_librarywhich does not pass any environment variables.Separately, updated zlib version in Bazel build because there is a known incompatibility between old zlib library and the latest macOS version.
fixes: #3547