Skip to content

Conversation

LinPoly
Copy link
Collaborator

@LinPoly LinPoly commented Aug 4, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling in the example script by providing clearer messages when JSON parsing fails and ensuring required keys are present in the response.
  • Tests
    • Enhanced test coverage by adding validation of server responses for curl-based client scripts, ensuring correct HTTP responses.
    • Introduced a temporary configuration file in tests to support additional backend settings during test execution.

Description

Test Coverage

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.

@LinPoly LinPoly requested a review from nv-guomingz August 4, 2025 12:51
@LinPoly LinPoly changed the title [None][fix] Enhance trtllm-serve example test [None][chore] Enhance trtllm-serve example test Aug 4, 2025
Copy link
Contributor

coderabbitai bot commented Aug 4, 2025

📝 Walkthrough

Walkthrough

The changes update an example script to improve JSON handling and clarify configuration requirements, and enhance a related test by introducing a temporary YAML config file, updating server fixture logic, and strengthening response validation for curl-based client scripts.

Changes

Cohort / File(s) Change Summary
Example Script Improvements
examples/serve/openai_completion_client_json_schema.py
Added comment about required external config (guided_decoding_backend). Imported json for parsing. Removed max_tokens from request. Added JSON parsing and key assertions for response, with error handling for failed parsing.
Test Enhancements and Fixture Updates
tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
Imported json, tempfile, yaml. Added temp_extra_llm_api_options_file fixture to create a temporary YAML config. Modified server fixture to use this config. Updated test to parse and validate JSON responses from curl-based scripts, asserting HTTP success.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested labels

Documentation

Suggested reviewers

  • Superjomn
  • litaotju
  • hchings
  • QiJune

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1dcb914 and 0472f56.

📒 Files selected for processing (2)
  • examples/serve/openai_completion_client_json_schema.py (2 hunks)
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • examples/serve/openai_completion_client_json_schema.py
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
⏰ 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
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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: 1

🧹 Nitpick comments (1)
examples/serve/openai_completion_client_json_schema.py (1)

46-52: Enhance error handling for JSON parsing.

The JSON parsing and validation logic is a good improvement, but the error handling could be more informative for debugging purposes.

Consider this enhancement to provide more detailed error information:

 content = response.choices[0].message.content
 try:
     response_json = json.loads(content)
     assert "name" in response_json and "population" in response_json
     print(content)
-except json.JSONDecodeError:
-    print("Failed to decode JSON response")
+except json.JSONDecodeError as e:
+    print(f"Failed to decode JSON response: {e}")
+    print(f"Raw content: {content}")
+except AssertionError:
+    print(f"JSON response missing required keys. Got: {list(response_json.keys())}")
+    print(f"Raw content: {content}")
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 13cc1c4 and 26f88f4.

📒 Files selected for processing (2)
  • examples/serve/openai_completion_client_json_schema.py (2 hunks)
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

**/*.py: The code developed for TensorRT-LLM should conform to Python 3.8+.
Indent Python code with 4 spaces. Do not use tabs.
Always maintain the namespace when importing in Python, even if only one class or function from a module is used.
Python filenames should use snake_case (e.g., some_file.py).
Python classes should use PascalCase (e.g., class SomeClass).
Python functions and methods should use snake_case (e.g., def my_awesome_function():).
Python local variables should use snake_case. Prefix k for variable names that start with a number (e.g., k_99th_percentile = ...).
Python global variables should use upper snake_case and prefix G (e.g., G_MY_GLOBAL = ...).
Python constants should use upper snake_case (e.g., MY_CONSTANT = ...).
Avoid shadowing variables declared in an outer scope in Python.
Initialize all externally visible members of a Python class in the constructor.
For interfaces that may be used outside a file, prefer docstrings over comments in Python.
Comments in Python should be reserved for code within a function, or interfaces that are local to a file.
Use Google style docstrings for classes and functions in Python, which can be parsed by Sphinx.
Attributes and variables in Python can be documented inline; attribute docstrings will be rendered under the docstring for the class.
Avoid using reflection in Python when functionality can be easily achieved without it.
When using try-except blocks in Python, limit the except to the smallest set of errors possible.
When using try-except blocks to handle multiple possible variable types in Python, keep the body of the try as small as possible, using the else block to implement the logic.

Files:

  • examples/serve/openai_completion_client_json_schema.py
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
**/*.{cpp,h,hpp,cc,cxx,cu,py}

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

All TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the current year. This includes .cpp, .h, .cu, .py, and any other source files which are compiled or interpreted.

Files:

  • examples/serve/openai_completion_client_json_schema.py
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
🔇 Additional comments (4)
examples/serve/openai_completion_client_json_schema.py (1)

3-5: Good documentation and necessary import addition.

The comment clearly explains the configuration requirement for guided_decoding_backend, and the json import is correctly added to support the new JSON parsing functionality.

tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (3)

1-1: LGTM! Necessary imports added.

The new imports (json, tempfile, yaml) are all required for the enhanced functionality and follow the namespace maintenance guideline.

Also applies to: 5-5, 8-8


22-34: Well-implemented temporary file fixture with proper cleanup.

The fixture correctly creates a temporary YAML config file, ensures proper cleanup with try-finally, and follows pytest fixture best practices.


37-37: Proper dependency injection for server configuration.

The server fixture correctly depends on the temporary config file fixture and passes it as an argument to RemoteOpenAIServer.

Also applies to: 40-41

@LinPoly LinPoly force-pushed the pengyunl/serve_test branch from 26f88f4 to 1dcb914 Compare August 5, 2025 08:02
@LinPoly
Copy link
Collaborator Author

LinPoly commented Aug 5, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14115 [ run ] triggered by Bot

Copy link
Collaborator

@nv-guomingz nv-guomingz left a comment

Choose a reason for hiding this comment

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

LGTM

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14115 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #10649 completed with status: 'FAILURE'

@LinPoly LinPoly force-pushed the pengyunl/serve_test branch from 1dcb914 to 0472f56 Compare August 5, 2025 15:04
@LinPoly
Copy link
Collaborator Author

LinPoly commented Aug 5, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14162 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14162 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #10688 completed with status: 'FAILURE'

@LinPoly
Copy link
Collaborator Author

LinPoly commented Aug 6, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14256 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14256 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #10763 completed with status: 'SUCCESS'

@LinPoly LinPoly merged commit 79fc2f4 into NVIDIA:main Aug 6, 2025
4 checks passed
jain-ria pushed a commit to jain-ria/TensorRT-LLM that referenced this pull request Aug 7, 2025
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.

3 participants