push some updates

Author: alexwizp

src/platform/packages/shared/kbn-axe-config/index.ts

@@ -50,3 +50,8 @@ export const AXE_OPTIONS = {
     },
   },
 };
+
+export const AXE_IMPACT_LEVELS: Array<'minor' | 'moderate' | 'serious' | 'critical'> = [
+  'critical',
+  'serious',
+];

src/platform/packages/shared/kbn-scout/src/playwright/fixtures/scope/test/scout_page/index.ts

@@ -8,7 +8,7 @@
  */
 
 import type { Page } from '@playwright/test';
-import type { A11yViolation } from '../../../../utils';
+import type { RunA11yScanOptions } from '../../../../utils';
 import type { PathOptions } from '../../../../../common/services/kibana_url';
 
 /**
@@ -42,9 +42,16 @@ export type ScoutPage = Page & {
    */
   keyTo: (selector: string, key: string, maxElementsToTraverse?: number) => Promise<void>;
 
-  // @todo
-  checkA11y: () => Promise<{
-    violations: A11yViolation[];
+  /**
+   * Performs an accessibility (a11y) scan of the current page using axe-core.
+   * Use this in tests to collect formatted violation summaries (one string per violation).
+   *
+   * @param options - Optional accessibility scan configuration (e.g. selectors to exclude, timeout).
+   * @returns A Promise resolving to an object with a 'violations' array containing
+   *          human-readable formatted strings for each detected violation (empty if none).
+   */
+  checkA11y: (options?: RunA11yScanOptions) => Promise<{
+    violations: string[];
   }>;
 
   /**

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 } from '../../../../utils';
+import { keyTo, checkA11y, type RunA11yScanOptions } from '../../../../utils';
 import type { KibanaUrl, ScoutLogger } from '../../worker';
 
 /**
@@ -109,7 +109,7 @@ export function extendPlaywrightPage({
     return await keyTo(page, selector, key, maxElementsToTraverse);
   };
 
-  extendedPage.checkA11y = () => checkA11y(page, kbnUrl);
+  extendedPage.checkA11y = (options) => checkA11y(page, kbnUrl, options);
 
   // Method to type text with delay character by character
   extendedPage.typeWithDelay = (selector: string, text: string, options?: { delay: number }) =>

src/platform/packages/shared/kbn-scout/src/playwright/utils/axe.ts

@@ -9,7 +9,7 @@
 
 import type { Page } from '@playwright/test';
 import AxeBuilder from '@axe-core/playwright';
-import { AXE_OPTIONS } from '@kbn/axe-config';
+import { AXE_OPTIONS, AXE_IMPACT_LEVELS } from '@kbn/axe-config';
 
 import type { KibanaUrl } from '../../..';
 
@@ -30,8 +30,6 @@ export interface A11yViolation {
 export interface RunA11yScanOptions {
   /** Optional CSS selectors to exclude from scan */
   exclude?: string[];
-  /** Optional result impact levels to include (e.g. \['critical','serious'\]) */
-  impactLevels?: Array<'minor' | 'moderate' | 'serious' | 'critical'>;
   /** Timeout in ms for the scan (defaults 10000) */
   timeoutMs?: number;
 }
@@ -42,13 +40,15 @@ export interface RunA11yScanResult {
 
 export const runA11yScan = async (
   page: Page,
-  { exclude = [], impactLevels, timeoutMs = 10000 }: RunA11yScanOptions = {}
+  { exclude = [], timeoutMs = 10000 }: RunA11yScanOptions = {}
 ): Promise<RunA11yScanResult> => {
   const builder = new AxeBuilder({ page });
   builder.options(AXE_OPTIONS);
 
-  for (const selector of exclude) {
-    builder.exclude(selector);
+  if (exclude) {
+    for (const selector of exclude) {
+      builder.exclude(selector);
+    }
   }
 
   const analysisPromise = builder.analyze();
@@ -70,10 +70,10 @@ export const runA11yScan = async (
 
   let violations = (result.violations as A11yViolation[]) || [];
 
-  if (impactLevels && impactLevels.length) {
-    const allowed = new Set(impactLevels);
+  if (AXE_IMPACT_LEVELS?.length) {
+    const allowed = new Set(AXE_IMPACT_LEVELS);
     violations = violations.filter(
-      (v) => v.impact && allowed.has(v.impact as (typeof impactLevels)[number])
+      (v) => v.impact && allowed.has(v.impact as (typeof AXE_IMPACT_LEVELS)[number])
     );
   }
 
@@ -83,13 +83,19 @@ export const runA11yScan = async (
 /**
  * Assert helper usable inside tests.
  */
-export const checkA11y = async (page: Page, kbnUrl?: KibanaUrl) => {
-  const { violations } = await runA11yScan(page);
+export const checkA11y = async (page: Page, kbnUrl?: KibanaUrl, options?: RunA11yScanOptions) => {
+  const { violations } = await runA11yScan(page, options);
 
   return {
-    violations: violations.map((v) => ({
-      ...v,
-      url: kbnUrl?.toString(),
-    })),
+    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')}`
+    ),
   };
 };

src/platform/packages/shared/kbn-scout/src/playwright/utils/index.ts

@@ -10,4 +10,4 @@
 export { isValidUTCDate, formatTime, getPlaywrightGrepTag, execPromise } from './runner_utils';
 export { resolveSelector, type SelectorInput } from './locator_helper';
 export { keyTo } from './a11y_utils';
-export { checkA11y, type A11yViolation } from './axe';
+export { checkA11y, type RunA11yScanOptions } from './axe';

…ut/test/scout/ui/tests/utils/axe.spec.ts …bn-scout/test/scout/ui/tests/axe.spec.tssrc/platform/packages/shared/kbn-scout/test/scout/ui/tests/utils/axe.spec.ts renamed to src/platform/packages/shared/kbn-scout/test/scout/ui/tests/axe.spec.ts src/platform/packages/shared/kbn-scout/test/scout/ui/tests/utils/axe.spec.ts renamed to src/platform/packages/shared/kbn-scout/test/scout/ui/tests/axe.spec.ts

@@ -7,9 +7,9 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { test, expect } from '../../../../../src/playwright';
+import { test, expect } from '../../../../src/playwright';
 
-test.describe('runA11yScan', () => {
+test.describe('runA11yScan', { tag: ['@svlSecurity', '@ess'] }, () => {
   test('returns violations array (empty for basic accessible markup)', async ({ page }) => {
     await page.setContent(`
       <main>