86c8097dc2
* Default to "cat" verb when none is supplied (#2029) Invocations like 'mlr --j2y' or 'mlr --c2p' previously failed with "no verb supplied", forcing users to type the trailing 'cat' explicitly for pure format conversions. Default the verb to 'cat' in that case. Bare 'mlr' with no flags, no verb, and no files still prints the main usage banner. This handles flag-only invocations (e.g. 'mlr --c2j < input.csv' or 'mlr --c2j --from input.csv'). File names without a preceding verb are still parsed as verb candidates and continue to error if not found; that broader change is out of scope here. * Use ${MLR} substitution for bare-mlr regression case (#2029) The regtester only substitutes the mlr executable when the cmd starts with "mlr " (with a trailing space). The bare-mlr usage-banner test had a cmd of just "mlr", so on CI -- which invokes regtest with a relative path like 'test/../mlr' -- the test shelled out to a literal 'mlr' that isn't on PATH and failed with exit 127. Switch the cmd to ${MLR} (the regtester's explicit substitution token) so the case runs the right binary in any invocation context. |
||
|---|---|---|
| .. | ||
| cases | ||
| cases-not-suitable-for-ci | ||
| expected | ||
| input | ||
| stdlib | ||
| README.md | ||
Miller regression tests
There are a few files unit-tested with Go's testing package -- a few dozen cases total.
The vast majority of Miller tests, though -- thousands of cases -- are tested by running scripted invocations of mlr with various flags and inputs, comparing against expected output, and checking the exit code back to the shell.
How to run the regression tests, in brief
Note: while this README.md file is within the test/ subdirectory, all paths in this file are written from the perspective of the user being cd'ed into the repository base directory, i.e. this directory's parent directory.
-
mlr regtest --help -
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
mlr regtest -c ...runs the C version of Miller from the local checkout
More details
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.
mr— run all regression cases (default path istest/cases/).mr test/cases/foo— run only cases under that directory.mr -v test/cases/foo— same, plus per-command pass/fail; use-vvor-vvvfor 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 overwriteexpoutandexperrfrom 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.
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
- Create a case directory under
test/cases/, e.g.test/cases/my-feature/0001. - Add a
cmdfile containing the Miller command line (one line), e.g.mlr cat test/input/simple.dkvp. - Use shared input under
test/input/, or add a localinputfile in the case directory; incmdyou can use${CASEDIR}so the command refers to the case directory (e.g.mlr cat ${CASEDIR}/input). - Run
mlr regtest -p test/cases/my-feature/0001to generateexpout(andexperrif the command produces stderr). If the command is expected to exit non-zero, add an emptyshould-failfile. - 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).