create_jvm_test_suite: allow multiple suites to use same test source #367
Conversation
Currently `test_name` per test source doesn't include `create_jvm_test_suite.name`, so multiple suites in same package would conflict if they share test sources. Multiple suites per test source could be useful to test multiple configurations: different env var, deps, or other parameters.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @dmivankov, 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 addresses a limitation in the create_jvm_test_suite rule that prevented multiple test suites from utilizing the same test source files due to naming collisions. By modifying how individual test names are generated, the change allows for greater flexibility in setting up test configurations, such as testing with different environments or dependencies, without requiring duplicate test source code.
Highlights
- Test Naming Conflict Resolution: The generation of test_name within create_jvm_test_suite now incorporates the suite's name parameter. This change ensures that multiple JVM test suites can safely share the same test sources without encountering naming conflicts, enabling diverse testing configurations.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request aims to prevent test name conflicts when multiple test suites use the same source files by prefixing the test name with the suite name. The change is correct in its intent, but it overlooks a potential issue where source file paths with subdirectories can lead to invalid Bazel target names. I've added a comment with a suggestion to make the implementation more robust by sanitizing the source file path.
| for src in test_srcs: | ||
| suffix = src.rfind(".") | ||
| test_name = src[:suffix] | ||
| test_name = "%s-%s" % (name, src[:suffix]) |
There was a problem hiding this comment.
The src variable can contain path separators (e.g., com/foo/MyTest.java) if the test sources are organized in subdirectories. The current construction of test_name does not account for this, which will result in an invalid target name like my_suite-com/foo/MyTest because target names cannot contain /.
To fix this, you should replace path separators with a valid character like -. This will ensure that generated test names are always valid Bazel target names.
| test_name = "%s-%s" % (name, src[:suffix]) | |
| test_name = "%s-%s" % (name, src[:suffix].replace("/", "-")) |
There was a problem hiding this comment.
That aspect doesn't change in this PR, will leave it to maintainers to decide what to do
|
One reason for not changing the name of the test is to ensure that running the tests in an IDE works as expected. Perhaps an alternative would be to allow some modifier to the test name to be passed in as an additional attribute |
|
Something like |
|
opened #368 |
2 participants
Currently
test_nameper test source doesn't includecreate_jvm_test_suite.name, so multiple suites in same package would conflict if they share test sources.Multiple suites per test source could be useful to test multiple configurations: different env var, deps, or other parameters.