-
Notifications
You must be signed in to change notification settings - Fork 423
Add a docker compose yaml for running integration tests #946
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
Add a docker compose yaml for running integration tests #946
Conversation
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
…to david-tests-docker-compose Signed-off-by: David Gardner <[email protected]>
…testing Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
WalkthroughAdds explicit image names and Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Tester
participant TestRunner
participant Env as "Env Vars"
participant MySQLClient as "aiomysql.connect"
participant MySQL as "MySQL Service"
Tester->>TestRunner: start NAT MySQL tests
TestRunner->>Env: read ROOT_PASSWORD
alt env provided
Env-->>TestRunner: return provided password
else env missing
note right of TestRunner#ffeadb: fallback to "my_password"
TestRunner-->>TestRunner: use "my_password"
end
TestRunner->>MySQLClient: connect(host, user=root, password)
MySQLClient->>MySQL: authenticate
MySQL-->>MySQLClient: OK / ERR
MySQLClient-->>TestRunner: connection result
TestRunner-->>Tester: test outcomes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested labels
Pre-merge checks and finishing touches✅ Passed checks (3 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: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/nvidia_nat_mysql/tests/test_mysql_object_store.py (1)
64-64: Fix inconsistent MySQL password default.Line 64 still uses the old default password
'my-secret-pw', while lines 28 and 39 have been updated to'my_password'. This inconsistency will cause test failures when the environment variableMYSQL_ROOT_PASSWORDis not set, as the docker-compose file usesmy_passwordas the default.Apply this diff to fix the inconsistency:
- password=os.environ.get('MYSQL_ROOT_PASSWORD', 'my-secret-pw'))) + password=os.environ.get('MYSQL_ROOT_PASSWORD', 'my_password')))
🧹 Nitpick comments (1)
tests/test_data/docker-compose.services.yml (1)
90-94: Add healthcheck for Redis service.The Redis service lacks a healthcheck, which can lead to race conditions when tests attempt to connect before Redis is fully ready. Other services in this compose file include healthchecks for reliability.
Add a healthcheck to ensure Redis is ready:
redis: image: redis:8.0 container_name: test-redis ports: - 6379:6379 + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 10s + timeout: 5s + retries: 5
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.gitlab-ci.yml(1 hunks)packages/nvidia_nat_mysql/tests/test_mysql_object_store.py(2 hunks)tests/test_data/docker-compose.services.yml(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)
In workflow/config YAML, set llms.._type: nat_test_llm to stub responses.
Files:
tests/test_data/docker-compose.services.yml
**/*.{py,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)
**/*.{py,yaml,yml}: Configure response_seq as a list of strings; values cycle per call, and [] yields an empty string.
Configure delay_ms to inject per-call artificial latency in milliseconds for nat_test_llm.
Files:
tests/test_data/docker-compose.services.ymlpackages/nvidia_nat_mysql/tests/test_mysql_object_store.py
**/*
⚙️ CodeRabbit configuration file
**/*: # Code Review Instructions
- Ensure the code follows best practices and coding standards. - For Python code, follow
PEP 20 and
PEP 8 for style guidelines.- Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
Example:def my_function(param1: int, param2: str) -> bool: pass- For Python exception handling, ensure proper stack trace preservation:
- When re-raising exceptions: use bare
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.exception()) to avoid duplicate stack trace output.- When catching and logging exceptions without re-raising: always use
logger.exception()
to capture the full stack trace information.Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any
words listed in the
ci/vale/styles/config/vocabularies/nat/reject.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile are OK.Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,
and should contain an Apache License 2.0 header comment at the top of each file.
- Confirm that copyright years are up-to date whenever a file is changed.
Files:
tests/test_data/docker-compose.services.ymlpackages/nvidia_nat_mysql/tests/test_mysql_object_store.py
**/*.py
📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)
**/*.py: Programmatic use: create TestLLMConfig(response_seq=[...], delay_ms=...), add with builder.add_llm("", cfg).
When retrieving the test LLM wrapper, use builder.get_llm(name, wrapper_type=LLMFrameworkEnum.) and call the framework’s method (e.g., ainvoke, achat, call).
**/*.py: In code comments/identifiers use NAT abbreviations as specified: nat for API namespace/CLI, nvidia-nat for package name, NAT for env var prefixes; do not use these abbreviations in documentation
Follow PEP 20 and PEP 8; run yapf with column_limit=120; use 4-space indentation; end files with a single trailing newline
Run ruff check --fix as linter (not formatter) using pyproject.toml config; fix warnings unless explicitly ignored
Respect naming: snake_case for functions/variables, PascalCase for classes, UPPER_CASE for constants
Treat pyright warnings as errors during development
Exception handling: use bare raise to re-raise; log with logger.error() when re-raising to avoid duplicate stack traces; use logger.exception() when catching without re-raising
Provide Google-style docstrings for every public module, class, function, and CLI command; first line concise and ending with a period; surround code entities with backticks
Validate and sanitize all user input, especially in web or CLI interfaces
Prefer httpx with SSL verification enabled by default and follow OWASP Top-10 recommendations
Use async/await for I/O-bound work; profile CPU-heavy paths with cProfile or mprof before optimizing; cache expensive computations with functools.lru_cache or external cache; leverage NumPy vectorized operations when beneficial
Files:
packages/nvidia_nat_mysql/tests/test_mysql_object_store.py
packages/*/tests/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
If a package contains Python code, include tests in a tests/ directory at the same level as pyproject.toml
Files:
packages/nvidia_nat_mysql/tests/test_mysql_object_store.py
packages/**/*
⚙️ CodeRabbit configuration file
packages/**/*: - This directory contains optional plugin packages for the toolkit, each should contain apyproject.tomlfile. - Thepyproject.tomlfile should declare a dependency onnvidia-nator another package with a name starting
withnvidia-nat-. This dependency should be declared using~=<version>, and the version should be a two
digit version (ex:~=1.0).
- Not all packages contain Python code, if they do they should also contain their own set of tests, in a
tests/directory at the same level as thepyproject.tomlfile.
Files:
packages/nvidia_nat_mysql/tests/test_mysql_object_store.py
…nstatntly re-pulled Signed-off-by: David Gardner <[email protected]>
…to david-tests-docker-compose Signed-off-by: David Gardner <[email protected]>
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: 1
♻️ Duplicate comments (1)
.gitlab-ci.yml (1)
91-93: Redis image still lacks RediSearch modulesThe plain
redis:8.0image omits RediSearch, so commands likeredis.commands.search.*will continue to break. Please swap toredis/redis-stack:8.0(or otherwise load the module) to restore those features; this matches the prior review guidance.- - name: redis:8.0 - alias: redis - pull_policy: if-not-present + - name: redis/redis-stack:8.0 + alias: redis + pull_policy: if-not-present
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.gitlab-ci.yml(1 hunks)
⏰ 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: CI Pipeline / Check
|
/merge |
Description
if-not-presentBy Submitting this PR I confirm:
Summary by CodeRabbit