Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

WIP: Setup E2E testing using @woocommerce/e2e-environment #786

Open
wants to merge 19 commits into
base: trunk
Choose a base branch
from
Open

WIP: Setup E2E testing using @woocommerce/e2e-environment #786

wants to merge 19 commits into from

Conversation

mattallan
Copy link
Contributor

@mattallan mattallan commented Jul 6, 2020 •
edited
Loading

This PR will act as a WIP for setting up the e2e tests and writing our first couple of e2e tests.

Changes proposed in this PR

  • Sets up e2e test environment using the @woocommerce/e2e-environment package
  • Adds a readme with testing instructions and running the tests locally
  • Adds our first example E2E test which just loads the checkout page 🎉

Other things to note:

  • While WooCommerce is still working on a @woocommerce/e2e-util package, I have copied the util files from core into our own utils folder, see f7a3473.
  • The default docker init script was just installing and activating WooCommerce and the 2019 theme, so to help with testing, I have modified this script to be similar some of what is done in WC Payments. See 8cb68a4.

How to run the e2e tests?

Check out the README added in this PR which has more detailed instructions.

  1. Install docker and make sure it's running
  2. npm install
  3. npm run docker:up
    1. This command is booting up the test environment, which includes installing and setting up WooCommerce and importing some dummy/test products. This happens in the background so it can take a while to finish even though the docker:up command has completed.
    2. To check that the site is ready for testing and set up properly, go to http://localhost:8084/shop/ and confirm the shop loads with the storefront theme and there are products in your store. It should look like this.
  4. Run the example test: npm run test:e2e

  1. To watch the tests running in a chrome window you can use npm run test:e2e-dev
  2. npm run docker:down when finished testing

TODOs
At the moment this PR is for running the e2e tests locally

  • Travis CI integration/setup

@mattallan mattallan force-pushed the e2e-init branch 5 times, most recently from a5ea52e to 23589ee Compare July 8, 2020 04:29
@mattallan
Copy link
Contributor Author

At the start of every test I've currently got it importing calling await importSampleProducts() to make sure our shop page is populated but I'd like to find a better way of doing this.

I originally had the importing of sample products using wp CLI which I changed in 23589ee because Travis was running the e2e tests before the initialize.sh had time to finish importing the products so the tests would fail.

I think we'll need to look at how other extensions handle setting up the test environment using WPI CLI

mattallan added 13 commits July 14, 2020 15:56
Add Docker setup files
a76b96f 
As per https://github.com/woocommerce/woocommerce/tree/85580cfb4f0ffec83a736f7391f7775bab9f50b9/tests/e2e/env#docker-setup
Add Jest Config
370f018 
As per https://github.com/woocommerce/woocommerce/tree/85580cfb4f0ffec83a736f7391f7775bab9f50b9/tests/e2e/env#jest-config
Add Bable and ES Lint config files
e115d75 
As per https://github.com/woocommerce/woocommerce/tree/85580cfb4f0ffec83a736f7391f7775bab9f50b9/tests/e2e/env#configuration
Fix 500 server error when starting the tests (see commit message)
8697fe8 
When running the tests there's a 500 error: https://d.pr/i/7A5Xg

This is being caused by the trashExistingProducts() function that is ran at the start of every test.
This commit copies the jest config from woo and just removes this function for now.

A similar patch was made on WC Pay: Automattic/woocommerce-payments@d670738
Add config package
3773511
Update the default docker init file
56963db
Update the default test data
d86059a
Manually load in the woo e2e util files since they're not yet packaged
15081cb 
These can be removed and replaced with installing the woocommerce e2e util package when it's ready
Adds the first e2e sample test case
211d58d
Add npm scripts for running the e2e test commands
8fbe8eb
Add notes on how to get the e2e tests setup
488fb0a
package lock
93a689a
Update travis.yml to run e2e tests
0df7cc1
@chickenn00dle chickenn00dle changed the base branch from master to main August 17, 2020 07:33
@chickenn00dle chickenn00dle changed the base branch from main to trunk August 26, 2020 05:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mattallan