Repository navigation
Conversation
The README showed string steps ("vp run build") and a table form with
`command`, and said steps run through /bin/sh. `Step` in main.rs is an
argv array or a table with `argv`, a string step makes the test binary
panic while loading fixtures, and steps start without a shell in a
cleared environment. Update the examples and notes to match: the table
and case keys, how `vt`/`vtt` are found, the full `write-key` list,
`vtt pipe-stdin` instead of shell pipes, the step timeout, and how new
snapshots are written and accepted.
The README said the tests execute `vp`; they run the `vt` binary built for the test. The `comment` field of a step was documented as appended to the command line, but the snapshot shows it under the step heading.
This branch has not been deployed
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
2 participants
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.
Motivation
The e2e snapshot test README describes a step format the harness doesn't accept. It shows string steps such as
"vp run build"and a table form withcommand, and says steps run through/bin/sh.Stepinmain.rsis an argv array or a table withargv. A string step makes the test binary panic while it loads the fixtures, before any case runs, and steps start without a shell in a cleared environment, so a fixture written from the README doesn't run.Changes
vtt pipe-stdin.argv,cwd,comment,envs,interactions,formatted-snapshot), the case keys (name,steps,comment,cwd,cfg,ignore), how programs are found, the fullwrite-keylist, the step timeout, and how new snapshots are written as<name>.md.newand accepted withUPDATE_SNAPSHOTS=1.vt, notvp, and correct the doc comment on a step'scommentfield: the snapshot shows it under the step's heading, not appended to the command line.The examples were run through the harness as written.