@shopware-ag/acceptance-test-suite 2.3.1 → 2.3.4

package/dist/index.d.mts

@@ -2,7 +2,6 @@ import * as _playwright_test from '@playwright/test';
 import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
 export * from '@playwright/test';
 import * as playwright_core from 'playwright-core';
-import { Page as Page$1 } from 'playwright-core';
 import { components } from '@shopware/api-client/admin-api-types';
 import { Image } from 'image-js';
 
@@ -28,8 +27,8 @@ declare class AdminApiContext {
     constructor(context: APIRequestContext, options: AdminApiContextOptions);
     static create(options?: AdminApiContextOptions): Promise<AdminApiContext>;
     private static createApiRequestContext;
-    private static authenticateWithClientCredentials;
-    private static authenticateWithUserPassword;
+    static authenticateWithClientCredentials(context: APIRequestContext, options: AdminApiContextOptions): Promise<string>;
+    static authenticateWithUserPassword(context: APIRequestContext, options: AdminApiContextOptions): Promise<string>;
     isAuthenticated(): boolean;
     get<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
     post<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
@@ -158,7 +157,7 @@ type Tag = components['schemas']['Tag'] & {
 type Rule = components['schemas']['Rule'] & {
     id: string;
 };
-type Currency = components['schemas']['Currency'] & {
+type Currency$1 = components['schemas']['Currency'] & {
     id: string;
 };
 type Order = components['schemas']['Order'] & {
@@ -387,7 +386,7 @@ declare class TestDataService {
      *
      * @param isoCode - The ISO code of the currency, for example "EUR".
      */
-    getCurrency(isoCode: string): Promise<Currency>;
+    getCurrency(isoCode: string): Promise<Currency$1>;
     /**
      * Retrieves a rule based on its name.
      *
@@ -481,7 +480,7 @@ declare class TestDataService {
         active: boolean;
     } & Partial<Category$1>;
     getBasicCustomerStruct(salesChannelId: string, customerGroupId: string, languageId: string, countryId: string, defaultPaymentMethodId: string, salutationId: string, overrides?: Partial<Customer>): Partial<Customer>;
-    getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
+    getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency$1, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
     getBasicProductLineItemStruct(lineItem: SimpleLineItem): {
         productId: string;
         referencedId: string;
@@ -996,12 +995,18 @@ interface DataFixtureTypes {
 interface FixtureTypes extends ApiContextTypes, PageContextTypes, ActorFixtureTypes, TestDataFixtureTypes, HelperFixtureTypes, DefaultSalesChannelTypes, StorefrontPageTypes, AdministrationPageTypes, DataFixtureTypes {
 }
 
-declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiContext) => Promise<{
+type Language = components['schemas']['Currency'] & {
     id: string;
-    localeId: string;
-}>;
+    translationCode: components['schemas']['Locale'] & {
+        id: string;
+    };
+};
+declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiContext) => Promise<Language>;
 declare const getSnippetSetId: (languageCode: string, adminApiContext: AdminApiContext) => Promise<string>;
-declare const getCurrency: (isoCode: string, adminApiContext: AdminApiContext) => Promise<any>;
+type Currency = components['schemas']['Currency'] & {
+    id: string;
+};
+declare const getCurrency: (isoCode: string, adminApiContext: AdminApiContext) => Promise<Currency>;
 declare const getTaxId: (adminApiContext: AdminApiContext) => Promise<string>;
 declare const getPaymentMethodId: (adminApiContext: AdminApiContext, handlerId?: string) => Promise<string>;
 declare const getDefaultShippingMethodId: (adminApiContext: AdminApiContext) => Promise<string>;
@@ -1020,7 +1025,7 @@ type OrderStatus = 'cancel' | 'complete' | 'reopen' | 'process';
 declare const setOrderStatus: (orderId: string, orderStatus: OrderStatus, adminApiContext: AdminApiContext) => Promise<APIResponse>;
 
 declare const isSaaSInstance: (adminApiContext: AdminApiContext) => Promise<boolean>;
-declare const isThemeCompiled: (page: Page$1) => Promise<boolean>;
+declare const isThemeCompiled: (context: AdminApiContext, storefrontUrl: string) => Promise<boolean>;
 
 declare function createRandomImage(width?: number, height?: number): Image;
 
@@ -1060,4 +1065,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Media, type Order, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Media, type Order, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };

package/dist/index.d.ts

@@ -2,7 +2,6 @@ import * as _playwright_test from '@playwright/test';
 import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
 export * from '@playwright/test';
 import * as playwright_core from 'playwright-core';
-import { Page as Page$1 } from 'playwright-core';
 import { components } from '@shopware/api-client/admin-api-types';
 import { Image } from 'image-js';
 
@@ -28,8 +27,8 @@ declare class AdminApiContext {
     constructor(context: APIRequestContext, options: AdminApiContextOptions);
     static create(options?: AdminApiContextOptions): Promise<AdminApiContext>;
     private static createApiRequestContext;
-    private static authenticateWithClientCredentials;
-    private static authenticateWithUserPassword;
+    static authenticateWithClientCredentials(context: APIRequestContext, options: AdminApiContextOptions): Promise<string>;
+    static authenticateWithUserPassword(context: APIRequestContext, options: AdminApiContextOptions): Promise<string>;
     isAuthenticated(): boolean;
     get<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
     post<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
@@ -158,7 +157,7 @@ type Tag = components['schemas']['Tag'] & {
 type Rule = components['schemas']['Rule'] & {
     id: string;
 };
-type Currency = components['schemas']['Currency'] & {
+type Currency$1 = components['schemas']['Currency'] & {
     id: string;
 };
 type Order = components['schemas']['Order'] & {
@@ -387,7 +386,7 @@ declare class TestDataService {
      *
      * @param isoCode - The ISO code of the currency, for example "EUR".
      */
-    getCurrency(isoCode: string): Promise<Currency>;
+    getCurrency(isoCode: string): Promise<Currency$1>;
     /**
      * Retrieves a rule based on its name.
      *
@@ -481,7 +480,7 @@ declare class TestDataService {
         active: boolean;
     } & Partial<Category$1>;
     getBasicCustomerStruct(salesChannelId: string, customerGroupId: string, languageId: string, countryId: string, defaultPaymentMethodId: string, salutationId: string, overrides?: Partial<Customer>): Partial<Customer>;
-    getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
+    getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency$1, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
     getBasicProductLineItemStruct(lineItem: SimpleLineItem): {
         productId: string;
         referencedId: string;
@@ -996,12 +995,18 @@ interface DataFixtureTypes {
 interface FixtureTypes extends ApiContextTypes, PageContextTypes, ActorFixtureTypes, TestDataFixtureTypes, HelperFixtureTypes, DefaultSalesChannelTypes, StorefrontPageTypes, AdministrationPageTypes, DataFixtureTypes {
 }
 
-declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiContext) => Promise<{
+type Language = components['schemas']['Currency'] & {
     id: string;
-    localeId: string;
-}>;
+    translationCode: components['schemas']['Locale'] & {
+        id: string;
+    };
+};
+declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiContext) => Promise<Language>;
 declare const getSnippetSetId: (languageCode: string, adminApiContext: AdminApiContext) => Promise<string>;
-declare const getCurrency: (isoCode: string, adminApiContext: AdminApiContext) => Promise<any>;
+type Currency = components['schemas']['Currency'] & {
+    id: string;
+};
+declare const getCurrency: (isoCode: string, adminApiContext: AdminApiContext) => Promise<Currency>;
 declare const getTaxId: (adminApiContext: AdminApiContext) => Promise<string>;
 declare const getPaymentMethodId: (adminApiContext: AdminApiContext, handlerId?: string) => Promise<string>;
 declare const getDefaultShippingMethodId: (adminApiContext: AdminApiContext) => Promise<string>;
@@ -1020,7 +1025,7 @@ type OrderStatus = 'cancel' | 'complete' | 'reopen' | 'process';
 declare const setOrderStatus: (orderId: string, orderStatus: OrderStatus, adminApiContext: AdminApiContext) => Promise<APIResponse>;
 
 declare const isSaaSInstance: (adminApiContext: AdminApiContext) => Promise<boolean>;
-declare const isThemeCompiled: (page: Page$1) => Promise<boolean>;
+declare const isThemeCompiled: (context: AdminApiContext, storefrontUrl: string) => Promise<boolean>;
 
 declare function createRandomImage(width?: number, height?: number): Image;
 
@@ -1060,4 +1065,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Media, type Order, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Media, type Order, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };

package/dist/index.mjs

@@ -20,10 +20,10 @@ const getLanguageData = async (languageCode, adminApiContext) => {
     }
   });
   const result = await resp.json();
-  return {
-    id: result.data[0].id,
-    localeId: result.data[0].translationCode.id
-  };
+  if (result.data.length === 0) {
+    throw new Error(`Language ${languageCode} not found`);
+  }
+  return result.data[0];
 };
 const getSnippetSetId = async (languageCode, adminApiContext) => {
   const resp = await adminApiContext.post("search/snippet-set", {
@@ -51,6 +51,9 @@ const getCurrency = async (isoCode, adminApiContext) => {
     }
   });
   const result = await resp.json();
+  if (result.data.length === 0) {
+    throw new Error(`Currency ${isoCode} not found`);
+  }
   return result.data[0];
 };
 const getTaxId = async (adminApiContext) => {
@@ -200,23 +203,6 @@ const setOrderStatus = async (orderId, orderStatus, adminApiContext) => {
   return await adminApiContext.post(`./_action/order/${orderId}/state/${orderStatus}`);
 };
 
-const isSaaSInstance = async (adminApiContext) => {
-  const instanceFeatures = await adminApiContext.get("./instance/features");
-  return instanceFeatures.ok();
-};
-const isThemeCompiled = async (page) => {
-  let allCSSFound = false;
-  const listener = (request) => {
-    if (request.url().includes("all.css")) {
-      allCSSFound = true;
-    }
-  };
-  page.on("request", listener);
-  await page.goto("./", { waitUntil: "load" });
-  page.off("request", listener);
-  return allCSSFound;
-};
-
 const test$b = test$d.extend({
   SalesChannelBaseConfig: [
     async ({ AdminApiContext }, use) => {
@@ -234,7 +220,7 @@ const test$b = test$d.extend({
       const lang = await requests.language;
       const currency = await requests.currencyEUR;
       await use({
-        enGBLocaleId: lang.localeId,
+        enGBLocaleId: lang.translationCode.id,
         enGBLanguageId: lang.id,
         storefrontTypeId: "8a243080f92e4c719546314b577cf82b",
         eurCurrencyId: currency.id,
@@ -403,31 +389,6 @@ const test$b = test$d.extend({
       });
     },
     { scope: "worker" }
-  ],
-  DefaultStorefront: [
-    async ({ browser, AdminApiContext, DefaultSalesChannel, SalesChannelBaseConfig }, use) => {
-      const { id: uuid } = DefaultSalesChannel.salesChannel;
-      const isSaasInstance = await isSaaSInstance(AdminApiContext);
-      const tmpContext = await browser.newContext({
-        baseURL: DefaultSalesChannel.url
-      });
-      const tmpPage = await tmpContext.newPage();
-      if (!await isThemeCompiled(tmpPage)) {
-        test$d.slow();
-        await AdminApiContext.post(
-          `./_action/theme/${SalesChannelBaseConfig.defaultThemeId}/assign/${uuid}`
-        );
-        if (isSaasInstance) {
-          while (!await isThemeCompiled(tmpPage)) {
-            await tmpPage.waitForTimeout(2e3);
-          }
-        }
-      }
-      await use({
-        ...DefaultSalesChannel
-      });
-    },
-    { scope: "worker" }
   ]
 });
 
@@ -671,6 +632,22 @@ async function mockApiCalls(page) {
   }));
 }
 
+const isSaaSInstance = async (adminApiContext) => {
+  const instanceFeatures = await adminApiContext.get("./instance/features");
+  return instanceFeatures.ok();
+};
+const isThemeCompiled = async (context, storefrontUrl) => {
+  const response = await context.get(storefrontUrl);
+  const body = (await response.body()).toString();
+  const matches = body.match(/.*"(https:\/\/.*all\.css[^"]*)".*/);
+  if (matches && matches?.length > 1) {
+    const allCssUrl = matches[1];
+    const allCssResponse = await context.get(allCssUrl);
+    return allCssResponse.status() < 400;
+  }
+  return false;
+};
+
 const test$9 = test$d.extend({
   AdminPage: async ({ IdProvider, AdminApiContext, SalesChannelBaseConfig, browser }, use) => {
     const context = await browser.newContext({
@@ -721,15 +698,26 @@ const test$9 = test$d.extend({
     await use(page);
     await page.close();
     await context.close();
-    const cleanupResponse = await AdminApiContext.delete(`user/${uuid}`);
-    expect(cleanupResponse.ok()).toBeTruthy();
+    await AdminApiContext.delete(`user/${uuid}`);
   },
-  StorefrontPage: async ({ DefaultStorefront, browser }, use) => {
-    const { url } = DefaultStorefront;
+  StorefrontPage: async ({ DefaultSalesChannel, SalesChannelBaseConfig, browser, AdminApiContext }, use) => {
+    const { url, salesChannel } = DefaultSalesChannel;
     const context = await browser.newContext({
       baseURL: url
     });
     const page = await context.newPage();
+    const isSaasInstance = await isSaaSInstance(AdminApiContext);
+    if (!await isThemeCompiled(AdminApiContext, DefaultSalesChannel.url)) {
+      test$d.slow();
+      await AdminApiContext.post(
+        `./_action/theme/${SalesChannelBaseConfig.defaultThemeId}/assign/${salesChannel.id}`
+      );
+      if (isSaasInstance) {
+        while (!await isThemeCompiled(AdminApiContext, DefaultSalesChannel.url)) {
+          await page.waitForTimeout(4e3);
+        }
+      }
+    }
     await page.goto("./", { waitUntil: "load" });
     await use(page);
     await page.close();
@@ -1856,23 +1844,22 @@ const test$6 = test$d.extend({
     { scope: "worker" }
   ],
   SaaSInstanceSetup: [
-    async ({ AdminApiContext, browser }, use) => {
+    async ({ AdminApiContext: context }, use) => {
       const SetupInstance = async function SetupInstance2() {
-        await test$6.skip(!await isSaaSInstance(AdminApiContext), "Skipping SaaS setup, could not detect SaaS instance");
-        const instanceStatusResponse = await AdminApiContext.get("./instance/status");
+        await test$6.skip(!await isSaaSInstance(context), "Skipping SaaS setup, could not detect SaaS instance");
+        expect(context.options.admin_username, "setup requires admin user credentials").toEqual(expect.any(String));
+        expect(context.options.admin_password, "setup requires admin user credentials").toEqual(expect.any(String));
+        const instanceStatusResponse = await context.get("./instance/status");
         const instanceStatus = await instanceStatusResponse.json();
         await expect(instanceStatus.tags, 'expect instance to have "ci" tag').toContain("ci");
-        await test$6.skip((await AdminApiContext.get(`${process.env.APP_URL}constructionmode`, { maxRedirects: 0 })).status() > 204, "Instance already setup");
-        const page = await browser.newPage({ baseURL: process.env.ADMIN_URL });
-        await page.goto("./set-up-shop");
-        await page.getByRole("button", { name: "Next" }).click();
-        await expect(page.getByRole("heading", { name: "Everything finished!" })).toBeVisible();
-        await page.getByRole("button", { name: "Open your shop" }).click();
-        await page.goto(`${process.env.ADMIN_URL}`);
-        await page.getByLabel(/Username|Email address/).fill(AdminApiContext.options.admin_username ?? "admin");
-        await page.getByLabel("Password").fill(AdminApiContext.options.admin_password ?? "shopware");
-        await page.getByRole("button", { name: "Log in" }).click();
-        await page.getByRole("button", { name: "Launch your business" }).click();
+        const currency = await getCurrency("USD", context);
+        const language = await getLanguageData("en-US", context);
+        await context.post(
+          "./_actions/set-default-entities",
+          { data: { currencyId: currency.id, languageId: language.id } }
+        );
+        const token = await AdminApiContext.authenticateWithUserPassword(context.context, context.options);
+        await context.post("./sbp/request-live-status", { headers: { Authorization: `Bearer ${token}` } });
       };
       await use(SetupInstance);
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware-ag/acceptance-test-suite",
-  "version": "2.3.1",
+  "version": "2.3.4",
   "description": "Shopware Acceptance Test Suite",
   "author": "shopware AG",
   "license": "MIT",