Docs: add a PW testing style guide #507
Draft
Conversation
This file contains hidden or 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
marusak
reviewed
Apr 15, 2025
| 3. **Test IDs** (for hard to locate elements) | ||
|
|
||
| ```typescript | ||
| page.locator('data-testid=submit-button'); |
There was a problem hiding this comment.
This is not how you would use it - you can use 'GetByTestId`
swadeley
reviewed
Apr 15, 2025
| If you are heavily interacting with your API, or writing API tests, consider using an openapi generator to generate the API client and a fixture to set up the API client for all tests that need it. | ||
|
|
||
| ## Test Structure 🏗 | ||
| Recommended folder/file structure, this will make it easier to run multiple test suites and once and share helpers/fixtures if desired. |
There was a problem hiding this comment.
Suggested change
| Recommended folder/file structure, this will make it easier to run multiple test suites and once and share helpers/fixtures if desired. | |
| Recommended folder/file structure, this will make it easier to run multiple test suites at once and share helpers/fixtures if desired. |
| 3. **Test IDs** (for hard to locate elements) | ||
|
|
||
| ```typescript | ||
| page.locator('data-testid=submit-button'); |
There was a problem hiding this comment.
I like this example, but tests ids have a few ways to get them.
This locator should be highlighted to target specific element variables.
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
This adds a style guide for writing Playwright tests. 💅🏼