Skip to content

Commit 4ab45b6

Browse files
committed
doc: Update Readme
Aline the documentation with the implemented cli interface.
1 parent b3e2787 commit 4ab45b6

File tree

2 files changed

+51
-14
lines changed

2 files changed

+51
-14
lines changed

modules/integration-browser/Readme.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
11
# AWS Encryption SDK for Javascript Browser Integration
22

3-
This module includes compatibility tests with the other versions of the AWS Encryption SDK.
4-
It's designed to facilitate testing for the set of test vectors of the AWS Encryption SDK.
5-
The test vectors can be found [here] (https://github.com/awslabs/aws-encryption-sdk-test-vectors/tree/a28851a188163e45b8cbf94c1d5a1e67e9622aa8).
3+
This repository is for compatibility tests with the other versions of the AWS Encryption SDKs.
4+
It's purpose is to facilitate testing the set of test vectors the AWS Encryption SDK.
5+
The test vectors can be found at https://github.com/awslabs/aws-encryption-sdk-test-vectors.
6+
Manifest information can be found at https://github.com/awslabs/aws-crypto-tools-test-vector-framework.
67

7-
This package will not add any dependencies in your environment, but it can be used to test the environment.
8+
It does not provide any useful functionality upon which you may want to build any dependencies.
9+
Instead you want to use it to verify environments (make sure the AWS Encryption SDK works on them).
10+
It uses karma under the hood to run in a browser.
811

912
# To test browser compatibility
10-
1. Get a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
11-
1. Use `npm run build_fixtures -- -v path/to/zip` to extract the fixtures from the zip file.
12-
1. Run `npm run karma` to execute the extracted tests.
13+
14+
1. Download a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
15+
1. Select or download both an encrypt manifest list and key manifest from aws-crypto-tools-test-vector-framework.
16+
1. Execute the CLI to run the integration tests for decrypt and encrypt.
17+
18+
## integration-browser is installed as a dependency or globally
19+
20+
### decrypt tests
21+
`integration_browser decrypt -v path/to/test/vectors/zip --karma`
22+
23+
### encrypt tests
24+
`integration_browser encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle" --karma`
25+
26+
## integration-browser has been checked out local
27+
28+
### decrypt tests
29+
`npm run build_fixtures -- decrypt -v path/to/test/vectors/zip --karma`
30+
31+
### encrypt tests
32+
`npm run build_fixtures -- encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle" --karma`
33+
34+
## Test Integration
35+
Just run
36+
37+
```sh
38+
npm test
39+
```
40+
41+
to run the tests.

modules/integration-node/Readme.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,32 @@
33
This repository is for compatibility tests with the other versions of the AWS Encryption SDKs.
44
It's purpose is to facilitate testing the set of test vectors the AWS Encryption SDK.
55
The test vectors can be found at https://github.com/awslabs/aws-encryption-sdk-test-vectors.
6+
Manifest information can be found at https://github.com/awslabs/aws-crypto-tools-test-vector-framework.
67

7-
It does not provide any useful functionality upon which you may want to build any dependencies. Instead you want to use it to verify environments (make sure the AWS Encryption SDK works on them).
8+
It does not provide any useful functionality upon which you may want to build any dependencies.
9+
Instead you want to use it to verify environments (make sure the AWS Encryption SDK works on them).
810

911
# To test Node.js compatibility
1012

11-
1. Get a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
12-
2. Execute the CLI to run the integration tests.
13-
14-
The second step can be done one of two ways
13+
1. Download a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
14+
1. Select or download both an encrypt manifest list and key manifest from aws-crypto-tools-test-vector-framework.
15+
1. Execute the CLI to run the integration tests for decrypt and encrypt.
1516

1617
## integration-node is installed as a dependency or globally
1718

18-
`integration_node -v path/to/test/vectors/zip`
19+
### decrypt tests
20+
`integration_node decrypt -v path/to/test/vectors/zip`
21+
22+
### encrypt tests
23+
`integration_node encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle"`
1924

2025
## integration-node has been checked out local
2126

22-
`npm run integration_node -- -v path/to/test/vectors/zip`
27+
### decrypt tests
28+
`npm run integration_node -- decrypt -v path/to/test/vectors/zip`
2329

30+
### encrypt tests
31+
`npm run integration_node -- encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle"`
2432

2533
## Test Integration
2634
Just run

0 commit comments

Comments
 (0)