Skip to content

doc: Update Readme #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 26, 2019
Merged

doc: Update Readme #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ab45b6
doc: Update Readme
seebees Sep 26, 2019
173dfd7
Merge branch 'master' into update_integration_readme
seebees Sep 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 36 additions & 7 deletions modules/integration-browser/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,41 @@
# AWS Encryption SDK for Javascript Browser Integration

This module includes compatibility tests with the other versions of the AWS Encryption SDK.
It's designed to facilitate testing for the set of test vectors of the AWS Encryption SDK.
The test vectors can be found [here] (https://github.com/awslabs/aws-encryption-sdk-test-vectors/tree/a28851a188163e45b8cbf94c1d5a1e67e9622aa8).
This repository is for compatibility tests with the other versions of the AWS Encryption SDKs.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a separate repository or is it a separate folder for the browser tests?

It's purpose is to facilitate testing the set of test vectors the AWS Encryption SDK.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: Its purpose is to test the known-good static test vectors of the AWS Encryption SDK.

The test vectors can be found at https://github.com/awslabs/aws-encryption-sdk-test-vectors.
Manifest information can be found at https://github.com/awslabs/aws-crypto-tools-test-vector-framework.

This package will not add any dependencies in your environment, but it can be used to test the environment.
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).
It uses karma under the hood to run in a browser.

# To test browser compatibility
1. Get a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
1. Use `npm run build_fixtures -- -v path/to/zip` to extract the fixtures from the zip file.
1. Run `npm run karma` to execute the extracted tests.

1. Download a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
1. Select or download both an encrypt manifest list and key manifest from aws-crypto-tools-test-vector-framework.
1. Execute the CLI to run the integration tests for decrypt and encrypt.

## integration-browser is installed as a dependency or globally

### decrypt tests
`integration_browser decrypt -v path/to/test/vectors/zip --karma`

### encrypt tests
`integration_browser encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle" --karma`

## integration-browser has been checked out local

### decrypt tests
`npm run build_fixtures -- decrypt -v path/to/test/vectors/zip --karma`

### encrypt tests
`npm run build_fixtures -- encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle" --karma`

## Test Integration
Just run

```sh
npm test
```

to run the tests.
22 changes: 15 additions & 7 deletions modules/integration-node/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,32 @@
This repository is for compatibility tests with the other versions of the AWS Encryption SDKs.
It's purpose is to facilitate testing the set of test vectors the AWS Encryption SDK.
The test vectors can be found at https://github.com/awslabs/aws-encryption-sdk-test-vectors.
Manifest information can be found at https://github.com/awslabs/aws-crypto-tools-test-vector-framework.

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).
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).

# To test Node.js compatibility

1. Get a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
2. Execute the CLI to run the integration tests.

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

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

`integration_node -v path/to/test/vectors/zip`
### decrypt tests
`integration_node decrypt -v path/to/test/vectors/zip`

### encrypt tests
`integration_node encrypt -m "path/or/url/to/manifest" -k "path/or/url/to/key" -o "url/to/decrypt/oracle"`

## integration-node has been checked out local

`npm run integration_node -- -v path/to/test/vectors/zip`
### decrypt tests
`npm run integration_node -- decrypt -v path/to/test/vectors/zip`

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

## Test Integration
Just run
Expand Down