nhs-notify-supplier-api/.env.template at main · NHSDigital/nhs-notify-supplier-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Your github Personal Access Token (PAT)
PR_NUMBER=prxx # remove if needs to run against main
GITHUB_TOKEN=

# Apigee proxy name to be used for test execution
# nhs-notify-supplier--internal-dev--nhs-notify-supplier-PR-xxx
PROXY_NAME=

# APIM env to run e2e tests against, other options are: ref, int, prod
API_ENVIRONMENT=internal-dev

# Used for component and e2e tests
# Account group controls default account id mapping for tests.
# If omitted, tests default to dev:
# TARGET_ACCOUNT_GROUP=nhs-notify-supplier-api-dev
# Mapping used by tests:
# nhs-notify-supplier-api-dev -> 820178564574
# nhs-notify-supplier-api-nonprod -> 885964308133
# nhs-notify-supplier-api-prod -> blocked (tests are intentionally disabled for prod)
TARGET_ACCOUNT_GROUP=nhs-notify-supplier-api-dev

# Resource namespace used to resolve AWS resource names for tests (main, pr123)
# remove if needs to run against main
TARGET_ENVIRONMENT=prxx

# API Keys
# ========
# In order to find out and set the value of NON_PROD_API_KEY follow these steps
# 1. Log in to the AWS NHS Notify Suppliers Dev account
# 2. Open the paramenter store and search for the parameter /dev/e2e/keys/apim/pr (this key will use the supplier Supplier1)
#    a. to use the supplier TestSupplier1, search for the parameter /dev/e2e/keys/apim/pr/secondary
#       NOTE: this needs to be set to the NON_PROD_SECONDARY_API_KEY environment variable
#    b. If you want to run against main, search for the parameter /dev/e2e/keys/apim/main
# 3. Copy the decrypted "value"
# Note: For INT and higher environments use developer portal https://identity.prod.api.platform.nhs.uk/
export NON_PROD_API_KEY=xxx
export NON_PROD_SECONDARY_API_KEY=xxx
export INTEGRATION_API_KEY=xxx
export INTEGRATION_SECONDARY_API_KEY=xxx
export PRODUCTION_API_KEY=xxx
export PRODUCTION_SECONDARY_API_KEY=xxx

# Status Endpoint API Key
# In order to find the value of the status endpoint API key, follow these steps:
# 1. Log in to the AWS NHS Notify Suppliers Dev account
# 2. Open the paramenter store and search for the parameter /dev/e2e/keys/apim/status
# 3. Copy the decrypted "value"
export STATUS_ENDPOINT_API_KEY=xxx

# Private Keys
# ============
# In order to set the NON_PROD_PRIVATE_KEY, follow these steps:
# 1. Log in to the AWS NHS Notify Suppliers Dev account
# 2. Open the paramenter store and search for the parameter /dev/e2e/keys/private
# 3. Copy the decrypted "value"
# 4. Create a .pem file and paste the value copied in step 3,
#    save the file and provide the path to the file as the value for NON_PROD_PRIVATE_KEY
#    for example /workspaces/nhs-notify-supplier-api/scripts/JWT/internal-dev-test-1.pem
# private key path used to generate authentication for tests ran against the internal-dev and internal-qa
export NON_PROD_PRIVATE_KEY=xxx
# private key path used to generate authentication for tests ran against the int environment
export INTEGRATION_PRIVATE_KEY=xxx
# private key path used to generate authentication for tests ran against the prod environment
export PRODUCTION_PRIVATE_KEY=xxx