@shopware-ag/acceptance-test-suite 1.2.0 → 1.3.1

package/dist/index.d.mts

@@ -590,6 +590,8 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     OpenSearchResultPage: Task;
 } & {
     OpenSearchSuggestPage: Task;
+} & {
+    ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & HelperFixtureTypes & FixtureTypes>;
 
 export { AdminPageObjects, type FixtureTypes, type PageObject, StorefrontPageObjects, type Task, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, test };

package/dist/index.d.ts

@@ -590,6 +590,8 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     OpenSearchResultPage: Task;
 } & {
     OpenSearchSuggestPage: Task;
+} & {
+    ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & HelperFixtureTypes & FixtureTypes>;
 
 export { AdminPageObjects, type FixtureTypes, type PageObject, StorefrontPageObjects, type Task, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, test };

package/dist/index.mjs

@@ -4,6 +4,8 @@ import crypto, { createHash } from 'crypto';
 import { stringify } from 'uuid';
 import { Image } from 'image-js';
 import fs from 'fs';
+import { AxeBuilder } from '@axe-core/playwright';
+import { createHtmlReport } from 'axe-html-reporter';
 
 const getLanguageData = async (languageCode, adminApiContext) => {
   const resp = await adminApiContext.post("search/language", {
@@ -365,6 +367,7 @@ const test$a = test$c.extend({
         email: `customer_${id}@example.com`,
         password: "shopware",
         salutationId: salutations.data[0].id,
+        languageId: SalesChannelBaseConfig.enGBLanguageId,
         defaultShippingAddress: {
           firstName: `${id} admin`,
           lastName: `${id} admin`,
@@ -1657,48 +1660,7 @@ const CategoryData = test$c.extend({
 });
 
 const DigitalProductData = test$c.extend({
-  DigitalProductData: async ({ IdProvider, AdminApiContext, SalesChannelBaseConfig, DefaultSalesChannel }, use) => {
-    const { id: productId, uuid: productUuid } = IdProvider.getIdPair();
-    const productName = `Digital_Product_test_${productId}`;
-    const productResponse = await AdminApiContext.post("./product?_response", {
-      data: {
-        active: true,
-        stock: 10,
-        taxId: SalesChannelBaseConfig.taxId,
-        id: productUuid,
-        name: productName,
-        productNumber: "Product-" + productId,
-        price: [
-          {
-            currencyId: SalesChannelBaseConfig.eurCurrencyId,
-            gross: 10,
-            linked: false,
-            net: 8.4
-          }
-        ],
-        purchasePrices: [
-          {
-            currencyId: SalesChannelBaseConfig.eurCurrencyId,
-            gross: 8,
-            linked: false,
-            net: 6.7
-          }
-        ],
-        visibilities: [
-          {
-            salesChannelId: DefaultSalesChannel.salesChannel.id,
-            visibility: 30
-          }
-        ],
-        categories: [
-          {
-            id: DefaultSalesChannel.salesChannel.navigationCategoryId
-          }
-        ]
-      }
-    });
-    expect(productResponse.ok()).toBeTruthy();
-    const { data: productData } = await productResponse.json();
+  DigitalProductData: async ({ ProductData, IdProvider, AdminApiContext }, use) => {
     const newMediaResource = await AdminApiContext.post("./media?_response", {
       data: {
         private: false
@@ -1718,41 +1680,37 @@ const DigitalProductData = test$c.extend({
     expect(newMediaUpload.ok()).toBeTruthy();
     const productDownloadResponse = await AdminApiContext.post(`./product-download?_response`, {
       data: {
-        productId: productData.id,
+        productId: ProductData.id,
         mediaId: newMediaId
       }
     });
     expect(productDownloadResponse.ok()).toBeTruthy();
     const { data: productDownload } = await productDownloadResponse.json();
     const returnData = {
-      product: productData,
+      product: ProductData,
       fileContent
     };
     await use(returnData);
     const orderSearchResponse = await AdminApiContext.post("./search/order", {
       data: {
         limit: 10,
-        filter: [
-          {
-            type: "equals",
-            field: "lineItems.productId",
-            value: productData.id
-          }
-        ]
+        filter: [{
+          type: "equals",
+          field: "lineItems.productId",
+          value: ProductData.id
+        }]
       }
     });
     expect(orderSearchResponse.ok()).toBeTruthy();
     const { data: ordersWithDigitalProduct } = await orderSearchResponse.json();
     for (const order of ordersWithDigitalProduct) {
       const deleteOrderResponse = await AdminApiContext.delete(`./order/${order.id}`);
-      expect(deleteOrderResponse.ok()).toBeTruthy();
+      expect(deleteOrderResponse.status()).toBeLessThan(500);
     }
     const unlinkMediaResponse = await AdminApiContext.delete(`./product-download/${productDownload.id}`);
     expect(unlinkMediaResponse.ok()).toBeTruthy();
     const cleanupMediaResponse = await AdminApiContext.delete(`./media/${newMediaId}`);
     expect(cleanupMediaResponse.ok()).toBeTruthy();
-    const cleanupResponse = await AdminApiContext.delete(`./product/${productUuid}`);
-    expect(cleanupResponse.ok()).toBeTruthy();
   }
 });
 
@@ -2143,7 +2101,7 @@ const OrderData = test$c.extend({
     const { data: order } = await orderResponse.json();
     await use(order);
     const cleanupResponse = await AdminApiContext.delete(`./order/${order.id}`);
-    expect(cleanupResponse.ok()).toBeTruthy();
+    expect(cleanupResponse.status()).toBeLessThan(500);
   }
 });
 
@@ -2423,6 +2381,31 @@ const OpenSearchSuggestPage = test$c.extend({
   }
 });
 
+const ValidateAccessibility = test$c.extend({
+  ValidateAccessibility: async ({ ShopCustomer }, use) => {
+    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 });
+        const accessibilityResults = await axeBuilder.withTags(ruleTags).analyze();
+        if (createReport) {
+          createHtmlReport({
+            results: accessibilityResults,
+            options: {
+              projectKey: pageName,
+              reportFileName: `${pageName.replace(/[^a-zA-Z]/g, "")}.html`,
+              outputDir
+            }
+          });
+        }
+        if (assertViolations) {
+          ShopCustomer.expects(accessibilityResults.violations).toEqual([]);
+        }
+      };
+    };
+    await use(task);
+  }
+});
+
 const test$1 = mergeTests(
   Login,
   Logout,
@@ -2438,7 +2421,8 @@ const test$1 = mergeTests(
   SelectExpressShippingOption,
   SubmitOrder,
   OpenSearchResultPage,
-  OpenSearchSuggestPage
+  OpenSearchSuggestPage,
+  ValidateAccessibility
 );
 
 const test = mergeTests(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware-ag/acceptance-test-suite",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Shopware Acceptance Test Suite",
   "author": "shopware AG",
   "license": "MIT",
@@ -38,6 +38,8 @@
   "dependencies": {
     "@playwright/test": "1.44.0",
     "@shopware/api-client": "0.5.0",
+    "@axe-core/playwright": "4.9.1",
+    "axe-html-reporter": "2.2.3",
     "image-js": "0.35.5",
     "uuid": "9.0.1"
   },