woocommerce/packages/js/e2e-core-tests/README.md

142 lines
5.9 KiB
Markdown
Raw Normal View History

2020-10-09 13:31:45 +00:00
# WooCommerce Core End to End Test Suite
This package contains the automated end-to-end tests for WooCommerce.
## Table of contents
- [Pre-requisites](#pre-requisites)
- [Setting up core tests](#setting-up-core-tests)
- [Test functions](#test-functions)
- [Activation and setup](#activation-and-setup)
- [Merchant](#merchant)
- [Shopper](#shopper)
- [Contributing a new test](#contributing-a-new-test)
## Pre-requisites
### Setting up the test environment
2021-11-04 11:58:11 +00:00
Follow [E2E setup instructions](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/tests/e2e/README.md).
2020-10-09 13:31:45 +00:00
### Setting up core tests
- Create the folder `tests/e2e/specs` in your repository if it does not exist.
- To add a core test to your test suite, create a new `.test.js` file within `tests/e2e/specs` . Example code to run all the shopper tests:
```js
const { runShopperTests } = require( '@woocommerce/e2e-core-tests' );
runShopperTests();
```
2021-04-12 17:33:00 +00:00
## Retrying/Re-running tests
On a new site, the setup and activation tests prepare the site for the remainder of the tests. To retry/rerun the test suite on a site where setup/onboarding test have already run use the environment variable `E2E_RETEST=1`.
2020-10-09 13:31:45 +00:00
## Test functions
The functions to access the core tests are:
### Activation and setup
- `runSetupOnboardingTests` - Run all setup and onboarding tests
- `runActivationTest` - Merchant can activate WooCommerce
- `runOnboardingFlowTest` - Merchant can complete onboarding flow
- `runTaskListTest` - Merchant can complete onboarding task list
- `runInitialStoreSettingsTest` - Merchant can complete initial settings
2020-10-09 13:31:45 +00:00
### Merchant
- `runMerchantTests` - Run all merchant tests
- `runAddShippingClassesTest` - Merchant can create shipping classes and let shopper test them
2021-03-17 19:40:49 +00:00
- `runAddNewShippingZoneTest` - Merchant can create shipping zones and let shopper test them
- `runAddSimpleProductTest` - Merchant can create a simple product
- `runAddVariableProductTest` - Merchant can create a variable product
- `runCreateCouponTest` - Merchant can create coupon
- `runCreateOrderTest` - Merchant can create order
- `runMerchantOrdersCustomerPaymentPage` - Merchant can visit the customer payment page
- `runMerchantOrderEmailsTest` - Merchant can receive order emails and resend emails by Order Actions
- `runEditOrderTest` - Merchant can edit an order in the dashboard
- `runOrderStatusFilterTest` - Merchant can filter orders by order status
- `runOrderRefundTest` - Merchant can refund an order
- `runOrderApplyCouponTest` - Merchant can apply a coupon to an order
2021-03-17 19:40:49 +00:00
- `runOrderSearchingTest` - Merchant can search for order via different terms
- `runProductEditDetailsTest` - Merchant can edit an existing product
- `runProductSearchTest` - Merchant can search for a product and view it
- `runProductSettingsTest` - Merchant can update product settings
- `runTaxSettingsTest` - Merchant can update tax settings
- `runUpdateGeneralSettingsTest` - Merchant can update general settings
2021-03-03 16:57:11 +00:00
- `runMerchantOrderEmailsTest` - Merchant can receive order emails and resend emails by Order Actions
2021-03-25 09:21:32 +00:00
- `runAnalyticsPageLoadsTest` - Merchant can load and see all pages in Analytics
2021-03-18 16:23:44 +00:00
- `runImportProductsTest` - Merchant can import products via CSV file
- `runInitiateWccomConnectionTest` - Merchant can initiate connection to WooCommerce.com
- `runAdminPageLoadTests` - Merchant can load pages from the WP Admin sidebar
2020-10-09 13:31:45 +00:00
### Shopper
- `runShopperTests` - Run all shopper tests
- `runCartApplyCouponsTest` - Shopper can use coupons on cart
- `runCartPageTest` - Shopper can view and update cart
- `runCheckoutApplyCouponsTest` - Shopper can use coupons on checkout
- `runCheckoutPageTest` - Shopper can complete checkout
- `runMyAccountPageTest` - Shopper can access my account page
- `runMyAccountPayOrderTest` - Shopper can pay for their order in My Account
- `runProductBrowseSearchSortTest` - Shopper can browse, search & sort products
- `runSingleProductPageTest` - Shopper can view single product page in many variations (simple, variable, grouped)
- `runVariableProductUpdateTest` - Shopper can view and update variations on a variable product
- `runCheckoutCreateAccountTest` - Shopper can create an account during checkout
- `runCheckoutLoginAccountTest` - Shopper can login to an account during checkout
- `runMyAccountCreateAccountTest` - Shopper can create an account via my account page
2021-04-07 15:52:58 +00:00
- `runCartCalculateShippingTest` - Shopper can calculate shipping in the cart
- `runCartRedirectionTest` - Shopper is redirected to the cart page after adding to cart
- `runOrderEmailReceivingTest` - Shopper can receive an email for his order
2020-10-09 13:31:45 +00:00
### REST API
- `runApiTests` - Run all API tests
- `runExternalProductAPITest` - Can create, read, and delete an external product
- `runGroupedProductAPITest` - Can create, read, and delete a grouped product
- `runVariableProductAPITest` - Can create, read, and delete a variable product and its variations
- `runCouponApiTest` - Can create, read, and delete a coupon
- `runOrderApiTest` - Can create, read, and delete an order
2020-10-09 13:31:45 +00:00
## Contributing a new test
- In your branch create a new `example-test-name.test.js` under the `tests/e2e/core-tests/specs` folder.
- Jest does not allow its global functions to be accessed outside the jest environment. To allow the test code to be published in a package import any jest global functions used in your test
```js
const {
it,
describe,
beforeAll,
} = require( '@jest/globals' );
```
- Wrap your test in a function and export it
```js
const runExampleTestName = () => {
describe('Example test', () => {
beforeAll(async () => {
// ...
});
it('do some example action', async () => {
// ...
});
// ...
});
});
module.exports = runExampleTestName;
```
- Add your test to `tests/e2e/core-tests/specs/index.js`
2020-10-09 13:31:45 +00:00
```js
const runExampleTestName = require( './grouping/example-test-name.test' );
// ...
module.exports = {
// ...
runExampleTestName,
}
```