7.3 KiB

Raw Blame History

WooCommerce End to End Test Utilities

This package contains utilities to simplify writing e2e tests specific to WooCommmerce.

Installation

npm install @woocommerce/e2e-utils --save

Usage

Example:

import {
	shopper,
	merchant,
	createSimpleProduct
} from '@woocommerce/e2e-utils';

describe( 'Cart page', () => {
	beforeAll( async () => {
		await createSimpleProduct();
	} );

	it( 'should display no item in the cart', async () => {
		await shopper.goToCart();
		await expect( page ).toMatchElement( '.cart-empty', { text: 'Your cart is currently empty.' } );
	} );
} );

Test Function

Merchant `merchant`

Function	Parameters	Description
`goToOrder`	`orderId`	Go to view a single order
`goToProduct`	`productId`	Go to view a single product
`login`		Log in as merchant
`logout`		Log out of merchant account
`openAllOrdersView`		Go to the orders listing
`openAllProductsView`		Go to the products listing
`openDashboard`		Go to the WordPress dashboard
`openNewCoupon`		Go to the new coupon editor
`openNewOrder`		Go to the new order editor
`openNewProduct`		Go to the new product editor
`openPermalinkSettings`		Go to Settings -> Permalinks
`openPlugins`		Go to the Plugins screen
`openSettings`		Go to WooCommerce -> Settings
`runSetupWizard`		Open the onboarding profiler
`updateOrderStatus`	`orderId, status`	Update the status of an order
`openEmailLog`		Open the WP Mail Log page
`openAnalyticsPage`		Open any Analytics page
`openAllUsersView`		Open the All Users page
`openImportProducts`		Open the Import Products page

Shopper `shopper`

Function	Parameters	Description
`addToCart`		Add an item to the cart from a single product page
`addToCartFromShopPage`	`productTitle`	Add an item to the cart from a single product page
`fillBillingDetails`	`customerBillingDetails`	Fill billing fields in checkout form using configured address
`fillShippingDetails`	`customerShippingDetails`	Fill shipping fields in checkout form using configured address
`goToAddresses`		Go to My Account -> Address Details
`goToAccountDetails`		Go to My Account -> Details
`goToCart`		Go to the cart page
`goToCheckout`		Go to the checkout page
`goToDownloads`		Go to My Account -> Downloads
`goToMyAccount`		Go to the My Account page
`goToOrders`		Go to My Account -> Orders
`goToProduct`	`productId`	Go to a single product in the shop
`goToShop`		Go to the shop page
`login`		Log in as the shopper
`placeOrder`		Place an order from the checkout page
`productIsInCheckout`	`productTitle, quantity, total, cartSubtotal`	Verify product is in cart on checkout page
`removeFromCart`	`productTitle`	Remove a product from the cart on the cart page
`setCartQuantity`	`productTitle, quantityValue`	Change the quantity of a product on the cart page
`searchForProduct`		Searching for a product name and landing on its detail page
`emptyCart`		Removes any products and coupons that are in the cart

Page Utilities

Function	Parameters	Description
`addProductToOrder`	`orderId, productName`	adds a product to an order using the product search
`applyCoupon`	`couponName`	helper method which applies a coupon in cart or checkout
`clearAndFillInput`	`selector, value`	Replace the contents of an input with the passed value
`clickFilter`	`selector`	helper method that clicks on a list page filter
`clickTab`	`tabName`	Click on a WooCommerce -> Settings tab
`clickUpdateOrder`	`noticeText`, `waitForSave`	Helper method to click the Update button on the order details page
`completeOnboardingWizard`		completes the onboarding wizard with some default settings
`createCoupon`	`couponAmount`, `couponType`	creates a basic coupon. Default amount is 5. Default coupon type is fixed discount. Returns the generated coupon code.
`createGroupedProduct`		creates a grouped product for the grouped product tests. Returns the product id.
`createSimpleOrder`	`status`	creates a basic order with the provided status string
`createSimpleProduct`		creates the simple product configured in default.json. Returns the product id.
`createSimpleProductWithCategory`	`name`, `price`,`categoryName`	creates a simple product used passed values. Returns the product id.
`createVariableProduct`		creates a variable product for the variable product tests. Returns the product id.
`deleteAllEmailLogs`		deletes the emails generated by WP Mail Logging plugin
`evalAndClick`	`selector`	helper method that clicks an element inserted in the DOM by a script
`moveAllItemsToTrash`		helper method that checks every item in a list page and moves them to the trash
`permalinkSettingsPageSaveChanges`		Save the current Permalink settings
`removeCoupon`		helper method that removes a single coupon within cart or checkout
`selectOptionInSelect2`	`selector, value`	helper method that searchs for select2 type fields and select plus insert value inside
`selectOrderAction`	`action`	Helper method to select an order action in the `Order Actions` postbox
`setCheckbox`	`selector`	Check a checkbox
`settingsPageSaveChanges`		Save the current WooCommerce settings page
`uiUnblocked`		Wait until the page is unblocked
`unsetCheckbox`	`selector`	Uncheck a checkbox
`verifyAndPublish`	`noticeText`	Verify that an item can be published
`verifyCheckboxIsSet`	`selector`	Verify that a checkbox is checked
`verifyCheckboxIsUnset`	`selector`	Verify that a checkbox is unchecked
`verifyPublishAndTrash`	`button, publishNotice, publishVerification, trashVerification`	Verify that an item can be published and trashed
`verifyValueOfInputField`	`selector, value`	Verify an input contains the passed value
`clickFilter`	`selector`	Click on a list page filter
`moveAllItemsToTrash`		Moves all items in a list view to the Trash
`verifyAndPublish`	`noticeText`	Verify that an item can be published
`selectOptionInSelect2`	`selector, value`	helper method that searchs for select2 type fields and select plus insert value inside
`searchForOrder`	`value, orderId, customerName`	helper method that searchs for an order via many different terms
`addShippingZoneAndMethod`	`zoneName, zoneLocation, zipCode, zoneMethod`	util helper method for adding shipping zones with shipping methods
`applyCoupon`	`couponName`	helper method which applies a coupon in cart or checkout
`removeCoupon`		helper method that removes a single coupon within cart or checkout
`selectOrderAction`	`action`	Helper method to select an order action in the `Order Actions` postbox
`clickUpdateOrder`	`noticeText`, `waitForSave`	Helper method to click the Update button on the order details page

Test Utilities

As of version 0.1.3, all test utilities from @wordpress/e2e-test-utils are available through this package.

7.3 KiB Raw Blame History