Merge pull request #4015 from woocommerce/dev/qa/fix-store-config-type

mishautkin · web-flow · commit 483777d1fbd1 · 2026-01-23T18:06:58.000+01:00
[QA] Implement type ShopConfig, update params naming
diff --git a/tests/qa/resources/types.ts b/tests/qa/resources/types.ts
@@ -1,3 +1,16 @@
+export type ShopConfig = {
+	enableWpDebugging?: boolean; // Is WP Debugging plugin activated
+	enableSubscriptionsPlugin?: boolean; // Is WC Subscriptions plugin activated
+	enableClassicPages?: boolean; // Are classic cart and checkout pages set in WC > Settings > Advanced
+	settings?: WooCommerce.Settings; // WooCommerce settings by tabs (general, advanced, etc.)
+	taxes?: {
+		options: WooCommerce.Settings; // Tax settings in WC > Settings > General tab
+		rates: WooCommerce.CreateTax[]; // Tax rates to be active in WC > Settings > Taxes > Tax rates tab
+	};
+	customer?: WooCommerce.CreateCustomer; // Registered customer to be created
+	products?: WooCommerce.CreateProduct[]; // Products to be created if not existing
+};
+
 export type PayPalAccount = {
 	email: string;
 	password: string;
diff --git a/tests/qa/resources/woocommerce-config.ts b/tests/qa/resources/woocommerce-config.ts
@@ -1,53 +1,48 @@
 /**
  * Internal dependencies
  */
-import { shopSettings, customers } from '.';
+import { shopSettings, ShopConfig } from '.';
 
 const country = process.env.WC_DEFAULT_COUNTRY || 'usa';
 
-export const storeConfigDefault = {
-	classicPages: false, // false = block cart and checkout (default), true = classic cart & checkout pages
-	wpDebugging: false, // WP Debugging plugin is deactivated
-	subscription: false, // WC Subscription plugin is deactivated
+export const storeConfigDefault: ShopConfig = {
+	enableClassicPages: false, // false = block cart and checkout (default), true = classic cart & checkout pages
+	enableWpDebugging: false, // WP Debugging plugin is deactivated
+	enableSubscriptionsPlugin: false, // WC Subscription plugin is deactivated
 	settings: shopSettings[ country ], // WC general settings
-	// customer: customers[ country ], // registered customer
 };
 
-export const storeConfigClassic = {
+export const storeConfigClassic: ShopConfig = {
 	...storeConfigDefault,
-	classicPages: true,
+	enableClassicPages: true,
 };
 
-export const storeConfigGermany = {
+export const storeConfigGermany: ShopConfig = {
 	...storeConfigDefault,
 	settings: shopSettings.germany, // WC general settings
-	// customer: customers.germany,
 };
 
-export const storeConfigUsa = {
+export const storeConfigUsa: ShopConfig = {
 	...storeConfigDefault,
-	wpDebugging: true,
+	enableWpDebugging: true,
 	settings: shopSettings.usa,
-	// customer: customers.usa,
 };
 
-export const storeConfigMexico = {
+export const storeConfigMexico: ShopConfig = {
 	...storeConfigDefault,
 	settings: shopSettings.mexico,
-	// customer: customers.mexico,
 };
 
-const storeConfigSubscription = {
-	// requireFinalConfirmation: false,
-	subscription: true,
+const storeConfigSubscription: ShopConfig = {
+	enableSubscriptionsPlugin: true,
 };
 
-export const storeConfigSubscriptionGermany = {
+export const storeConfigSubscriptionGermany: ShopConfig = {
 	...storeConfigGermany,
 	...storeConfigSubscription,
 };
 
-export const storeConfigSubscriptionUsa = {
+export const storeConfigSubscriptionUsa: ShopConfig = {
 	...storeConfigUsa,
 	...storeConfigSubscription,
 };
diff --git a/tests/qa/tests/05-transactions/transaction-usa-classic.spec.ts b/tests/qa/tests/05-transactions/transaction-usa-classic.spec.ts
@@ -43,7 +43,7 @@ const { payPal, payLater, venmo, acdc, fastlane } = gateways;
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
+		enableClassicPages: true,
 		customer: customers.usa,
 	} );
 	await utils.installAndActivatePcp();
diff --git a/tests/qa/tests/07-vaulting/vaulting-checkout.spec.ts b/tests/qa/tests/07-vaulting/vaulting-checkout.spec.ts
@@ -21,7 +21,7 @@ const {
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: false,
+		enableClassicPages: false,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/tests/07-vaulting/vaulting-classic-cart.spec.ts b/tests/qa/tests/07-vaulting/vaulting-classic-cart.spec.ts
@@ -14,7 +14,7 @@ const { testSavePaymentMethod, testVaultedPaymentMethod } =
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
+		enableClassicPages: true,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/tests/07-vaulting/vaulting-classic-checkout.spec.ts b/tests/qa/tests/07-vaulting/vaulting-classic-checkout.spec.ts
@@ -21,7 +21,7 @@ const {
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
+		enableClassicPages: true,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/tests/07-vaulting/vaulting-my-account.spec.ts b/tests/qa/tests/07-vaulting/vaulting-my-account.spec.ts
@@ -18,7 +18,7 @@ const acdc2 = { ...acdc, card: cards.visa2 };
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
+		enableClassicPages: true,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/tests/07-vaulting/vaulting-pay-by-link.spec.ts b/tests/qa/tests/07-vaulting/vaulting-pay-by-link.spec.ts
@@ -21,7 +21,7 @@ const {
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: false,
+		enableClassicPages: false,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/tests/08-subscription/subscription-checkout.spec.ts b/tests/qa/tests/08-subscription/subscription-checkout.spec.ts
@@ -15,8 +15,8 @@ const { testSubscriptionOrderGuest, testSubscriptionOrderCustomer } =
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: false,
-		subscription: true,
+		enableClassicPages: false,
+		enableSubscriptionsPlugin: true,
 		products: [ products.subscription100, products.subscriptionFreeTrial ],
 	} );
 	await utils.installAndActivatePcp();
diff --git a/tests/qa/tests/08-subscription/subscription-classic-checkout.spec.ts b/tests/qa/tests/08-subscription/subscription-classic-checkout.spec.ts
@@ -15,8 +15,8 @@ const { testSubscriptionOrderGuest, testSubscriptionOrderCustomer } =
 test.beforeAll( async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
-		subscription: true,
+		enableClassicPages: true,
+		enableSubscriptionsPlugin: true,
 		products: [ products.subscription100, products.subscriptionFreeTrial ],
 	} );
 	await utils.installAndActivatePcp();
diff --git a/tests/qa/tests/08-subscription/subscription-renewal.spec.ts b/tests/qa/tests/08-subscription/subscription-renewal.spec.ts
@@ -24,9 +24,9 @@ const {
 test.beforeAll( async ( { utils, pcpApi, wooCommerceApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		wpDebugging: false,
-		classicPages: false,
-		subscription: true,
+		enableWpDebugging: false,
+		enableClassicPages: false,
+		enableSubscriptionsPlugin: true,
 		products: [ products.subscription100, products.subscriptionFreeTrial ],
 	} );
 	await utils.installAndActivatePcp();
diff --git a/tests/qa/tests/09-stress/stress.spec.ts b/tests/qa/tests/09-stress/stress.spec.ts
@@ -28,7 +28,7 @@ const testOrder: WooCommerce.ShopOrder = {
 test.beforeAll( async ( { utils, pcpApi, wooCommerceApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: true,
+		enableClassicPages: true,
 		products: [ testProduct ],
 	} );
 	// Restore stock_quantity before each test
diff --git a/tests/qa/tests/_setup/store.setup.ts b/tests/qa/tests/_setup/store.setup.ts
@@ -211,8 +211,8 @@ configureEnv( {
 setup( 'setup:pcp:usa:paypal:subscription;', async ( { utils, pcpApi } ) => {
 	await utils.configureStore( {
 		...storeConfigUsa,
-		classicPages: false,
-		subscription: true,
+		enableClassicPages: false,
+		enableSubscriptionsPlugin: true,
 	} );
 	await utils.installAndActivatePcp();
 	await pcpApi.resetDb();
diff --git a/tests/qa/utils/utils.ts b/tests/qa/utils/utils.ts
@@ -22,6 +22,7 @@ import {
 	wpDebuggingPlugin,
 	pcpPlugin,
 	ShopOrder,
+	ShopConfig,
 } from '../resources';
 import { getCustomerStorageStateName } from './helpers';
 import urls from './urls';
@@ -243,52 +244,41 @@ export class Utils {
 	 * @param          data.customer
 	 * @param          data.products
 	 */
-	configureStore = async ( data: {
-		wpDebugging?: boolean; // Is WP Debugging plugin activated
-		subscription?: boolean; // Is WC Subscriptions plugin activated
-		classicPages?: boolean; // Are classic cart and checkout pages set in WC > Settings > Advanced
-		settings?: WooCommerce.Settings; // WooCommerce settings by tabs (general, advanced, etc.)
-		taxes?: {
-			options: WooCommerce.Settings; // Tax settings in WC > Settings > General tab
-			rates: WooCommerce.CreateTax[]; // Tax rates to be active in WC > Settings > Taxes > Tax rates tab
-		};
-		customer?: WooCommerce.CreateCustomer; // Registered customer to be created
-		products?: WooCommerce.CreateProduct[]; // Products to be created if not existing
-	} ) => {
+	configureStore = async ( data: ShopConfig ) => {
 		const {
-			wpDebugging,
-			subscription,
-			classicPages,
+			enableWpDebugging,
+			enableSubscriptionsPlugin,
+			enableClassicPages,
 			settings,
 			taxes,
 			customer,
 			products,
-		} = data;
+		}: ShopConfig = data;
 
-		if ( subscription === true ) {
+		if ( enableSubscriptionsPlugin === true ) {
 			await this.requestUtils.activatePlugin( subscriptionsPlugin.slug );
 		}
 
-		if ( subscription === false ) {
+		if ( enableSubscriptionsPlugin === false ) {
 			await this.requestUtils.deactivatePlugin(
 				subscriptionsPlugin.slug
 			);
 		}
 
-		if ( wpDebugging === true ) {
+		if ( enableWpDebugging === true ) {
 			await this.requestUtils.activatePlugin( wpDebuggingPlugin.slug );
 		}
 
-		if ( wpDebugging === false ) {
+		if ( enableWpDebugging === false ) {
 			await this.requestUtils.deactivatePlugin( wpDebuggingPlugin.slug );
 		}
 
-		if ( classicPages === true ) {
+		if ( enableClassicPages === true ) {
 			await this.wooCommerceUtils.activateClassicCartPage();
 			await this.wooCommerceUtils.activateClassicCheckoutPage();
 		}
 
-		if ( classicPages === false ) {
+		if ( enableClassicPages === false ) {
 			await this.wooCommerceUtils.activateBlockCartPage();
 			await this.wooCommerceUtils.activateBlockCheckoutPage();
 		}
