Enforce @Validation.Required annotation on PipelineOptions

[Simarjeet112]

What changed

This PR enforces fail-fast validation for PipelineOptions getters annotated
with @Validation.Required.

Details

• Throw IllegalStateException when a required option is accessed without being set
• Add helper method to detect @Validation.Required annotation
• Add test covering required option validation
• Update existing tests affected by stricter validation

Testing

• ./gradlew :sdks:java:core:test --tests "*PipelineOptionsTest"

[gemini-code-assist]

Summary of Changes

Hello @Simarjeet112, I'm Gemini Code Assist¹! 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 Apache Beam's PipelineOptions by introducing a fail-fast validation mechanism. It ensures that any PipelineOptions getter method explicitly marked with @Validation.Required will throw an IllegalStateException if its corresponding option has not been provided, thereby preventing pipelines from proceeding with incomplete or critical configurations. This change improves the predictability and reliability of pipeline execution by catching configuration errors early.

Highlights

• Fail-Fast Validation for PipelineOptions: Introduced fail-fast validation for PipelineOptions methods annotated with @Validation.Required, ensuring that critical options are set before use.
• IllegalStateException for Unset Required Options: Implemented logic in ProxyInvocationHandler to throw an IllegalStateException if a required, non-primitive option is accessed without being explicitly set.
• Annotation Detection Helper: Added a new private helper method isRequired to programmatically detect the presence of the @Validation.Required annotation on a method.
• New Unit Test for Validation: Included a dedicated unit test (testRequiredOptionWithoutDefaultThrows) to verify the correct behavior of the new required option validation mechanism.
• Test Case Adjustments: Adjusted existing test cases in PipelineOptionsTest and PortablePipelineOptionsTest to align with the new stricter validation rules.

🧠 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.

Changelog

• sdks/java/core/src/main/java/org/apache/beam/sdk/options/ProxyInvocationHandler.java
  • Added logic within the getDefault method to check if a method is marked as @Validation.Required and if its return type is not primitive. If both conditions are true and the option is not set, an IllegalStateException is thrown.
  • Introduced a new private static helper method isRequired(Method method) to determine if a method is annotated with org.apache.beam.sdk.options.Validation$Required.
  • Added a new private static helper method isNullable(Method method) to check for the Nullable annotation.
• sdks/java/core/src/test/java/org/apache/beam/sdk/options/PipelineOptionsTest.java
  • Added a new test method testRequiredOptionWithoutDefaultThrows to assert that an IllegalStateException is thrown when a required option without a default value is accessed.
  • Defined a new nested interface RequiredStringOption to demonstrate the @Validation.Required annotation.
  • Minor formatting adjustments and a comment update from 'Test interface.' to 'Base test interface.'.
• sdks/java/core/src/test/java/org/apache/beam/sdk/options/PortablePipelineOptionsTest.java
  • Commented out an assertion for options.getJobEndpoint() in testDefaults() to adapt to potential changes in default behavior or validation introduced by this PR.

Activity

• No specific activity (comments, reviews, or progress updates) was provided in the context for this pull request.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers