From bcbd35525db5eb8919961a9060ab2c6ce17b6a66 Mon Sep 17 00:00:00 2001 From: Allain Magyar Date: Tue, 17 Sep 2024 09:01:18 -0300 Subject: [PATCH] chore: update e2e readme (#286) Signed-off-by: Allain Magyar --- integration-tests/e2e-tests/README.md | 41 +++++++++++++++++++++++---- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/integration-tests/e2e-tests/README.md b/integration-tests/e2e-tests/README.md index 19bd67e7f..1da9d1e82 100644 --- a/integration-tests/e2e-tests/README.md +++ b/integration-tests/e2e-tests/README.md @@ -1,6 +1,10 @@ # Wallet SDK - Typescript E2E -How to use +## How to run + +This guide shows you how to run the end-to-end tests + +### Setting up the environment variables - Copy `.env.example` to `.env` - Fill the required properties @@ -9,7 +13,34 @@ How to use | ------------------------ | ----------------------------------------------------------- | | MEDIATOR_OOB_URL | URL that returns the OOB url | | AGENT_URL | URL for Cloud Agent - should end with a forward slash ("/") | -| APIKEY | Apikey authentication | -| PUBLISHED_DID | Existing DID | -| JWT_SCHEMA_GUID | Existing jwt schema guid | -| ANONCRED_DEFINITION_GUID | Existing anoncred definition guid | +| APIKEY | (Optional) Apikey authentication | +| PUBLISHED_DID | (Optional) Existing DID | +| JWT_SCHEMA_GUID | (Optional) Existing jwt schema guid | +| ANONCRED_DEFINITION_GUID | (Optional) Existing anoncred definition guid | + +### Compile the SDK + +To test the changes you'll need to build the SDK. Refer to [README](/../../README.md#building-from-source) for +further instructions. + +### Installing dependencies + +```bash +yarn install +``` + +### Running the tests + +To run the full end-to-end regression test suite + +```bash +yarn test:sdk +``` + +To run a specific tagged scenario + +```bash +yarn test:sdk --tags "@mytag and @anothertag" +``` + +After the execution is done, it will generate the report inside the `target` folder. \ No newline at end of file