Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
petrkalos committed Jul 5, 2024
1 parent 65f930a commit 4cf42e8
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions tests_new/integration_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

The purpose of these tests is to automatically validate functionalities of data.all on a real deployment.

🚨🚨🚨

Currently **we support only Cognito based deployments** but support for any IdP is on the plans

🚨🚨🚨

## Pre-requisites

- A real deployment of data.all in AWS
Expand Down Expand Up @@ -57,32 +63,25 @@ The purpose of these tests is to automatically validate functionalities of data.
}
}
```
- If you are not using Cognito then you must manually create the users/groups
- If you are using Cognito the pipeline will create the users/groups
- The pipeline will create the users/groups
## Run tests
The tests are executed in CodeBuild as part of the CICD pipeline if the cdk.json parameter `with_approval_tests` is set
to True.
But you can also run the tests locally with deployment account credentials:
```bash
export ENVNAME = "Introduce deployment environment name"
export AWS_REGION = "Introduce backend region"
make integration-tests
```
You can also run the tests locally by...
or run the tests locally without credentials
* Authenticating to your data.all environment account (you might want to set the `AWS_PROFILE` env variable)
```bash
export ENVNAME = "Introduce deployment environment name"
export AWS_REGION = "Introduce backend region"
export COGNITO_CLIENT = "Introduce Cognito client id"
export API_ENDPOINT = "Introduce API endpoint url"
echo "add your testdata here" > testdata.json
make integration-tests
```
* ```bash
export ENVNAME = "Introduce deployment environment name"
export AWS_REGION = "Introduce backend region"
export COGNITO_CLIENT = "Introduce Cognito client id"
export API_ENDPOINT = "Introduce API endpoint url"
echo "add your testdata here" > testdata.json
make integration-tests
```

## Coverage

Expand Down

0 comments on commit 4cf42e8

Please sign in to comment.