Skip to content

NEW e2e environment using playground cli #810

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.

Sign up for GitHub

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

Jump to bottom
Closed
carstingaxion wants to merge 108 commits into from
Closed

NEW e2e environment using playground cli #810

carstingaxion wants to merge 108 commits into from

Conversation

@carstingaxion
Copy link
Collaborator

@carstingaxion carstingaxion commented Aug 17, 2024 •
edited
Loading

This PR allows GatherPress to run automated & manual end-to-end tests, while sharing the same, wp-playground/cli powered, setup. The started playground imports the GatherPress/demo-data, that can be used instead of mocks or fixtures (for now).

NEEDED nice-to-have, before merge

Closes #693

How to test the Change

  1. Checkout this PR locally
  2. Follow the before mentioned installation instructions
  3. Run Playwright by one of the 4 given options, try npm run test:e2e for example

Changelog Entry

Changed environment for e2e-tests to run on wp-playground/cli

Credits

Props @carstingaxion, @WunderBart

Checklist:

@carstingaxion
Install needed packages & setup new e2e scripts
de23420
@carstingaxion
REMOVE special port settings for wp-env (which may be a problem, I'm …
493c9aa 
…not seeing yet)
@carstingaxion
Add configuration files to run Playwright tests
c38da61
@carstingaxion
Update Github workflow to use wp-env for e2e tests
673e566
@carstingaxion
Rename folder with tests
e20f215 
(which is a bit weird, because the playwright.config.ts setting is ignored and the folder needs to be re-named to 'tests' to make tests be found at all)
@carstingaxion
NEW (WIP) e2e-tests utilising the wordpress/e2e-test-utils-playwright…
1ed3bd1 
… package
@carstingaxion
Fix script name to start wp-env
da4fe13
@carstingaxion
Add basic dev-documentation about e2e-tests
6a4ea6f
@carstingaxion
Run BUILD before Playwright tests
9477ecc
@carstingaxion
DO NOT MERGE // FOR DEBUGGING ONLY // simple Gutenberg paragraph bloc…
94d99f6 
…k test
@carstingaxion
Remove custom globalSetup & env vars in favor of Gutenbergs defaults
eb8dbdc
@carstingaxion
TRY: Disable blank mappings for themes & plugins in wp-env
a888cc2 
TRICKY: Enabled mapping leads to 404 for build blocks, Disabled mapping helps gatherpress blocks, but make the simple paragraph test fail (copied for debugging from gutenberg)
@carstingaxion
Add caching to the Playwright browser download step
ee9544c
@carstingaxion
Creating a short lived node_modules cache to be used by multiple accr…
d1b3b3a 
…oss one Github actions workflow attempt.
@carstingaxion
DISABLED TEMPORARY // REVERT BEFORE MERGE // to make debugging easier
308ca4e
@carstingaxion
Fix the artifacts upload on CI, to get traces and screenshots from fa…
9cd89ad 
…iled attempts (suggested at GatherPress#776 (comment) by @swissspidy)
@carstingaxion
Update actions/checkout to v4
ea0739d
@carstingaxion
Run npm install, only when really needed
6f2c8f5
@carstingaxion
Remove steps, that are being done via npm pre-script runs
f3c6ad4
@carstingaxion
Cleanup
b7fad4b
@carstingaxion
Move doc into contributor folder
421c3b0
@carstingaxion
Rename scripts to align with screenshot-workflow
ed4ff96
@carstingaxion
Remove debug stuff
cb6e65b
@carstingaxion
Clean up
c7dae87
@carstingaxion
Re-Enable 'publish event through admin side' (WIP)
345fd9e
@carstingaxion
Resolve merge conflicts
cab2d14
@carstingaxion
Re-Add test:e2e scripts
d8e59a0
@carstingaxion
Merge branch 'main' into feature/e2e-tests-workflow
158a7ef
@carstingaxion
Fix indention
082f6c5
@carstingaxion
Lint JS
eb7125d
@carstingaxion
Copy link
Collaborator Author

carstingaxion commented Sep 25, 2024

Wow!
Thank you very much for your detailed review @WunderBart !

Given that we never ever had any contact and that I was working just yesterday evening on this stuck PR, I do call this a great community moment!

I absolutely appreciate you flying by and taking the time, thank you very much!

@WunderBart
Copy link

WunderBart commented Sep 25, 2024 •
edited
Loading

Wow! Thank you very much for your detailed review @WunderBart !

Given that we never ever had any contact and that I was working just yesterday evening on this stuck PR, I do call this a great community moment!

I absolutely appreciate you flying by and taking the time, thank you very much!

Happy to help, @carstingaxion! I did spend a lot of time with Playwright so please don't hesitate to ping me anytime! 🙌 😄

BTW, I noticed a lot of increased timeouts for the actions (mostly clicks) in this PR. Is it because the app is responding slowly? Maybe we could come up with some pre-test solution for that, or configure (action) timeouts globally.

@carstingaxion
Simplify test by relying on Playwrights actionability checks (auto-wa…
5f986d9 
…iting), including visibility and enabled state
@carstingaxion
Simplify test because the getByRole locator supports expanded selector
50f84b6
@carstingaxion
Replace isVisible() with expect( ... ).toBeVisible(), as per the sugg…
569c7c8 
…estion by @WunderBart
@carstingaxion
The "$" method is discouraged, Locator should be used
08d3b13
@carstingaxion
The URL attribute should be asserted via the toHaveAttribute locator …
9719773 
…assertion so that it's properly awaited
@carstingaxion
Disable "Merge Artifacts" step
442e6cb
@carstingaxion
Update workflow echo
917f485
@carstingaxion
Fix test: A logged in user can perform RSVP action (which failed in TT5)
439a794
@carstingaxion
Clean up
6bb65de
@carstingaxion
Clean up
7574542
@carstingaxion
Fix test: By re-enabling force click
d7e8c3f
@carstingaxion
WIP event tests
b087736
@carstingaxion
Run for different WP versions
a1f8574
@carstingaxion
Fix for CS
d46fc40
@carstingaxion
Remove comma
fd0cd22
@carstingaxion
Reduce WP-version matrix to "minimum required"
3e4c8de
@carstingaxion
Login step can be removed (because its part of importWxr)
d23bfea
@carstingaxion
TRY test for non-logged-in users (FAILED)
079cfd2
@carstingaxion
Clean up
c414abe
@carstingaxion
Splitting the problematic test into smaller pieces
602d590
@carstingaxion
wp-scripts package-update
66aa030
@carstingaxion
BUILD
f8d255c
@carstingaxion
Merge branch 'main' into feature/e2e-tests-workflow-wp-now
5a4b97f
@github-actions
Copy link
Contributor

github-actions bot commented Oct 7, 2024

Preview changes with Playground

You can preview the recent changes for PR#810 with the following PHP versions:

PHP Version 8.3

PHP Version 7.4

Download .zip with build changes

Made with 💙 from GatherPress & a little bit of WordPress Playground. Changes will not persist between sessions.

@adamziel
Copy link

adamziel commented Oct 8, 2024

Also looping in @swissspidy who might find this work interesting

@mauteri mauteri changed the base branch from main to develop October 10, 2024 13:00
@mauteri
Copy link
Contributor

mauteri commented Dec 6, 2025

Instead of playground, I had a lot more success running the E2E tests with wp-env. #1173

Going to close this now that the environment issue is resolved and we can focus on writing E2E tests that run successfully locally and in the CI.

@mauteri mauteri closed this Dec 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MervinHernandez MervinHernandez Awaiting requested review from MervinHernandez

@prashantabellad prashantabellad Awaiting requested review from prashantabellad

@01Prayag 01Prayag Awaiting requested review from 01Prayag

1 more reviewer

@WunderBart WunderBart WunderBart left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

help wanted Extra attention is needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

DEBUG End-End Testing

4 participants

@carstingaxion @adamziel @WunderBart @mauteri