axe-playwright 1.2.3 → 2.0.1

package/README.md

@@ -6,7 +6,7 @@
 [![NPM release](https://img.shields.io/npm/v/axe-playwright.svg 'NPM release')](https://www.npmjs.com/package/axe-playwright)
 [![NPM Downloads](https://img.shields.io/npm/dt/axe-playwright.svg?style=flat-square)](https://www.npmjs.com/package/axe-playwright)
 
-[Axe](https://www.deque.com/axe/) is an accessibility testing engine for websites and other HTML-based user interfaces. This package provides simple axe analyser commands which you can incorporate in your [Playwright](https://www.npmjs.com/package/playwright) tests.
+[Axe](https://www.deque.com/axe/) is an accessibility testing engine for websites and other HTML-based user interfaces. This package provides simple axe analyser commands which you can incorporate in your [Playwright](https://www.npmjs.com/package/playwright) tests. [Axe](https://www.deque.com/axe/) seamlessly functions across all Playwright browsers: Chromium, Firefox, and WebKit.
 
 ## Install and configure
 
@@ -118,16 +118,16 @@ The `detailedReport` key is a boolean whether to print the more detailed report
 
 The `verbose` key is a boolean to whether to print the message `No accessibility violations detected!` when there aren't accessibility violations present in the test. For the `DefaultTerminalReporter` this is true and for the `v2 Reporter` this is false.
 
+##### skipFailures (optional, defaults to false)
+
+Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail.
+
 ##### reporter (optional)
 
 A class instance that implements the `Reporter` interface or values `default`, `v2` and `html`. Custom reporter instances can be supplied to override default reporting behaviour dictated by `DefaultTerminalReporter` set by the value `default`. `v2` is the new TerminalReporter inspired by the reports from [jest-axe](https://github.com/nickcolley/jest-axe). `html` reporter will generate external HTML file.
 
 Note! `html` reporter will disable printed to logs violations.
 
-##### skipFailures (optional, defaults to false)
-
-Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail.
-
 ##### options (dedicated for axe-html-reporter)
 
 Options dedicated for HTML reporter. 
@@ -305,7 +305,8 @@ await checkA11y(
           },
         },
       },
-      true, 'default',
+      true,
+      'html',
       {
         outputDirPath: 'results',
         outputDir: 'accessibility',
@@ -313,8 +314,29 @@ await checkA11y(
       }
     )
 ```
+#### JUnit Report
 
-
+```
+await checkA11y(
+      page,
+      'form',
+      {
+        axeOptions: {
+          runOnly: {
+            type: 'tag',
+            values: ['wcag2a'],
+          },
+        },
+      },
+      true,
+      'junit',
+     {
+        outputDirPath: 'results',
+        outputDir: 'accessibility',
+        reportFileName: 'accessibility-audit.xml',
+      },
+    )
+```
 ## Before you Go
 
 If it works for you , leave a [Star](https://github.com/abhinaba-ghosh/axe-playwright)! :star:

package/dist/index.d.ts

@@ -52,5 +52,5 @@ export declare const reportViolations: (violations: Result[], reporter: Reporter
  * @param reporter
  * @param options
  */
-export declare const checkA11y: (page: Page, context?: ElementContext | undefined, axeOptions?: AxeOptions | undefined, skipFailures?: boolean, reporter?: Reporter | 'default' | 'html' | 'v2', options?: Options | undefined) => Promise<void>;
+export declare const checkA11y: (page: Page, context?: ElementContext | undefined, axeOptions?: AxeOptions | undefined, skipFailures?: boolean, reporter?: Reporter | 'default' | 'html' | 'junit' | 'v2', options?: Options | undefined) => Promise<void>;
 export { DefaultTerminalReporter };

package/dist/index.js

@@ -42,6 +42,8 @@ const defaultTerminalReporter_1 = __importDefault(require("./reporter/defaultTer
 exports.DefaultTerminalReporter = defaultTerminalReporter_1.default;
 const terminalReporterV2_1 = __importDefault(require("./reporter/terminalReporterV2"));
 const axe_html_reporter_1 = require("axe-html-reporter");
+const junitReporter_1 = __importDefault(require("./reporter/junitReporter"));
+const path = __importStar(require("path"));
 /**
  * Injects axe executable commands in the active window
  * @param page
@@ -115,17 +117,26 @@ const checkA11y = (page, context = undefined, axeOptions = undefined, skipFailur
     }
     else if (reporter === 'html') {
         if (violations.length > 0) {
-            yield (0, axe_html_reporter_1.createHtmlReport)({ results: { violations }, options });
+            yield (0, axe_html_reporter_1.createHtmlReport)({
+                results: { violations },
+                options,
+            });
         }
         else
-            console.log("There were no violations to save in report");
+            console.log('There were no violations to save in report');
+    }
+    else if (reporter === 'junit') {
+        // Get the system root directory
+        // Construct the file path
+        const outputFilePath = path.join(process.cwd(), options === null || options === void 0 ? void 0 : options.outputDirPath, options === null || options === void 0 ? void 0 : options.outputDir, options === null || options === void 0 ? void 0 : options.reportFileName);
+        reporterWithOptions = new junitReporter_1.default(axeOptions === null || axeOptions === void 0 ? void 0 : axeOptions.detailedReport, page, outputFilePath);
     }
     else {
         reporterWithOptions = reporter;
     }
     if (reporter !== 'html')
         yield (0, exports.reportViolations)(impactedViolations, reporterWithOptions);
-    if (reporter === 'v2' || reporter !== 'html')
+    if (reporter === 'v2' || (reporter !== 'html' && reporter !== 'junit'))
         (0, utils_1.testResultDependsOnViolations)(impactedViolations, skipFailures);
 });
 exports.checkA11y = checkA11y;

package/dist/reporter/junitReporter.d.ts

@@ -0,0 +1,10 @@
+import Reporter from '../types';
+import { Result } from 'axe-core';
+import { Page } from 'playwright';
+export default class JUnitReporter implements Reporter {
+    protected verbose: boolean | undefined;
+    protected page: Page | undefined;
+    protected outputFilename: string | undefined;
+    constructor(verbose: boolean | undefined, page: Page | undefined, outputFilename: string | undefined);
+    report(violations: Result[]): Promise<void>;
+}

package/dist/reporter/junitReporter.js

@@ -0,0 +1,104 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const junit_report_builder_1 = __importDefault(require("junit-report-builder"));
+const assert_1 = __importDefault(require("assert"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+class JUnitReporter {
+    constructor(verbose, page, outputFilename) {
+        this.verbose = verbose;
+        this.page = page;
+        this.outputFilename = outputFilename;
+    }
+    report(violations) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let lineBreak = '\n';
+            let pageUrl = ((_a = this.page) === null || _a === void 0 ? void 0 : _a.url()) || 'Page';
+            let suite = junit_report_builder_1.default.testSuite().name(pageUrl);
+            const message = violations.length === 0
+                ? 'No accessibility violations detected!'
+                : `Found ${violations.length} accessibility violations`;
+            violations.map((violation) => {
+                const errorBody = violation.nodes
+                    .map((node) => {
+                    const selector = node.target.join(', ');
+                    const expectedText = `Expected the HTML found at $('${selector}') to have no violations:` +
+                        '\n';
+                    return (expectedText +
+                        node.html +
+                        lineBreak +
+                        `Received:\n` +
+                        `${violation.help} (${violation.id})` +
+                        lineBreak +
+                        node.failureSummary +
+                        lineBreak +
+                        (violation.helpUrl
+                            ? `You can find more information on this issue here: \n${violation.helpUrl}`
+                            : '') +
+                        '\n');
+                })
+                    .join(lineBreak);
+                suite
+                    .testCase()
+                    .className(violation.id)
+                    .name(violation.description)
+                    .failure(errorBody);
+            });
+            const pass = violations.length === 0;
+            if (pass) {
+                junit_report_builder_1.default.testCase().name('Accesibility testing - A11Y');
+                this.verbose && console.log(`No accessibility violations detected!`);
+            }
+            let location = this.outputFilename || 'a11y-tests.xml';
+            const dir = path.dirname(location);
+            if (!fs.existsSync(dir)) {
+                fs.mkdirSync(dir, { recursive: true });
+            }
+            // Check if the file exists, if not create it
+            if (!fs.existsSync(location)) {
+                fs.writeFileSync(location, ''); // Create an empty file
+            }
+            junit_report_builder_1.default.writeTo(location);
+            if (!pass) {
+                assert_1.default.fail(message);
+            }
+        });
+    }
+}
+exports.default = JUnitReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-playwright",
-  "version": "1.2.3",
+  "version": "2.0.1",
   "description": "Custom Playwright commands to inject axe-core and test for a11y",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,9 +40,11 @@
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "picocolors": "^1.0.0",
+    "@types/junit-report-builder": "^3.0.0",
     "axe-core": "^4.5.1",
-    "axe-html-reporter": "2.2.3"
+    "axe-html-reporter": "2.2.3",
+    "junit-report-builder": "^3.0.1",
+    "picocolors": "^1.0.0"
   },
   "repository": {
     "type": "git",