Skip to content
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

[e2e tests] Fix command pallete test failing with Gutenberg active #45121

Merged
merged 8 commits into from Feb 26, 2024

Conversation

adimoldovan
Copy link
Contributor

@adimoldovan adimoldovan commented Feb 26, 2024

Submission Review Guidelines:

Changes proposed in this Pull Request:

Closes #45124 .

Fixed tests command-palette.spec.js broken by a label change in Gutenberg.

I took this occasion to add some improvements to this spec:

  • introduced fixtures to replace the beforeAll/afterAll hooks.
  • added a new function to disable the editor welcome guide by setting a pref instead of waiting for the modal and clicking the close button. This shaves off 5 seconds useless waiting on every test.

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

The tests should pass with both Gutenberg active and inactive.

Locally:

  1. Run without Gutengerng: pnpm env:restart && pnpm test:e2e-pw ./tests/e2e-pw/tests/merchant/command-palette.spec.js
  2. Install Gutenberg
  3. Run again: pnpm test:e2e-pw ./tests/e2e-pw/tests/merchant/command-palette.spec.js

Changelog entry

  • Automatically create a changelog entry from the details below.

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Comment

@adimoldovan adimoldovan self-assigned this Feb 26, 2024
@github-actions github-actions bot added focus: e2e tests Issues related to e2e tests plugin: woocommerce Issues related to the WooCommerce Core plugin. labels Feb 26, 2024
Copy link
Contributor

github-actions bot commented Feb 26, 2024

Test Results Summary

Commit SHA: 9c43938

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests25900202610m 38s
E2E Tests319002403436m 53s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

@adimoldovan adimoldovan marked this pull request as ready for review February 26, 2024 12:00
@woocommercebot woocommercebot requested a review from a team February 26, 2024 12:04
Copy link
Contributor

Hi , @woocommerce/vortex

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

@rrennick
Copy link
Contributor

added a new function to disable the editor welcome guide by setting a pref instead of waiting for the modal and clicking the close button. This shaves off 5 seconds useless waiting on every test.

Is there still some place in the E2E tests where the modal is being dismissed through the browser? The concern with completely eliminating this by setting a pref is that the modal itself is not longer tested in E2E.

@adimoldovan
Copy link
Contributor Author

Is there still some place in the E2E tests where the modal is being dismissed through the browser? The concern with completely eliminating this by setting a pref is that the modal itself is not longer tested in E2E.

Good question @rrennick. At this point, yes, there are many other tests that are dismissing the modal through the browser.
But, I'm actually working on another PR (#45132) to remove all those. I think this is a good discussion to have in there.

Copy link
Contributor

@rrennick rrennick left a comment

Choose a reason for hiding this comment

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

Looks good.

@rrennick rrennick merged commit 9a20444 into trunk Feb 26, 2024
29 of 30 checks passed
@rrennick rrennick deleted the e2e/fix-command-pallete-with-gb-tests branch February 26, 2024 18:16
@github-actions github-actions bot added this to the 8.8.0 milestone Feb 26, 2024
@github-actions github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Feb 26, 2024
@alvarothomas alvarothomas added status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels Feb 26, 2024
Konamiman pushed a commit that referenced this pull request Mar 13, 2024
…45121)

* Fix locator for command palette

* Add changelog

* Use fixtures instead of before/after hooks

* Disable welcome modal

* Remove describe block

* Move function to avoid a future merge conflict
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: e2e tests Issues related to e2e tests plugin: woocommerce Issues related to the WooCommerce Core plugin. status: analysis complete Indicates if a PR has been analysed by Solaris
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[e2e tests] Fix the command-palette spec failing with Gutenberg active
3 participants