Skip to content

Commit

Permalink
chore: update e2e readme (#286)
Browse files Browse the repository at this point in the history
Signed-off-by: Allain Magyar <allain.magyar@iohk.io>
  • Loading branch information
amagyar-iohk committed Sep 17, 2024
1 parent 02430db commit bcbd355
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions integration-tests/e2e-tests/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

1 comment on commit bcbd355

@github-actions
Copy link

Choose a reason for hiding this comment

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

Lines Statements Branches Functions
Coverage: 77%
78.11% (3430/4391) 67.2% (1508/2244) 81.73% (828/1013)

Please sign in to comment.