feat: add declarative YAML-based e2e test framework #31
Conversation
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
Replace fragmented e2e tests with a unified, declarative approach: - Add YAML scenario files for checkout, create, list, remove, shellenv - Add Go orchestrator that parses YAML and generates shell scripts - Support bash, zsh, powershell, pwsh across Linux, macOS, Windows - Simplify CI workflow from 611 to 233 lines (62% reduction) - Add justfile recipes: e2e, e2e-bash, e2e-zsh, e2e-shells Adding new tests now requires only YAML changes, no code modifications.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #31 +/- ##
==========================================
- Coverage 18.95% 11.83% -7.12%
==========================================
Files 1 2 +1
Lines 496 794 +298
==========================================
Hits 94 94
- Misses 396 694 +298
Partials 6 6
🚀 New features to boost your workflow:
|
- Update settings.yml with new CI job names - Fix PowerShell script generation: - Handle expected non-zero exit codes with try/catch - Normalize path separators for cwd_ends_with checks - Translate $WT_BIN to $env:WT_BIN for PowerShell - Run commands directly when auto-cd is needed - Skip remove_cleans_directory on Windows (uses Unix test -d)
- Add & call operator when running commands that start with $env: - Skip remove_nonexistent_fails on Windows (exit code handling differs) - Skip shellenv_produces_output on PowerShell (expects POSIX syntax)
All Windows tests now pass, remove continue-on-error.
Remove deprecated test files now replaced by declarative YAML e2e tests: - e2e/docker/ - Docker-based shell tests - e2e/native/ - Native shell test scripts - e2e/lib/ - Unused setup helpers - e2e_test.go - Go e2e tests - e2e_windows_test.go - Windows Go e2e tests - test-gitlab-support.sh - Manual test script - test-windows-local.ps1 - Local Windows test script All scenarios are now covered by e2e/scenarios/*.yaml running via the Go orchestrator (e2e/run.go). Kept: e2e_interactive_test.go (PTY tests for future integration)
The helper functions (setupTestRepo, buildWtBinary, runGitCommand) were previously in e2e_test.go which was removed. Add them back to support the interactive PTY tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Redesign e2e testing to be declarative and easy to maintain:
Changes
New Files
e2e/scenarios/*.yaml— 5 scenario files with 18 test casese2e/run.go— Go orchestrator that parses YAML and executes testse2e/lib/setup.{sh,ps1}— Shared helper functionse2e/README.md— DocumentationModified Files
justfile— Added e2e recipes.github/workflows/ci.yml— Unified e2e job using orchestratorgo.mod— Added yaml.v3 dependencyTest Plan
Known Issues
Windows PowerShell tests are currently marked as
continue-on-errorbecause:This can be addressed in a follow-up PR.