Skip to content

Commit

Permalink
Crosslink test.list and test.list.bi
Browse files Browse the repository at this point in the history
  • Loading branch information
rexim committed Jun 1, 2024
1 parent 8f61cd4 commit c3677a5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ Universal Behavior Testing Tool in Python. The script is completely self-contain

## Quick Start

1. Create a file with a shell command line per line. Let's call it `test.list`.
1. Create a file with a shell command line per line. Let's call it [test.list](./test.list).
2. Record the expected behavior of each shell command:
```console
$ ./rere.py record test.list
```
The above command should create `test.list.bi` snapshot file with stdout, stderr, and returncode captured as the expected behavior. The file uses [bi format](https://github.com/tsoding/bi-format), for more infor see [Snapshot Schema](#snapshot-schema).
The above command should create [test.list.bi](./test.list.bi) snapshot file with stdout, stderr, and returncode captured as the expected behavior. The file uses [bi format](https://github.com/tsoding/bi-format), for more infor see [Snapshot Schema](#snapshot-schema).

3. Replay the command lines checking their behavior against the recorded one:
```console
$ ./rere.py replay test.list.bi
```

4. `test.list.bi` is expected to be committed into the project repo.
4. [test.list.bi](./test.list.bi) is expected to be committed into the project repo.

## Snapshot Schema

Expand Down

0 comments on commit c3677a5

Please sign in to comment.