Spec: Provide a starter for end-to-end testing

[sawyerh]

What's the task?

End-to-end (E2E) test suites are common across our projects, but no templates currently provide this functionality. Let's spec out what it might look like for Platform to provide some support to teams setting up an end-to-end test suite. There are a number of open questions, such as what repo the E2E code should live within and how the tests would run.

References

Some existing references from prior projects

• WIC PRP
• 🔒 MA PFML

Resources

• 🔒 Tech Spec Template
• 🔒 Example Platform spec

[jcq]

The other thing to consider is that we can do "E2E" testing of sorts with just the FE/NextJS code. For instance, we can't fully test the language-switching functionality in a component unit test, as the actual switch of the locale requires the execution of the related middleware. We could cover this use case w/ something like Playwright tests (see example).

[sbolel]

@jcq Playwright is a great option! Happy to help if going down that route is deemed appropriate and feasible.

[rocketnova]

@sawyerh I asked Sasha to build out Playwright e2e testing into the Remix template we made for the WIC PRP project. I think there's a ton of reusable work there: https://github.com/navapbc/remix-shoegaze-stack

[kniedermaier]

I've written up a 🔒 Tech Spec that addresses many of this issue's open questions. Thanks to @sawyerh for weighing in on that document. Its current status is "ready for review", so feedback is entirely welcome.

[sawyerh]

navapbc/platform#22