[TRTLLM-4866] [test] Support waiving unit tests by waives.txt #8359
Conversation
Signed-off-by: Xiwen Yu <[email protected]>
📝 WalkthroughWalkthroughAdds a convert_unittest flag to test list parsing, reorganizes correction application timing, introduces a new --waives-file option and corresponding waive application during pytest collection, and updates unittest command construction to include the waives file and adjust logging. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Caller as Caller
participant Parser as parse_test_list_lines
participant Corr as parse_and_validate_test_list
Caller->>Parser: parse_test_list_lines(lines, test_prefix, convert_unittest)
alt convert_unittest == True
Parser->>Parser: Extract full_prefix
Parser->>Parser: Convert unittest identifiers to names
Parser->>Parser: Combine full_prefix + test_name
else convert_unittest == False
Parser->>Parser: Skip prefix extraction and conversion
Parser->>Parser: Use raw test_name
end
Caller->>Corr: compute corrections
Corr-->>Caller: corrections
Caller->>Corr: if option --apply-test-list-correction: apply corrections
Corr-->>Caller: corrected list (conditional)
sequenceDiagram
autonumber
participant Pytest as pytest
participant Conf as tests/unittest/conftest.py
participant Parser as test_list_parser.parse_test_list_lines
Pytest->>Conf: pytest_collection_modifyitems(config, items)
Conf->>Conf: read --waives-file
alt waives file provided
Conf->>Conf: apply_waives_ut(waives_file, items, config)
Conf->>Parser: Temporarily wrap to set convert_unittest=False
Conf->>Conf: Parse and validate waive list
Conf->>Conf: Filter to unittest-related waivers
loop Matching strategy
Conf->>Conf: Exact match
Conf->>Conf: Param-stripped match
Conf->>Conf: File-level match
end
Conf->>Pytest: Mark matching items as waived
else no waives file
Conf-->>Pytest: No waiver changes
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
tests/integration/defs/test_unittests.py (1)
142-142: Improve command logging with shlex.join for correct quotingSafer for paths with spaces.
- print(f"Running unit test:\"python {' '.join(command)}\"") + print(f'Running unit test:"python {shlex.join(command)}"')tests/integration/defs/test_list_parser.py (1)
86-86: Update docstring to document new convert_unittest parameter (and timeout in mapping)Add arg description and clarify the tuple includes timeout.
def parse_test_list_lines(test_list, lines, test_prefix, convert_unittest=True): """Parses the lines of a test list. Test names returned contain all values within square brackets. Args: test_list: Name of the test list, used for debugging lines: The lines of the test list file test_prefix: The value of the --test-prefix option, or None if this option isn't set. convert_unittest (bool): When True, convert 'unittest/...' entries to 'test_unittests.py::test_unittests_v2[unittest/...]'. When False, leave as-is. Returns: Tuple (test_names, test_name_to_marker_dict). test_names: Ordered list of test names. test_name_to_marker_dict: Dict mapping test name to (marker, reason, timeout_seconds). """tests/unittest/conftest.py (2)
28-30: Prefer sys.path.insert(0, ...) to control import precedenceSlightly safer than append to avoid being shadowed by similarly named top‑level packages.
-sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) +sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
166-182: Minor: silence linter and keep semanticsRename unused session param; waives application after prefixing nodeids matches parse logic.
-def pytest_collection_modifyitems(session, config, items): +def pytest_collection_modifyitems(_session, config, items): @@ - if waives_file: + if waives_file: apply_waives_ut(waives_file, items, config)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
tests/integration/defs/test_list_parser.py(3 hunks)tests/integration/defs/test_unittests.py(2 hunks)tests/unittest/conftest.py(4 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/unittest/conftest.pytests/integration/defs/test_list_parser.pytests/integration/defs/test_unittests.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/unittest/conftest.pytests/integration/defs/test_list_parser.pytests/integration/defs/test_unittests.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/unittest/conftest.pytests/integration/defs/test_list_parser.pytests/integration/defs/test_unittests.py
🧠 Learnings (1)
📓 Common learnings
Learnt from: tongyuantongyu
PR: NVIDIA/TensorRT-LLM#7781
File: tests/integration/test_lists/waives.txt:313-313
Timestamp: 2025-09-17T02:48:52.732Z
Learning: In TensorRT-LLM, `tests/integration/test_lists/waives.txt` is specifically for waiving/skipping tests, while other test list files like those in `test-db/` and `qa/` directories are for different test execution contexts (pre-merge, post-merge, QA tests). The same test appearing in both waives.txt and execution list files is intentional - the test is part of test suites but will be skipped due to the waiver.
🧬 Code graph analysis (1)
tests/unittest/conftest.py (2)
tests/integration/defs/test_list_parser.py (2)
parse_test_list_lines(86-177)parse_and_validate_test_list(583-615)tests/integration/defs/conftest.py (1)
pytest_collection_modifyitems(2139-2190)
🪛 Ruff (0.14.0)
tests/unittest/conftest.py
126-126: Test for membership should be not in
Convert to not in
(E713)
167-167: Unused function argument: session
(ARG001)
⏰ 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 (3)
tests/integration/defs/test_list_parser.py (2)
149-163: LGTM: Conditional unittest conversion is clean and localizedThe full: prefix handling and unittest→param nodeid mapping under the flag looks correct and backward compatible.
600-601: LGTM: Fetching --apply-test-list-correction post-computation is appropriateDefers the option use until corrections are known. No behavior regressions.
tests/unittest/conftest.py (1)
94-103: LGTM: Adds --waives-file option for unittest collectionOption shape and help are clear; short alias -S is fine.
Signed-off-by: Xiwen Yu <[email protected]>
|
/bot run |
|
PR_Github #21348 [ run ] triggered by Bot |
|
PR_Github #21348 [ run ] completed with state |
|
/bot run |
|
PR_Github #21408 [ run ] triggered by Bot |
|
PR_Github #21408 [ run ] completed with state |
|
/bot run |
|
PR_Github #21506 [ run ] triggered by Bot |
|
PR_Github #21506 [ run ] completed with state |
…#8359) Signed-off-by: Xiwen Yu <[email protected]>
…#8359) Signed-off-by: Xiwen Yu <[email protected]> Signed-off-by: yufeiwu-nv <[email protected]>
…#8359) Signed-off-by: Xiwen Yu <[email protected]>
…#8359) Signed-off-by: Xiwen Yu <[email protected]>
…#8359) Signed-off-by: Xiwen Yu <[email protected]>
…#8359) Signed-off-by: Xiwen Yu <[email protected]>
3 participants
Summary by CodeRabbit
New Features
Tests
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 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.