@shopware-ag/acceptance-test-suite 2.4.0 → 2.5.0

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import * as axe_core from 'axe-core';
 import * as _playwright_test from '@playwright/test';
 import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
 export * from '@playwright/test';
@@ -194,6 +195,9 @@ type Product = Omit<components['schemas']['Product'], 'price' | 'prices'> & {
         name: string;
     };
 };
+type Manufacturer = components['schemas']['ProductManufacturer'] & {
+    id: string;
+};
 type PropertyGroup = components['schemas']['PropertyGroup'] & {
     id: string;
 };
@@ -338,6 +342,18 @@ declare class TestDataService {
      * @param currencyId - The uuid of the currency to use for the product pricing.
      */
     createProductWithPriceRange(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a basic manufacturer without images or other special configuration.
+     *
+     * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+     */
+    createBasicManufacturer(overrides?: Partial<Manufacturer>): Promise<Manufacturer>;
+    /**
+     * Creates a basic manufacturer with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+     */
+    createManufacturerWithImage(overrides?: Partial<Manufacturer>): Promise<Manufacturer>;
     /**
      * Creates a basic product category to assign products to.
      *
@@ -419,6 +435,20 @@ declare class TestDataService {
      * @param mediaId - The uuid of the media resource.
      */
     assignProductMedia(productId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a media resource to a manufacturer as a logo.
+     *
+     * @param manufacturerId - The uuid of the manufacturer.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignManufacturerMedia(manufacturerId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a manufacturer to a product.
+     *
+     * @param manufacturerId - The uuid of the manufacturer.
+     * @param productId - The uuid of the product.
+     */
+    assignManufacturerProduct(manufacturerId: string, productId: string): Promise<playwright_core.APIResponse>;
     /**
      * Assigns a product to a category.
      *
@@ -521,6 +551,7 @@ declare class TestDataService {
     convertDateTime(date: Date): string;
     getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
     getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
+    getBasicManufacturerStruct(overrides?: Partial<Manufacturer>): Partial<Manufacturer>;
     getBasicCategoryStruct(overrides?: Partial<Category$1>, parentId?: string): {
         id: string;
         name: string;
@@ -1115,7 +1146,7 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
 } & {
     OpenSearchSuggestPage: Task;
 } & {
-    ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
+    ValidateAccessibility: (pageName: string, assertViolations?: number | boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<axe_core.Result[]>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-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 };
+export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, 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

@@ -1,3 +1,4 @@
+import * as axe_core from 'axe-core';
 import * as _playwright_test from '@playwright/test';
 import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
 export * from '@playwright/test';
@@ -194,6 +195,9 @@ type Product = Omit<components['schemas']['Product'], 'price' | 'prices'> & {
         name: string;
     };
 };
+type Manufacturer = components['schemas']['ProductManufacturer'] & {
+    id: string;
+};
 type PropertyGroup = components['schemas']['PropertyGroup'] & {
     id: string;
 };
@@ -338,6 +342,18 @@ declare class TestDataService {
      * @param currencyId - The uuid of the currency to use for the product pricing.
      */
     createProductWithPriceRange(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a basic manufacturer without images or other special configuration.
+     *
+     * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+     */
+    createBasicManufacturer(overrides?: Partial<Manufacturer>): Promise<Manufacturer>;
+    /**
+     * Creates a basic manufacturer with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+     */
+    createManufacturerWithImage(overrides?: Partial<Manufacturer>): Promise<Manufacturer>;
     /**
      * Creates a basic product category to assign products to.
      *
@@ -419,6 +435,20 @@ declare class TestDataService {
      * @param mediaId - The uuid of the media resource.
      */
     assignProductMedia(productId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a media resource to a manufacturer as a logo.
+     *
+     * @param manufacturerId - The uuid of the manufacturer.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignManufacturerMedia(manufacturerId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a manufacturer to a product.
+     *
+     * @param manufacturerId - The uuid of the manufacturer.
+     * @param productId - The uuid of the product.
+     */
+    assignManufacturerProduct(manufacturerId: string, productId: string): Promise<playwright_core.APIResponse>;
     /**
      * Assigns a product to a category.
      *
@@ -521,6 +551,7 @@ declare class TestDataService {
     convertDateTime(date: Date): string;
     getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
     getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
+    getBasicManufacturerStruct(overrides?: Partial<Manufacturer>): Partial<Manufacturer>;
     getBasicCategoryStruct(overrides?: Partial<Category$1>, parentId?: string): {
         id: string;
         name: string;
@@ -1115,7 +1146,7 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
 } & {
     OpenSearchSuggestPage: Task;
 } & {
-    ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
+    ValidateAccessibility: (pageName: string, assertViolations?: number | boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<axe_core.Result[]>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-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 };
+export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, 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

@@ -1032,6 +1032,31 @@ class TestDataService {
     const productOverrides = Object.assign({}, priceRange, overrides);
     return this.createBasicProduct(productOverrides, taxId, currencyId);
   }
+  /**
+   * Creates a basic manufacturer without images or other special configuration.
+   *
+   * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+   */
+  async createBasicManufacturer(overrides = {}) {
+    const basicManufacturer = this.getBasicManufacturerStruct(overrides);
+    const manufacturerResponse = await this.AdminApiClient.post("./product-manufacturer?_response=detail", {
+      data: basicManufacturer
+    });
+    const { data: manufacturer } = await manufacturerResponse.json();
+    this.addCreatedRecord("product-manufacturer", manufacturer.id);
+    return manufacturer;
+  }
+  /**
+   * Creates a basic manufacturer with one randomly generated image.
+   *
+   * @param overrides - Specific data overrides that will be applied to the manufacturer data struct.
+   */
+  async createManufacturerWithImage(overrides = {}) {
+    const manufacturer = await this.createBasicManufacturer(overrides);
+    const media = await this.createMediaPNG();
+    await this.assignManufacturerMedia(manufacturer.id, media.id);
+    return manufacturer;
+  }
   /**
    * Creates a basic product category to assign products to.
    *
@@ -1289,6 +1314,34 @@ class TestDataService {
     const { data: productMedia } = await mediaResponse.json();
     return productMedia;
   }
+  /**
+   * Assigns a media resource to a manufacturer as a logo.
+   *
+   * @param manufacturerId - The uuid of the manufacturer.
+   * @param mediaId - The uuid of the media resource.
+   */
+  async assignManufacturerMedia(manufacturerId, mediaId) {
+    const mediaResponse = await this.AdminApiClient.patch(`product-manufacturer/${manufacturerId}?_response=basic`, {
+      data: {
+        mediaId
+      }
+    });
+    const { data: manufacturerMedia } = await mediaResponse.json();
+    return manufacturerMedia;
+  }
+  /**
+   * Assigns a manufacturer to a product.
+   *
+   * @param manufacturerId - The uuid of the manufacturer.
+   * @param productId - The uuid of the product.
+   */
+  async assignManufacturerProduct(manufacturerId, productId) {
+    return await this.AdminApiClient.patch(`product/${productId}?_response=basic`, {
+      data: {
+        manufacturerId
+      }
+    });
+  }
   /**
    * Assigns a product to a category.
    *
@@ -1643,6 +1696,21 @@ class TestDataService {
       }]
     };
   }
+  getBasicManufacturerStruct(overrides = {}) {
+    const { id: manufacturerId, uuid: manufacturerUuid } = this.IdProvider.getIdPair();
+    const manufacturerName = `${this.namePrefix}Manufacturer-${manufacturerId}${this.nameSuffix}`;
+    const description = `
+            Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
+            At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. 
+            Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
+            At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.`.trim();
+    const basicManufacturer = {
+      id: manufacturerUuid,
+      name: manufacturerName,
+      description
+    };
+    return Object.assign({}, basicManufacturer, overrides);
+  }
   getBasicCategoryStruct(overrides = {}, parentId = this.defaultCategoryId) {
     const { id: categoryId, uuid: categoryUuid } = this.IdProvider.getIdPair();
     const categoryName = `${this.namePrefix}Category-${categoryId}${this.nameSuffix}`;
@@ -3657,6 +3725,7 @@ const ValidateAccessibility = test$d.extend({
     const task = (pageName, assertViolations = true, createReport = true, ruleTags = ["wcag2a", "wcag2aa", "wcag2aaa", "wcag21a", "wcag21aa", "best-practice"], outputDir = "test-results/AccessibilityReports") => {
       return async function ValidateAccessibility2() {
         const axeBuilder = new AxeBuilder({ page: ShopCustomer.page });
+        axeBuilder.exclude(".sf-toolbar");
         const accessibilityResults = await axeBuilder.withTags(ruleTags).analyze();
         if (createReport) {
           createHtmlReport({
@@ -3668,9 +3737,12 @@ const ValidateAccessibility = test$d.extend({
             }
           });
         }
-        if (assertViolations) {
+        if (typeof assertViolations === "number") {
+          ShopCustomer.expects(accessibilityResults.violations.length).toBeLessThanOrEqual(assertViolations);
+        } else if (assertViolations) {
           ShopCustomer.expects(accessibilityResults.violations).toEqual([]);
         }
+        return accessibilityResults.violations;
       };
     };
     await use(task);

package/package.json

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