-
Notifications
You must be signed in to change notification settings - Fork 3.1k
docs(e2e): keep migration state in issues #4649
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,149 +1,38 @@ | ||
| <!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> | ||
| <!-- SPDX-License-Identifier: Apache-2.0 --> | ||
|
|
||
| # E2E Migration Tracker | ||
| # E2E migration tracking | ||
|
|
||
| This PR migrates all existing `test/e2e/test-*.sh` scripts into the | ||
| scenario-based runner introduced by PR #3363. Full deep migration | ||
| (Strategy B). Legacy scripts remain in the repo during this PR and run | ||
| in parallel for 1–2 nightly cycles after merge; a follow-up PR retires | ||
| them once parity is verified. | ||
| Migration state for the scenario-based E2E framework is intentionally tracked | ||
| outside the repository, in GitHub issues and pull requests. This file documents | ||
| that policy so the repo does not retain stale per-script checklists, migrated | ||
| counts, or ownership tables after the work moves on. | ||
|
|
||
| **Merge gate:** All 40 legacy entry points must have a scenario-based | ||
| equivalent that produces the same PASS/FAIL outcomes as the legacy | ||
| script in a side-by-side CI run. | ||
| ## Where to track current work | ||
|
|
||
| ## Reuse being absorbed | ||
| - Use issue #3588 as the parent epic for the layered E2E scenario model. | ||
| - Use the active audit-coverage phase issues #4347 through #4357 for current | ||
| domain-by-domain implementation, review, and reconciliation state. | ||
| - Use issue #4378 for the setup-scenario alias cleanup that bridges layered | ||
| `test_plans` to friendly scenario IDs. | ||
| - Use the pull request for each change as the evidence record for what landed, | ||
| what was deferred, and what follow-up issues remain. | ||
|
|
||
| Migrating 40 scripts collapses 13 distinct categories of duplication. | ||
| Each row maps to a Wave 0 item or an existing helper. | ||
| ## What belongs in the repo | ||
|
|
||
| | # | Category | Fan-in (legacy) | Target absorber | LOC | | ||
| |---|---|---|---|---:| | ||
| | 1 | Logging helpers (`section` / `info` / `pass` / `fail`) | 28–39 scripts redefine each | `runtime/lib/logging.sh` (Wave 0.B.5) | 1,556 | | ||
| | 2 | Non-interactive env exports | 187 inlined lines across 40 scripts | `runtime/lib/env.sh::e2e_env_apply_noninteractive` + convention 0.G.1 | 175 | | ||
| | 3 | Repo-root / `SCRIPT_DIR` discovery | 37 lines, 4 competing patterns | One convention (Wave 0.G.2) | 25 | | ||
| | 4 | `nemoclaw list` / `status` / gateway state probes | 142 inlined sites | `validation_suites/assert/{gateway,sandbox}-alive.sh` | 500 | | ||
| | 5 | `bash install.sh ...` invocations | 24 scripts | `nemoclaw_scenarios/install/dispatch.sh` dispatcher (Wave 0.C.1) | 300 | | ||
| | 6 | `nemoclaw onboard ...` variants | 42 invocations, 8+ flag incantations | `nemoclaw_scenarios/onboard/dispatch.sh` + profile handlers | 800 | | ||
| | 7 | Docker older-base-image pattern | 3 hand-rolled implementations | `nemoclaw_scenarios/fixtures/older-base-image.sh` (Wave 0.A.1) | 250 | | ||
| | 8 | Trap / cleanup / teardown blocks | 112 lines, ~15 patterns | `runtime/lib/cleanup.sh` + convention 0.G.3 | 400 | | ||
| | 9 | Fake-endpoint inline setups | 3 inline variants | `nemoclaw_scenarios/fixtures/fake-{openai,telegram,discord,slack}.sh` (Wave 0.A.2–5) | 150 | | ||
| | 10 | Sandbox-scoped exec (`nemoclaw shell <sb> -- ...`) | 15 scripts reimplement with drift | `validation_suites/sandbox-exec.sh` (Wave 0.A.6) | 200 | | ||
| | 11 | Hermes/OpenClaw pair-variant scripts | 7 paired scripts share ~70% | Shared suite steps; scenario agent via `expected_state.sandbox.agent` | 800 | | ||
| | 12 | `section "Phase N: X"` markers | Every script inflates logs with phase text | Step-script filename carries the name (convention 0.G.4) | 300 | | ||
| | 13 | Log-capture paths (`/tmp/*.log`) | 25 different conventions; CI artifact upload assumes one | `$E2E_CONTEXT_DIR/logs/` convention 0.G.5 | 300 | | ||
| | **Total** | | | | **~5,556** | | ||
| Keep durable framework guidance here: | ||
|
|
||
| About **25% LOC reduction** net after legacy retirement. The larger win | ||
| is drift reduction: when `--yes-i-accept-third-party-software` renames | ||
| again, it's a 1-file change instead of a 24-file change. | ||
| - how to run the scenario runner, | ||
| - where scenario metadata, typed builders, manifests, and suites live, | ||
| - how to add or review a scenario, expected state, assertion, or suite, | ||
| - stable conventions that should not change with every migration batch. | ||
|
|
||
| ## Status summary | ||
| Do not add migration status tables, per-legacy-script checklists, temporary | ||
| coverage counts, or owner queues to this file. Put those in the issue or PR | ||
| that owns the work instead. | ||
|
|
||
| | Bucket | Legacy LOC | Status | | ||
| |---|---:|---| | ||
| | Wave 0 — fixtures, asserts, setup splits, conventions, parity workflow | — | ⬜ not started | | ||
| | Wave 1 — onboarding baseline | 1,101 | ⬜ | | ||
| | Wave 2 — onboarding lifecycle | 2,013 | ⬜ | | ||
| | Wave 3 — sandbox lifecycle | 2,891 | ⬜ | | ||
| | Wave 4 — rebuild / upgrade | 1,292 | ⬜ | | ||
| | Wave 5 — inference variants | 2,593 | ⬜ | | ||
| | Wave 6 — Hermes | 1,646 | ⬜ | | ||
| | Wave 7 — messaging | 3,397 | ⬜ | | ||
| | Wave 8 — security / policy | 2,241 | ⬜ | | ||
| | Wave 9 — runtime / platform services | 1,696 | ⬜ | | ||
| | Wave 10 — platform + remote | 1,589 | ⬜ | | ||
| | Wave 11 — misc | 405 | ⬜ | | ||
| | **Total** | **20,864** | **0 / 40 scripts migrated** | | ||
| ## Why | ||
|
|
||
| ## Per-script tracker | ||
|
|
||
| Legend: ⬜ not started · 🟨 in progress · ✅ migrated · 🔵 parity verified | ||
|
|
||
| ### Wave 1 — onboarding baseline | ||
|
|
||
| - ⬜ `test-full-e2e.sh` (473) → `onboarding/happy-path/` + scenario `ubuntu-curl-cloud-openclaw` | ||
| - ⬜ `test-cloud-onboard-e2e.sh` (337) → `onboarding/public-installer/` | ||
| - ⬜ `test-cloud-inference-e2e.sh` (291) → extends `inference/cloud/` | ||
|
|
||
| ### Wave 2 — onboarding lifecycle | ||
|
|
||
| - ⬜ `test-double-onboard.sh` (717) → `onboarding/double-onboard/` | ||
| - ⬜ `test-gpu-double-onboard.sh` (571) → `onboarding/double-onboard/` on GPU scenario | ||
| - ⬜ `test-onboard-repair.sh` (372) → `onboarding/repair/` | ||
| - ⬜ `test-onboard-resume.sh` (353) → `onboarding/resume/` | ||
|
|
||
| ### Wave 3 — sandbox lifecycle | ||
|
|
||
| - ⬜ `test-sandbox-operations.sh` (828) → `sandbox/operations/` | ||
| - ⬜ `test-sandbox-survival.sh` (721) → `sandbox/survival/` | ||
| - ⬜ `test-snapshot-commands.sh` (281) → `sandbox/snapshot/` | ||
| - ⬜ `test-diagnostics.sh` (452) → `sandbox/diagnostics/` | ||
| - ⬜ `test-issue-2478-crash-loop-recovery.sh` (609) → `sandbox/crash-loop-recovery/` | ||
|
|
||
| ### Wave 4 — rebuild / upgrade | ||
|
|
||
| - ⬜ `test-rebuild-openclaw.sh` (453) → `sandbox/rebuild-openclaw/` (uses `nemoclaw_scenarios/fixtures/older-base-image.sh`) | ||
| - ⬜ `test-rebuild-hermes.sh` (401) → `sandbox/rebuild-hermes/` | ||
| - ⬜ `test-upgrade-stale-sandbox.sh` (241) → `sandbox/upgrade-stale/` | ||
| - ⬜ `test-sandbox-rebuild.sh` (197) → folded into `sandbox/rebuild-openclaw/` | ||
|
|
||
| ### Wave 5 — inference variants | ||
|
|
||
| - ⬜ `test-gpu-e2e.sh` (565) → `inference/ollama-gpu/` (deep port) | ||
| - ⬜ `test-ollama-auth-proxy-e2e.sh` (548) → `inference/ollama-auth-proxy/` (deep port) | ||
| - ⬜ `test-inference-routing.sh` (715) → `inference/routing-errors/` | ||
| - ⬜ `test-kimi-inference-compat.sh` (765) → `inference/kimi-compat/` | ||
|
|
||
| ### Wave 6 — Hermes | ||
|
|
||
| - ⬜ `test-hermes-e2e.sh` (591) → `onboarding/hermes/` (deep port; currently 1-step health) | ||
| - ⬜ `test-hermes-slack-e2e.sh` (537) → `messaging/slack/hermes/` | ||
| - ⬜ `test-hermes-discord-e2e.sh` (518) → `messaging/discord/hermes/` | ||
|
|
||
| ### Wave 7 — messaging | ||
|
|
||
| - ⬜ `test-messaging-providers.sh` (1,677) → `messaging/providers/{telegram,discord,slack}/` | ||
| - ⬜ `test-token-rotation.sh` (575) → `messaging/token-rotation/` | ||
| - ⬜ `test-telegram-injection.sh` (475) → `security/telegram-injection/` | ||
| - ⬜ `test-messaging-compatible-endpoint.sh` (670) → `messaging/compatible-endpoint/` | ||
|
|
||
| ### Wave 8 — security / policy | ||
|
|
||
| - ⬜ `test-shields-config.sh` (550) → `security/shields/` | ||
| - ⬜ `test-network-policy.sh` (579) → `security/network-policy/` | ||
| - ⬜ `test-credential-sanitization.sh` (810) → `security/credentials/sanitization/` | ||
| - ⬜ `test-credential-migration.sh` (302) → `security/credentials/migration/` | ||
|
|
||
| ### Wave 9 — runtime / platform services | ||
|
|
||
| - ⬜ `test-runtime-overrides.sh` (272) → `sandbox/runtime-overrides/` | ||
| - ⬜ `test-overlayfs-autofix.sh` (537) → `sandbox/overlayfs-autofix/` | ||
| - ⬜ `test-device-auth-health.sh` (373) → `lifecycle/device-auth-health/` | ||
| - ⬜ `test-state-backup-restore.sh` (378) → `lifecycle/state-backup-restore/` | ||
| - ⬜ `test-tunnel-lifecycle.sh` (472) → `lifecycle/tunnel-lifecycle/` | ||
|
|
||
| ### Wave 10 — platform + remote | ||
|
|
||
| - ⬜ `test-spark-install.sh` (157) → `platform/spark/` | ||
| - ⬜ `test-launchable-smoke.sh` (589) → `platform/launchable/` | ||
| - ⬜ `brev-e2e.test.ts` (843) → `platform/brev-remote/` | ||
|
|
||
| ### Wave 11 — misc | ||
|
|
||
| - ⬜ `test-skill-agent-e2e.sh` (244) → `onboarding/skill-agent/` | ||
| - ⬜ `test-docs-validation.sh` (161) → `lifecycle/docs-validation/` | ||
|
|
||
| ## Migration tracking | ||
|
|
||
| The old workflow-level parity report has been removed. Migration is tracked by | ||
| coverage domain under issue #3588 and its child issues. For each domain, add the | ||
| missing primitive layer first, then migrate assertions into scenario plans and | ||
| post-onboard suites with stable assertion IDs. | ||
|
|
||
| Use the scenario coverage report plus code review to answer: | ||
|
|
||
| - which legacy/nightly behaviors are now represented in scenarios, | ||
| - which behaviors remain outstanding for the domain issue, and | ||
| - which legacy behaviors should be retired rather than ported. | ||
| The E2E migration moves quickly and is coordinated across multiple issues and | ||
| pull requests. Keeping mutable migration state in GitHub avoids leaving stale | ||
| repo documentation that disagrees with the latest merged code or open review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Assert the README still points to issues/PRs.
This test only checks that
README.mdsays migration status is tracked "outside the repository". It would still pass if the README lost the issue/PR guidance that this PR is trying to preserve.Suggested tightening
it("documents that migration state lives in issues and PRs", () => { const migration = read(MIGRATION_DOC); const readme = read(README_DOC); expect(migration).toMatch(/tracked\s+outside the repository/); expect(migration).toContain("GitHub issues and pull requests"); expect(readme).toMatch(/Migration status is tracked outside the repository/); + expect(readme).toMatch(/parent epic/i); + expect(readme).toMatch(/pull requests?/i); });📝 Committable suggestion
🤖 Prompt for AI Agents