Skip to content

Commit 201031b

Browse files
committed
Improve check output and start adding E2E testing
1 parent 420aaef commit 201031b

File tree

5 files changed

+453
-1
lines changed

5 files changed

+453
-1
lines changed

TESTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Testing
2+
3+
## CLI
4+
5+
| Command | Description | Unit Tests | Manual Testing Required |
6+
| ------- | ---------------------------------------------------------- | ---------- | ------------------------------------- |
7+
| check | Check language validity and formatting of a notebook || No |
8+
| convert | Convert an existing runbook to different format || Yes - Test conversion between formats |
9+
| create | Create a new runbook from [template] || Yes - Verify template rendering |
10+
| diff | Diff two notebooks || Yes - Visual verification |
11+
| edit | Edit an existing runbook || Yes - Interactive editing |
12+
| init | Initialize a folder as a runbook repository || No |
13+
| list | List runbooks || No |
14+
| plan | Prepares the runbook for execution by injecting parameters || Yes - Parameter injection |
15+
| review | [Unimplemented] Entrypoint for reviewing runbook || N/A |
16+
| run | Run a notebook || Yes - Full execution |
17+
| show | Show runbook parameters and metadata || No |
18+
| version | Display version information about runbook || No |
19+
20+
Commands marked with "Manual Testing Required: Yes" should be tested manually as
21+
they cannot be easily automation tested. Key areas to verify:
22+
23+
- `convert`: Test conversion between all supported formats
24+
- `create`: Verify template rendering and parameter substitution
25+
- `diff`: Visually verify diff output is correct
26+
- `edit`: Test interactive editing workflow
27+
- `plan`: Verify parameter injection and validation
28+
- `run`: Test full execution with various parameter combinations

0 commit comments

Comments
 (0)