-
Notifications
You must be signed in to change notification settings - Fork 202
Bazel output results as junit.xml #507
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
base: main
Are you sure you want to change the base?
Bazel output results as junit.xml #507
Conversation
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.
Summary of Changes
Hello @vinnybod, 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 Bazel integration for container-structure-test
by enabling the output of test results in junit.xml
format. The primary motivation is to improve compatibility with CI systems by allowing the JUnit test suite name to be dynamically set based on the Bazel test target, rather than a generic default. This involved modifications to the Bazel rule definition, the Go application's command-line interface to accept a new suite name parameter, and updates to the internal Go logic for processing and outputting JUnit XML. Additionally, the PR includes an update to the Bazel test version and improved documentation for local development and testing.
Highlights
- Bazel Rule for JUnit XML Output: The Bazel rule for
container_structure_test
now includes arguments to generate test results injunit.xml
format, dynamically setting the suite name based on the Bazel test target. - Configurable JUnit Suite Name: The core Go application now supports a new command-line flag
--junit-suite-name
for thetest
command, allowing users to explicitly define the JUnit test suite name. - Go Application Logic Updates: Internal Go functions responsible for processing and outputting test results have been updated to accept and utilize the specified JUnit suite name, ensuring it's correctly reflected in the generated XML.
- Improved Local Testing Documentation: Documentation has been added to
bazel/test/README.md
providing clear instructions on how to test local changes to thecontainer-structure-test
binary within the Bazel testing environment. - Bazel Version Update: The Bazel version used for testing has been updated from 6.1.1 to 7.6.0.
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.
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 successfully adds support for generating junit.xml
output from Bazel tests. The changes include passing necessary flags from the Bazel rule, adding a new command-line flag --junit-suite-name
to the Go application to customize the test suite name, and plumbing this new option through to the output generation logic. The implementation looks solid. I've added a few comments regarding documentation portability, a minor formatting issue, and an opportunity to improve test coverage for the new functionality.
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.
Neat!
We'll have to do a two step release dance here, since we didn't hook up a way for the Go binaries to be built as part of the release
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@vinnybod do you need help getting the tests green on this one? |
Most test rules in Bazel output the results in a
junit.xml
format. The only change needed for this is:But this uses the same test suite name for every test, which doesn't look great in most CI systems that parse junit.xml files. So it also passes the test target as the suite name, which also required me to modify the go code to accept a suite name.