docs(e2e): choose Vitest fixtures as scenario runner - #4963
Conversation
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
cv
added
the
area: e2e
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
📝 WalkthroughWalkthroughThis PR updates E2E scenario documentation to clarify the target architecture as a single Vitest-based execution path with NemoClaw fixtures owning scenario vocabulary, setup, evidence, cleanup, and assertions, while adjusting migration guidance and CI integration to prioritize fixture-first design. ChangesE2E Scenario Migration Documentation Alignment
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
PR Review AdvisorFindings: 0 needs attention, 0 worth checking, 0 nice ideas Consider writing more tests for
This is an automated advisory review. A human maintainer must make the final merge decision. |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@test/e2e-scenario/docs/README.md`:
- Around line 111-114: The provider value in the fixture-first example passed to
openclaw.onboard uses lowercase "nvidia"; change it to the required uppercase
"NVIDIA" (update the call to openclaw.onboard where provider is set) so the
snippet reads provider: "NVIDIA" to comply with the casing guideline.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d9defc73-ed55-4cd7-870c-18176ebaa0d2
📒 Files selected for processing (2)
test/e2e-scenario/docs/MIGRATION.mdtest/e2e-scenario/docs/README.md
| const instance = await openclaw.onboard({ | ||
| agent: "openclaw", | ||
| provider: "nvidia", | ||
| }); |
There was a problem hiding this comment.
Fix NVIDIA casing in the fixture-first example.
Line 113 uses provider: "nvidia", but Markdown guidance requires NVIDIA in all caps.
Suggested edit
- provider: "nvidia",
+ provider: "NVIDIA",As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const instance = await openclaw.onboard({ | |
| agent: "openclaw", | |
| provider: "nvidia", | |
| }); | |
| const instance = await openclaw.onboard({ | |
| agent: "openclaw", | |
| provider: "NVIDIA", | |
| }); |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@test/e2e-scenario/docs/README.md` around lines 111 - 114, The provider value
in the fixture-first example passed to openclaw.onboard uses lowercase "nvidia";
change it to the required uppercase "NVIDIA" (update the call to
openclaw.onboard where provider is set) so the snippet reads provider: "NVIDIA"
to comply with the casing guideline.
Source: Coding guidelines
2 participants
Summary
Documents #4941 as a Vitest fixture-based end state for E2E scenarios: one runner, typed NemoClaw scenario fixtures, and shell/YAML only as migration bridges. Draft stack PR 1/7. cc @jyaunches for review.
Related Issue
Refs #4941.
Changes
test/e2e-scenario/docs/README.mdto describe the final Vitest scenario shape and the smallest expected test.test/e2e-scenario/docs/MIGRATION.mdto reconcile the legacy and scenario paths around the single-runner target.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Signed-off-by: Carlos Villela cvillela@nvidia.com
Summary by CodeRabbit
Documentation