Commit 305b7403 authored by Daniel Scholl's avatar Daniel Scholl
Browse files

Readme Updated

parent 90f7a312
Pipeline #9647 failed with stage
in 7 seconds
......@@ -41,6 +41,20 @@ az keyvault secret show --vault-name $KEY_VAULT_NAME --name $KEY_VAULT_SECRET_NA
**Required to run integration tests**
| name | value | description | sensitive? | source |
| --- | --- | --- | --- | --- |
| `AZURE_AD_TENANT_ID` | `********` | AD tenant to authenticate users from | yes | -- |
| `INTEGRATION_TESTER` | `********` | System identity to assume for API calls. Note: this user must have entitlements configured already | no | -- |
| `AZURE_TESTER_SERVICEPRINCIPAL_SECRET` | `********` | Secret for `$INTEGRATION_TESTER` | yes | -- |
| `AZURE_AD_APP_RESOURCE_ID` | `********` | AAD client application ID | yes | output of infrastructure deployment |
| `AZURE_AD_OTHER_APP_RESOURCE_ID` | `********` | AAD client application ID for another application | yes | -- |
| `NO_DATA_ACCESS_TESTER` | `********` | Service principal ID of a service principal without entitlements | yes | `aad-no-data-access-tester-client-id` secret from keyvault |
| `NO_DATA_ACCESS_TESTER_SERVICEPRINCIPAL_SECRET` | `********` | Secret for `$NO_DATA_ACCESS_TESTER` | yes | `aad-no-data-access-tester-secret` secret from keyvault |
### Configure Maven
Check that maven is installed:
......@@ -72,6 +86,25 @@ $ java -jar $(find provider/partition-azure/target/ -name '*-spring-boot.jar')
```
### Test the application
After the service has started it should be accessible via a web browser by visiting [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html). If the request does not fail, you can then run the integration tests.
```bash
# build + install integration test core
$ (cd testing/partition-test-core/ && mvn clean install)
# build + run Azure integration tests.
#
# Note: this assumes that the environment variables for integration tests as outlined
# above are already exported in your environment.
$ (cd testing/partition-test-azure/ && mvn clean test)
```
A liveness check can also be performed at `http://localhost:8080/_ah/liveness_check`.
### Test the application
After the service has started it should be accessible via a web browser by visiting [http://localhost:8080/api/partition/v1/swagger-ui.html](http://localhost:8080/api/partition/v1/swagger-ui.html). If the request does not fail, you can then run the integration tests.
......@@ -79,13 +112,13 @@ After the service has started it should be accessible via a web browser by visit
see [instructions](../../testing/README.md) on how to run integration tests locally. In addition to common testing environment variables, the `partition-test-azure` module also needs additional environment variables, which are described below:
```
AZURE_AD_TENANT_ID (azure tenant id)
INTEGRATION_TESTER (app-dev-sp-username)
TESTER_SERVICEPRINCIPAL_SECRET (app-dev-sp-password)
NO_DATA_ACCESS_TESTER (aad-no-data-access-tester-client-id)
NO_DATA_ACCESS_TESTER_SERVICEPRINCIPAL_SECRET (aad-no-data-access-tester-secret)
AZURE_AD_TENANT_ID (azure tenant id)
AZURE_AD_APP_RESOURCE_ID (aad-client-id)
AZURE_AD_OTHER_APP_RESOURCE_ID (AD Application ID used for negative testing)
NO_DATA_ACCESS_TESTER (aad-no-data-access-tester-client-id)
NO_DATA_ACCESS_TESTER_SERVICEPRINCIPAL_SECRET (aad-no-data-access-tester-secret)
```
A liveness check can also be performed at `http://localhost:8080/api/partition/v1/_ah/liveness_check`. Other apis can be found on the swagger page
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment