Skip to content

Build: add a PW testing style guide #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2025

Conversation

dominikvagner
Copy link
Contributor

@dominikvagner dominikvagner commented Apr 15, 2025

Summary

This adds a style guide for writing Playwright tests. 💅🏼

@dominikvagner dominikvagner added the sourcery-review This will instruct an AI reviewer (sourcery.ai) to review this PR. label Jun 19, 2025
@dominikvagner dominikvagner marked this pull request as ready for review June 19, 2025 13:23
Copy link

sourcery-ai bot commented Jun 19, 2025

Reviewer's Guide

This PR adds a comprehensive Markdown-based Playwright testing style guide under _playwright-tests/style_guide.md, standardizing best practices, test structure, selectors, assertions, debugging workflows, and known caveats.

File-Level Changes

Change Details Files
Add Playwright style guide documentation
  • Create new style_guide.md file in _playwright-tests
  • Populate with purpose, TOC, and introduction tip
_playwright-tests/style_guide.md
Define best practices for Playwright tests
  • Enumerate guidelines on isolation, idempotency, parallelization, and built-in capture features
  • Advise minimal abstractions, selective helpers/fixtures, and clear test descriptions
_playwright-tests/style_guide.md
Establish recommended test structure
  • Describe folder/file hierarchy for utils, UI, and integration tests
  • Provide example TypeScript spec with beforeEach, test.step, and imports
_playwright-tests/style_guide.md
Outline selector strategy preferences
  • Rank selectors: roles, text, test IDs, CSS, and discourage XPath and style-dependent locators
  • Include code examples for each primary strategy
_playwright-tests/style_guide.md
Document assertion patterns
  • Recommend Playwright web-first assertions (toBeVisible, toHaveText, etc.)
  • Show polling and promise patterns for non-DOM checks
_playwright-tests/style_guide.md
Detail debugging techniques
  • Cover Playwright Inspector (--debug), trace viewer config, and page.pause()
  • Mention VS Code extension for live debugging
_playwright-tests/style_guide.md
Highlight caveats and workarounds
  • Warn about modal/dialog interaction issues and provide locator workaround
  • Note flaky navigation scenarios and suggest retry logic
_playwright-tests/style_guide.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @dominikvagner - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @dominikvagner - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@dominikvagner dominikvagner changed the title Docs: add a PW testing style guide Build: add a PW testing style guide Jun 19, 2025
Copy link
Member

@marusak marusak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add one more good practice - don't use sleep. If you need to wait for something, define it same way as user would wait for it. Sleeps make tests flaky and/or slow.

Copy link
Member

@marusak marusak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@dominikvagner dominikvagner merged commit 213412b into content-services:main Jun 24, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sourcery-review This will instruct an AI reviewer (sourcery.ai) to review this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants