[https://nvbugs/5538098][fix] Checking connection to etcd server in unit test #8006
Conversation
📝 WalkthroughWalkthroughReplaces a fixed sleep-based etcd startup wait with a port readiness check. Introduces wait_for_port(host, port, timeout) using socket polling, integrates it into setUp prior to client creation, removes time.sleep(5), and adds the necessary socket import in the test module. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Tester
participant TestCase
participant EtcdProc as etcd Process
participant Port as Port (host:port)
participant Client as etcd Client
Note over TestCase: New flow
Tester->>TestCase: setUp()
TestCase->>EtcdProc: start_etcd_server()
EtcdProc-->>TestCase: process started
TestCase->>Port: wait_for_port(host, port, timeout)
alt Port opens before timeout
Port-->>TestCase: ready
TestCase->>Client: create client()
Client-->>TestCase: connected
else Timeout
Port-->>TestCase: not ready
TestCase-->>Tester: RuntimeError
end
sequenceDiagram
autonumber
actor Tester
participant TestCase
participant EtcdProc as etcd Process
participant Sleep as Fixed Delay
participant Client as etcd Client
Note over TestCase: Previous flow
Tester->>TestCase: setUp()
TestCase->>EtcdProc: start_etcd_server()
EtcdProc-->>TestCase: process started
TestCase->>Sleep: time.sleep(5)
Sleep-->>TestCase: delay done
TestCase->>Client: create client()
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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: 1
🧹 Nitpick comments (4)
tests/unittest/disaggregated/test_remoteDictionary.py (4)
13-21: Make the wait helper more specific and linter-friendly (TimeoutError, narrower except).
Good replacement for fixed sleep with a readiness probe. Prefer raising TimeoutError and catching more specific exceptions; also shortens the failure message as suggested by lint (TRY003).Apply this diff:
- while time.time() - start < timeout: + while time.time() - start < timeout: try: with socket.create_connection((host, port), timeout=1): return True - except OSError: + except (ConnectionRefusedError, socket.timeout): time.sleep(0.5) - raise RuntimeError(f"Timeout waiting for {host}:{port}") + raise TimeoutError(f"Timed out waiting for {host}:{port}")Optionally add a short Google-style docstring and type hints for clarity. Based on coding guidelines and static analysis hints.
10-10: Maintain module namespace for imports.
Prefer importing the module and referencing the class via the module to keep the namespace clear.Apply this diff:
-from tensorrt_llm.serve.metadata_server import EtcdDictionary +from tensorrt_llm.serve import metadata_server @@ - self.etcd_dict = EtcdDictionary(host=self.host, port=self.port) + self.etcd_dict = metadata_server.EtcdDictionary(host=self.host, port=self.port)As per coding guidelines.
Also applies to: 65-65
29-33: Avoid PIPEs you don't read to prevent child blocking.
Using PIPE for stdout/stderr without consuming can deadlock if buffers fill. Route to DEVNULL for tests.Apply this diff:
- stdout=subprocess.PIPE, - stderr=subprocess.PIPE, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL,
48-55: Use addCleanup for robust resource/env restoration even on setUp failures.
Ensure etcd is stopped and env var restored if setUp fails midway.Apply this diff:
def setUp(self): - # Set the protocol buffers implementation to python - os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] = "python" + # Set the protocol buffers implementation to python + prev_pb_impl = os.environ.get("PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION") + os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] = "python" + def _restore_pb_impl(): + if prev_pb_impl is None: + os.environ.pop("PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION", None) + else: + os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] = prev_pb_impl + self.addCleanup(_restore_pb_impl) @@ - # Start etcd server - self.etcd_process = start_etcd_server() + # Start etcd server + self.etcd_process = start_etcd_server() + self.addCleanup(stop_etcd_server, self.etcd_process) @@ def tearDown(self): # Clean up test keys after each test self._cleanup_test_keys() - - # Stop etcd server - stop_etcd_server(self.etcd_process) - - # Unset the protocol buffers implementation - del os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] + # Process and env cleanup handled by addCleanup() in setUp()This improves resilience for failures in setUp.
Also applies to: 70-79
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tests/unittest/disaggregated/test_remoteDictionary.py(3 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/disaggregated/test_remoteDictionary.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/disaggregated/test_remoteDictionary.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/disaggregated/test_remoteDictionary.py
🪛 Ruff (0.13.1)
tests/unittest/disaggregated/test_remoteDictionary.py
21-21: Avoid specifying long messages outside the exception class
(TRY003)
⏰ 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/unittest/disaggregated/test_remoteDictionary.py (2)
3-3: LGTM: Necessary import for socket polling.
The added socket import is required for the new readiness check.
59-60: LGTM: Readiness wait before client creation.
This should reduce flakes from early client initialization.Please confirm this eliminates the prior flakiness in CI across all runners (IPv4/IPv6 environments).
|
/bot run --disable-fail-fast |
|
PR_Github #19995 [ run ] triggered by Bot |
|
PR_Github #19995 [ run ] completed with state |
Signed-off-by: Patrice Castonguay <[email protected]>
pcastonguay
force-pushed
the
etcd_dict_test_fix
branch
from
ea146cd to
5c8f935
Compare
|
/bot run --disable-fail-fast |
|
PR_Github #20094 [ run ] triggered by Bot |
|
PR_Github #20094 [ run ] completed with state |
|
/bot run --disable-fail-fast |
|
PR_Github #20265 [ run ] triggered by Bot |
|
PR_Github #20265 [ run ] completed with state |
…nit test (NVIDIA#8006) Signed-off-by: Patrice Castonguay <[email protected]> Signed-off-by: Faradawn Yang <[email protected]>
…nit test (NVIDIA#8006) Signed-off-by: Patrice Castonguay <[email protected]>
3 participants
Summary by CodeRabbit
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.