Darkroom

Crates.io Docs.rs

A contract testing tool built in Rust using the filmReel format.

Sample request:

usr.cut.json: jsonc // Cut: the data sharing system allowing one Frame to pass messages to the next Frame {"HTTP_ENDPOINT": "/create_user"}

usr.01s.createuser.fr.json:

jsonc // Frame: the JSON file where input an output expectations are set { "protocol": "HTTP", // protocol: the declared communication protocol "cut": { // cut: declare what variables should be pulled "from" and pushed "to" `usr.cut.json` "from": ["HTTP_ENDPOINT"], // pull the HTTP_ENDPOINT "from" `usr.cut.json` "to": { // push the USER_ID found in .response.body.msg "to" `usr.cut.json` "USER_ID": "'response'.'body'.'msg'" } }, "request": { // request object "body": { // request body "email": "new_user@humanmail.com" }, "uri": "POST ${HTTP_ENDPOINT}" // request uri: HTTP_ENDPOINT will be replaced by "/create_user" }, "response": { // response object "body": { // response body "msg": "created user: ${USER_ID}" // USER_ID will be stored if there is a match for the surrounding values }, "status": 200 // expected response status code } }

Installation

 

For gRPC requests: Darkroom 0.3 or greater requires grpcurl v1.6.0 or greater for making gRPC requests.

Usage:

dark:

``` Usage: dark [

] [-v] [-H
] [--cut-out ] [-i] [--tls] [--proto-dir []

Darkroom: A contract testing tool built in Rust using the filmReel format.

Options: -v, --verbose enable verbose output -H, --header fallback header passed to the specified protocol --cut-out output of final cut file -i, --interactive interactive frame sequence transitions --tls enable TLS (automatically inferred for HTTP/S) --proto-dir the path to a directory from which proto sources can be imported, for use with --proto flags. -p, --proto pass proto files used for payload forming --help display usage information

Commands: version Returns CARGOPKGVERSION 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 man return a given manual entry vrecord Attempts to play through an entire VirtualReel sequence running a take for every frame in the sequence

Examples: Step through the httpbin test in [-i]nteractive mode: $ dark -i record ./testdata post Echo the origin ${IP} that gets written to the cut register from the httpbin.org POST request: $ dark --cut-out >(jq .IP) take ./testdata/post.01s.body.fr.json Run the post reel in a v-reel setup: $ dark vrecord ./test_data/post.vr.json

Notes: Use dark man for details on filmReel, the JSON format.

```

Examples:

```sh

step through the httpbin test in [-i]nteractive mode

dark -i record ./test_data post

to fail at the third httpbin frame, set a timeout of two seconds

dark --interactive record ./test_data post --timeout 2

multiple merge cuts can be used, with values being overridden left to right (right will have newer values)

dark --interactive record ./testdata post --cut ./testdata/post.cut.json '{"NEW":"value"}' '{"NEWER": "value", "NEW":"overridden"}'

echo the origin "${IP}" that gets written to the cut register from the httpbin.org POST response

dark --cut-out >(jq .IP) take ./testdata/post.01s.body.fr.json --cut ./testdata/post.cut.json

create a stripe token using the public Stripe API key

dark --verbose --cut-out >(jq) record ./testdata stripetoken

create a stripe subscription preceding it with the stripe_token flow

dark --cut-out >(jq) record ./testdata stripesubscription --component './testdata&stripetoken' ```

CHANGELOG

Please see the CHANGELOG for a release history.