Smokey is a suite of Cucumber tests that probe GOV.UK
frontend and backend publishing functionality. The tests use Selenium to
automate a headless Chrome browser.
Smokey is run automatically:
- every few minutes via a cronjob
- by the deployment
automation
to determine whether to promote a release to the next environment (staging,
production)
You can also start a Smokey run from Argo CD. Click the three
dots in the ‘smokey’ cronjob and choose ‘Create Job’. It can take a few seconds
for the job to appear.
Each test should check that a critical area of GOV.UK is working as expected.
See the guidance on what tests belong here and how to write new
ones.
Technical documentation
You can use the GOV.UK Docker
environment to run the application
and its tests with all the necessary dependencies. Follow the usage
instructions to get started.
Use GOV.UK Docker to run any commands that follow.
Run the test suite from your machine
You will need to be connected to the VPN to test against Integration or
Staging.
The tests require additional configuration to run successfully on a local
machine.
env \
ENVIRONMENT=integration \
SIGNON_EMAIL="<email-address>" \
SIGNON_PASSWORD="<password>" \
bundle exec cucumber
You can use the following environment variables to configure the tests:
-
ENVIRONMENT: controls domains returned by
Plek (see
env.rb)
-
SIGNON_EMAIL: email of a Signon user in $ENVIRONMENT
-
SIGNON_PASSWORD: password of a Signon user in $ENVIRONMENT
-
RATE_LIMIT_TOKEN: (optional) a token used to bypass rate limiting if present on apps.
Smokey cannot use a Signon account which has multi-factor authentication
enabled.
To test against integration/staging from your machine, you can fetch
the Signon credentials for the Smokey test user:
k get secret smokey-signon-account -oyaml | yq .data.password | base64 -d
k get secret smokey-signon-account -oyaml | yq .data.email | base64 -d
Further documentation
Licence
MIT License