Update Playwright to use a custom test fixture with global mocks #2196
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
zackkrida
commented
May 25, 2023
github-actions
bot
added
🧱 stack: documentation
openverse-bot
added
the
🚦 status: awaiting triage
|
Size Change: 0 B Total Size: 846 kB ℹ️ View Unchanged
|
|
Full-stack documentation: https://docs.openverse.org/_preview/2196 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
7 tasks
zackkrida
added
🟨 priority: medium
|
@obulat indeed, there is! I had already written it and forgot to push 🤦 |
zackkrida
commented
Jun 5, 2023
AetherUnbound
previously requested changes
Jun 6, 2023
There was a problem hiding this comment.
Hmm, the eslint rule doesn't appear to be working for me 😮 I made the following change:
diff --git a/frontend/test/storybook/visual-regression/v-select-field.spec.ts b/frontend/test/storybook/visual-regression/v-select-field.spec.ts
index c759c64af..b0265a671 100644
--- a/frontend/test/storybook/visual-regression/v-select-field.spec.ts
+++ b/frontend/test/storybook/visual-regression/v-select-field.spec.ts
@@ -1,6 +1,4 @@
-import { Page, expect } from "@playwright/test"
-
-import { test } from "~~/test/playwright/utils/test-fixture"
+import { Page, expect, test } from "@playwright/test"
import { makeGotoWithArgs } from "~~/test/storybook/utils/args"But just lint eslint is still passing. Is that expected?
|
@AetherUnbound I will look into the eslint rule! It might be that you need to |
|
FWIW I ran |
|
@zackkrida The ESLint rule you added is in the overrides block scoped exclusively to the unit tests (see the |
|
@sarayourfriend, ah, thanks so much! That's definitely it |
|
@AetherUnbound thanks to Sara's excellent suggestion this is ready for review 👍 the rule should definitely work now. Edit: And as a perfect test, there was one replacement of the import I missed, that CI caught with the now-working rule 😄 https://github.com/WordPress/openverse/actions/runs/5194737466/jobs/9366737945?pr=2196 |
sarayourfriend
requested changes
Jun 7, 2023
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
sarayourfriend
approved these changes
Jun 8, 2023
|
LGTM once the tests pass 👍 |
AetherUnbound
approved these changes
Jun 8, 2023
|
Looks like there might be some test flake here 😢 I'll confirm on the next run and create the necessary critical issues. |
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.
Creates a
testfixture which overrides the base Playwright test fixture. This allows for easily setting global route mocks and other settings. Most crucially it removes the thousands of logs cluttering the output about the failed proxying of the analytics server.This PR also makes our provider mocks global and adds a global mock for the analytics event endpoint, to prevent that from outputting hundreds of proxy-related error logs during the run of the test suite.
frontend/test/playwright/utils/test-fixture.tsis the main thing to review here. The rest is just implementations of the new fixture (switching the import from playwright to our custom test fixture).This will be cleaned up and undrafted once #2194 is merged.Testing instructions
import { test } from "@playwright/test"and you should be able to observe a lint error.