KEMBAR78
[TRTLLM-8580][test] save runtime report periodically by crazydemo · Pull Request #8312 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@crazydemo
Copy link
Collaborator

@crazydemo crazydemo commented Oct 13, 2025

This feature now is only enabled in tests/integration/defs/conftest.py, should not affect L0 test currently.
verified locally, no obvious time overhead is detected.
only one results.xml will be generated.

Summary by CodeRabbit

  • New Features

    • Optional periodic JUnit XML reporting during test runs.
    • New pytest options:
      • --periodic-junit (enable/disable)
      • --periodic-interval (seconds between saves)
      • --periodic-batch-size (tests per save)
    • Incremental, atomic XML writes and graceful flush on interruption.
  • Tests

    • Test configuration updated to support the periodic JUnit reporter.
    • Automatically logs configured interval and batch size when enabled.
    • Emits a warning and disables the feature if enabled without an output directory.

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

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

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 the stage-list parameter 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.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip 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-pipeline

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

@crazydemo crazydemo force-pushed the save_runtime_report branch from 4f11560 to ab09462 Compare October 13, 2025 08:21
@crazydemo crazydemo requested a review from yiqingy0 October 14, 2025 05:46
@crazydemo crazydemo assigned EmmaQiaoCh and unassigned EmmaQiaoCh Oct 14, 2025
@crazydemo crazydemo force-pushed the save_runtime_report branch 2 times, most recently from 105828b to e18c944 Compare October 15, 2025 04:17
@crazydemo crazydemo marked this pull request as ready for review October 16, 2025 02:56
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
@crazydemo crazydemo force-pushed the save_runtime_report branch from 248fdf7 to 1e8f723 Compare October 16, 2025 02:56
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 16, 2025

📝 Walkthrough

Walkthrough

Introduces a new pytest reporter (PeriodicJUnitXML) that batches test reports and periodically writes JUnit XML. Integrates via conftest with new CLI options to enable and configure interval and batch size. Exposes the reporter through the utils package’s public API and wires optional signal-based flushing.

Changes

Cohort / File(s) Summary
Pytest config integration
tests/integration/defs/conftest.py
Adds CLI options: --periodic-junit, --periodic-interval, --periodic-batch-size. When enabled with an output directory, constructs and registers PeriodicJUnitXML; logs configuration; warns and disables if no output dir.
Utils package exports
tests/integration/defs/utils/__init__.py
Imports and re-exports PeriodicJUnitXML; updates __all__ ordering alongside existing timeout utilities.
Periodic JUnit reporter implementation
tests/integration/defs/utils/periodic_junit.py
Adds PeriodicJUnitXML class implementing batching, periodic writes, atomic XML generation via pytest’s LogXML, signal handlers (SIGINT/SIGTERM), lazy init, and pytest hooks: pytest_configure, pytest_runtest_logreport, pytest_sessionfinish.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Pytest as Pytest Runner
  participant Conftest as conftest.py
  participant Reporter as PeriodicJUnitXML
  participant LogXML as pytest LogXML
  participant FS as Filesystem
  participant OS as OS Signals

  Pytest->>Conftest: Parse CLI options
  Conftest->>Reporter: Instantiate if --periodic-junit enabled
  Pytest->>Reporter: pytest_configure(config)
  Reporter->>Reporter: Register signal handlers
  Note over Reporter: Lazy init of LogXML on first use

  loop For each test phase
    Pytest->>Reporter: pytest_runtest_logreport(report)
    Reporter->>Reporter: Buffer report<br/>Process when batch size met
    alt Batch ready or interval elapsed
      Reporter->>LogXML: Append processed reports
      LogXML->>FS: Write XML to temp
      FS-->>LogXML: Temp written
      LogXML->>FS: Atomic rename to target
    end
  end

  OS-->>Reporter: SIGINT/SIGTERM
  Reporter->>Reporter: Flush pending reports
  Reporter->>LogXML: Generate XML
  LogXML->>FS: Atomic write

  Pytest->>Reporter: pytest_sessionfinish()
  Reporter->>Reporter: Final flush
  Reporter->>LogXML: Final XML generation
  LogXML->>FS: Atomic write
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The provided PR description is entirely the default template and contains no actual title, summary of changes, test coverage details, or completed checklist items. The Description and Test Coverage sections remain blank, and placeholders such as @coderabbitai summary have not been replaced with real content. This fails to meet the repository’s PR description template requirements. Please replace the placeholder title with a properly formatted title following the specified template, fill in the Description section with a clear summary of the issue and solution, and list the relevant tests under Test Coverage. Also complete the PR checklist items and remove any leftover template comments or placeholders to ensure the description is fully informative. Make sure that each section of the template is populated before requesting review.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "[TRTLLM-8580][test] save runtime report periodically" follows the required template format with a valid JIRA ticket identifier, a type label, and a clear summary. The title directly corresponds to the main change in the changeset, which adds a new PeriodicJUnitXML reporter that periodically saves test results to an XML file. The phrasing is concise and specific enough that a teammate reviewing the history would understand the primary change without needing to examine the detailed changeset.
Docstring Coverage ✅ Passed Docstring coverage is 85.71% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (2)
tests/integration/defs/utils/periodic_junit.py (2)

181-191: Narrow exception handling and include error details

Catching bare Exception multiple times hides specific failures. Prefer narrower exceptions (e.g., OSError for I/O) and include more context (e.g., traceback).

  • Replace broad catches where feasible (I/O paths) with OSError.
  • When keeping broad catches for resilience, log with traceback to aid debugging.

Example adjustment:

import traceback
...
except OSError as e:
    self._log_warning(f"Filesystem error during report generation: {e}")
except Exception:
    self._log_warning(f"Unexpected error:\n{traceback.format_exc()}")

As per coding guidelines and static analysis hints

Also applies to: 283-291, 322-325


296-334: Minor: mark unused signal handler frame parameter

To silence linters and clarify intent, prefix the unused argument with underscore.

-        def signal_handler(signum, frame):
+        def signal_handler(signum, _frame):
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4143887 and 1e8f723.

📒 Files selected for processing (3)
  • tests/integration/defs/conftest.py (3 hunks)
  • tests/integration/defs/utils/__init__.py (1 hunks)
  • tests/integration/defs/utils/periodic_junit.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Use only spaces, no tabs; indent with 4 spaces.

Files:

  • tests/integration/defs/utils/__init__.py
  • tests/integration/defs/conftest.py
  • tests/integration/defs/utils/periodic_junit.py
**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.

Files:

  • tests/integration/defs/utils/__init__.py
  • tests/integration/defs/conftest.py
  • tests/integration/defs/utils/periodic_junit.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).

Files:

  • tests/integration/defs/utils/__init__.py
  • tests/integration/defs/conftest.py
  • tests/integration/defs/utils/periodic_junit.py
🧬 Code graph analysis (3)
tests/integration/defs/utils/__init__.py (1)
tests/integration/defs/utils/periodic_junit.py (1)
  • PeriodicJUnitXML (41-341)
tests/integration/defs/conftest.py (2)
tests/integration/defs/utils/periodic_junit.py (2)
  • PeriodicJUnitXML (41-341)
  • pytest_configure (120-137)
tests/integration/defs/trt_test_alternative.py (2)
  • print_info (300-306)
  • print_warning (309-315)
tests/integration/defs/utils/periodic_junit.py (1)
tests/integration/defs/conftest.py (1)
  • pytest_configure (2221-2261)
🪛 Ruff (0.14.0)
tests/integration/defs/conftest.py

2253-2253: f-string without any placeholders

Remove extraneous f prefix

(F541)

tests/integration/defs/utils/periodic_junit.py

182-182: Do not catch blind exception: Exception

(BLE001)


190-190: Do not catch blind exception: Exception

(BLE001)


289-290: try-except-pass detected, consider logging the exception

(S110)


289-289: Do not catch blind exception: Exception

(BLE001)


296-296: Unused function argument: frame

(ARG001)


322-322: Do not catch blind exception: Exception

(BLE001)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Pre-commit Check
🔇 Additional comments (2)
tests/integration/defs/utils/__init__.py (1)

22-22: Public API exposure looks good

Import and all entry for PeriodicJUnitXML are consistent and ready for use.

Also applies to: 27-30

tests/integration/defs/conftest.py (1)

2099-2125: CLI options are well-scoped and typed

Options names, help, and typing look correct and align with the reporter’s API.

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
@crazydemo
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21526 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21526 [ run ] completed with state ABORTED
LLM/main/L0_MergeRequest_PR #16253 (Blue Ocean) completed with status: ABORTED

@crazydemo
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21551 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21551 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #16269 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.

@crazydemo crazydemo merged commit 70a0f5b into NVIDIA:main Oct 17, 2025
5 checks passed
crazydemo added a commit to crazydemo/TensorRT-LLM that referenced this pull request Oct 17, 2025
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
crazydemo added a commit to crazydemo/TensorRT-LLM that referenced this pull request Oct 17, 2025
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
LarryXFly pushed a commit that referenced this pull request Oct 20, 2025
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 20, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 20, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 20, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 20, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 21, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 21, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
govind-ramnarayan pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Oct 21, 2025
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 22, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 23, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Oct 24, 2025
…VIDIA#8455)

Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>
yufeiwu-nv pushed a commit to yufeiwu-nv/TensorRT-LLM that referenced this pull request Oct 24, 2025
Signed-off-by: Ivy Zhang <25222398+crazydemo@users.noreply.github.com>
Signed-off-by: yufeiwu-nv <230315618+yufeiwu-nv@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants