HMRC Check Credential Issuer API
These tests run against API Gateway in AWS. To run these tests the following environment variables are needed:
- STACK_NAME
- AWS_REGION
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_SESSION_TOKEN
Temporary credentials can be found by going to the AWS start page, selecting the account and clicking
Access Keys and clicking the copy next to Option 1: Set AWS environment variables to authenticate the correct account.
Then run the command:
AWS_PROFILE=YourProfileName npm run test:api --workspace integration-tests
This will run all tests in the api-gateway directory.
Where YourProfileName is your aws sso profile, created against the Check Hmrc CRI AWS Account
When deploying using sam deploy, canary deployment strategy will be used which is set by the LambdaDeploymentPreference in template.yaml file.
When deploying using the pipeline, canary deployment strategy set in the pipeline will be used and override the default set in template.yaml.
Canary deployments will cause a rollback if any canary alarms associated with a lambda are triggered and a slack notification will be sent to #di-orange-warnings-non-prod or #di-orange-warning-alerts-prod.
To skip canaries such as when releasing urgent changes to production, set the last commit message to contain either of these phrases: [skip canary], [canary skip], or [no canary] as specified in the Canary Escape Hatch guide.
git commit -m "some message [skip canary]"
Note: To update LambdaDeploymentPreference, update the LambdaCanaryDeployment pipeline parameter in the identity-common-infra repository. To update the LambdaDeploymentPreference for a stack in dev using sam deploy, parameter override needs to be set in the deploy script:
--parameter-overrides LambdaDeploymentPreference=<define-strategy> \