diff --git a/README.md b/README.md index 657bbed..40bae3c 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,16 @@ Flexible test runner for testing Nix code, written in Go. +[![asciicast](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6.svg)](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6) + ## Features - Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say) - Supports testing against raw Nix code or derivation output - Simple and easy to read summary of test results + ![screenshot](./docs/images/summary_screenshot.png) - Junit report support (eg. for displaying the results in GitLab etc.) + ![screenshot](./docs/images/gitlab_junit_screenshot.png) ## Usage diff --git a/docs/cli.md b/docs/cli.md index 9c69c9c..943939e 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -3,10 +3,11 @@ ```sh title="nix run .#nixtests:run -- --help" Usage of nixtest: --junit string Path to generate JUNIT report to, leave empty to disable + --no-color Disable coloring --pure Unset all env vars before running script tests - --skip string Regular expression to skip (e.g., 'test-.*|.*-b') + -s, --skip string Regular expression to skip tests (e.g., 'test-.*|.*-b') --snapshot-dir string Directory where snapshots are stored (default "./snapshots") - --tests string Path to JSON file containing tests - --update-snapshots Update all snapshots - --workers int Amount of tests to run in parallel (default 4) + -f, --tests string Path to JSON file containing tests (required) + -u, --update-snapshots Update all snapshots + -w, --workers int Amount of tests to run in parallel (default 4) ``` diff --git a/docs/images/gitlab_junit_screenshot.png b/docs/images/gitlab_junit_screenshot.png new file mode 100644 index 0000000..03696af Binary files /dev/null and b/docs/images/gitlab_junit_screenshot.png differ diff --git a/docs/images/summary_screenshot.png b/docs/images/summary_screenshot.png new file mode 100644 index 0000000..af60a6d Binary files /dev/null and b/docs/images/summary_screenshot.png differ diff --git a/docs/index.md b/docs/index.md index 37124d9..f9fc7b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,4 +7,6 @@ Flexible test runner for testing Nix code, written in Go. - Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say) - Supports testing against raw Nix code or derivation output - Simple and easy to read summary of test results + ![screenshot](./images/summary_screenshot.png) - Junit report support (eg. for displaying the results in GitLab etc.) + ![screenshot](./images/gitlab_junit_screenshot.png) diff --git a/docs/usage.md b/docs/usage.md index 2c72e4a..fbcccb3 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -93,7 +93,7 @@ Examples: name = "pretty-test"; # by default it uses json to serialize and compare the values. Derivations # and functions don't really work that way though, so you can also use - # "pretty" to use lib.generators.pretty + # "pretty" to use lib.generators.toPretty format = "pretty"; # you can also set the pos here pos = __curPos;