[e2e tests] Replace utils from the new `@woocommerce/e2e-utils-playwr…

…ight` package (woocommerce#53377)
ntindicator · Dec 4, 2024 · d837888 · d837888
1 parent ccd5f72
commit d837888
Show file tree

Hide file tree

Showing 26 changed files with 203 additions and 97 deletions.
diff --git a/plugins/woocommerce/changelog/tests-52957 b/plugins/woocommerce/changelog/tests-52957
@@ -0,0 +1,4 @@
+Significance: minor
+Type: dev
+
+Update existing tests with the Playwright utils from the @woocommerce/e2e-utils-playwright package
diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/command-palette.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/command-palette.spec.js
@@ -1,5 +1,9 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const { disableWelcomeModal } = require( '../../utils/editor' );
+
+/**
+ * External dependencies
+ */
+import { disableWelcomeModal } from '@woocommerce/e2e-utils-playwright';
 
 // need to figure out whether tests are being run on a mac
 const macOS = process.platform === 'darwin';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-cart-block.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-cart-block.spec.js
@@ -1,14 +1,20 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
 const {
-	goToPageEditor,
 	fillPageTitle,
-	insertBlock,
 	transformIntoBlocks,
 	publishPage,
-	closeChoosePatternModal,
 } = require( '../../utils/editor' );
 const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
 
+/**
+ * External dependencies
+ */
+import {
+	closeChoosePatternModal,
+	goToPageEditor,
+	insertBlock,
+} from '@woocommerce/e2e-utils-playwright';
+
 const test = baseTest.extend( {
 	storageState: process.env.ADMINSTATE,
 	testPageTitlePrefix: 'Transformed cart',

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-checkout-block.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-checkout-block.spec.js
@@ -1,16 +1,22 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
 const {
-	goToPageEditor,
-	getCanvas,
 	fillPageTitle,
-	insertBlock,
 	transformIntoBlocks,
 	publishPage,
-	openEditorSettings,
-	closeChoosePatternModal,
 } = require( '../../utils/editor' );
 const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
 
+/**
+ * External dependencies
+ */
+import {
+	closeChoosePatternModal,
+	openEditorSettings,
+	getCanvas,
+	insertBlock,
+	goToPageEditor,
+} from '@woocommerce/e2e-utils-playwright';
+
 const simpleProductName = 'Very Simple Product';
 const singleProductPrice = '999.00';
 

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-page.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-page.spec.js
@@ -1,11 +1,14 @@
 const { test: baseTest } = require( '../../fixtures/fixtures' );
-const {
-	goToPageEditor,
-	fillPageTitle,
-	getCanvas,
-	publishPage,
+const { fillPageTitle, publishPage } = require( '../../utils/editor' );
+
+/**
+ * External dependencies
+ */
+import {
 	closeChoosePatternModal,
-} = require( '../../utils/editor' );
+	getCanvas,
+	goToPageEditor,
+} from '@woocommerce/e2e-utils-playwright';
 
 const test = baseTest.extend( {
 	storageState: process.env.ADMINSTATE,

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-post.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-post.spec.js
@@ -2,10 +2,14 @@ const { test: baseTest } = require( '../../fixtures/fixtures' );
 const {
 	goToPostEditor,
 	fillPageTitle,
-	getCanvas,
 	publishPage,
 } = require( '../../utils/editor' );
 
+/**
+ * External dependencies
+ */
+import { getCanvas } from '@woocommerce/e2e-utils-playwright';
+
 const test = baseTest.extend( {
 	storageState: process.env.ADMINSTATE,
 } );

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-woocommerce-blocks.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-woocommerce-blocks.spec.js
@@ -1,13 +1,16 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const {
+const { fillPageTitle, publishPage } = require( '../../utils/editor' );
+const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
+
+/**
+ * External dependencies
+ */
+import {
+	closeChoosePatternModal,
+	getCanvas,
 	goToPageEditor,
-	fillPageTitle,
 	insertBlock,
-	getCanvas,
-	publishPage,
-	closeChoosePatternModal,
-} = require( '../../utils/editor' );
-const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const simpleProductName = 'Simplest Product';
 const singleProductPrice = '555.00';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-woocommerce-patterns.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/merchant/create-woocommerce-patterns.spec.js
@@ -1,13 +1,16 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const {
+const { fillPageTitle, publishPage } = require( '../../utils/editor' );
+const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
+
+/**
+ * External dependencies
+ */
+import {
+	closeChoosePatternModal,
+	getCanvas,
 	goToPageEditor,
-	fillPageTitle,
 	insertBlock,
-	getCanvas,
-	publishPage,
-	closeChoosePatternModal,
-} = require( '../../utils/editor' );
-const { getInstalledWordPressVersion } = require( '../../utils/wordpress' );
+} from '@woocommerce/e2e-utils-playwright';
 
 // some WooCommerce Patterns to use
 const wooPatterns = [

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/add-to-cart.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/add-to-cart.spec.js
@@ -1,6 +1,10 @@
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
-const { addAProductToCart } = require( '../../utils/cart' );
+
+/**
+ * External dependencies
+ */
+import { addAProductToCart } from '@woocommerce/e2e-utils-playwright';
 
 const productName = `Cart product test ${ Date.now() }`;
 const productPrice = '13.99';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block-calculate-shipping.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block-calculate-shipping.spec.js
@@ -1,11 +1,15 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const {
-	goToPageEditor,
-	fillPageTitle,
+const { fillPageTitle } = require( '../../utils/editor' );
+
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
 	insertBlockByShortcut,
+	goToPageEditor,
 	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const firstProductName = 'First Product';
 const firstProductPrice = '10.00';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block-coupons.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block-coupons.spec.js
@@ -1,11 +1,15 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const {
-	goToPageEditor,
-	fillPageTitle,
+const { fillPageTitle } = require( '../../utils/editor' );
+
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
 	insertBlockByShortcut,
+	goToPageEditor,
 	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const simpleProductName = 'Cart Coupons Product';
 const singleProductFullPrice = '110.00';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-block.spec.js
@@ -1,11 +1,15 @@
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
-const {
-	goToPageEditor,
-	fillPageTitle,
+const { fillPageTitle } = require( '../../utils/editor' );
+
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
 	insertBlockByShortcut,
+	goToPageEditor,
 	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const simpleProductName = 'Single Simple Product';
 const simpleProductDesc = 'Lorem ipsum dolor sit amet.';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-calculate-shipping.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-calculate-shipping.spec.js
@@ -1,4 +1,7 @@
-const { addAProductToCart } = require( '../../utils/cart' );
+/**
+ * External dependencies
+ */
+import { addAProductToCart } from '@woocommerce/e2e-utils-playwright';
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-block-calculate-tax.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-block-calculate-tax.spec.js
@@ -1,13 +1,17 @@
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
-const {
-	goToPageEditor,
-	fillPageTitle,
+const { fillPageTitle } = require( '../../utils/editor' );
+const { random } = require( '../../utils/helpers' );
+
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
 	insertBlockByShortcut,
+	goToPageEditor,
 	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
-const { random } = require( '../../utils/helpers' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const productName = 'First Product Cart Block Taxing';
 const productPrice = '100.00';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-calculate-tax.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-calculate-tax.spec.js
@@ -1,9 +1,13 @@
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 const { customer } = require( '../../test-data/data' );
-const { addAProductToCart } = require( '../../utils/cart' );
 const { random } = require( '../../utils/helpers' );
 
+/**
+ * External dependencies
+ */
+import { addAProductToCart } from '@woocommerce/e2e-utils-playwright';
+
 const productName = `Taxed products are awesome ${ random() }`;
 const productPrice = '200.00';
 const messyProductPrice = '13.47';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-coupons.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-coupons.spec.js
@@ -1,4 +1,7 @@
-const { addAProductToCart } = require( '../../utils/cart' );
+/**
+ * External dependencies
+ */
+import { addAProductToCart } from '@woocommerce/e2e-utils-playwright';
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-restricted-coupons.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/cart-checkout-restricted-coupons.spec.js
@@ -1,6 +1,11 @@
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
+	getOrderIdFromUrl,
+} from '@woocommerce/e2e-utils-playwright';
 const { test, expect } = require( '@playwright/test' );
-const { getOrderIdFromUrl } = require( '../../utils/order' );
-const { addAProductToCart } = require( '../../utils/cart' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 
 const includedProductName = 'Included test product';

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-block-coupons.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-block-coupons.spec.js
@@ -1,10 +1,13 @@
-const {
-	goToPageEditor,
-	fillPageTitle,
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
 	insertBlockByShortcut,
 	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
+	goToPageEditor,
+} from '@woocommerce/e2e-utils-playwright';
+const { fillPageTitle } = require( '../../utils/editor' );
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
 const { random } = require( '../../utils/helpers' );
 

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-block.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-block.spec.js
@@ -1,22 +1,23 @@
-const {
-	goToPageEditor,
-	fillPageTitle,
-	insertBlockByShortcut,
-	publishPage,
-} = require( '../../utils/editor' );
-const { addAProductToCart } = require( '../../utils/cart' );
+const { fillPageTitle } = require( '../../utils/editor' );
 const { test: baseTest, expect } = require( '../../fixtures/fixtures' );
 
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 const { admin, customer } = require( '../../test-data/data' );
 const { logIn } = require( '../../utils/login' );
 const { setFilterValue, clearFilters } = require( '../../utils/filters' );
 
-const {
+/**
+ * External dependencies
+ */
+import {
+	insertBlockByShortcut,
+	goToPageEditor,
+	publishPage,
+	addAProductToCart,
+	getOrderIdFromUrl,
 	fillShippingCheckoutBlocks,
 	fillBillingCheckoutBlocks,
-} = require( '../../utils/checkout' );
-const { getOrderIdFromUrl } = require( '../../utils/order' );
+} from '@woocommerce/e2e-utils-playwright';
 
 const guestEmail = '[email protected]';
 const newAccountEmail = `marge-${ new Date()

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-create-account.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-create-account.spec.js
@@ -1,8 +1,14 @@
 const { test, expect } = require( '@playwright/test' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 const { admin } = require( '../../test-data/data' );
-const { getOrderIdFromUrl } = require( '../../utils/order' );
-const { addAProductToCart } = require( '../../utils/cart' );
+
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
+	getOrderIdFromUrl,
+} from '@woocommerce/e2e-utils-playwright';
 
 const billingEmail = '[email protected]';
 

diff --git a/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-login.spec.js b/plugins/woocommerce/tests/e2e-pw/tests/shopper/checkout-login.spec.js
@@ -1,6 +1,11 @@
+/**
+ * External dependencies
+ */
+import {
+	addAProductToCart,
+	getOrderIdFromUrl,
+} from '@woocommerce/e2e-utils-playwright';
 const { test, expect } = require( '@playwright/test' );
-const { getOrderIdFromUrl } = require( '../../utils/order' );
-const { addAProductToCart } = require( '../../utils/cart' );
 const wcApi = require( '@woocommerce/woocommerce-rest-api' ).default;
 
 const customer = {