feat: adds E2E tests for the frontend static site and runs them as part of CI #1392
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kniedermaier
requested review from
andycochran,
acouch,
SammySteiner,
aplybeah and
chouinar
as code owners
github-actions
bot
added
documentation
github-actions
bot
added
the
documentation
kniedermaier
commented
Mar 4, 2024
rylew1
reviewed
Mar 5, 2024
| /test-results/ | ||
| /playwright-report/ | ||
| /blob-report/ | ||
| /playwright/.cache/ |
rylew1
reviewed
Mar 5, 2024
| 2. Follow the [instructions](https://playwright.dev/docs/getting-started-vscode#running-tests) Playwright provides | ||
|
|
||
| In CI, the "Front-end Checks" workflow (`.github/workflows/ci-frontend.yml`) summary will include an "Artifacts" section where there is an attached "playwright-report". [Playwright docs](https://playwright.dev/docs/ci-intro#html-report) describe how to view HTML Report in more detail. | ||
|
|
There was a problem hiding this comment.
Would it make sense to document what we're trying to test here - the entire flow with mock db data? How does it differ from the jest unit tests we write?
There was a problem hiding this comment.
How it's set up now is a proof-of-concept with tests for published pages that mirror the jest ones. Once more features like /search are built out, I would argue that another workflow specifically for E2E tests is going to be necessary because "Front-end Checks" workflow isn't currently spinning up the rest of the application.
I'm happy to take that on as part of this PR if that corresponds to how others are reasoning about the purpose of this test suite.
acouch
reviewed
Mar 7, 2024
acouch
reviewed
Mar 7, 2024
acouch
approved these changes
Mar 7, 2024
Co-authored-by: Aaron Couch <acinternets@gmail.com>
acouch
approved these changes
Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
(To add ticket)
Time to review: 20 mins
Changes proposed
@playwright/testas a dev dependencyContext for reviewers
The playwright config added in this PR is largely based on the default provided by running
npm init playwright@latest. The options run the gambit for customizing the configuration. For instance, it's possible to add tracing artifacts (e.g. screenshots or videos) when tests fail during CI.To run via command line:
npm run test:e2eInstructions on using the VS Code extension: https://playwright.dev/docs/getting-started-vscode
Additional information
Running
npm run test:e2e:uiwill result in opening up the Playwright UI, which looks like this: