Classify Axe findings by conformance tier

Author: kzhou314

.github/actions/find/src/findForUrl.ts

@@ -1,4 +1,4 @@
-import type {ColorSchemePreference, Finding, ReducedMotionPreference, UrlConfig} from './types.d.js'
+import type {ColorSchemePreference, Finding, FindingCategory, ReducedMotionPreference, UrlConfig} from './types.d.js'
 import {AxeBuilder} from '@axe-core/playwright'
 import playwright from 'playwright'
 import {AuthContext} from './AuthContext.js'
@@ -87,6 +87,7 @@ async function runAxeScan({
     for (const violation of rawFindings.violations) {
       await addFinding({
         scannerType: 'axe',
+        category: categorizeAxeViolation(violation.tags),
         url,
         html: violation.nodes[0].html.replace(/'/g, '''),
         problemShort: violation.help.toLowerCase().replace(/'/g, '''),
@@ -98,3 +99,11 @@ async function runAxeScan({
     }
   }
 }
+
+// Maps an Axe violation's tags to a conformance tier. Experimental is checked
+// first because some experimental rules also carry a wcag* tag.
+function categorizeAxeViolation(tags: string[]): FindingCategory {
+  if (tags.includes('experimental')) return 'experimental'
+  if (tags.includes('best-practice')) return 'best-practice'
+  return 'wcag'
+}

.github/actions/find/src/types.d.ts

@@ -1,5 +1,8 @@
+export type FindingCategory = 'wcag' | 'best-practice' | 'experimental'
+
 export type Finding = {
   scannerType: string
+  category?: FindingCategory
   url: string
   html?: string
   problemShort: string

.github/actions/find/tests/findForUrl.test.ts

@@ -117,4 +117,40 @@ describe('findForUrl', () => {
       expect(loadedPlugins[1].default).toHaveBeenCalledTimes(0)
     })
   })
+
+  describe('axe finding categorization', () => {
+    function axeViolation(tags: string[]) {
+      return {
+        id: 'some-rule',
+        help: 'Help',
+        helpUrl: 'https://example.com',
+        description: 'Description',
+        tags,
+        nodes: [{html: '<div></div>', failureSummary: 'summary'}],
+      }
+    }
+
+    async function categoryFor(tags: string[]) {
+      clearAll()
+      actionInput = JSON.stringify(['axe'])
+      vi.mocked(AxeBuilder.prototype.analyze).mockResolvedValueOnce({
+        violations: [axeViolation(tags)],
+      } as unknown as axe.AxeResults)
+
+      const findings = await findForUrl('test.com')
+      return findings[0].category
+    }
+
+    it('categorizes a violation with only wcag tags as wcag', async () => {
+      expect(await categoryFor(['wcag2a', 'wcag111'])).toBe('wcag')
+    })
+
+    it('categorizes a violation with a best-practice tag as best-practice', async () => {
+      expect(await categoryFor(['cat.semantics', 'best-practice'])).toBe('best-practice')
+    })
+
+    it('categorizes a violation with an experimental tag as experimental, even alongside wcag tags', async () => {
+      expect(await categoryFor(['wcag2a', 'experimental'])).toBe('experimental')
+    })
+  })
 })