-
Notifications
You must be signed in to change notification settings - Fork 2k
[None][chore] Add periodic junit xml path in conftest #9337
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
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
📝 WalkthroughWalkthroughA new pytest command-line option Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tests/integration/defs/conftest.py (1)
2331-2363: Remove duplicate PeriodicJUnitXML initialization code.This code block duplicates the reporter initialization logic from
pytest_configure(lines 2236-2281) but:
- It doesn't respect the new
--periodic-junit-xmlpathoption (hardcodes the default path at line 2340)- It's incorrectly placed inside
deselect_by_test_model_suites, which should only filter tests- It will re-register the reporter if this function is called, potentially causing conflicts
The reporter should only be initialized once in
pytest_configure.Apply this diff to remove the duplicate code:
if deselected: config.hook.pytest_deselected(items=deselected) items[:] = selected - - # Initialize PeriodicJUnitXML reporter if enabled - periodic = config.getoption("--periodic-junit", default=False) - output_dir = config.getoption("--output-dir", default=None) - - if periodic and output_dir: - periodic_interval = config.getoption("--periodic-interval") - periodic_batch_size = config.getoption("--periodic-batch-size") - - # Create the reporter with logger - xmlpath = os.path.join(output_dir, "results.xml") - reporter = PeriodicJUnitXML( - xmlpath=xmlpath, - interval=periodic_interval, - batch_size=periodic_batch_size, - logger={ - 'info': print_info, - 'warning': print_warning - }, - ) - - # Configure and register the reporter - reporter.pytest_configure(config) - config.pluginmanager.register(reporter, 'periodic_junit') - - print_info("PeriodicJUnitXML reporter registered") - print_info( - f" Interval: {periodic_interval}s ({periodic_interval/60:.1f} min)" - ) - print_info(f" Batch size: {periodic_batch_size} tests") - elif periodic and not output_dir: - print_warning( - "Warning: --periodic-junit requires --output-dir to be set. " - "Periodic reporting disabled.") def deselect_by_test_model_suites(test_model_suites, items, test_prefix,
🧹 Nitpick comments (1)
tests/integration/defs/conftest.py (1)
2245-2246: Consider validating and normalizing the XML path.The current implementation correctly reads and uses the
--periodic-junit-xmlpathoption, but there are edge cases to consider:
- If a relative path is provided, it's interpreted relative to the current working directory, not
output_dir. This might be unexpected.- If an absolute path is provided pointing to a non-existent directory, the parent directory isn't created (unlike
output_dirat line 2253).Consider applying this enhancement to normalize the path and ensure its parent directory exists:
periodic_junit_xmlpath = config.getoption("--periodic-junit-xmlpath", default=None) if periodic and output_dir: periodic_interval = config.getoption("--periodic-interval") periodic_batch_size = config.getoption("--periodic-batch-size") # Create output directory early (like --junitxml does) to avoid conflicts with other plugins # that may need to write to the same directory (e.g., pytest-split) os.makedirs(output_dir, exist_ok=True) # Create the reporter with logger - xmlpath = periodic_junit_xmlpath or os.path.join( - output_dir, "results.xml") + if periodic_junit_xmlpath: + # If relative path, make it relative to output_dir for consistency + xmlpath = periodic_junit_xmlpath if os.path.isabs(periodic_junit_xmlpath) else os.path.join(output_dir, periodic_junit_xmlpath) + # Ensure parent directory exists + os.makedirs(os.path.dirname(xmlpath), exist_ok=True) + else: + xmlpath = os.path.join(output_dir, "results.xml")Also applies to: 2256-2257
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tests/integration/defs/conftest.py(3 hunks)
🔇 Additional comments (1)
tests/integration/defs/conftest.py (1)
2134-2140: LGTM!The new command-line option is well-defined with appropriate defaults and clear help text.
|
/bot run --skip-test |
|
PR_Github #25274 [ run ] triggered by Bot. Commit: |
|
PR_Github #25274 [ run ] completed with state |
|
/bot reuse-pipeline |
|
PR_Github #25312 [ reuse-pipeline ] triggered by Bot. Commit: |
|
PR_Github #25312 [ reuse-pipeline ] completed with state |
Summary by CodeRabbit
Release Notes
--periodic-junit-xmlpathpytest option to customize the output location for periodic JUnit XML reports. When specified, the reporter uses the provided path; otherwise, it defaults to the standard location.✏️ Tip: You can customize this high-level summary in your review settings.
Description
Test Coverage
PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
Update tava architecture diagram if there is a significant design change in PR.
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
Details
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.