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

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", {
@@ -2423,6 +2425,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 +2465,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.0",
   "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"
   },