https://github.com/alphagov/pay-smoke-tests
Smoke tests for GOV.UK Pay
https://github.com/alphagov/pay-smoke-tests
govuk-pay
Last synced: about 1 month ago
JSON representation
Smoke tests for GOV.UK Pay
- Host: GitHub
- URL: https://github.com/alphagov/pay-smoke-tests
- Owner: alphagov
- License: mit
- Created: 2021-03-02T15:50:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T08:47:58.000Z (3 months ago)
- Last Synced: 2025-05-08T22:52:00.349Z (about 1 month ago)
- Topics: govuk-pay
- Language: JavaScript
- Homepage:
- Size: 582 KB
- Stars: 1
- Watchers: 16
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pay-smoke-tests
## GOV.UK Pay's AWS CloudWatch Synthetics Canaries
This repository contains the code used by GOV.UK Pay to run smoke tests against the Pay platform.
They are triggered on a schedule and post application deploy on Concourse.
They are managed via Terraform in which is stored in [pay-infra](https://github.com/alphagov/pay-infra).
The scripts which run the Canaries post application deploy can be found in [pay-ci](https://github.com/alphagov/pay-ci).
## Naming
The AWS Canary resources have a 21-character name limit. The full test name is included
in the resource tags, however here's a quick reference guide:
| Scenario | Environment | Canary name |
|------------------------------------------------|-------------|-----------------------|
| make-card-payment-sandbox-without-3ds | test | card_sandbox_test |
| make-recurring-card-payment-sandbox | test | rec_card_sandbox_test |
| make-card-payment-stripe-with-3ds2 | test | card_stripe_3ds_test |
| make-card-payment-stripe-without-3ds | test | card_stripe_test |
| make-card-payment-worldpay-with-3ds2 | test | card_wpay_3ds2_test |
| make-card-payment-worldpay-with-3ds2-exemption | test | card_wpay_3ds2ex_test |
| make-card-payment-worldpay-without-3ds | test | card_wpay_test |
| make-recurring-card-payment-worldpay | test | reccard_worldpay_test |
| make-recurring-card-payment-stripe | test | rec_card_stripe_test |
| notifications-sandbox | test | notifications_test |
| cancel-card-payment-sandbox-without-3ds | test | cancel_sandbox_test |
| use-payment-link-for-sandbox | test | pymntlnk_sandbox_test |
| make-card-payment-sandbox-without-3ds | staging | card_sandbox_stag |
| make-recurring-card-payment-sandbox | staging | rec_card_sandbox_stag |
| make-card-payment-stripe-with-3ds2 | staging | card_stripe_3ds_stag |
| make-card-payment-stripe-without-3ds | staging | card_stripe_stag |
| make-card-payment-worldpay-with-3ds2 | staging | card_wpay_3ds2_stag |
| make-card-payment-worldpay-with-3ds2-exemption | staging | card_wpay_3ds2ex_stag |
| make-card-payment-worldpay-without-3ds | staging | card_wpay_stag |
| make-recurring-card-payment-worldpay | staging | reccard_worldpay_test |
| make-recurring-card-payment-stripe | staging | rec_card_stripe_stag |
| notifications-sandbox | staging | notifications_stag |
| cancel-card-payment-sandbox-without-3ds | staging | cancel_sandbox_stag |
| use-payment-link-for-sandbox | staging | pymntlnk_sandbox_stag |
| make-card-payment-sandbox-without-3ds | production | card_sandbox_prod |
| make-recurring-card-payment-sandbox | production | rec_card_sandbox_prod |
| make-card-payment-stripe-with-3ds2 | production | card_stripe_3ds_prod |
| make-card-payment-stripe-without-3ds | production | card_stripe_prod |
| make-card-payment-worldpay-with-3ds2 | production | card_wpay_3ds2_prod |
| make-card-payment-worldpay-with-3ds2-exemption | production | card_wpay_3ds2ex_prod |
| make-card-payment-worldpay-without-3ds | production | card_wpay_prod |
| make-recurring-card-payment-worldpay | production | reccard_worldpay_test |
| make-recurring-card-payment-stripe | production | rec_card_stripe_prod |
| notifications-sandbox | production | notifications_prod |
| cancel-card-payment-sandbox-without-3ds | production | cancel_sandbox_prod |
| use-payment-link-for-sandbox | production | pymntlnk_sandbox_prod |
## Structure
### Stubs
AWS uses two libraries `Synthetics` and `SyntheticsLogger`, which appear to only be available inside of the lambda runtime, because of this when running tests locally we need to stub out both of these libraries using Puppeteer. The stubs for these exist in the `stubs` directory in the root of the repository.
### Test Harness
To run the tests locally use the `run-local/index.js` script. Provide the name
of the test you want to run with the `--test` flag. It will print out the valid
test names if none is provided or an invalid name is given. Provide the environment to run the tests for with the '--env' flag.
To run the tests in a headless mode use the `--headless` flag.
Example:
> aws-vault exec deploy -- node run-local/index.js --test make-card-payment-sandbox-without-3ds --env test --headless
### Tests
Each smoke test should have its own folder which should be placed in the root of the repository.
## Building packaged zip files
In the event you need to build packaged zip files of the tests, for example when [adding a new smoke test](https://pay-team-manual.cloudapps.digital/manual/tools/canary.html#adding-a-new-smoke-test), run
```
npm run build
```
The zip files will be located in the `dist/zip` directory.
## Releases
When a PR is merged, a Github Action will build a package and create a release.
The smoke test Canaries can then be updated by a developer using the [Concourse deploy-smoke-tests pipeline](https://pay-cd.deploy.payments.service.gov.uk/teams/pay-deploy/pipelines/deploy-smoke-tests).
## Licence
[MIT License](LICENCE)
## Responsible Disclosure
GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. We will give appropriate credit to those reporting confirmed issues. Please e-mail [email protected] with details of any issue you find, we aim to reply quickly.