Feat/scaffold UI test user on demand

[andrewleith]

Summary | Résumé

API Changes

This PR adds a new API endpoint, secured by the admin_auth mechanism, at /cypress:

• /cypress/create_user/<email_name>
• /cypress/cleanup

At the start of each UI test session, both methods will be called:

• /create_user will be called to generate a unique set of accounts (regular + platform admin) for the test run.
• /cleanup will be called to remove any test accounts older than 3 hours

Note: these endpoints will be blocked from running in PROD in code, as well as by the WAF.

/create_user

• Adds 2 new UI test accounts aliases using our UI test account as a base, [email protected]
• Accounts are of the form:
  • regular account: [email protected]
  • platform admin: [email protected]

/cleanup

• Loops through all accounts with the UI testing prefix (notify-ui-tests+ag_) that are older than 3 hours and removes them and their related entities.

Migration

This PR also adds a migration to create the a base UI test service and user that will be used for all tests, and introduces some new config variables to keep track of these:

• CYPRESS_SERVICE_ID: ID of the cypress service used in UI tests
• CYPRESS_TEST_USER_ID: ID of the base cypress ui test user (this will not get removed between tests)
• CYPRESS_TEST_USER_ADMIN_ID: ID of the base cypress ui platform admin test user (this will not get removed between tests)
• CYPRESS_SMOKE_TEST_EMAIL_TEMPLATE_ID: ID of base email template used in tests
• CYPRESS_SMOKE_TEST_SMS_TEMPLATE_ID: ID of base SMS template used in tests
• CYPRESS_USER_PW_SECRET: password of generated UI test users

Related Issues | Cartes liées

Test instructions | Instructions pour tester la modification

TODO: Fill in test instructions for the reviewer.

Release Instructions | Instructions pour le déploiement

None.

Reviewer checklist | Liste de vérification du réviseur

• This PR does not break existing functionality.
• This PR does not violate GCNotify's privacy policies.
• This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive.
• This PR does not significantly alter performance.
• Additional required documentation resulting of these changes is covered (such as the README, setup instructions, a related ADR or the technical documentation).

⚠ If boxes cannot be checked off before merging the PR, they should be moved to the "Release Instructions" section with appropriate steps required to verify before release. For example, changes to celery code may require tests on staging to verify that performance has not been affected.

[whabanks]

Love this addition + the Cypress auth, I'll be sure to move the utility method from that PR in here too!

[whabanks]

LGTM, exciting changes!