Skip to content

Commit ba2fa17

Browse files
author
Bennett Hardwick
committed
Update README with test instructions
1 parent 2585069 commit ba2fa17

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,26 @@ When self-hosting ZeroKMS, we recommend running it in different account to your
451451

452452
<!-- cargo-rdme end -->
453453

454+
## Running the tests
455+
456+
In order to run the tests you need to have the following variables set in your environment:
457+
458+
```sh
459+
export CS_CLIENT_ID=<your client id>
460+
export CS_CLIENT_KEY=<your client key>
461+
462+
// The following are required for using the local dynamo emulator
463+
export AWS_ACCESS_KEY_ID=dynamo
464+
export AWS_SECRET_ACCESS_KEY=dynamo
465+
export AWS_REGION=ap-southeast-2
466+
```
467+
468+
With these variables set, you're free to run the tests with the following command:
469+
470+
```sh
471+
cargo test
472+
```
473+
454474
## Contributing
455475

456476
We welcome contributions to CipherStash for DynamoDB.

0 commit comments

Comments
 (0)