From 4cf42e881ef40afab9b1fbe5cc93146bb645ac3d Mon Sep 17 00:00:00 2001 From: Petros Kalos Date: Fri, 5 Jul 2024 15:19:34 +0300 Subject: [PATCH] improve docs --- tests_new/integration_tests/README.md | 35 +++++++++++++-------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/tests_new/integration_tests/README.md b/tests_new/integration_tests/README.md index ef8b1fd1e..9bb9f5575 100644 --- a/tests_new/integration_tests/README.md +++ b/tests_new/integration_tests/README.md @@ -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 @@ -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