Darkroom
A contract testing tool built in Rust using the filmReel format.
Usage:
dark
:
Usage: dark [<address>] [-v] [--tls] [-p <proto>] [-H <header>] [-C <cut-out>] [-i] <command> [<args>]
Top-level command.
Options:
-v, --verbose enable verbose output
--tls enable TLS (automatically inferred for HTTP/S)
-p, --proto pass proto files used for payload forming
-H, --header fallback header passed to the specified protocol
-C, --cut-out output of final cut file
-i, --interactive interactive frame sequence transitions
--help display usage information
Commands:
version Returns CARGO_PKG_VERSION
take Takes a single frame, emitting the request then validating
the returned response
record Attempts to play through an entire Reel sequence running a
take for every frame in the sequence
dark take
:
Usage: dark take <frame> -c <cut> [-o <take-out>]
Takes a single frame, emitting the request then validating the returned response
Options:
-c, --cut filepath of input cut file
-o, --take-out output of take file
--help display usage information
dark record
:
Usage: dark record <reel_path> <reel_name> [<merge_cuts...>] [-c <cut>] [-b <component>] [-o <take-out>]
Attempts to play through an entire Reel sequence running a take for every frame in the sequence
Options:
-c, --cut filepath of input cut file
-b, --component repeatable component reel pattern using an ampersand
separator: `--component "<dir>&<reel_name>"`
-o, --take-out output directory for successful takes
--help display usage information
Examples:
SOPS example:
# destructively merge FIFO sops "KEY_NAME" value into the in-memory cut register
# multiple merge cuts can be used, with values being overridden left to right (right will have newer values)
Cut output example:
# echo the origin "${IP}" that gets written to the cut register from the httpbin.org POST request
Changes:
0.2
:
- HTTP support
- Full JSON object storage and retrieval, the cut register is no longer a flat associative array, strings are still used to map to JSON objects for templating
- Variable discarding:
${lowercase}
variables will only be kept around for the duration of the frame - Headers and entrypoints can be stored and read on a per JSON frame basis
- SOPS/JSON secrets support
0.2.1
:
- Added hidden variable support, hidden variables are defined with a leading underscore:
${_HIDDEN}
- Added
dark version
command - moved common parameters into the main
dark
command to be shared across subcommands
0.2.3
:
- Added component reel support, component reels are generated as a prelude to the provided reel
dark record --component "<dir>&<reel_name>" ./dir/ my_reel_name
- Added anyhow error handling
--cut-out
can now be returned on a failedrecord
ortake