#cli-applications #cli #strategy #testing #command-line-interface #command-line-tool #snapshot-testing

app cli-snap

cli-snap is a command-line interface (CLI) tool designed for testing other CLI applications using a snapshot-based testing strategy

1 unstable release

0.1.0 Apr 21, 2024

#23 in #strategy

MIT license

8KB
132 lines

CLI SNAP

cli-snap is a command-line interface (CLI) tool designed for testing other CLI applications using a snapshot-based testing strategy.

Installation

Using cargo

cargo install cli-snap

Usage

  1. Create a test suite file named cli-snap.toml to define your testing commands:
[[tests]]
commands = ["echo 'Hello'"]
id = "hello-world"

[[tests]]
commands = ["echo 'test 2'", "echo 'second hello'"]
id = "test-2"

[config]
snapshot_directory = "./snaps"

| Ensure each test has a unique ID to distinguish and identify each snapshot.

  1. Run the test suite using the following command:
cli-snap --config <directory where you have saved toml>

output image

  1. To update snapshots, run the command.
cli-snap --config <directory where you have saved toml> --update-snapshot

Dependencies

~1.5–2.4MB
~43K SLoC