From 46b4ab6389b56e9c1794533e03153bfb069d0367 Mon Sep 17 00:00:00 2001
From: Allain Magyar <allain.magyar@iohk.io>
Date: Mon, 9 Sep 2024 21:55:31 -0300
Subject: [PATCH] chore: update e2e test readme

Signed-off-by: Allain Magyar <allain.magyar@iohk.io>
---
 tests/end-to-end/README.md | 41 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/tests/end-to-end/README.md b/tests/end-to-end/README.md
index b03ae0c45..6bd6dc362 100644
--- a/tests/end-to-end/README.md
+++ b/tests/end-to-end/README.md
@@ -1,6 +1,6 @@
 # End-to-end tests
 
-## Preparation
+## Setting up the environment variables
 
 Duplicate `local.properties.example` file from `test/resources` and rename the copy to `local.properties`
 
@@ -15,3 +15,42 @@ Setup properties:
 | ANONCRED_DEFINITION_GUID | Existing Anoncred definition guid  |
 | APIKEY                   | APIKEY header token authentication |
 
+## Running the end-to-end tests
+
+### Building the SDK
+
+In the command line navigate to the SDK directory 
+
+1. Set the `ATALA_GITHUB_ACTOR` environment variable with your GitHub email
+2. Set `ATALA_GITHUB_TOKEN` environment variable with your GitHub token 
+3. Comment out the `signing` part of the `build.gradle.kts`
+4. Change the version in `gradle.properties` to something else
+5. Run the following command
+
+```bash
+./gradlew publishToMavenLocal
+```
+
+### Update the SDK dependency in e2e test
+
+Now, in the `build.gradle.kts` file inside the `e2e tests` directory you'll have to update
+the version of the sdk with  the new one you published to your maven local
+
+E.g.
+```kotlin
+testImplementation("org.hyperledger.identus:edge-agent-sdk:1.2.3-MY-CHANGE")
+```
+
+### Running the tests
+
+Full regression
+
+```bash
+./gradlew test --tests "org.hyperledger.identus.walletsdk.TestSuite"
+```
+
+Tagged scenario
+
+```bash
+./gradlew test --tests "org.hyperledger.identus.walletsdk.TestSuite" -Dcucumber.filter.tags="@mytag and @anothertag"
+```