Add storage state to rest in e2e tests #38060
Closed
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
kevin940726
added
the
[Type] Automated Testing
|
Size Change: +6.45 kB (+1%) Total Size: 1.14 MB
ℹ️ View Unchanged
|
talldan
reviewed
Jan 20, 2022
13 tasks
|
I tried running the tests locally on this branch, but it's not working for me (at least, the file wasn't generated) |
8 tasks
|
This is now implemented and made obsolete by #38570. |
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.
Description
Inspired by the
storageStateAPI in Playwright, This PR refactors the usage of therestAPI in e2e tests.restandbatchare experimental APIs ine2e-test-utilsto do server-side fetching to speed up the performance of cleaning and setting test states in e2e testing. They have already been used in navigation and widgets tests. Simply said,restcalls the WordPress REST API viaapiFetchon the server-side. To do this, it has to first authenticate using the admin user permission to perform most of the operations. However, every test suite in Jest is a separated context, so before this PR, we have to authenticate again in every test suite.This PR authenticates once during
globalSetupand saves the login state (cookie, nonce, etc) to disk. Then, each test suite can just grab the state from disk without sending the network request. This process is heavily inspired by the similar approach in Playwright.This PR also refactors the implementation to better handle some edge cases (auto re-authentication, getting max batch size, etc).
I can't decide where to put the state file though. Currently, it's placed at
test/integration/storage-state/admin.json, I doubt that it's the best place to store that though.How has this been tested?
Running
npm run test-e2eshould generate a file attest/integration/storage-path/admin.jsonto store the test state (cookie,nonce,rootURL).Types of changes
New feature
Checklist:
*.native.jsfiles for terms that need renaming or removal).