add compact test output with step descriptions#198
Open
theodore-s-beers wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances the CLI test renderer to support plain-language step descriptions and a more compact default output mode, with a --verbose flag to show full per-step detail. It also adds visual truncation for large command/HTTP outputs and wires step descriptions through the manifest → runner → renderer pipeline.
Changes:
- Add
descriptionsupport for CLI steps (manifest + message plumbing) and render it alongside a technical detail string. - Default to compact pass/fail step lines, expanding failed steps (and hiding later steps) unless
--verboseis used. - Truncate large stdout/HTTP response bodies for readability, and add renderer-focused tests.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| render/view.go | Implements compact/verbose rendering logic, failure expansion, and output truncation. |
| render/view_test.go | Adds tests for compact vs verbose output, description fallback, and truncation behavior. |
| render/render.go | Adds support for step description + detail fields and threads verbose into the model. |
| render/models.go | Renames step display fields and adds verbose to the root model/init. |
| render/http.go | Applies visual truncation to HTTP response bodies (including pretty JSON). |
| messages/messages.go | Extends StartStepMsg with an optional plain-language Description. |
| cmd/submit.go | Adds --verbose/-v flag and passes it into the renderer. |
| cmd/run.go | Adds --verbose/-v flag for non-submit runs. |
| cmd/localtest.go | Adds --verbose/-v flag and passes it into the renderer. |
| cmd/localtest_test.go | Updates local CLI data parsing test to include/verify step description in YAML. |
| client/lessons.go | Adds CLIStep.Description YAML field to support descriptions in manifests. |
| checks/runner.go | Passes step description into StartStepMsg for both CLI and HTTP steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f993c0e to
8529725
Compare
8529725 to
9f128c8
Compare
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
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.
--verboseto display full details for every step