patrick91 / patrick91/shortcake
CLI test runner script and validation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- Avg merge
- 4h 22m
- Merged PRs (30d)
- 5
Description
Objective
Create executable test scripts to validate all features through real CLI usage.
Tasks
E2E Test Script (scripts/test_e2e.sh)
- Create bash script for full workflow testing
- Set up isolated test environment (temp repo)
- Configure mock GitHub API endpoint
- Test workflow:
- Create stack of 3 branches
- Submit all PRs
- Edit middle branch
- Re-submit updated PR
- Sync with main
- Validate all operations
- Validate outputs at each step
- Validate git state (branches, commits, notes)
- Clean up test environment
- Return exit code 0 on success, 1 on failure
- Add colored output (green=pass, red=fail)
- Add verbose mode (
--verbose)
Feature Validation Script (scripts/validate_features.py)
- Python script to check all commands
- Verify all commands have help text
- Smoke test each command
- Validate command output formats
- Check version display
- Check config operations
- Validate error handling
- Generate validation report (markdown)
- Can run against installed CLI or dev version
- Add
--quickmode for fast checks
Integration with CI
- Add
scripts/test_e2e.shto CI pipeline - Run on every PR
- Run on main branch pushes
- Add status badge to README
Documentation
- Document how to run scripts
- Add troubleshooting guide
- Document expected outputs
Acceptance Criteria
scripts/test_e2e.shsuccessfully runs full workflowscripts/validate_features.pychecks all commands- Scripts run in CI successfully
- Clear output with pass/fail indicators
- Scripts handle failures gracefully
- Documentation complete
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing CLI command entry points and the repository's CI configuration, then inspect how branches, commits, notes, and GitHub API interactions are handled. Implement scripts/test_e2e.sh and scripts/validate_features.py, integrate them into CI, and document their usage, troubleshooting, and expected output. Done means both scripts validate the listed workflows and commands with clear pass/fail results and successful CI runs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash, git, python
- Domain
- ci-cd, cli, documentation, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100