File size: 3,668 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
import React from 'react';
import { render } from '@testing-library/react';
import { globSync } from 'glob';
import { axe } from 'jest-axe';
class AxeQueueManager {
private queue: Promise<any> = Promise.resolve();
private isProcessing = false;
async enqueue<T>(task: () => Promise<T>): Promise<T> {
const currentQueue = this.queue;
const newTask = async () => {
try {
await currentQueue;
this.isProcessing = true;
return await task();
} finally {
this.isProcessing = false;
}
};
this.queue = this.queue.then(newTask, newTask);
return this.queue;
}
isRunning(): boolean {
return this.isProcessing;
}
}
const axeQueueManager = new AxeQueueManager();
const runAxe = async (...args: Parameters<typeof axe>): Promise<ReturnType<typeof axe>> => {
return axeQueueManager.enqueue(async () => {
try {
return await axe(...args);
} catch (error) {
console.error('Axe test failed:', error);
throw error;
}
});
};
type Rules = {
[key: string]: {
enabled: boolean;
};
};
const convertRulesToAxeFormat = (rules: string[]): Rules => {
return rules.reduce(
(acc, rule) => ({
...acc,
[rule]: { enabled: false },
}),
{},
);
};
// eslint-disable-next-line jest/no-export
export function accessibilityTest(Component: React.ComponentType, disabledRules?: string[]) {
beforeAll(() => {
// Fake ResizeObserver
global.ResizeObserver = jest.fn(() => {
return {
observe() {},
unobserve() {},
disconnect() {},
};
}) as jest.Mock;
// fake fetch
global.fetch = jest.fn(() => {
return {
then() {
return this;
},
catch() {
return this;
},
finally() {
return this;
},
};
}) as jest.Mock;
});
beforeEach(() => {
// Reset all mocks
if (global.fetch) {
(global.fetch as jest.Mock).mockClear();
}
});
afterEach(() => {
// Clear all mocks
jest.clearAllMocks();
});
describe(`accessibility`, () => {
it(`component does not have any violations`, async () => {
jest.useRealTimers();
const { container } = render(<Component />);
const rules = convertRulesToAxeFormat(disabledRules || []);
const results = await runAxe(container, { rules });
expect(results).toHaveNoViolations();
}, 50000);
});
}
type Options = {
/**
* skip test
* @default false
*/
skip?: boolean | string[];
/**
* Disable axe rule checks
* @default []
*/
disabledRules?: string[];
};
// eslint-disable-next-line jest/no-export
export default function accessibilityDemoTest(component: string, options: Options = {}) {
// If skip is true, return immediately without executing any tests
if (options.skip === true) {
// eslint-disable-next-line jest/no-disabled-tests
describe.skip(`${component} demo a11y`, () => {
it('skipped', () => {});
});
return;
}
describe(`${component} demo a11y`, () => {
const files = globSync(`./components/${component}/demo/*.tsx`).filter(
(file) =>
!file.includes('_semantic') && !file.includes('debug') && !file.includes('component-token'),
);
files.forEach((file) => {
const shouldSkip = Array.isArray(options.skip) && options.skip.some((c) => file.endsWith(c));
const testMethod = shouldSkip ? describe.skip : describe;
testMethod(`Test ${file} accessibility`, () => {
const Demo = require(`../../${file}`).default;
accessibilityTest(Demo, options.disabledRules);
});
});
});
}
|