cleanup

alexwizp · alexwizp · commit 4c2f7479ba2e · 2025-11-26T13:44:31.000+02:00
diff --git a/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/scope/test/scout_page/single_thread.ts b/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/scope/test/scout_page/single_thread.ts
@@ -12,7 +12,7 @@ import type { Page } from '@playwright/test';
 import { test as base } from '@playwright/test';
 import type { ScoutPage } from '.';
 import type { PathOptions } from '../../../../../common/services/kibana_url';
-import { keyTo, checkA11y, type RunA11yScanOptions } from '../../../../utils';
+import { keyTo, checkA11y } from '../../../../utils';
 import type { KibanaUrl, ScoutLogger } from '../../worker';
 
 /**
diff --git a/src/platform/packages/shared/kbn-scout/src/playwright/utils/axe.ts b/src/platform/packages/shared/kbn-scout/src/playwright/utils/axe.ts
@@ -8,40 +8,23 @@
  */
 
 import type { Page } from '@playwright/test';
+import type { Result } from 'axe-core';
 import AxeBuilder from '@axe-core/playwright';
 import { AXE_OPTIONS, AXE_IMPACT_LEVELS } from '@kbn/axe-config';
 
 import type { KibanaUrl } from '../../..';
 
-export interface A11yViolation {
-  id: string;
-  impact?: string;
-  description: string;
-  help: string;
-  helpUrl: string;
-  nodes: Array<{
-    html: string;
-    target: string[];
-    failureSummary?: string;
-  }>;
-  url?: string;
-}
-
 export interface RunA11yScanOptions {
   /** Optional CSS selectors to exclude from scan */
   exclude?: string[];
   /** Timeout in ms for the scan (defaults 10000) */
   timeoutMs?: number;
 }
 
-export interface RunA11yScanResult {
-  violations: A11yViolation[];
-}
-
-export const runA11yScan = async (
+const runA11yScan = async (
   page: Page,
   { exclude = [], timeoutMs = 10000 }: RunA11yScanOptions = {}
-): Promise<RunA11yScanResult> => {
+) => {
   const builder = new AxeBuilder({ page });
   builder.options(AXE_OPTIONS);
 
@@ -68,7 +51,7 @@ export const runA11yScan = async (
     clearTimeout(timeoutId);
   }
 
-  let violations = (result.violations as A11yViolation[]) || [];
+  let violations: Result[] = result.violations;
 
   if (AXE_IMPACT_LEVELS?.length) {
     const allowed = new Set(AXE_IMPACT_LEVELS);
@@ -80,22 +63,31 @@ export const runA11yScan = async (
   return { violations };
 };
 
-/**
- * Assert helper usable inside tests.
- */
 export const checkA11y = async (page: Page, kbnUrl?: KibanaUrl, options?: RunA11yScanOptions) => {
   const { violations } = await runA11yScan(page, options);
 
+  const formatA11yViolation = (v: Result): string => {
+    const nodesSection = v.nodes
+      .map((n, idx) => {
+        const selectors = n.target.join(', ');
+        const failure = n.failureSummary?.trim() || 'No failure summary provided';
+        return `  ${idx + 1}. Selectors: ${selectors}\n     Failure: ${failure}`;
+      })
+      .join('\n');
+
+    return [
+      `\nAccessibility violation detected!\n`,
+      `  Rule: ${v.id}. Impact: (${v.impact ?? 'impact unknown'})`,
+      `  Description: ${v.description}`,
+      `  Help: ${v.help}. See more: ${v.helpUrl}`,
+      `  Page: ${kbnUrl}`,
+      `  Nodes:\n${nodesSection}`,
+    ]
+      .join('\n')
+      .trim();
+  };
+
   return {
-    violations: violations.map(
-      (v) =>
-        `Accessibility violation: ${v.id} (${v.impact}): \n
-          ${v.helpUrl}\n
-          ${v.description}\n
-          ${kbnUrl} \n
-          Nodes:\n${v.nodes
-            .map((n) => `    ${n.target.join(', ')} -> ${n.failureSummary}`)
-            .join('\n')}`
-    ),
+    violations: violations.map((v) => formatA11yViolation(v)),
   };
 };
diff --git a/src/platform/packages/shared/kbn-scout/test/scout/ui/tests/axe.spec.ts b/src/platform/packages/shared/kbn-scout/test/scout/ui/tests/axe.spec.ts
@@ -12,14 +12,19 @@ import { test, expect } from '../../../../src/playwright';
 test.describe('runA11yScan', { tag: ['@svlSecurity', '@ess'] }, () => {
   test('returns violations array (empty for basic accessible markup)', async ({ page }) => {
     await page.setContent(`
+      <html lang="en">
+      <head>
+        <title>AXE Core check for basic accessible markup</title>
+      </head>
       <main>
-        <h1>Title</h1>
+        <h1>AXE Core check for basic accessible markup</h1>
         <button aria-label="Close dialog">X</button>
         <form>
           <label for="email">Email</label>
           <input id="email" type="email" />
         </form>
       </main>
+      </html>
     `);
 
     const { violations } = await page.checkA11y();
