POC: Investigate test automation approach for onboarding

[gfou-al]

User Story

While onboarding the xhibit portal application, we discovered some issues which we resolved on the spot and reported couple of other non-blocking issues:

• https://github.com/ministryofjustice/modernisation-platform/issues/1166
• https://github.com/ministryofjustice/modernisation-platform/issues/1165

The onboarding is fairly automated and works well, however, we keep discovering issues every time.

Therefore, investigating a test automation approach might be worthwhile.

Some concerns are that our automation is heavily relied on external APIs, such as the GitHub API and the AWS API, and terraform automation.

Is there a way to mock out those APIs in order to unit test our bash scripts? Is there a good practice to test terraform?

As part of this exercise, it would be worth looking at existing tools and coming up with a minimal example of how we could potentially test our onboarding automation.

Value

Questions / Assumptions

Definition of done

• [ ] readme has been updated
• [ ] user docs have been updated
• [ ] another team member has reviewed
• [ ] tests are green

Reference

How to write good user stories