@grafana/plugin-e2e 3.3.2 → 3.4.0-canary.2462.22113308144.0

package/dist/fixtures/scanForA11yViolations.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var AxeBuilder = require('@axe-core/playwright');
+
+const scanForA11yViolations = async ({ page }, use, testInfo) => {
+  const builder = new AxeBuilder({ page }).withTags([
+    "wcag2a",
+    "wcag2aa",
+    "wcag21a",
+    "wcag21aa"
+    /*'best-practice'*/
+  ]);
+  use(async (options) => {
+    if (options) {
+      builder.options(options);
+    }
+    const accessibilityScanResults = await builder.analyze();
+    testInfo.annotations.push({
+      type: "axe-a11y",
+      description: JSON.stringify(accessibilityScanResults, null, 2)
+    });
+    return accessibilityScanResults;
+  });
+};
+
+exports.scanForA11yViolations = scanForA11yViolations;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as _playwright_test from '@playwright/test';
 import { Locator, Request, Response as Response$1, APIRequestContext, TestInfo, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, MatcherReturnType, Page } from '@playwright/test';
 export { selectors } from '@playwright/test';
+import { RunOptions, AxeResults } from 'axe-core';
 import { SelectorsOf, versionedPages, versionedComponents } from '@grafana/e2e-selectors';
 import * as playwright_core from 'playwright-core';
 
@@ -931,6 +932,14 @@ type PluginFixture = {
      * Fixture command that navigates to an AppPage for a given plugin.
      */
     gotoAppPage: (args: GotoAppPageArgs) => Promise<AppPage>;
+    /**
+     * Fixture command that scans the current page for accessibility violations using axe-core.
+     * By default, it checks for WCAG 2.0 A and AA level violations, as well as WCAG 2.1 A and AA.
+     * You can customize the rules that are checked by passing options to the command.
+     *
+     * You can use this in conjuntion with the .toHaveNoA11yViolations matcher to assert that there are no accessibility violations on the page.
+     */
+    scanForA11yViolations: (options?: RunOptions) => Promise<AxeResults>;
 };
 /**
  * The context object passed to page object models
@@ -1284,6 +1293,11 @@ declare function toBeChecked(target: Switch | Locator, options?: {
     timeout?: number;
 }): Promise<MatcherReturnType>;
 
+declare function toHaveNoA11yViolations(results: AxeResults, options?: {
+    threshold?: number;
+    ignoredRules?: string[];
+}): Promise<MatcherReturnType>;
+
 declare function toHaveChecked(radioGroup: RadioGroup, expected: string, options?: {
     timeout?: number;
 }): Promise<MatcherReturnType>;
@@ -1337,6 +1351,7 @@ declare const expect: _playwright_test.Expect<{
     toBeChecked: typeof toBeChecked;
     toHaveChecked: typeof toHaveChecked;
     toHaveColor: typeof toHaveColor;
+    toHaveNoA11yViolations: typeof toHaveNoA11yViolations;
 }>;
 
 declare global {

package/dist/index.js

@@ -30,6 +30,7 @@ var panelEditPage = require('./fixtures/panelEditPage.js');
 var selectors = require('./fixtures/selectors.js');
 var variableEditPage = require('./fixtures/variableEditPage.js');
 var alertRuleEditPage = require('./fixtures/alertRuleEditPage.js');
+var scanForA11yViolations = require('./fixtures/scanForA11yViolations.js');
 var options = require('./options.js');
 var toHaveAlert = require('./matchers/toHaveAlert.js');
 var toDisplayPreviews = require('./matchers/toDisplayPreviews.js');
@@ -38,6 +39,7 @@ var variablePage = require('./fixtures/variablePage.js');
 var gotoVariablePage = require('./fixtures/commands/gotoVariablePage.js');
 var toHaveSelected = require('./matchers/toHaveSelected.js');
 var toBeChecked = require('./matchers/toBeChecked.js');
+var toHaveNoA11yViolations = require('./matchers/toHaveNoA11yViolations.js');
 var toHaveChecked = require('./matchers/toHaveChecked.js');
 var toHaveColor = require('./matchers/toHaveColor.js');
 var DataSourcePicker = require('./models/components/DataSourcePicker.js');
@@ -91,6 +93,7 @@ const test = testWithInternal.extend({
   gotoDataSourceConfigPage: gotoDataSourceConfigPage.gotoDataSourceConfigPage,
   gotoAppConfigPage: gotoAppConfigPage.gotoAppConfigPage,
   gotoAppPage: gotoAppPage.gotoAppPage,
+  scanForA11yViolations: scanForA11yViolations.scanForA11yViolations,
   ...options.options
 });
 const expect = test$1.expect.extend({
@@ -100,7 +103,8 @@ const expect = test$1.expect.extend({
   toHaveSelected: toHaveSelected.toHaveSelected,
   toBeChecked: toBeChecked.toBeChecked,
   toHaveChecked: toHaveChecked.toHaveChecked,
-  toHaveColor: toHaveColor.toHaveColor
+  toHaveColor: toHaveColor.toHaveColor,
+  toHaveNoA11yViolations: toHaveNoA11yViolations.toHaveNoA11yViolations
 });
 
 Object.defineProperty(exports, "selectors", {

package/dist/matchers/toHaveNoA11yViolations.js

@@ -0,0 +1,38 @@
+'use strict';
+
+async function toHaveNoA11yViolations(results, options) {
+  const threshold = options?.threshold ?? 0;
+  let violations = [];
+  try {
+    violations = results.violations.filter((violation) => !options?.ignoredRules?.includes(violation.id));
+    if (violations.length > threshold) {
+      throw new Error(`${violations.length} Axe violations found (Threshold: ${threshold})`);
+    }
+    return {
+      pass: true,
+      expected: threshold,
+      message: () => `Fewer than ${threshold} Axe violations found.`
+    };
+  } catch (err) {
+    let message = err instanceof Error ? err.toString() : "Unknown error";
+    if (violations.length > 0) {
+      const violationDetails = violations.flatMap((v) => [
+        `- Rule: ${v.id}`,
+        `  Description: ${v.description}`,
+        `  Docs: ${v.helpUrl}`,
+        `  Affected nodes: 
+${v.nodes.map((node) => `    - ${node.html}`).join("\n")}`
+      ]).join("\n");
+      message += `
+
+Axe Violations:
+${violationDetails}`;
+    }
+    return {
+      message: () => message,
+      pass: false
+    };
+  }
+}
+
+exports.toHaveNoA11yViolations = toHaveNoA11yViolations;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "3.3.2",
+  "version": "3.4.0-canary.2462.22113308144.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -39,13 +39,15 @@
   "devDependencies": {
     "@playwright/test": "^1.58.1",
     "@types/uuid": "^11.0.0",
+    "axe-core": "^4.11.1",
     "dotenv": "^17.2.4"
   },
   "dependencies": {
+    "@axe-core/playwright": "^4.11.1",
     "@grafana/e2e-selectors": "12.4.0-21983999378",
     "semver": "^7.5.4",
     "uuid": "^13.0.0",
     "yaml": "^2.3.4"
   },
-  "gitHead": "eb61fc98de779b2b080355a32b0e3ab1e01a798c"
+  "gitHead": "2461eb0e2375ab90ee71a022aac299aef99c8de1"
 }