Mirrors/miller
1
0
Fork 0
mirror of https://github.com/johnkerl/miller.git synced 2026-07-18 00:45:47 +00:00
Code Issues Projects Releases Wiki Activity

test/README.md (#1972)

Browse source
This commit is contained in:
John Kerl 2026-02-16 16:44:31 -05:00 • committed by GitHub
parent 5eb40c9e7b
commit 1e762d7c4c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

34
test/README.md
View file

@ -10,7 +10,7 @@ The vast majority of Miller tests, though -- thousands of cases -- are tested by
* `mlr regtest --help`
* `go test` -- TODO -- also comment
* `go test github.com/johnkerl/miller/v6/pkg/...` — runs the Go unit tests (a few dozen cases).
## Items for the duration of the Go port
@ -18,25 +18,23 @@ The vast majority of Miller tests, though -- thousands of cases -- are tested by
## More details
TODO: needs to be written up
You can alias `mr='mlr regtest'` for convenience. With no arguments, `mr` runs all cases under `test/cases/`. Pass one or more paths to run only those directories or specific `.cmd` files.
```
alias mr='mlr regtest'
mr
mr test/cases/foo
mr -v test/cases/foo
mr -cj test/cases/foo/0003
mr -gj test/cases/foo/0003
mr -gp test/cases/foo/0003
...
```
* **`mr`** — run all regression cases (default path is `test/cases/`).
* **`mr test/cases/foo`** — run only cases under that directory.
* **`mr -v test/cases/foo`** — same, plus per-command pass/fail; use `-vv` or `-vvv` for more detail.
* **`mr -j test/cases/foo/0003`** — show the Miller command, any script, and actual output for that case (handy for debugging).
* **`mr -p test/cases/foo/0003`** — *populate*: write or overwrite `expout` and `experr` from the current run (use when adding or updating expected output).
* **`mr -c ...`** — use the C build of Miller (e.g. `-c` → `../c/mlr`) instead of the current executable.
```
mr -gp test/cases/foo
git diff
git reset --hard
```
To review populated files before committing, run `mr -p` on the desired path, then `git diff` to inspect changes and `git reset --hard` to discard them.
## Creating new cases
TODO: needs to be written up
1. Create a case directory under `test/cases/`, e.g. `test/cases/my-feature/0001`.
2. Add a **`cmd`** file containing the Miller command line (one line), e.g. `mlr cat test/input/simple.dkvp`.
3. Use shared input under `test/input/`, or add a local **`input`** file in the case directory; in `cmd` you can use **`${CASEDIR}`** so the command refers to the case directory (e.g. `mlr cat ${CASEDIR}/input`).
4. Run **`mlr regtest -p test/cases/my-feature/0001`** to generate **`expout`** (and **`experr`** if the command produces stderr). If the command is expected to exit non-zero, add an empty **`should-fail`** file.
5. Run **`mlr regtest test/cases/my-feature/0001`** (without `-p`) to confirm the case passes.
Optional: **`mlr`** — DSL script file when the test uses `-f`/`put`/`filter`; **`env`** — environment variables to set for the case (unset after).