├── .github
    ├── CODEOWNERS
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   ├── feature_request.md
    │   └── general_question.md
    ├── dependabot.yml
    ├── policies
    │   └── resourceManagement.yml
    └── pull_request_template.md
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── csharp-selenium-webdriver-sample
    ├── .gitignore
    ├── CSharpSeleniumWebdriverSample.csproj
    ├── README.md
    ├── Resources
    │   ├── screenshot-dotnet-test-failure.png
    │   ├── screenshot-dotnet-test-success.png
    │   ├── screenshot-logs-tab.png
    │   └── screenshot-tests-tab.png
    ├── SamplePage.html
    ├── SamplePageTests.cs
    ├── WebDriverFactory.cs
    └── azure-pipelines.yml
├── typescript-playwright-sample
    ├── .gitignore
    ├── README.md
    ├── assets
    │   ├── screenshot-failing-logs-tab.png
    │   ├── screenshot-failing-scans-tab.png
    │   ├── screenshot-failing-tests-tab.png
    │   ├── screenshot-local-yarn-test.png
    │   ├── screenshot-passing-logs-tab.png
    │   ├── screenshot-passing-scans-tab.png
    │   └── screenshot-passing-tests-tab.png
    ├── azure-pipelines.yml
    ├── package.json
    ├── playwright.config.ts
    ├── src
    │   └── index.html
    ├── tests
    │   ├── export-to-sarif.ts
    │   ├── failing-examples.spec.ts
    │   └── passing-examples.spec.ts
    └── yarn.lock
├── typescript-selenium-webdriver-sample
    ├── .gitignore
    ├── .vscode
    │   └── launch.json
    ├── README.md
    ├── assets
    │   ├── screenshot-logs-tab.png
    │   ├── screenshot-scans-tab.png
    │   ├── screenshot-tests-tab.png
    │   └── screenshot-yarn-test-success.png
    ├── azure-pipelines.yml
    ├── jest.config.js
    ├── package.json
    ├── src
    │   └── index.html
    ├── tests
    │   ├── __snapshots__
    │   │   └── index.test.ts.snap
    │   ├── index.test.ts
    │   └── webdriver-factory.ts
    ├── tsconfig.json
    └── yarn.lock
└── windows-app-resources
    └── README.md


/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | # default owners for everything in the repository.
2 | *   @microsoft/accessibility-insights-code-owners
3 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | title: ''
 5 | labels: bug, needs triage
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | ## Describe the bug
11 | 
12 | <!-- A clear and concise description of what the bug is. -->
13 | 
14 | **To Reproduce**
15 | Steps to reproduce the behavior:
16 | 
17 | 1. Go to '...'
18 | 2. Run '...'
19 | 3. See error
20 | 
21 | ## Expected behavior
22 | 
23 | <!-- A clear and concise description of what you expected to happen. -->
24 | 
25 | ## Extension (please complete the following information)
26 | 
27 | - OS [e.g. Windows/Mac]: 
28 | - OS Version [e.g. 1.140.1]: 
29 | - Node Version [e.g. 10.15.3]: 
30 | 
31 | ## Are you willing to submit a PR?
32 | 
33 | <!-- If asked, will you be willing to submit a PR to fix this bug? Yes/No -->
34 | 
35 | ## Did you search for similar existing issues?
36 | 
37 | <!-- Did you search for similar issues in our GitHub issues or on StackOverflow for [azure-pipelines](https://stackoverflow.com/questions/tagged/azure-pipelines) and [accessibility](https://stackoverflow.com/questions/tagged/accessibility)? -->
38 | 
39 | ## Additional context
40 | 
41 | <!-- Add any other context about the problem here. -->


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: ''
 5 | labels: feature request
 6 | assignees: ''
 7 | ---
 8 | 
 9 | ## Is your feature request related to a problem? Please describe.
10 | <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
11 | 
12 | ## Describe the desired outcome
13 | <!-- A clear and concise description of what you want to happen. -->
14 | 
15 | ## Describe alternatives you've considered
16 | <!-- A clear and concise description of any alternative solutions or features you've considered. -->
17 | 
18 | ## Additional context
19 | <!-- Add any other context or screenshots about the feature request here. -->


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/general_question.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: General Question
 3 | about: This is a template for people to ask questions that don't fit into any other issue categories
 4 | title: ''
 5 | labels: question
 6 | assignees: ''
 7 | ---
 8 | 
 9 | ## Your question here
10 | 
11 | <!--
12 | Make sure to provide enough context. If you have spoken to a team member please mention them here.
13 | Add any items (screenshots etc) that will help.
14 | -->
15 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 | - package-ecosystem: nuget
 4 |   directory: "/csharp-selenium-webdriver-sample"
 5 |   schedule:
 6 |     interval: daily
 7 |     time: "08:30"  # UTC
 8 |   open-pull-requests-limit: 10  # Default value of 5 has been problematic
 9 | - package-ecosystem: npm
10 |   directory: "/typescript-selenium-webdriver-sample"
11 |   schedule:
12 |     interval: daily
13 |     time: "08:30"  # UTC
14 |   versioning-strategy: increase
15 |   ignore:
16 |     # Major version of @types/node is pinned to match the version of node we
17 |     # use for builds (ideally, latest LTS)
18 |   - dependency-name: "@types/node"
19 |     versions:
20 |     - ">=17.0.0"
21 |   open-pull-requests-limit: 10  # Default value of 5 has been problematic
22 | - package-ecosystem: npm
23 |   directory: "/typescript-playwright-sample"
24 |   schedule:
25 |     interval: daily
26 |     time: "08:30"  # UTC
27 |   versioning-strategy: increase
28 |   ignore:
29 |     # Major version of @types/node is pinned to match the version of node we
30 |     # use for builds (ideally, latest LTS)
31 |   - dependency-name: "@types/node"
32 |     versions:
33 |     - ">=21.0.0"
34 |   open-pull-requests-limit: 10  # Default value of 5 has been problematic
35 | 


--------------------------------------------------------------------------------
/.github/policies/resourceManagement.yml:
--------------------------------------------------------------------------------
  1 | id: 
  2 | name: GitOps.PullRequestIssueManagement
  3 | description: GitOps.PullRequestIssueManagement primitive
  4 | owner: 
  5 | resource: repository
  6 | disabled: false
  7 | where: 
  8 | configuration:
  9 |   resourceManagementConfiguration:
 10 |     scheduledSearches:
 11 |     - description: 
 12 |       frequencies:
 13 |       - hourly:
 14 |           hour: 3
 15 |       filters:
 16 |       - isOpen
 17 |       - isIssue
 18 |       - noActivitySince:
 19 |           days: 4
 20 |       - isNotLabeledWith:
 21 |           label: 'status: no recent activity'
 22 |       - hasLabel:
 23 |           label: 'status: needs author feedback'
 24 |       actions:
 25 |       - addLabel:
 26 |           label: 'status: no recent activity'
 27 |       - addReply:
 28 |           reply: This issue has been automatically marked as stale because it is marked as requiring author feedback but has not had any activity for **4 days**. It will be closed if no further activity occurs **within 3 days of this comment**. Thank you for contributing to Accessibility Insights!
 29 |     - description: 
 30 |       frequencies:
 31 |       - hourly:
 32 |           hour: 3
 33 |       filters:
 34 |       - isOpen
 35 |       - isIssue
 36 |       - hasLabel:
 37 |           label: 'status: no recent activity'
 38 |       - noActivitySince:
 39 |           days: 3
 40 |       actions:
 41 |       - closeIssue
 42 |     eventResponderTasks:
 43 |     - if:
 44 |       - payloadType: Pull_Request
 45 |       - hasLabel:
 46 |           label: 'pr: auto-merge'
 47 |       then:
 48 |       - enableAutoMerge:
 49 |           mergeMethod: Squash
 50 |       description: 
 51 |     - if:
 52 |       - payloadType: Pull_Request
 53 |       - labelRemoved:
 54 |           label: 'pr: auto-merge'
 55 |       then:
 56 |       - disableAutoMerge
 57 |       description: 
 58 |     - if:
 59 |       - payloadType: Issues
 60 |       - or:
 61 |         - isAction:
 62 |             action: Opened
 63 |         - isAction:
 64 |             action: Reopened
 65 |       - not:
 66 |           hasLabel:
 67 |             label: task
 68 |       - not: isAssignedToSomeone
 69 |       then:
 70 |       - addLabel:
 71 |           label: 'status: new'
 72 |       - assignIcmUsers:
 73 |           teamId: 57436
 74 |           primary: True
 75 |           secondary: False
 76 |       description: 
 77 |     - if:
 78 |       - payloadType: Issues
 79 |       - isAction:
 80 |           action: Opened
 81 |       - hasLabel:
 82 |           label: task
 83 |       then:
 84 |       - addLabel:
 85 |           label: 'status: new'
 86 |       description: 
 87 |     - if:
 88 |       - payloadType: Issues
 89 |       - labelAdded:
 90 |           label: 'status: needs author feedback'
 91 |       then:
 92 |       - removeLabel:
 93 |           label: 'status: new'
 94 |       - addReply:
 95 |           reply: The team requires additional author feedback; please review their replies and update this issue accordingly. Thank you for contributing to Accessibility Insights!
 96 |       description: 
 97 |     - if:
 98 |       - payloadType: Issues
 99 |       - isActivitySender:
100 |           issueAuthor: True
101 |       - hasLabel:
102 |           label: 'status: needs author feedback'
103 |       - not:
104 |           isAction:
105 |             action: Closed
106 |       then:
107 |       - addLabel:
108 |           label: 'status: needs attention'
109 |       - removeLabel:
110 |           label: 'status: needs author feedback'
111 |       description: 
112 |     - if:
113 |       - payloadType: Issues
114 |       - labelAdded:
115 |           label: 'status: ready for triage'
116 |       then:
117 |       - assignTo:
118 |           users:
119 |           - nang4ally
120 |       - addReply:
121 |           reply: This issue has been marked as ready for team triage; we will triage it in our weekly review and update the issue. Thank you for contributing to Accessibility Insights!
122 |       description: 
123 |     - if:
124 |       - payloadType: Issues
125 |       - labelAdded:
126 |           label: 'status: needs investigation'
127 |       then:
128 |       - addReply:
129 |           reply: 'This issue requires additional investigation by the Accessibility Insights team. When the issue is ready to be triaged again, we will update the issue with the investigation result and add "status: ready for triage". Thank you for contributing to Accessibility Insights!'
130 |       - removeLabel:
131 |           label: 'status: ready for triage'
132 |       description: 
133 |     - if:
134 |       - payloadType: Issues
135 |       - labelAdded:
136 |           label: good first issue
137 |       then:
138 |       - addLabel:
139 |           label: help wanted
140 |       description: 
141 |     - if:
142 |       - payloadType: Issues
143 |       - labelAdded:
144 |           label: 'resolution: out of scope'
145 |       then:
146 |       - addReply:
147 |           reply: 'This issue has been marked as being beyond the support scope of Accessibility Insights. It will now be closed automatically for house-keeping purposes. '
148 |       - closeIssue
149 |       description: 
150 |     - if:
151 |       - payloadType: Issues
152 |       - or:
153 |         - labelAdded:
154 |             label: 'status: needs author feedback'
155 |         - labelAdded:
156 |             label: 'status: needs attention'
157 |         - labelAdded:
158 |             label: 'status: needs investigation'
159 |         - labelAdded:
160 |             label: 'status: blocked'
161 |         - labelAdded:
162 |             label: 'status: ready for triage'
163 |         - labelAdded:
164 |             label: 'status: ready for work'
165 |         - labelAdded:
166 |             label: 'status: active'
167 |         - labelAdded:
168 |             label: 'status: resolved'
169 |         - labelAdded:
170 |             label: 'resolution: out of scope'
171 |       then:
172 |       - removeLabel:
173 |           label: 'status: new'
174 |       description: 
175 |     - if:
176 |       - payloadType: Issues
177 |       - or:
178 |         - labelAdded:
179 |             label: 'status: new'
180 |         - labelAdded:
181 |             label: 'status: needs attention'
182 |         - labelAdded:
183 |             label: 'status: needs investigation'
184 |         - labelAdded:
185 |             label: 'status: blocked'
186 |         - labelAdded:
187 |             label: 'status: ready for triage'
188 |         - labelAdded:
189 |             label: 'status: ready for work'
190 |         - labelAdded:
191 |             label: 'status: active'
192 |         - labelAdded:
193 |             label: 'status: resolved'
194 |         - labelAdded:
195 |             label: 'resolution: out of scope'
196 |       then:
197 |       - removeLabel:
198 |           label: 'status: needs author feedback'
199 |       description: 
200 |     - if:
201 |       - payloadType: Issues
202 |       - or:
203 |         - labelAdded:
204 |             label: 'status: new'
205 |         - labelAdded:
206 |             label: 'status: needs author feedback'
207 |         - labelAdded:
208 |             label: 'status: needs investigation'
209 |         - labelAdded:
210 |             label: 'status: blocked'
211 |         - labelAdded:
212 |             label: 'status: ready for triage'
213 |         - labelAdded:
214 |             label: 'status: ready for work'
215 |         - labelAdded:
216 |             label: 'status: active'
217 |         - labelAdded:
218 |             label: 'status: resolved'
219 |         - labelAdded:
220 |             label: 'resolution: out of scope'
221 |       then:
222 |       - removeLabel:
223 |           label: 'status: needs attention'
224 |       description: 
225 |     - if:
226 |       - payloadType: Issues
227 |       - or:
228 |         - labelAdded:
229 |             label: 'status: new'
230 |         - labelAdded:
231 |             label: 'status: needs author feedback'
232 |         - labelAdded:
233 |             label: 'status: needs attention'
234 |         - labelAdded:
235 |             label: 'status: blocked'
236 |         - labelAdded:
237 |             label: 'status: ready for triage'
238 |         - labelAdded:
239 |             label: 'status: ready for work'
240 |         - labelAdded:
241 |             label: 'status: active'
242 |         - labelAdded:
243 |             label: 'status: resolved'
244 |         - labelAdded:
245 |             label: 'resolution: out of scope'
246 |       then:
247 |       - removeLabel:
248 |           label: 'status: needs investigation'
249 |       description: 
250 |     - if:
251 |       - payloadType: Issues
252 |       - or:
253 |         - labelAdded:
254 |             label: 'status: new'
255 |         - labelAdded:
256 |             label: 'status: needs author feedback'
257 |         - labelAdded:
258 |             label: 'status: needs attention'
259 |         - labelAdded:
260 |             label: 'status: needs investigation'
261 |         - labelAdded:
262 |             label: 'status: ready for triage'
263 |         - labelAdded:
264 |             label: 'status: ready for work'
265 |         - labelAdded:
266 |             label: 'status: active'
267 |         - labelAdded:
268 |             label: 'status: resolved'
269 |         - labelAdded:
270 |             label: 'resolution: out of scope'
271 |       then:
272 |       - removeLabel:
273 |           label: 'status: blocked'
274 |       description: 
275 |     - if:
276 |       - payloadType: Issues
277 |       - or:
278 |         - labelAdded:
279 |             label: 'status: new'
280 |         - labelAdded:
281 |             label: 'status: needs author feedback'
282 |         - labelAdded:
283 |             label: 'status: needs attention'
284 |         - labelAdded:
285 |             label: 'status: needs investigation'
286 |         - labelAdded:
287 |             label: 'status: blocked'
288 |         - labelAdded:
289 |             label: 'status: ready for work'
290 |         - labelAdded:
291 |             label: 'status: active'
292 |         - labelAdded:
293 |             label: 'status: resolved'
294 |         - labelAdded:
295 |             label: 'resolution: out of scope'
296 |       then:
297 |       - removeLabel:
298 |           label: 'status: ready for triage'
299 |       description: 
300 |     - if:
301 |       - payloadType: Issues
302 |       - or:
303 |         - labelAdded:
304 |             label: 'status: new'
305 |         - labelAdded:
306 |             label: 'status: needs author feedback'
307 |         - labelAdded:
308 |             label: 'status: needs attention'
309 |         - labelAdded:
310 |             label: 'status: needs investigation'
311 |         - labelAdded:
312 |             label: 'status: blocked'
313 |         - labelAdded:
314 |             label: 'status: ready for triage'
315 |         - labelAdded:
316 |             label: 'status: active'
317 |         - labelAdded:
318 |             label: 'status: resolved'
319 |         - labelAdded:
320 |             label: 'resolution: out of scope'
321 |       then:
322 |       - removeLabel:
323 |           label: 'status: ready for work'
324 |       description: 
325 |     - if:
326 |       - payloadType: Issues
327 |       - hasLabel:
328 |           label: task
329 |       - isAction:
330 |           action: Closed
331 |       then:
332 |       - addLabel:
333 |           label: 'status: resolved'
334 |       - removeLabel:
335 |           label: 'status: active'
336 |       - removeLabel:
337 |           label: 'status: new'
338 |       description: 
339 |     - if:
340 |       - payloadType: Issues
341 |       - or:
342 |         - labelAdded:
343 |             label: 'status: new'
344 |         - labelAdded:
345 |             label: 'status: needs author feedback'
346 |         - labelAdded:
347 |             label: 'status: needs attention'
348 |         - labelAdded:
349 |             label: 'status: needs investigation'
350 |         - labelAdded:
351 |             label: 'status: blocked'
352 |         - labelAdded:
353 |             label: 'status: ready for triage'
354 |         - labelAdded:
355 |             label: 'status: ready for work'
356 |         - labelAdded:
357 |             label: 'status: resolved'
358 |         - labelAdded:
359 |             label: 'resolution: out of scope'
360 |       then:
361 |       - removeLabel:
362 |           label: 'status: active'
363 |       description: 
364 |     - if:
365 |       - payloadType: Issues
366 |       - or:
367 |         - labelAdded:
368 |             label: 'status: new'
369 |         - labelAdded:
370 |             label: 'status: needs author feedback'
371 |         - labelAdded:
372 |             label: 'status: needs attention'
373 |         - labelAdded:
374 |             label: 'status: needs investigation'
375 |         - labelAdded:
376 |             label: 'status: blocked'
377 |         - labelAdded:
378 |             label: 'status: ready for triage'
379 |         - labelAdded:
380 |             label: 'status: ready for work'
381 |         - labelAdded:
382 |             label: 'status: active'
383 |         - labelAdded:
384 |             label: 'resolution: out of scope'
385 |       then:
386 |       - removeLabel:
387 |           label: 'status: resolved'
388 |       description: 
389 |     - if:
390 |       - payloadType: Issue_Comment
391 |       - isActivitySender:
392 |           issueAuthor: True
393 |       - hasLabel:
394 |           label: 'status: needs author feedback'
395 |       then:
396 |       - addLabel:
397 |           label: 'status: needs attention'
398 |       - removeLabel:
399 |           label: 'status: needs author feedback'
400 |       description: 
401 | onFailure: 
402 | onSuccess: 
403 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | #### Details
 2 | 
 3 | <!-- Usually a sentence or two describing what the PR changes -->
 4 | 
 5 | ##### Motivation
 6 | 
 7 | <!-- This can be as simple as "addresses issue #123" -->
 8 | 
 9 | ##### Context
10 | 
11 | <!-- Are there any parts that you've intentionally left out-of-scope for a later PR to handle? -->
12 | 
13 | <!-- Were there any alternative approaches you considered? What tradeoffs did you consider? -->
14 | 
15 | #### Pull request checklist
16 | <!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox -->
17 | 
18 | - [ ] If this PR addresses an existing issue, it is linked: Fixes #0000
19 | - [ ] New sample content is commented at a similar verbosity as existing content
20 | - [ ] All updated/modified sample code builds and runs in at least one PR/CI build
21 | - [ ] PR checks for builds named `[failing example] ...` pass in the PR build, then confirm they fail in the CI build
22 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | npm-debug.log*
 5 | yarn-debug.log*
 6 | yarn-error.log*
 7 | 
 8 | # Runtime data
 9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 | 
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 | 
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 | 
20 | # nyc test coverage
21 | .nyc_output
22 | 
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 | 
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 | 
29 | # node-waf configuration
30 | .lock-wscript
31 | 
32 | # Compiled binary addons (https://nodejs.org/api/addons.html)
33 | build/Release
34 | 
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 | 
39 | # TypeScript v1 declaration files
40 | typings/
41 | 
42 | # Optional npm cache directory
43 | .npm
44 | 
45 | # Optional eslint cache
46 | .eslintcache
47 | 
48 | # Optional REPL history
49 | .node_repl_history
50 | 
51 | # Output of 'npm pack'
52 | *.tgz
53 | 
54 | # Yarn Integrity file
55 | .yarn-integrity
56 | 
57 | # dotenv environment variables file
58 | .env
59 | 
60 | # next.js build output
61 | .next
62 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | This project welcomes contributions and suggestions.
 4 | 
 5 | For larger contributions (eg, a new sample), we recommend starting out by filing an issue (use the "Suggestion" template) to discuss your idea with us first.
 6 | 
 7 | For small contributions (eg, a minor fix to an existing sample), feel free to just send a Pull Request.
 8 | 
 9 | ## Pull Requests
10 | 
11 | Before sending a pull request, please double check that:
12 | 
13 | * Any new sample content being added is documented with a sample-level README.md and verbosely commented inline.
14 | * The tests run and pass in each sample you're modifying.
15 | 
16 | Pull requests will be reviewed and merged by a member of the Accessibility Insights team.
17 | 
18 | ## Contributor License Agreement
19 | 
20 | Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
21 | 
22 | When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
23 | 
24 | ## Code of Conduct
25 | 
26 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
27 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 |     MIT License
 2 | 
 3 |     Copyright (c) Microsoft Corporation. All rights reserved.
 4 | 
 5 |     Permission is hereby granted, free of charge, to any person obtaining a copy
 6 |     of this software and associated documentation files (the "Software"), to deal
 7 |     in the Software without restriction, including without limitation the rights
 8 |     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 |     copies of the Software, and to permit persons to whom the Software is
10 |     furnished to do so, subject to the following conditions:
11 | 
12 |     The above copyright notice and this permission notice shall be included in all
13 |     copies or substantial portions of the Software.
14 | 
15 |     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 |     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 |     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 |     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 |     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 |     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 |     SOFTWARE
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Axe + Azure Pipelines: Automate accessibility testing in your CI builds
 2 | 
 3 | Watch a [short intro video](https://www.youtube.com/watch?v=SarmnCULt8M) to get started with automated accessibility tests in Azure pipelines. Please note that these samples are applicable to web projects that have UI automation tests. Benefits include,
 4 | 
 5 | - Automated accessibility tests run during Continuous Integration and Pull Request builds, ensuring that all code changes are free of common easily-detected accessibility issues before they go to production
 6 | - Builds can be configured to fail based on the results of the automated accessibility tests, preventing both new accessibility bugs and regressions
 7 | - Failure details and _how to fix_ information can be viewed in Azure DevOps under Builds, making it quick and easy to investigate and resolve the accessibility issues
 8 | 
 9 | This repository contains sample projects (see next section [Available samples](#available-samples)) demonstrating how to implement automated accessibility testing in [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) builds using [axe-core](https://github.com/dequelabs/axe-core), the same accessibility scanning engine used in [Accessibility Insights for Web](https://accessibilityinsights.io/docs/en/web/overview), and [Axe.Windows](https://github.com/microsoft/axe-windows), the same accessibility scanning engine used in [Accessibility Insights for Windows](https://accessibilityinsights.io/docs/en/windows/overview/).
10 | 
11 | ## Available samples
12 | 
13 | The following sample projects specify the main technologies used. A team that uses comparable tools and frameworks should be able to refer to the sample and update their existing tests to incorporate automated accessibility checks.
14 | 
15 | - **[Sample 1: typescript-playwright-sample](./typescript-playwright-sample)**:
16 | 
17 |   - Useful for teams using Playwright and TypeScript/JavaScript.
18 | 
19 | - **[Sample 2: typescript-selenium-webdriver-sample](./typescript-selenium-webdriver-sample)**:
20 | 
21 |   - Useful for teams using Selenium and TypeScript/JavaScript.
22 | 
23 | - **[Sample 3: CSharpSeleniumWebdriverSample](./csharp-selenium-webdriver-sample)**:
24 | 
25 |   - Useful for teams using Selenium and C#.
26 | 
27 | ## Other Resources
28 | 
29 | The following may be helpful as an example of how our accessibility scanning tools have been used where the product is not based on HTML:
30 | 
31 | - **[WindowsAppResources](./windows-app-resources)**:
32 | 
33 |   - Useful for teams developing non-browser-based Windows applications. These applications can use any language or framework.
34 | 
35 | ## Requests
36 | 
37 | _Are we missing a sample or resource you'd like to see? [File a sample request](https://github.com/microsoft/axe-pipelines-samples/issues/new?assignees=&labels=sample_request&template=feature_request.md&title=Sample+Request%3A+%3Csample+name+here%3E) or [submit a pull request](./CONTRIBUTING.md)!_
38 | 
39 | ## Disclaimer
40 | 
41 | Automated accessibility tests can detect some common accessibility problems such as missing or invalid properties. But most accessibility problems can only be discovered through manual testing. We recommend **both** automated testing, to continuously protect against simple types of issues, and regular manual assessments with [Accessibility Insights for Web](https://accessibilityinsights.io/docs/en/web/overview), a free and open source dev tool that walks you through assessing a website for [WCAG 2.1 AA](https://www.w3.org/WAI/WCAG21/quickref/?currentsidebar=%23col_customize&levels=aaa) coverage.
42 | 
43 | ## Contributing
44 | 
45 | This project welcomes contributions and suggestions. Most contributions require you to agree to a
46 | Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
47 | the rights to use your contribution. For details, visit https://cla.microsoft.com.
48 | 
49 | When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
50 | a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
51 | provided by the bot. You will only need to do this once across all repos using our CLA.
52 | 
53 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
54 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
55 | contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
56 | 


--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
 1 | <!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
 2 | 
 3 | ## Security
 4 | 
 5 | Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 6 | 
 7 | If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
 8 | 
 9 | ## Reporting Security Issues
10 | 
11 | **Please do not report security vulnerabilities through public GitHub issues.**
12 | 
13 | Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
14 | 
15 | If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
16 | 
17 | You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
18 | 
19 | Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
20 | 
21 |   * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22 |   * Full paths of source file(s) related to the manifestation of the issue
23 |   * The location of the affected source code (tag/branch/commit or direct URL)
24 |   * Any special configuration required to reproduce the issue
25 |   * Step-by-step instructions to reproduce the issue
26 |   * Proof-of-concept or exploit code (if possible)
27 |   * Impact of the issue, including how an attacker might exploit the issue
28 | 
29 | This information will help us triage your report more quickly.
30 | 
31 | If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
32 | 
33 | ## Preferred Languages
34 | 
35 | We prefer all communications to be in English.
36 | 
37 | ## Policy
38 | 
39 | Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
40 | 
41 | <!-- END MICROSOFT SECURITY.MD BLOCK -->


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/.gitignore:
--------------------------------------------------------------------------------
  1 | ## Ignore Visual Studio temporary files, build results, and
  2 | ## files generated by popular Visual Studio add-ons.
  3 | 
  4 | # User-specific files
  5 | *.suo
  6 | *.user
  7 | *.userosscache
  8 | *.sln.docstates
  9 | 
 10 | # User-specific files (MonoDevelop/Xamarin Studio)
 11 | *.userprefs
 12 | 
 13 | # Build results
 14 | [Dd]ebug/
 15 | [Dd]ebugPublic/
 16 | [Rr]elease/
 17 | [Rr]eleases/
 18 | x64/
 19 | x86/
 20 | bld/
 21 | [Bb]in/
 22 | [Oo]bj/
 23 | [Ll]og/
 24 | 
 25 | # Visual Studio 2015 cache/options directory
 26 | .vs/
 27 | # Uncomment if you have tasks that create the project's static files in wwwroot
 28 | #wwwroot/
 29 | 
 30 | # MSTest test Results
 31 | [Tt]est[Rr]esult*/
 32 | [Bb]uild[Ll]og.*
 33 | 
 34 | # NUNIT
 35 | *.VisualState.xml
 36 | TestResult.xml
 37 | 
 38 | # Build Results of an ATL Project
 39 | [Dd]ebugPS/
 40 | [Rr]eleasePS/
 41 | dlldata.c
 42 | 
 43 | # DNX
 44 | project.lock.json
 45 | artifacts/
 46 | 
 47 | *_i.c
 48 | *_p.c
 49 | *_i.h
 50 | *.ilk
 51 | *.meta
 52 | *.obj
 53 | *.pch
 54 | *.pdb
 55 | *.pgc
 56 | *.pgd
 57 | *.rsp
 58 | *.sbr
 59 | *.tlb
 60 | *.tli
 61 | *.tlh
 62 | *.tmp
 63 | *.tmp_proj
 64 | *.log
 65 | *.vspscc
 66 | *.vssscc
 67 | .builds
 68 | *.pidb
 69 | *.svclog
 70 | *.scc
 71 | 
 72 | # Chutzpah Test files
 73 | _Chutzpah*
 74 | 
 75 | # Visual C++ cache files
 76 | ipch/
 77 | *.aps
 78 | *.ncb
 79 | *.opendb
 80 | *.opensdf
 81 | *.sdf
 82 | *.cachefile
 83 | *.VC.db
 84 | *.VC.VC.opendb
 85 | 
 86 | # Visual Studio profiler
 87 | *.psess
 88 | *.vsp
 89 | *.vspx
 90 | *.sap
 91 | 
 92 | # TFS 2012 Local Workspace
 93 | $tf/
 94 | 
 95 | # Guidance Automation Toolkit
 96 | *.gpState
 97 | 
 98 | # ReSharper is a .NET coding add-in
 99 | _ReSharper*/
100 | *.[Rr]e[Ss]harper
101 | *.DotSettings.user
102 | 
103 | # JustCode is a .NET coding add-in
104 | .JustCode
105 | 
106 | # TeamCity is a build add-in
107 | _TeamCity*
108 | 
109 | # DotCover is a Code Coverage Tool
110 | *.dotCover
111 | 
112 | # NCrunch
113 | _NCrunch_*
114 | .*crunch*.local.xml
115 | nCrunchTemp_*
116 | 
117 | # MightyMoose
118 | *.mm.*
119 | AutoTest.Net/
120 | 
121 | # Web workbench (sass)
122 | .sass-cache/
123 | 
124 | # Installshield output folder
125 | [Ee]xpress/
126 | 
127 | # DocProject is a documentation generator add-in
128 | DocProject/buildhelp/
129 | DocProject/Help/*.HxT
130 | DocProject/Help/*.HxC
131 | DocProject/Help/*.hhc
132 | DocProject/Help/*.hhk
133 | DocProject/Help/*.hhp
134 | DocProject/Help/Html2
135 | DocProject/Help/html
136 | 
137 | # Click-Once directory
138 | publish/
139 | 
140 | # Publish Web Output
141 | *.[Pp]ublish.xml
142 | *.azurePubxml
143 | # TODO: Comment the next line if you want to checkin your web deploy settings
144 | # but database connection strings (with potential passwords) will be unencrypted
145 | *.pubxml
146 | *.publishproj
147 | 
148 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
149 | # checkin your Azure Web App publish settings, but sensitive information contained
150 | # in these scripts will be unencrypted
151 | PublishScripts/
152 | 
153 | # NuGet Packages
154 | *.nupkg
155 | # The packages folder can be ignored because of Package Restore
156 | **/packages/*
157 | # except build/, which is used as an MSBuild target.
158 | !**/packages/build/
159 | # Uncomment if necessary however generally it will be regenerated when needed
160 | #!**/packages/repositories.config
161 | # NuGet v3's project.json files produces more ignoreable files
162 | *.nuget.props
163 | *.nuget.targets
164 | 
165 | # Microsoft Azure Build Output
166 | csx/
167 | *.build.csdef
168 | 
169 | # Microsoft Azure Emulator
170 | ecf/
171 | rcf/
172 | 
173 | # Windows Store app package directories and files
174 | AppPackages/
175 | BundleArtifacts/
176 | Package.StoreAssociation.xml
177 | _pkginfo.txt
178 | 
179 | # Visual Studio cache files
180 | # files ending in .cache can be ignored
181 | *.[Cc]ache
182 | # but keep track of directories ending in .cache
183 | !*.[Cc]ache/
184 | 
185 | # Others
186 | ClientBin/
187 | ~$*
188 | *~
189 | *.dbmdl
190 | *.dbproj.schemaview
191 | *.pfx
192 | *.publishsettings
193 | node_modules/
194 | orleans.codegen.cs
195 | 
196 | # Since there are multiple workflows, uncomment next line to ignore bower_components
197 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
198 | #bower_components/
199 | 
200 | # RIA/Silverlight projects
201 | Generated_Code/
202 | 
203 | # Backup & report files from converting an old project file
204 | # to a newer Visual Studio version. Backup files are not needed,
205 | # because we have git ;-)
206 | _UpgradeReport_Files/
207 | Backup*/
208 | UpgradeLog*.XML
209 | UpgradeLog*.htm
210 | 
211 | # SQL Server files
212 | *.mdf
213 | *.ldf
214 | 
215 | # Business Intelligence projects
216 | *.rdl.data
217 | *.bim.layout
218 | *.bim_*.settings
219 | 
220 | # Microsoft Fakes
221 | FakesAssemblies/
222 | 
223 | # GhostDoc plugin setting file
224 | *.GhostDoc.xml
225 | 
226 | # Node.js Tools for Visual Studio
227 | .ntvs_analysis.dat
228 | 
229 | # Visual Studio 6 build log
230 | *.plg
231 | 
232 | # Visual Studio 6 workspace options file
233 | *.opt
234 | 
235 | # Visual Studio LightSwitch build output
236 | **/*.HTMLClient/GeneratedArtifacts
237 | **/*.DesktopClient/GeneratedArtifacts
238 | **/*.DesktopClient/ModelManifest.xml
239 | **/*.Server/GeneratedArtifacts
240 | **/*.Server/ModelManifest.xml
241 | _Pvt_Extensions
242 | 
243 | # Paket dependency manager
244 | .paket/paket.exe
245 | paket-files/
246 | 
247 | # FAKE - F# Make
248 | .fake/
249 | 
250 | # JetBrains Rider
251 | .idea/
252 | *.sln.iml
253 | 
254 | # Solution File for the purpose of this project only
255 | *.sln


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/CSharpSeleniumWebdriverSample.csproj:
--------------------------------------------------------------------------------
 1 | <Project Sdk="Microsoft.NET.Sdk">
 2 |   <PropertyGroup>
 3 |     <ProjectGuid>{E6205F43-94B0-462C-AA5B-AE816794E95A}</ProjectGuid>
 4 |     <TargetFrameworks>net6.0</TargetFrameworks>
 5 |     <AssemblyTitle>CSharpSeleniumWebdriverSample</AssemblyTitle>
 6 |     <Product>CSharpSeleniumWebdriverSample</Product>
 7 |   </PropertyGroup>
 8 |   <ItemGroup>
 9 |     <Content Include="SamplePage.html">
10 |       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
11 |     </Content>
12 |   </ItemGroup>
13 |   <ItemGroup>
14 |     <PackageReference Include="FluentAssertions" Version="8.2.0" />
15 |     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
16 |     <PackageReference Include="MSTest.TestAdapter" Version="3.8.3" />
17 |     <PackageReference Include="MSTest.TestFramework" Version="3.8.3" />
18 |     <PackageReference Include="Selenium.Axe" Version="4.0.21" />
19 |     <PackageReference Include="Selenium.WebDriver.ChromeDriver" Version="136.0.7103.4900" />
20 |     <PackageReference Include="Selenium.WebDriver.GeckoDriver" Version="0.36.0" />
21 |   </ItemGroup>
22 | </Project>
23 | 


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/README.md:
--------------------------------------------------------------------------------
 1 | # CSharpSeleniumWebdriverSample
 2 | 
 3 | This sample demonstrates how you might set up a C# Project with an Azure Pipelines build that runs end to end accessibility tests in a browser.
 4 | 
 5 | ## Getting Started
 6 | 
 7 | The individual files in the sample contain comments that explain the important parts of each file in context.
 8 | 
 9 | Some good places to start reading are:
10 | 
11 | * [SamplePageTests.cs](./SamplePageTests.cs): C# test file that opens [SamplePage.html](./SamplePage.html) in a browser with Selenium and runs accessibility scans against it
12 | * [azure-pipelines.yml](./azure-pipelines.yml): Azure Pipelines config file that sets up our Continuous Integration and Pull Request builds
13 | 
14 | ## Tools and libraries used
15 | 
16 | The key tools and libraries this sample demonstrates are:
17 | 
18 | * [Selenium.WebDriver](https://www.seleniumhq.org), the .NET library for Selenium, a tool for automating interactions with different web browsers.
19 | * [Selenium.Axe](https://github.com/TroyWalshProf/SeleniumAxeDotnet), a .NET library for running accessibility scans on web pages by using Selenium.WebDriver to run the [axe-core](https://github.com/dequelabs/axe-core) accessibility scanning engine.
20 | * [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) to run the tests in a CI build with every Pull Request.
21 | 
22 | This sample also uses a few other tools and libraries which are less important; if you use a different test framework or a different version of .NET, you can still follow along with most of the sample.
23 | 
24 | * [.NET Core](https://dotnet.microsoft.com) to build/run the code.
25 |   * None of the libraries or C# code in the sample are specific to .NET Core; if your project uses the full .NET Framework, you can still follow along with the sample!
26 | * [MSTest](https://github.com/microsoft/testfx) as our test framework.
27 |   * None of the other libraries we're using require this particular framework; you can still follow along with the sample using NUnit, xUnit, or any other test framework you like.
28 | * [Chrome](https://google.com/chrome) (with [Selenium.WebDriver.ChromeDriver](https://github.com/jsakamoto/nupkg-selenium-webdriver-chromedriver/)) and [Firefox](https://www.mozilla.org/firefox/) (with [Selenium.WebDriver.GeckoDriver](https://github.com/jsakamoto/nupkg-selenium-webdriver-geckodriver/)) as our test browsers
29 |   * Selenium supports many different browsers and operating systems; use whichever combination is most important for your product!
30 | * [FluentAssertions](https://fluentassertions.com/) to write test assertions
31 |   * We like FluentAssertions because it gives great error messages out-of-the-box with Selenium.Axe. But you can still follow the rest of the sample if you prefer a different assertion style!
32 | 
33 | ## See it in action on your local machine
34 | 
35 | 1. Install the [.NET Core SDK](https://dotnet.microsoft.com/download)
36 | 1. Install the stable version of [Chrome](https://www.google.com/chrome/)
37 | 1. Install the stable version of [Firefox](https://www.mozilla.org/en-US/firefox/)
38 | 1. Clone this sample repository
39 | 
40 |    ```sh
41 |    git clone https://github.com/microsoft/axe-pipelines-samples
42 |    ```
43 | 
44 | 1. Run the tests
45 | 
46 |     Filter to only run passing tests:
47 | 
48 |    ```sh
49 |    cd ./axe-pipelines-samples/csharp-selenium-webdriver-sample
50 |    dotnet test --filter TestCategory!=IntentionallyFailsAsAnExample
51 |    ```
52 | 
53 |    ![Screenshot of 'dotnet test' command showing all tests passing](./Resources/screenshot-dotnet-test-success.png)
54 | 
55 |    Run all tests (both passing and failing):
56 | 
57 |    ```sh
58 |    cd ./axe-pipelines-samples/csharp-selenium-webdriver-sample
59 |    dotnet test
60 |    ```
61 | 
62 |    ![Screenshot of 'dotnet test' command showing some accessibility violations](./Resources/screenshot-dotnet-test-failure.png)
63 | 
64 | ## See it in action in Azure Pipelines
65 | 
66 | * Example build with failures: [![Azure Pipelines Build Status for failing example build](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_apis/build/status/%5Bfailing%20example%5D%20csharp-selenium-webdriver-sample?branchName=main)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/latest?definitionId=33&branchName=main)
67 | * Example build without failures: [![Azure Pipelines Build Status for passing example build](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_apis/build/status/%5Bpassing%20example%5D%20csharp-selenium-webdriver-sample?branchName=main)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/latest?definitionId=32&branchName=main)
68 | 
69 | <!--
70 |   Note to maintainers: The below example images/links come from a specific build instead of the most recent build so we can link to specific tabs.
71 |   If you update the links such that they point to a different build, make sure to mark that build as Retained so the links don't expire in a month.
72 | -->
73 | The accessibility tests run as part of the `dotnet test` build step:
74 | 
75 | [![Screenshot of "dotnet test" build logs in sample build](./Resources/screenshot-logs-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=2338&view=logs&j=12f1170f-54f2-53f3-20dd-22fc7dff55f9)
76 | 
77 | The test pass/fail results display in the Tests tab of the build logs:
78 | 
79 | [![Screenshot of Tests tab in sample build](./Resources/screenshot-tests-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=2338&view=ms.vss-test-web.build-test-results-tab&runId=6512&resultId=100000&paneView=debug)
80 | 


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/Resources/screenshot-dotnet-test-failure.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/csharp-selenium-webdriver-sample/Resources/screenshot-dotnet-test-failure.png


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/Resources/screenshot-dotnet-test-success.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/csharp-selenium-webdriver-sample/Resources/screenshot-dotnet-test-success.png


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/Resources/screenshot-logs-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/csharp-selenium-webdriver-sample/Resources/screenshot-logs-tab.png


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/Resources/screenshot-tests-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/csharp-selenium-webdriver-sample/Resources/screenshot-tests-tab.png


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/SamplePage.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en-US">
 3 | <head>
 4 |     <title>Example page with some accessibility issues</title>
 5 | </head>
 6 | <body>
 7 |     <main>
 8 |         <h1>This is a static sample page with some accessibility issues</h1>
 9 |         <h2>Here are some examples of content without axe-core violations</h2>
10 |         <p id="id-of-example-accessible-element">There's nothing wrong with this paragraph!</p>
11 |         <p class="class-of-example-accessible-element">There's also nothing wrong with this paragraph!</p>
12 | 
13 |         <h2>Here are some examples of content with different types of axe-core violations</h2>
14 |         <ul id="id-of-example-accessibility-violation-list">
15 |             <li>This input box lacks an accessible label, which violates wcag2a rule "label": <input id="example-wcag2a-violation" type="text"></li>
16 |             <li>This text's color contrast is too low, which violates wcag2aa rule "color-contrast": <span id="example-wcag2aa-violation" style="color: #A2A2A2">low-contrast text</span></li>
17 |             <li>This button uses a tabindex greater than 0, which violates best-practice rule "tabindex": <button id="example-best-practice-violation" tabindex="1">button with high tabindex</button></li>
18 |         </ul>
19 |     </main>
20 | </body>
21 | </html>
22 | 


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/SamplePageTests.cs:
--------------------------------------------------------------------------------
  1 | // Copyright (c) Microsoft. All rights reserved.
  2 | // Licensed under the MIT license. See LICENSE file in the project root for full license information.
  3 | 
  4 | // This sample happens to use .NET Core, but you can use whichever .NET version makes sense for your project.
  5 | // Everything we're demonstrating would also work in .NET Framework 4.5+ with no modifications.
  6 | using System;
  7 | using System.IO;
  8 | // This sample happens to use MSTest, but you can use whichever test framework you like.
  9 | // Everything we're demonstrating would also work with xUnit, NUnit, or any other test framework.
 10 | using Microsoft.VisualStudio.TestTools.UnitTesting;
 11 | // If you're using Selenium already, you're probably already using these.
 12 | using OpenQA.Selenium;
 13 | using OpenQA.Selenium.Support.UI;
 14 | // These are the important new libraries we're demonstrating.
 15 | // You'll probably need to add new NuGet package references for these.
 16 | using Selenium.Axe;
 17 | using FluentAssertions;
 18 | 
 19 | namespace CSharpSeleniumWebdriverSample
 20 | {
 21 |     [TestClass]
 22 |     public class SamplePageTests
 23 |     {
 24 |         #region Example test methods
 25 | 
 26 |         // This test case shows the most basic example: run an accessibility scan on a page and assert that there are no violations.
 27 |         [TestMethod]
 28 |         [TestCategory("IntentionallyFailsAsAnExample")]
 29 |         public void TestAccessibilityOfPage()
 30 |         {
 31 |             AxeResult axeResult = new AxeBuilder(_webDriver)
 32 |                 // This WithTags directive restricts Axe to only run tests that detect known violations of WCAG 2.1 A and AA rules
 33 |                 // (similar to what Accessibility Insights reports). If you omit this, Axe will additionally run several "best practice"
 34 |                 // rules, which are good ideas to check for periodically but may report false positives in certain edge cases.
 35 |                 //
 36 |                 // For complete documentation of which rule IDs and tags axe supports, see:
 37 |                 // * summary of rules with IDs and tags: https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md
 38 |                 // * full reference documentation for each rule: https://dequeuniversity.com/rules/axe
 39 |                 .WithTags("wcag2a", "wcag2aa", "wcag21a", "wcag21aa")
 40 |                 .Analyze();
 41 | 
 42 |             // axeResult.Violations is an array of all the accessibility violations the scan found; the easiest way to assert
 43 |             // that a scan came back clean is to assert that the Violations array is empty. You can do this with the built in
 44 |             // MSTest assertions like this:
 45 |             //
 46 |             //     Assert.AreEqual(0, axeResult.Violations.Length);
 47 |             //
 48 |             // However, we don't recommend using Assert.AreEqual for this because it doesn't give very useful error messages if
 49 |             // it does detect a violation; the error message will just say "expected 0 but found 1".
 50 |             //
 51 |             // We recommend using FluentAssertions instead; its default behavior gives much better error messages that include
 52 |             // full descriptions of accessibility issues, including links to detailed guidance at https://dequeuniversity.com
 53 |             // and CSS selector paths that exactly identify the element on the page with the issue.
 54 |             axeResult.Error.Should().BeNull();
 55 | 
 56 |             // Our PR builds do not change the presence or absence of accessibility issues, so we special case
 57 |             // our PR build tests to expect the errors. This is not recommended for most projects, but since the
 58 |             // check takes effect only if the ACCESSIBILITY_ERRORS_ARE_EXPECTED_IN_PR_BUILD variable is set to
 59 |             // true within the pipeline, you may safely copy this code and the special case will be ignored.
 60 |             if (AccessibilityErrorsAreExpectedInThisBuild()) 
 61 |             {
 62 |                 axeResult.Violations.Should().NotBeEmpty();
 63 |             }
 64 |             else
 65 |             {
 66 |                 axeResult.Violations.Should().BeEmpty();
 67 |             }
 68 |         }
 69 | 
 70 |         // This test case shows 2 options for scanning specific elements within a page, rather than an entire page.
 71 |         [TestMethod]
 72 |         public void TestAccessibilityOfIndividualElements()
 73 |         {
 74 |             // Both of these 2 options work equally well; which one to use is a matter of preference.
 75 | 
 76 |             // Option 1: using Selenium's FindElement to identify the element to test
 77 |             //
 78 |             // This can be simpler if your test already had to find the element for earlier assertions, or if you want to test
 79 |             // an element that is hard to identify using a CSS selector.
 80 |             IWebElement elementUnderTest = _webDriver.FindElement(By.Id("id-of-example-accessible-element"));
 81 | 
 82 |             AxeResult axeResultWithAnalyzeWebElement = new AxeBuilder(_webDriver)
 83 |                 .WithTags("wcag2a", "wcag2aa", "wcag21a", "wcag21aa")
 84 |                 .Analyze(elementUnderTest);
 85 | 
 86 |             axeResultWithAnalyzeWebElement.Error.Should().BeNull();
 87 |             axeResultWithAnalyzeWebElement.Violations.Should().BeEmpty();
 88 | 
 89 |             // Option 2: using AxeBuilder.Include
 90 |             //
 91 |             // This can be simpler if you need to test multiple elements at once or need to deal with <iframe>s.
 92 |             AxeResult axeResultWithInclude = new AxeBuilder(_webDriver)
 93 |                 .Include("#id-of-example-accessible-element")
 94 |                 .Include(".class-of-example-accessible-element")
 95 |                 .Include("#id-of-iframe", "#id-of-element-inside-iframe")
 96 |                 .WithTags("wcag2a", "wcag2aa", "wcag21a", "wcag21aa")
 97 |                 .Analyze();
 98 | 
 99 |             axeResultWithInclude.Error.Should().BeNull();
100 |             axeResultWithInclude.Violations.Should().BeEmpty();
101 |         }
102 | 
103 |         // This test case shows how you might baseline some known/pre-existing accessibility violations from your tests.
104 |         // This is useful when just getting started with accessibility testing, so you can prevent new issues from creeping in
105 |         // while you're still working on fixing any existing issues.
106 |         [TestMethod]
107 |         public void TestAccessibilityOfPageExcludingKnownIssues()
108 |         {
109 |             // You can use AxeBuilder.Exclude to exclude individual elements with known issues from a scan.
110 |             //
111 |             // Exclude accepts any CSS selector; you could also use ".some-classname" or "div[some-attr='some value']"
112 |             AxeResult axeResultExcludingExampleViolationsElement = new AxeBuilder(_webDriver)
113 |                 .Exclude("#id-of-example-accessibility-violation-list")
114 |                 .Analyze();
115 |             
116 |             axeResultExcludingExampleViolationsElement.Error.Should().BeNull();
117 |             axeResultExcludingExampleViolationsElement.Violations.Should().BeEmpty();
118 | 
119 |             // You can also use AxeBuilder.DisableRules to exclude certain individual rules from a scan. This is particularly
120 |             // useful if you still want to perform *some* scanning on the elements you exclude from more broad scans.
121 |             AxeResult axeResultDisablingRulesViolatedByExamples = new AxeBuilder(_webDriver)
122 |                 .Include("#id-of-example-accessibility-violation-list") // Like Exclude(), accepts any CSS selector
123 |                 .DisableRules("color-contrast", "label", "tabindex")
124 |                 .Analyze();
125 | 
126 |             axeResultDisablingRulesViolatedByExamples.Error.Should().BeNull();
127 |             axeResultDisablingRulesViolatedByExamples.Violations.Should().BeEmpty();
128 | 
129 |             // Another option is to assert on the size of the Violations array. This works just fine, but we recommend the
130 |             // other options above as your first choice instead because when they do find new issues, they will produce error
131 |             // messages that more clearly identify exactly what the new/unexpected issues are.
132 |             AxeResult axeResult = new AxeBuilder(_webDriver).Analyze();
133 |             axeResult.Error.Should().BeNull();
134 |             axeResult.Violations.Should().HaveCount(3);
135 |         }
136 | 
137 |         #endregion
138 | 
139 |         #region Example setup and cleanup methods
140 | 
141 |         // The rest of this file shows examples of how to set up an IWebDriver instance to connect to a browser and
142 |         // navigate to a test page.
143 |         //
144 |         // If you're incorporating accessibility testing into an existing body of end to end tests, you can stick with
145 |         // however your existing tests are already solving this; you don't need to do anything special to use Selenium.Axe.
146 | 
147 |         // Starting a new browser process is good for keeping tests isolated from one another, but can be slow. Here, we're
148 |         // using a [ClassInitialize] method so the same browser will be shared between different [TestMethod]s.
149 |         [ClassInitialize]
150 |         public static void StartBrowser(TestContext testContext) {
151 |             // WebDriverFactory uses environment variables set by azure-pipelines.yml to determine which browser to use;
152 |             // the test cases we'll write in this file will work regardless of which browser they're running against.
153 |             //
154 |             // This WebDriverFactory is just one example of how you might initialize Selenium; if you're adding Selenium.Axe
155 |             // to an existing set of end to end tests that already have their own way of initializing a webdriver, you can
156 |             // keep using that instead.
157 |             _webDriver = WebDriverFactory.CreateFromEnvironmentVariableSettings();
158 | 
159 |             // You *must* set this timeout to use Selenium.Axe. It defaults to "0 seconds", which isn't enough time for
160 |             // Axe to scan the page. The exact amount of time will depend on the complexity of the page you're testing.
161 |             _webDriver.Manage().Timeouts().AsynchronousJavaScript = TimeSpan.FromSeconds(20);
162 |         }
163 | 
164 |         // It's important to remember to clean up the browser and webdriver; otherwise, the browser process will remain
165 |         // alive after your tests are done, which can cause confusing errors during later builds and/or test sessions.
166 |         [ClassCleanup]
167 |         public static void StopBrowser()
168 |         {
169 |             _webDriver?.Quit();
170 |         }
171 | 
172 |         // Reloading the test page before every test isn't strictly necessary (since these accessibility scans aren't
173 |         // modifying the page), but is a good practice to default to in the interest of making sure different tests
174 |         // can execute independently.
175 |         [TestInitialize]
176 |         public void LoadTestPage() {
177 |             // For simplicity, we're pointing our test browser directly to a static html file on disk.
178 |             // In a project with more complex hosting needs, you might instead start up a localhost http server
179 |             // and then navigate to a http://localhost link.
180 |             string samplePageFilePath = Path.GetFullPath(@"SamplePage.html");
181 |             string samplePageFileUrl = new Uri(samplePageFilePath).AbsoluteUri;
182 |             _webDriver.Navigate().GoToUrl(samplePageFileUrl);
183 | 
184 |             // It's a good practice to make sure the page's content has actually loaded *before* running any
185 |             // accessibility tests. This acts as a sanity check that the browser initialization worked and makes
186 |             // sure that you aren't just scanning a blank page.
187 |             new WebDriverWait(_webDriver, TimeSpan.FromSeconds(10))
188 |                 .Until(d => d.FindElement(By.TagName("main")));
189 |         }
190 | 
191 |         private static IWebDriver _webDriver;
192 | 
193 |         #endregion
194 | 
195 |         #region Helper methods
196 | 
197 |         private bool AccessibilityErrorsAreExpectedInThisBuild() {
198 |             return
199 |                 Environment.GetEnvironmentVariable("ACCESSIBILITY_ERRORS_ARE_EXPECTED_IN_PR_BUILD") == "true" &&
200 |                 Environment.GetEnvironmentVariable("BUILD_SOURCEBRANCH") != "refs/heads/main";
201 |         }
202 | 
203 |         #endregion
204 |     }
205 | }
206 | 


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/WebDriverFactory.cs:
--------------------------------------------------------------------------------
 1 | // Copyright (c) Microsoft. All rights reserved.
 2 | // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 3 | 
 4 | using OpenQA.Selenium;
 5 | using OpenQA.Selenium.Chrome;
 6 | using OpenQA.Selenium.Firefox;
 7 | using System;
 8 | 
 9 | namespace CSharpSeleniumWebdriverSample
10 | {
11 |     // This factory class is just one example of how you might initialize Selenium. If your project already has its own means
12 |     // of initializing Selenium, you can keep using that as-is and ignore this sample file; skip ahead to SamplePageTests.cs.
13 |     public static class WebDriverFactory
14 |     {
15 |         public static IWebDriver CreateFromEnvironmentVariableSettings() {
16 |             // This environment variable gets set by our Azure Pipelines build definition in ./azure-pipelines.yml.
17 |             // That file uses a matrix strategy to run multiple different build jobs for different combinations of OS/browser.
18 |             // Each job sets this environment variable accordingly, and we use it to decide which browser the tests will use.
19 |             const string BROWSER_ENVIRONMENT_VARIABLE = "SELENIUM_BROWSER";
20 |             var browserEnvVar = Environment.GetEnvironmentVariable(BROWSER_ENVIRONMENT_VARIABLE);
21 | 
22 |             // It's convenient to have a default to make it easier for a developer to run a plain "dotnet test" command.
23 |             // In our CI builds in Azure Pipelines, we'll always specify the browser explicitly instead of using this.
24 |             const string DEFAULT_BROWSER = "chrome";
25 | 
26 |             // Headless browsers generally use small window sizes by default. Some of the axe checks require
27 |             // elements to be present in the viewport to be assessable, so using a viewport size based on your
28 |             // most common usage is a good idea to prevent axe from having to do extra work to scroll items into
29 |             // view and avoid issues with elements not fitting into the viewport.
30 |             const int windowWidth = 1920;
31 |             const int windowHeight = 1080;
32 | 
33 |             switch (browserEnvVar ?? DEFAULT_BROWSER)
34 |             {
35 |                 case "chrome":
36 |                     // The ChromeWebDriver environment variable comes pre-set in the Azure Pipelines VM Image we
37 |                     // specify in azure-pipelines.yml. ChromeDriver requires that you use *matching* versions of Chrome and
38 |                     // the Chrome WebDriver; in the build agent VMs, using this environment variable will make sure that we use
39 |                     // the pre-installed version of ChromeDriver that matches the pre-installed version of Chrome.
40 |                     //
41 |                     // See https://docs.microsoft.com/en-us/azure/devops/pipelines/test/continuous-test-selenium
42 |                     //
43 |                     // Environment.CurrentDirectory is where the Selenium.Webdriver.ChromeDriver NuGet package will place the
44 |                     // version of the Chrome WebDriver that it comes with. We fall back to this so that if a developer working on
45 |                     // the project hasn't separately installed ChromeDriver, the test will still be able to run on their machine.
46 |                     var chromeDriverDirectory = Environment.GetEnvironmentVariable("ChromeWebDriver") ?? Environment.CurrentDirectory;
47 | 
48 |                     // The tests will work fine in non-headless mode; we recommend using --headless for performance and
49 |                     // because it makes it easier to run the tests in non-graphical environments (eg, most Docker containers)
50 |                     var chromeOptions = new ChromeOptions();
51 |                     chromeOptions.AddArgument("--headless");
52 |                     chromeOptions.AddArgument($"--window-size={windowWidth},{windowHeight}");
53 | 
54 |                     return new ChromeDriver(chromeDriverDirectory, chromeOptions);
55 | 
56 |                 case "firefox":
57 |                     // This environment variable works just like ChromeWebDriver above.
58 |                     var geckoDriverDirectory = Environment.GetEnvironmentVariable("GeckoWebDriver") ?? Environment.CurrentDirectory;
59 |                     
60 |                     // Same as for Chrome above; the tests will work fine without --headless, but you'll get better test
61 |                     // performance and easier compatibility with non-graphical environments by using it.
62 |                     var firefoxOptions = new FirefoxOptions();
63 |                     firefoxOptions.AddArgument("-headless");
64 |                     firefoxOptions.AddArguments("-width", $"{windowWidth}", "-height", $"{windowHeight}");
65 | 
66 |                     var firefoxDriverService = FirefoxDriverService.CreateDefaultService(geckoDriverDirectory);
67 |                     // This is a workaround for Windows-specific performance issues caused by https://github.com/mozilla/geckodriver/issues/1496
68 |                     if (Platform.CurrentPlatform.IsPlatformType(PlatformType.Windows)) {
69 |                         firefoxDriverService.Host = "::1";
70 |                     }
71 | 
72 |                     return new FirefoxDriver(firefoxDriverService, firefoxOptions);
73 | 
74 |                 default:
75 |                     throw new ArgumentException($"Unknown browser type '{browserEnvVar}' specified in '{BROWSER_ENVIRONMENT_VARIABLE}' environment variable");
76 |             }
77 |         }
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/csharp-selenium-webdriver-sample/azure-pipelines.yml:
--------------------------------------------------------------------------------
  1 | # Copyright (c) Microsoft Corporation. All rights reserved.
  2 | # Licensed under the MIT License.
  3 | 
  4 | # This file defines an Azure Pipelines build, which you can configure on https://dev.azure.com
  5 | # to run automatically with each Pull Request update and/or each commit to your repository.
  6 | # In this example, we do not change the default "trigger" behavior, so this build gets run
  7 | # for all commits/PRs to all branches of the axe-pipelines-samples repository.
  8 | #
  9 | # If you already have an Azure Pipelines build for your project, we recommend integrating
 10 | # your new accessibility tests into it, rather than creating a separate pipeline. Pipelines
 11 | # builds are usually defined in files like this one named "azure-pipelines.yml" or "build.yaml",
 12 | # but some projects use different file names.
 13 | #
 14 | # If you are using an Azure Pipelines build with tasks configured using the GUI on https://dev.azure.com,
 15 | # instead of a checked in YAML file, you can add the same tasks listed below from the GUI. However, we
 16 | # strongly recommend switching to using a checked in YAML file.
 17 | #
 18 | # Most C# projects with an Azure Pipelines build will already have most of the steps shown below
 19 | #
 20 | # If you *don't* already have an Azure Pipelines build, we recommend following Azure Pipelines'
 21 | # documentation at https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline
 22 | # (using this sample as your starter code).
 23 | #
 24 | # For more information, see:
 25 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started
 26 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/customize-pipeline
 27 | 
 28 | # The browser automation tool we're using, Selenium, works with many different browsers. Here, we show
 29 | # an example of using the same test code with different combinations of browsers and OSes.
 30 | #
 31 | # For more information, see:
 32 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started-multiplatform# Copyright (c) Microsoft Corporation. All rights reserved.
 33 | parameters:
 34 | - name: strategy
 35 |   type: object
 36 |   default:
 37 |   - name: win_chrome
 38 |     imageName: windows-2022-secure
 39 |     browser: chrome
 40 |     os: windows
 41 |   - name: linux_firefox
 42 |     imageName: ubuntu-20.04
 43 |     browser: firefox
 44 |     os: linux
 45 | 
 46 | # The `resources` specify the location and version of the 1ES PT.
 47 | resources:
 48 |   repositories:
 49 |   - repository: 1esPipelines
 50 |     type: git
 51 |     name: 1ESPipelineTemplates/1ESPipelineTemplates
 52 |     ref: refs/tags/release
 53 | 
 54 | extends:
 55 |   template: v1/1ES.Unofficial.PipelineTemplate.yml@1esPipelines
 56 |   parameters:
 57 |     settings:
 58 |       skipBuildTagsForGitHubPullRequests: true
 59 |     pool:
 60 |       name: $(a11yInsightsPool)  # Name of your hosted pool
 61 |       image: windows-2022-secure  # Name of the image in your pool. If not specified, first image of the pool is used
 62 |       os: windows  
 63 | 
 64 |     stages:
 65 |     - stage: Stage
 66 |       jobs:
 67 |       - ${{ each item in parameters.strategy }}:
 68 |         - job: Job_${{ item.name }}
 69 |           pool:
 70 |             name: $(a11yInsightsPool)
 71 |             image: ${{ item.imageName }}
 72 |             os: ${{ item.os }}
 73 |           variables:
 74 |             # This will be sent to the build agent as an environment variable which our test code will be able to see.
 75 |             # We'll use this environment variable in WebDriverFactory.cs to determine which browser the tests will use.
 76 |             SELENIUM_BROWSER: ${{ item.browser }}
 77 |             # This skips unnecessary steps during dotnet restore and saves ~30-60s
 78 |             DOTNET_SKIP_FIRST_TIME_EXPERIENCE: '1'
 79 | 
 80 |           steps:
 81 |             # This task makes sure .NET Core SDK is installed on the build agent.
 82 |             #
 83 |             # It is a good idea to test against a specific, known version of .NET SDK; this makes it easier for other users
 84 |             # to reproduce your build results.
 85 |           - task: UseDotNet@2
 86 |             displayName: install .NET 6.0.415
 87 |             inputs:
 88 |               version: '6.0.415'
 89 | 
 90 |           - task: DotNetCoreCLI@2
 91 |             displayName: dotnet restore
 92 |             inputs:
 93 |               command: restore
 94 |               projects: $(Build.SourcesDirectory)/csharp-selenium-webdriver-sample/**/*.csproj
 95 | 
 96 |               # Using DotNetCoreCLI rather than a "script" step that runs "dotnet test" makes it easier to publish the test results
 97 |               # to see along with the rest of the build details in the Azure Pipelines web UI.
 98 |           - task: DotNetCoreCLI@2
 99 |             displayName: dotnet test
100 |             inputs:
101 |               command: test
102 |               projects: $(Build.SourcesDirectory)/csharp-selenium-webdriver-sample/**/*.csproj
103 |               publishTestResults: true
104 |               testRunTitle: "dotnet test (${{ item.imageName }} ${{ item.browser }})"
105 |                # We use this EXTRA_DOTNET_TEST_ARGUMENTS variable in the sample's CI/PR builds so the "success" examples can --filter
106 |                # out the tests that intentionally fail for example purposes. You probably don't need this in a real project.
107 |               arguments: $(EXTRA_DOTNET_TEST_ARGUMENTS)
108 | 
109 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | yarn-debug.log*
 5 | yarn-error.log*
 6 | 
 7 | # Dependency directories
 8 | node_modules/
 9 | 
10 | # Yarn Integrity file
11 | .yarn-integrity
12 | 
13 | # build output
14 | /dist/
15 | /test-results/
16 | 
17 | **/.DS_Store


--------------------------------------------------------------------------------
/typescript-playwright-sample/README.md:
--------------------------------------------------------------------------------
 1 | # typescript-playwright-sample
 2 | 
 3 | This sample demonstrates how you might set up a CI build for a simple, static html page to perform end to end accessibility tests in a browser, including how to suppress pre-existing or third-party failures. 
 4 | 
 5 | This sample uses [Playwright](https://playwright.dev) for browser automation and uses the corresponding `@axe-core/playwright` library to integrate Axe and Playwright. But you don't have to use Playwright to use Axe! If you prefer a different browser automation tool, you can still follow the same concepts from this sample by using the integration library appropriate for your framework:
 6 | 
 7 | * For **Selenium**, see our [typescript-selenium-webdriver-sample](../typescript-selenium-webdriver-sample/README.md)
 8 | * For **Puppeteer**, use [@axe-core/puppeteer](https://www.npmjs.com/package/@axe-core/puppeteer)
 9 | * For **Cypress**, use [cypress-axe](https://www.npmjs.com/package/cypress-axe)
10 | * For **WebdriverIO**, see our [typescript-selenium-webdriver-sample](../typescript-selenium-webdriver-sample/README.md) and use [@axe-core/webdriverio](https://www.npmjs.com/package/@axe-core/webdriverio)
11 | * For **Protractor**, see our [typescript-selenium-webdriver-sample](../typescript-selenium-webdriver-sample/README.md); keep using `@axe-core/webdriverjs` like that sample shows, but instead of creating your own Webdriver object, pass [`browser.webdriver`](https://www.protractortest.org/#/api?view=ProtractorBrowser) to `@axe-core/webdriverjs`.
12 | 
13 | ## Getting Started
14 | 
15 | The individual files in the sample contain comments that explain the important parts of each file in context.
16 | 
17 | Some good places to start reading are:
18 | 
19 | * [tests/passing-examples.spec.ts](./tests/passing-examples.spec.ts): Playwright test file that opens [src/index.html](./src/index.html) in a browser with Playwright and runs accessibility scans against it with `@axe-core/playwright`
20 | * [azure-pipelines.yml](./azure-pipelines.yml): Azure Pipelines config file that sets up our Continuous Integration and Pull Request builds
21 | * [playwright.config.ts](./playwright.config.ts): Playwright configuration file that enables test result reporting in Azure Pipelines (using the `junit` reporter)
22 | 
23 | ## Tools and libraries used
24 | 
25 | * [TypeScript](https://www.typescriptlang.org/) to author our test code
26 | * [Playwright](https://playwright.dev/) as our test framework and browser automation library
27 | * [@axe-core/playwright](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/playwright) to run an axe accessibility scan on the page from the Playwright browser
28 | * [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) to run the tests in a CI build with every Pull Request
29 | * [axe-sarif-converter](https://github.com/microsoft/axe-sarif-converter) to convert axe results to SARIF format
30 | * [SARIF SAST Scans Tab](https://marketplace.visualstudio.com/items?itemName=sariftools.scans) to visualize the results in Azure Pipelines
31 | 
32 | ## See it in action in Azure Pipelines
33 | 
34 | <!--
35 |   Note to maintainers: The below example images/links come from a specific build instead of the most recent build so we can link to specific tabs.
36 |   If you update the links such that they point to a different build, make sure to mark that build as Retained so the links don't expire in a month.
37 | -->
38 | 
39 | These two Azure Pipelines demonstrate what it looks like to incorporate passing or failing accessibility tests into your CI.
40 | 
41 | ### Passing examples
42 | 
43 | [![Build Status](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_apis/build/status/42?branchName=main)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/latest?definitionId=42&branchName=main)
44 | 
45 | The passing accessibility tests included in passing-examples.spec.ts run as part of the `yarn test` build step:
46 | 
47 | [![Screenshot of "yarn test" build logs in passing sample build](./assets/screenshot-passing-logs-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39169)
48 | 
49 | The test pass results display in the Tests tab of the build logs:
50 | 
51 | [![Screenshot of Tests tab in passing sample build](./assets/screenshot-passing-tests-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39169&view=ms.vss-test-web.build-test-results-tab)
52 | 
53 | Detailed accessibility scan information also appears in the Scans tab, courtesy of the [SARIF SAST Scans Tab extension](https://marketplace.visualstudio.com/items?itemName=sariftools.scans):
54 | 
55 | [![Screenshot of Scans tab in passing sample build](./assets/screenshot-passing-scans-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39169&view=sariftools.scans.build-tab)
56 | 
57 | ### Failing examples
58 | 
59 | [![Build Status](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_apis/build/status/43?branchName=main)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/latest?definitionId=43&branchName=main)
60 | 
61 | The failing accessibility tests included in failing-examples.spec.ts run as part of the `yarn test` build step:
62 | 
63 | [![Screenshot of "yarn test" build logs in failing sample build](./assets/screenshot-failing-logs-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39170)
64 | 
65 | The test pass/fail results display in the Tests tab of the build logs:
66 | 
67 | [![Screenshot of Tests tab in failing sample build](./assets/screenshot-failing-tests-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39170&view=ms.vss-test-web.build-test-results-tab)
68 | 
69 | Detailed accessibility scan information also appears in the Scans tab, courtesy of the [SARIF SAST Scans Tab extension](https://marketplace.visualstudio.com/items?itemName=sariftools.scans):
70 | 
71 | [![Screenshot of Scans tab in failing sample build](./assets/screenshot-failing-scans-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=39170&view=sariftools.scans.build-tab)
72 | 
73 | ## See it in action on your local machine
74 | 
75 | 1. Clone this sample repository
76 | 
77 |    ```sh
78 |    git clone https://github.com/microsoft/axe-pipelines-samples
79 |    ```
80 | 
81 | 1. Install the dependencies
82 | 
83 |    ```sh
84 |    cd ./axe-pipelines-samples/typescript-playwright-sample
85 |    yarn install # or npm install, whichever your project prefers
86 |    ```
87 | 
88 | 1. Run the tests!
89 | 
90 |    ```sh
91 |    yarn test # or `npm test`. You can also append a file name to only run passing or failing tests (ex: `yarn test passing-examples.spec.ts`)
92 |    ```
93 | 
94 |    ![Screenshot of yarn test command showing 3 tests passing and 1 test failed](./assets/screenshot-local-yarn-test.png)
95 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-failing-logs-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-failing-logs-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-failing-scans-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-failing-scans-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-failing-tests-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-failing-tests-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-local-yarn-test.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-local-yarn-test.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-passing-logs-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-passing-logs-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-passing-scans-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-passing-scans-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/assets/screenshot-passing-tests-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-playwright-sample/assets/screenshot-passing-tests-tab.png


--------------------------------------------------------------------------------
/typescript-playwright-sample/azure-pipelines.yml:
--------------------------------------------------------------------------------
  1 | # Copyright (c) Microsoft Corporation. All rights reserved.
  2 | # Licensed under the MIT License.
  3 | 
  4 | # This file defines an Azure Pipelines build, which you can configure on https://dev.azure.com
  5 | # to run automatically with each Pull Request update and/or each commit to your repository.
  6 | # In this example, we do not change the default "trigger" behavior, so this build gets run
  7 | # for all commits/PRs to all branches of the axe-pipelines-samples repository.
  8 | #
  9 | # If you already have an Azure Pipelines build for your project, we recommend integrating
 10 | # your new accessibility tests into it, rather than creating a separate pipeline. Pipelines
 11 | # builds are usually defined in files like this one named "azure-pipelines.yml" or "build.yaml",
 12 | # but some projects use different file names.
 13 | #
 14 | # If you are using an Azure Pipelines build with tasks configured using the GUI on https://dev.azure.com,
 15 | # instead of a checked in YAML file, you can add the same tasks listed below from the GUI. However, we
 16 | # strongly recommend switching to using a checked in YAML file.
 17 | #
 18 | # Most TypeScript projects with an Azure Pipelines build will already have most of the steps
 19 | # shown below, with the exception of the final "PublishBuildArtifact" task; you'll probably
 20 | # have to add that.
 21 | #
 22 | # If you *don't* already have an Azure Pipelines build, we recommend following Azure Pipelines'
 23 | # documentation at https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline
 24 | # (using this sample as your starter code).
 25 | #
 26 | # For more information, see:
 27 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started
 28 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/customize-pipeline
 29 | 
 30 | # The browser automation tool we're using, Playwright, works with many different browsers. Here,
 31 | # we show an example of using the same test code with different combinations of browsers and OSes.
 32 | #
 33 | # For more information, see:
 34 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started-multiplatform
 35 | # * https://playwright.dev/docs/test-intro
 36 | parameters:
 37 | - name: strategy
 38 |   type: object
 39 |   default:
 40 |   - name: win_chromium
 41 |     imageName: windows-2022-secure
 42 |     browser: chromium
 43 |     os: windows
 44 |   - name: linux_firefox
 45 |     imageName: ubuntu-22.04-secure
 46 |     browser: firefox
 47 |     os: linux  
 48 |   - name: mac_webkit
 49 |     imageName: macOS-13
 50 |     browser: webkit
 51 |     os: macOS
 52 | # The `resources` specify the location and version of the 1ES PT.
 53 | resources:
 54 |   repositories:
 55 |   - repository: 1esPipelines
 56 |     type: git
 57 |     name: 1ESPipelineTemplates/1ESPipelineTemplates
 58 |     ref: refs/tags/release
 59 | 
 60 | extends:
 61 |   template: v1/1ES.Unofficial.PipelineTemplate.yml@1esPipelines
 62 |   parameters:
 63 |     settings:
 64 |       skipBuildTagsForGitHubPullRequests: true
 65 |     # Update the pool with your team's 1ES hosted pool.
 66 |     pool:
 67 |       name: $(a11yInsightsPool) # Name of your hosted pool
 68 |       image: windows-2022-secure # Name of the image in your pool. If not specified, first image of the pool is used
 69 |       os: windows # OS of the image. Allowed values: windows, linux, macOS
 70 | 
 71 |     stages:
 72 |     - stage: Stage
 73 |       jobs:
 74 |       - ${{ each item in parameters.strategy }}:
 75 |         - job: Job_${{ item.name }}
 76 |           pool:
 77 |             image: ${{ item.imageName }}
 78 |             os: ${{ item.os }}
 79 |             ${{ if or(eq(item.os,'linux'),eq(item.os, 'windows'))}} :
 80 |               name: $(a11yInsightsPool)
 81 |             ${{ else }} :
 82 |               name: Azure Pipelines
 83 |           
 84 |           templateContext:
 85 |           # If you are adding tests to an existing project that already uses Azure Pipelines, this is probably the only
 86 |           # new task you'll need to add.
 87 |           #
 88 |           # This task is how the "Scans" tab in our Azure Pipelines build results page gets its data. It requires using
 89 |           # PublishBuildArtifacts rather than the newer PublishPipelineArtifacts.
 90 |             outputs:
 91 |             - output: buildArtifacts
 92 |               # The exact name "CodeAnalysisLogs" is required for the Sarif Results Viewer Extension for Azure Pipelines
 93 |               # to find the .sarif files our accessibility test produces.
 94 |               displayName: publish sarif results
 95 |               # "test-results" is not a required convention; it just happens to be where our tests write .sarif files to.
 96 |               PathtoPublish: $(Build.SourcesDirectory)/typescript-playwright-sample/test-results
 97 |               ArtifactName: CodeAnalysisLogs
 98 |               condition: succeededOrFailed()
 99 |           # This task makes sure Node.js is installed on the build agent.
100 |           #
101 |           # It is a good idea to test against a specific, known version of Node; this makes it easier for other users
102 |           # to reproduce your build results.
103 |           steps:
104 |           - task: NodeTool@0
105 |             displayName: install node 20.17.0
106 |             inputs:
107 |               versionSpec: "20.17.0"
108 |               
109 |           # This task installs dependencies specified in your package.json file.
110 |           #
111 |           # Our sample uses Yarn for this, but if your project uses NPM instead, that's also fine.
112 |           - script: yarn install --frozen-lockfile # or "npm install --ci"
113 |             displayName: yarn install
114 |           # workingDirectory should match where your package.json file is located. It defaults to the root of the repository.
115 |             workingDirectory: $(Build.SourcesDirectory)/typescript-playwright-sample
116 | 
117 |           # This task runs the tests specified by playwright.config.js, including our example accessibility tests.
118 |           #
119 |           # If your project already uses npm instead of yarn, or if your project already runs "playwright test" directly here,
120 |           # those are both fine.
121 |           #
122 |           # We use the EXTRA_PLAYWRIGHT_TEST_ARGUMENTS variable in the sample's CI/PR builds to separate our passing and failing
123 |           # example builds using Playwright Test's --project argument. You probably don't need EXTRA_PLAYWRIGHT_TEST_ARGUMENTS in
124 |           # a real project.
125 |           - script: yarn test --browser=${{ item.browser }} $(EXTRA_PLAYWRIGHT_TEST_ARGUMENTS) # or "npm run test -- --browser=$(browser)"
126 |             displayName: yarn test
127 |             workingDirectory: $(Build.SourcesDirectory)/typescript-playwright-sample
128 | 
129 |           # This task is how the "Tests" tab in our Azure Pipelines build results page gets its data
130 |           - task: PublishTestResults@2
131 |             displayName: publish test results
132 |             inputs:
133 |               testResultsFiles: $(Build.SourcesDirectory)/typescript-playwright-sample/test-results/junit.xml
134 |               testRunTitle: typescript-playwright-sample (${{ item.imageName }} ${{ item.browser }})
135 |             condition: succeededOrFailed()
136 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "typescript-playwright-sample",
 3 |   "version": "0.0.0",
 4 |   "description": "Sample project that demonstrates accessibility testing with TypeScript, Playwright, @axe-core/playwright, SARIF, and Azure Pipelines.",
 5 |   "private": true,
 6 |   "devDependencies": {
 7 |     "@axe-core/playwright": "^4.10.1",
 8 |     "@playwright/test": "^1.52.0",
 9 |     "@types/node": "^20.17.45",
10 |     "axe-sarif-converter": "^3.0.0",
11 |     "typescript": "^5.8.3"
12 |   },
13 |   "scripts": {
14 |     "test": "yarn playwright install && yarn playwright install-deps && yarn playwright test"
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/playwright.config.ts:
--------------------------------------------------------------------------------
1 | import { PlaywrightTestConfig } from '@playwright/test';
2 | const config: PlaywrightTestConfig = {
3 |     // JUnit output is required to show results in Azure Pipelines' test view
4 |     reporter: [['list'], ['junit', { outputFile: 'test-results/junit.xml' }]],
5 |     retries: 3,
6 | };
7 | export default config;


--------------------------------------------------------------------------------
/typescript-playwright-sample/src/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en-US">
 3 |     <head>
 4 |         <title>Example page with some accessibility issues</title>
 5 |     </head>
 6 |     <body>
 7 |         <main>
 8 |             <h1>This is a static sample page with some accessibility issues</h1>
 9 |             <ul id="example-accessibility-violations">
10 |                 <li>This text box has no accessible label: <input type="text"></li>
11 |                 <li>This text's color contrast is too low: <span style="color: #A2A2A2">low-contrast text</span></li>
12 |                 <li>This text has an invalid "role" attribute: <span role="invalid">span with invalid role</a></li>
13 |             </ul>
14 |         </main>
15 |     </body>
16 | </html>
17 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/tests/export-to-sarif.ts:
--------------------------------------------------------------------------------
 1 | // Copyright (c) Microsoft Corporation. All rights reserved.
 2 | // Licensed under the MIT License.
 3 | import * as Axe from 'axe-core';
 4 | import { convertAxeToSarif } from 'axe-sarif-converter';
 5 | import * as fs from 'fs';
 6 | import * as path from 'path';
 7 | import { promisify } from 'util';
 8 | 
 9 | // SARIF is a general-purpose log format for code analysis tools.
10 | //
11 | // Exporting axe results as .sarif files lets our Azure Pipelines build results page show a nice visualization
12 | // of any accessibility failures we find using the Sarif Results Viewer Tab extension
13 | // (https://marketplace.visualstudio.com/items?itemName=sariftools.sarif-viewer-build-tab)
14 | export async function exportAxeAsSarifTestResult(sarifFileName: string, axeResults: Axe.AxeResults, browserName: string): Promise<void> {
15 |     // We use the axe-sarif-converter package for the conversion step, then write the results
16 |     // to a file that we'll be publishing from a CI build step in azure-pipelines.yml
17 |     const sarifResults = convertAxeToSarif(axeResults);
18 | 
19 |     // This directory should be .gitignore'd and should be published as a build artifact in azure-pipelines.yml
20 |     const testResultsDirectory = path.join(__dirname, '..', 'test-results', browserName);
21 |     await promisify(fs.mkdir)(testResultsDirectory, { recursive: true });
22 | 
23 |     const sarifResultFile = path.join(testResultsDirectory, sarifFileName);
24 |     await promisify(fs.writeFile)(
25 |         sarifResultFile,
26 |         JSON.stringify(sarifResults, null, 2));
27 | 
28 |     console.log(`Exported axe results to ${sarifResultFile}`);
29 | }
30 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/tests/failing-examples.spec.ts:
--------------------------------------------------------------------------------
 1 | // Copyright (c) Microsoft Corporation. All rights reserved.
 2 | // Licensed under the MIT License.
 3 | import { test, expect } from '@playwright/test';
 4 | import AxeBuilder from '@axe-core/playwright';
 5 | import * as path from 'path';
 6 | import { exportAxeAsSarifTestResult } from './export-to-sarif';
 7 | 
 8 | // This file contains test cases that intentionally fail; you can refer to this project's
 9 | // "[failing example] typescript-playwright-sample" Pipeline to see what an accessibility
10 | // failure would look like in a real CI build.
11 | test.describe('[failing example] index.html', () => {
12 | 
13 |     // This is the same setup as passing-examples.spec.ts; see its comments for details
14 |     test.beforeEach(async ({page}) => {
15 |         const pageUnderTest = 'file://' + path.join(__dirname, '..', 'src', 'index.html');
16 |         await page.goto(pageUnderTest);
17 |         await page.waitForSelector('h1');
18 |     });
19 | 
20 |     // This test case scans an element which includes a few examples of accessibility violations.
21 |     test('accessibility of elements with issues', async ({ browserName, page }) => {
22 |         const accessibilityScanResults = await new AxeBuilder({ page })
23 |             .include('#example-accessibility-violations')
24 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
25 |             .analyze();
26 |             
27 |         await exportAxeAsSarifTestResult('index-except-examples.sarif', accessibilityScanResults, browserName);
28 | 
29 |         // Our PR builds do not change the presence or absence of accessibility issues, so we special case
30 |         // our PR build tests to expect the errors. This is not recommended for most projects, but since the
31 |         // check takes effect only if the ACCESSIBILITY_ERRORS_ARE_EXPECTED_IN_PR_BUILD variable is set to
32 |         // true within the pipeline, you may safely copy this code and the special case will be ignored.
33 |         if (AccessibilityErrorsAreExpectedInThisBuild()) {
34 |             expect(accessibilityScanResults.violations).not.toEqual([]);
35 |         } else {
36 |             expect(accessibilityScanResults.violations).toEqual([]);
37 |         }
38 |     });
39 | 
40 |     function AccessibilityErrorsAreExpectedInThisBuild(): boolean {
41 |         return process.env["ACCESSIBILITY_ERRORS_ARE_EXPECTED_IN_PR_BUILD"] === "true" &&
42 |             process.env["BUILD_SOURCEBRANCH"] !== "refs/heads/main";
43 |     }
44 | });
45 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/tests/passing-examples.spec.ts:
--------------------------------------------------------------------------------
  1 | // Copyright (c) Microsoft Corporation. All rights reserved.
  2 | // Licensed under the MIT License.
  3 | import { test, expect } from '@playwright/test';
  4 | import * as Axe from 'axe-core';
  5 | import AxeBuilder from '@axe-core/playwright';
  6 | import * as path from 'path';
  7 | import { exportAxeAsSarifTestResult } from './export-to-sarif';
  8 | 
  9 | test.describe('[passing examples] index.html', () => {
 10 |     test.beforeEach(async ({page}) => {
 11 |         // For simplicity, we're pointing our test browser directly to a static html file on disk.
 12 |         //
 13 |         // In a project with more complex hosting needs, you might instead start up a localhost http server
 14 |         // from your test's beforeAll block, and point your test cases to a http://localhost link.
 15 |         //
 16 |         // Some common node.js libraries for hosting this sort of localhost http server include Express.js,
 17 |         // http-server, and Koa.
 18 |         const pageUnderTest = 'file://' + path.join(__dirname, '..', 'src', 'index.html');
 19 |         await page.goto(pageUnderTest);
 20 | 
 21 |         // Checking for a known element on the page in beforeEach serves two purposes:
 22 |         // * It acts as a smoke test that our browser automation setup basically works
 23 |         // * It ensures that the page is loaded before we run our accessibility scans
 24 |         await page.waitForSelector('h1');
 25 |     });
 26 | 
 27 | 
 28 |     // This test case shows the most basic example: run a scan, fail the test if there are any failures.
 29 |     // This is the way to go if you have no known/pre-existing violations you need to temporarily baseline.
 30 |     test('accessibility of h1 element', async ({ browserName, page }) => {
 31 |         const accessibilityScanResults = await new AxeBuilder({ page })
 32 |             // You can use any CSS selector in place of "h1" here
 33 |             .include('h1')
 34 |             // This withTags directive restricts Axe to only run tests that detect known violations of
 35 |             // WCAG 2.1 A and AA rules (similar to what Accessibility Insights reports). If you omit
 36 |             // this, Axe will additionally run several "best practice" rules, which are good ideas to
 37 |             // check for periodically but may report false positives in certain edge cases.
 38 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 39 |             .analyze();
 40 | 
 41 |         await exportAxeAsSarifTestResult('index-h1-element.sarif', accessibilityScanResults, browserName);
 42 | 
 43 |         expect(accessibilityScanResults.violations).toEqual([]);
 44 |     });
 45 | 
 46 |     // If you want to run a scan of a page but need to exclude an element with known issues (eg, a third-party
 47 |     // component you don't control fixing yourself), you can exclude it specifically and still scan the rest
 48 |     // of the page.
 49 |     test('accessibility of page (excluding element with known issues)', async ({ browserName, page }) => {
 50 |         const accessibilityScanResults = await new AxeBuilder({ page })
 51 |             .exclude('#example-accessibility-violations')
 52 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 53 |             .analyze();
 54 |             
 55 |         await exportAxeAsSarifTestResult('index-except-examples.sarif', accessibilityScanResults, browserName);
 56 | 
 57 |         expect(accessibilityScanResults.violations).toEqual([]);
 58 |     });
 59 | 
 60 |     // If you want to more precisely baseline a particular set of known issues, you can extract a "fingerprint"
 61 |     // for each issue and test whether the set of fingerprints found matches the set you already know about.
 62 |     test('accessibility of page should match snapshot', async ({ browserName, page }) => {
 63 |         const accessibilityScanResults = await new AxeBuilder({ page })
 64 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 65 |             .analyze();
 66 | 
 67 |         await exportAxeAsSarifTestResult('index-page.sarif', accessibilityScanResults, browserName);
 68 | 
 69 |         // We recommend pinning your known failure cases using fingerprints, rather than pinning the entire
 70 |         // contents of the violation objects. Violation objects include contextual information like "a snippet
 71 |         // of the HTML containing the violation", so snapshotting entire violation objects is prone to failing
 72 |         // when unrelated changes are made to the element (or even to unrelated ancestors of the element in
 73 |         // the DOM).
 74 |         //
 75 |         // This technique will have the side effect of test failures only showing the fingerprint, rather than
 76 |         // the entire violation, when an unexpected failure occurs. You can still use the exported .sarif files
 77 |         // to see complete failure information in a SARIF viewer (https://sarifweb.azurewebsites.net/#Viewers)
 78 |         // or a text editor.
 79 |         const violationFingerprints = accessibilityScanResults.violations.map(getViolationFingerprint);
 80 |         
 81 |         expect(violationFingerprints).toEqual([
 82 |             {
 83 |                 "rule": "aria-roles",
 84 |                 "targets": [[ "span[role=\"invalid\"]" ]],
 85 |             },
 86 |             {
 87 |                 "rule": "color-contrast",
 88 |                 "targets": [[ "li:nth-child(2) > span" ]],
 89 |             },
 90 |             {
 91 |                 "rule": "label",
 92 |                 "targets": [[ "input" ]]
 93 |             }
 94 |         ]);
 95 |     });
 96 | });
 97 | 
 98 | // You can make your "fingerprint" function as specific as you like. This one considers a violation to be
 99 | // "the same" if it corresponds the same Axe rule on the same set of elements.
100 | const getViolationFingerprint = (violation: Axe.Result) => ({
101 |     rule: violation.id,
102 |     targets: violation.nodes.map(node => node.target),
103 | });
104 | 


--------------------------------------------------------------------------------
/typescript-playwright-sample/yarn.lock:
--------------------------------------------------------------------------------
  1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  2 | # yarn lockfile v1
  3 | 
  4 | 
  5 | "@axe-core/playwright@^4.10.1":
  6 |   version "4.10.1"
  7 |   resolved "https://registry.yarnpkg.com/@axe-core/playwright/-/playwright-4.10.1.tgz#c811ba8bfa244833cce422c4131e0043828c42cc"
  8 |   integrity sha512-EV5t39VV68kuAfMKqb/RL+YjYKhfuGim9rgIaQ6Vntb2HgaCaau0h98Y3WEUqW1+PbdzxDtDNjFAipbtZuBmEA==
  9 |   dependencies:
 10 |     axe-core "~4.10.2"
 11 | 
 12 | "@playwright/test@^1.52.0":
 13 |   version "1.52.0"
 14 |   resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.52.0.tgz#267ec595b43a8f4fa5e444ea503689629e91a5b8"
 15 |   integrity sha512-uh6W7sb55hl7D6vsAeA+V2p5JnlAqzhqFyF0VcJkKZXkgnFcVG9PziERRHQfPLfNGx1C292a4JqbWzhR8L4R1g==
 16 |   dependencies:
 17 |     playwright "1.52.0"
 18 | 
 19 | "@puppeteer/browsers@^2.1.0":
 20 |   version "2.2.0"
 21 |   resolved "https://registry.yarnpkg.com/@puppeteer/browsers/-/browsers-2.2.0.tgz#25b5c6d1c93eb91e7086ebc95b767fe7b3ee5ec4"
 22 |   integrity sha512-MC7LxpcBtdfTbzwARXIkqGZ1Osn3nnZJlm+i0+VqHl72t//Xwl9wICrXT8BwtgC6s1xJNHsxOpvzISUqe92+sw==
 23 |   dependencies:
 24 |     debug "4.3.4"
 25 |     extract-zip "2.0.1"
 26 |     progress "2.0.3"
 27 |     proxy-agent "6.4.0"
 28 |     semver "7.6.0"
 29 |     tar-fs "3.0.5"
 30 |     unbzip2-stream "1.4.3"
 31 |     yargs "17.7.2"
 32 | 
 33 | "@tootallnate/quickjs-emscripten@^0.23.0":
 34 |   version "0.23.0"
 35 |   resolved "https://registry.yarnpkg.com/@tootallnate/quickjs-emscripten/-/quickjs-emscripten-0.23.0.tgz#db4ecfd499a9765ab24002c3b696d02e6d32a12c"
 36 |   integrity sha512-C5Mc6rdnsaJDjO3UpGW/CQTHtCKaYlScZTly4JIu97Jxo/odCiH0ITnDXSJPTOrEKk/ycSZ0AOgTmkDtkOsvIA==
 37 | 
 38 | "@types/node@*", "@types/node@^20.17.45":
 39 |   version "20.17.45"
 40 |   resolved "https://registry.yarnpkg.com/@types/node/-/node-20.17.45.tgz#a50a51a7da7b7bddecd90851bc0173b51db00724"
 41 |   integrity sha512-vO9+E1smq+149wsmmLdM8SKVW7gRzLjfo0mU7kiykhV6rL+GEUhUmW7VywJNSxJHQzt9QBIHEo+3SG4MrFTqbA==
 42 |   dependencies:
 43 |     undici-types "~6.19.2"
 44 | 
 45 | "@types/sarif@>=2.1.1 <=2.1.8":
 46 |   version "2.1.7"
 47 |   resolved "https://registry.yarnpkg.com/@types/sarif/-/sarif-2.1.7.tgz#dab4d16ba7568e9846c454a8764f33c5d98e5524"
 48 |   integrity sha512-kRz0VEkJqWLf1LLVN4pT1cg1Z9wAuvI6L97V3m2f5B76Tg8d413ddvLBPTEHAZJlnn4XSvu0FkZtViCQGVyrXQ==
 49 | 
 50 | "@types/yauzl@^2.9.1":
 51 |   version "2.10.0"
 52 |   resolved "https://registry.yarnpkg.com/@types/yauzl/-/yauzl-2.10.0.tgz#b3248295276cf8c6f153ebe6a9aba0c988cb2599"
 53 |   integrity sha512-Cn6WYCm0tXv8p6k+A8PvbDG763EDpBoTzHdA+Q/MF6H3sapGjCm9NzoaJncJS9tUKSuCoDs9XHxYYsQDgxR6kw==
 54 |   dependencies:
 55 |     "@types/node" "*"
 56 | 
 57 | agent-base@^7.0.2, agent-base@^7.1.0:
 58 |   version "7.1.0"
 59 |   resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-7.1.0.tgz#536802b76bc0b34aa50195eb2442276d613e3434"
 60 |   integrity sha512-o/zjMZRhJxny7OyEF+Op8X+efiELC7k7yOjMzgfzVqOzXqkBkWI79YoTdOtsuWd5BWhAGAuOY/Xa6xpiaWXiNg==
 61 |   dependencies:
 62 |     debug "^4.3.4"
 63 | 
 64 | ansi-regex@^5.0.0, ansi-regex@^5.0.1:
 65 |   version "5.0.1"
 66 |   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"
 67 |   integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==
 68 | 
 69 | ansi-styles@^4.0.0:
 70 |   version "4.3.0"
 71 |   resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937"
 72 |   integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==
 73 |   dependencies:
 74 |     color-convert "^2.0.1"
 75 | 
 76 | ast-types@^0.13.4:
 77 |   version "0.13.4"
 78 |   resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.13.4.tgz#ee0d77b343263965ecc3fb62da16e7222b2b6782"
 79 |   integrity sha512-x1FCFnFifvYDDzTaLII71vG5uvDwgtmDTEVWAxrgeiR8VjMONcCXJx7E+USjDtHlwFmt9MysbqgF9b9Vjr6w+w==
 80 |   dependencies:
 81 |     tslib "^2.0.1"
 82 | 
 83 | "axe-core@^3.2.2 || ^4.0.0", axe-core@~4.10.2:
 84 |   version "4.10.2"
 85 |   resolved "https://registry.yarnpkg.com/axe-core/-/axe-core-4.10.2.tgz#85228e3e1d8b8532a27659b332e39b7fa0e022df"
 86 |   integrity sha512-RE3mdQ7P3FRSe7eqCWoeQ/Z9QXrtniSjp1wUjt5nRC3WIpz5rSCve6o3fsZ2aCpJtrZjSZgjwXAoTO5k4tEI0w==
 87 | 
 88 | axe-sarif-converter@^3.0.0:
 89 |   version "3.0.0"
 90 |   resolved "https://registry.yarnpkg.com/axe-sarif-converter/-/axe-sarif-converter-3.0.0.tgz#c1da89f752af3c7fb50f7a5d0d408176ad62b246"
 91 |   integrity sha512-oYAgxSccgFLc8n/aYyjS1xWYxb8k4VHYqII6/YsJsk1jnttfiRUkR631LyN+5T7UCJVzD2hILA0c3q3kTHpypg==
 92 |   dependencies:
 93 |     "@puppeteer/browsers" "^2.1.0"
 94 |     "@types/sarif" ">=2.1.1 <=2.1.8"
 95 |     axe-core "^3.2.2 || ^4.0.0"
 96 |     yargs "^17.0.0"
 97 | 
 98 | b4a@^1.6.4:
 99 |   version "1.6.4"
100 |   resolved "https://registry.yarnpkg.com/b4a/-/b4a-1.6.4.tgz#ef1c1422cae5ce6535ec191baeed7567443f36c9"
101 |   integrity sha512-fpWrvyVHEKyeEvbKZTVOeZF3VSKKWtJxFIxX/jaVPf+cLbGUSitjb49pHLqPV2BUNNZ0LcoeEGfE/YCpyDYHIw==
102 | 
103 | bare-events@^2.0.0, bare-events@^2.2.0:
104 |   version "2.2.2"
105 |   resolved "https://registry.yarnpkg.com/bare-events/-/bare-events-2.2.2.tgz#a98a41841f98b2efe7ecc5c5468814469b018078"
106 |   integrity sha512-h7z00dWdG0PYOQEvChhOSWvOfkIKsdZGkWr083FgN/HyoQuebSew/cgirYqh9SCuy/hRvxc5Vy6Fw8xAmYHLkQ==
107 | 
108 | bare-fs@^2.1.1:
109 |   version "2.2.2"
110 |   resolved "https://registry.yarnpkg.com/bare-fs/-/bare-fs-2.2.2.tgz#286bf54cc6f15f613bee6bb26f0c61c79fb14f06"
111 |   integrity sha512-X9IqgvyB0/VA5OZJyb5ZstoN62AzD7YxVGog13kkfYWYqJYcK0kcqLZ6TrmH5qr4/8//ejVcX4x/a0UvaogXmA==
112 |   dependencies:
113 |     bare-events "^2.0.0"
114 |     bare-os "^2.0.0"
115 |     bare-path "^2.0.0"
116 |     streamx "^2.13.0"
117 | 
118 | bare-os@^2.0.0, bare-os@^2.1.0:
119 |   version "2.2.1"
120 |   resolved "https://registry.yarnpkg.com/bare-os/-/bare-os-2.2.1.tgz#c94a258c7a408ca6766399e44675136c0964913d"
121 |   integrity sha512-OwPyHgBBMkhC29Hl3O4/YfxW9n7mdTr2+SsO29XBWKKJsbgj3mnorDB80r5TiCQgQstgE5ga1qNYrpes6NvX2w==
122 | 
123 | bare-path@^2.0.0, bare-path@^2.1.0:
124 |   version "2.1.0"
125 |   resolved "https://registry.yarnpkg.com/bare-path/-/bare-path-2.1.0.tgz#830f17fd39842813ca77d211ebbabe238a88cb4c"
126 |   integrity sha512-DIIg7ts8bdRKwJRJrUMy/PICEaQZaPGZ26lsSx9MJSwIhSrcdHn7/C8W+XmnG/rKi6BaRcz+JO00CjZteybDtw==
127 |   dependencies:
128 |     bare-os "^2.1.0"
129 | 
130 | base64-js@^1.3.1:
131 |   version "1.5.1"
132 |   resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.5.1.tgz#1b1b440160a5bf7ad40b650f095963481903930a"
133 |   integrity sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==
134 | 
135 | basic-ftp@^5.0.2:
136 |   version "5.0.3"
137 |   resolved "https://registry.yarnpkg.com/basic-ftp/-/basic-ftp-5.0.3.tgz#b14c0fe8111ce001ec913686434fe0c2fb461228"
138 |   integrity sha512-QHX8HLlncOLpy54mh+k/sWIFd0ThmRqwe9ZjELybGZK+tZ8rUb9VO0saKJUROTbE+KhzDUT7xziGpGrW8Kmd+g==
139 | 
140 | buffer-crc32@~0.2.3:
141 |   version "0.2.13"
142 |   resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-0.2.13.tgz#0d333e3f00eac50aa1454abd30ef8c2a5d9a7242"
143 |   integrity sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ==
144 | 
145 | buffer@^5.2.1:
146 |   version "5.7.1"
147 |   resolved "https://registry.yarnpkg.com/buffer/-/buffer-5.7.1.tgz#ba62e7c13133053582197160851a8f648e99eed0"
148 |   integrity sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==
149 |   dependencies:
150 |     base64-js "^1.3.1"
151 |     ieee754 "^1.1.13"
152 | 
153 | cliui@^8.0.1:
154 |   version "8.0.1"
155 |   resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa"
156 |   integrity sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==
157 |   dependencies:
158 |     string-width "^4.2.0"
159 |     strip-ansi "^6.0.1"
160 |     wrap-ansi "^7.0.0"
161 | 
162 | color-convert@^2.0.1:
163 |   version "2.0.1"
164 |   resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3"
165 |   integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==
166 |   dependencies:
167 |     color-name "~1.1.4"
168 | 
169 | color-name@~1.1.4:
170 |   version "1.1.4"
171 |   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
172 |   integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
173 | 
174 | data-uri-to-buffer@^5.0.1:
175 |   version "5.0.1"
176 |   resolved "https://registry.yarnpkg.com/data-uri-to-buffer/-/data-uri-to-buffer-5.0.1.tgz#db89a9e279c2ffe74f50637a59a32fb23b3e4d7c"
177 |   integrity sha512-a9l6T1qqDogvvnw0nKlfZzqsyikEBZBClF39V3TFoKhDtGBqHu2HkuomJc02j5zft8zrUaXEuoicLeW54RkzPg==
178 | 
179 | debug@4, debug@4.3.4, debug@^4.1.1, debug@^4.3.4:
180 |   version "4.3.4"
181 |   resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865"
182 |   integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==
183 |   dependencies:
184 |     ms "2.1.2"
185 | 
186 | degenerator@^5.0.0:
187 |   version "5.0.1"
188 |   resolved "https://registry.yarnpkg.com/degenerator/-/degenerator-5.0.1.tgz#9403bf297c6dad9a1ece409b37db27954f91f2f5"
189 |   integrity sha512-TllpMR/t0M5sqCXfj85i4XaAzxmS5tVA16dqvdkMwGmzI+dXLXnw3J+3Vdv7VKw+ThlTMboK6i9rnZ6Nntj5CQ==
190 |   dependencies:
191 |     ast-types "^0.13.4"
192 |     escodegen "^2.1.0"
193 |     esprima "^4.0.1"
194 | 
195 | emoji-regex@^8.0.0:
196 |   version "8.0.0"
197 |   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
198 |   integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==
199 | 
200 | end-of-stream@^1.1.0:
201 |   version "1.4.4"
202 |   resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0"
203 |   integrity sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==
204 |   dependencies:
205 |     once "^1.4.0"
206 | 
207 | escalade@^3.1.1:
208 |   version "3.1.1"
209 |   resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40"
210 |   integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==
211 | 
212 | escodegen@^2.1.0:
213 |   version "2.1.0"
214 |   resolved "https://registry.yarnpkg.com/escodegen/-/escodegen-2.1.0.tgz#ba93bbb7a43986d29d6041f99f5262da773e2e17"
215 |   integrity sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w==
216 |   dependencies:
217 |     esprima "^4.0.1"
218 |     estraverse "^5.2.0"
219 |     esutils "^2.0.2"
220 |   optionalDependencies:
221 |     source-map "~0.6.1"
222 | 
223 | esprima@^4.0.1:
224 |   version "4.0.1"
225 |   resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71"
226 |   integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==
227 | 
228 | estraverse@^5.2.0:
229 |   version "5.3.0"
230 |   resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123"
231 |   integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==
232 | 
233 | esutils@^2.0.2:
234 |   version "2.0.3"
235 |   resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
236 |   integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==
237 | 
238 | extract-zip@2.0.1:
239 |   version "2.0.1"
240 |   resolved "https://registry.yarnpkg.com/extract-zip/-/extract-zip-2.0.1.tgz#663dca56fe46df890d5f131ef4a06d22bb8ba13a"
241 |   integrity sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg==
242 |   dependencies:
243 |     debug "^4.1.1"
244 |     get-stream "^5.1.0"
245 |     yauzl "^2.10.0"
246 |   optionalDependencies:
247 |     "@types/yauzl" "^2.9.1"
248 | 
249 | fast-fifo@^1.1.0, fast-fifo@^1.2.0:
250 |   version "1.3.0"
251 |   resolved "https://registry.yarnpkg.com/fast-fifo/-/fast-fifo-1.3.0.tgz#03e381bcbfb29932d7c3afde6e15e83e05ab4d8b"
252 |   integrity sha512-IgfweLvEpwyA4WgiQe9Nx6VV2QkML2NkvZnk1oKnIzXgXdWxuhF7zw4DvLTPZJn6PIUneiAXPF24QmoEqHTjyw==
253 | 
254 | fd-slicer@~1.1.0:
255 |   version "1.1.0"
256 |   resolved "https://registry.yarnpkg.com/fd-slicer/-/fd-slicer-1.1.0.tgz#25c7c89cb1f9077f8891bbe61d8f390eae256f1e"
257 |   integrity sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g==
258 |   dependencies:
259 |     pend "~1.2.0"
260 | 
261 | fs-extra@^8.1.0:
262 |   version "8.1.0"
263 |   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-8.1.0.tgz#49d43c45a88cd9677668cb7be1b46efdb8d2e1c0"
264 |   integrity sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==
265 |   dependencies:
266 |     graceful-fs "^4.2.0"
267 |     jsonfile "^4.0.0"
268 |     universalify "^0.1.0"
269 | 
270 | fsevents@2.3.2:
271 |   version "2.3.2"
272 |   resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.2.tgz#8a526f78b8fdf4623b709e0b975c52c24c02fd1a"
273 |   integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==
274 | 
275 | get-caller-file@^2.0.5:
276 |   version "2.0.5"
277 |   resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
278 |   integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==
279 | 
280 | get-stream@^5.1.0:
281 |   version "5.2.0"
282 |   resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.2.0.tgz#4966a1795ee5ace65e706c4b7beb71257d6e22d3"
283 |   integrity sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==
284 |   dependencies:
285 |     pump "^3.0.0"
286 | 
287 | get-uri@^6.0.1:
288 |   version "6.0.1"
289 |   resolved "https://registry.yarnpkg.com/get-uri/-/get-uri-6.0.1.tgz#cff2ba8d456c3513a04b70c45de4dbcca5b1527c"
290 |   integrity sha512-7ZqONUVqaabogsYNWlYj0t3YZaL6dhuEueZXGF+/YVmf6dHmaFg8/6psJKqhx9QykIDKzpGcy2cn4oV4YC7V/Q==
291 |   dependencies:
292 |     basic-ftp "^5.0.2"
293 |     data-uri-to-buffer "^5.0.1"
294 |     debug "^4.3.4"
295 |     fs-extra "^8.1.0"
296 | 
297 | graceful-fs@^4.1.6, graceful-fs@^4.2.0:
298 |   version "4.2.11"
299 |   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3"
300 |   integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==
301 | 
302 | http-proxy-agent@^7.0.0:
303 |   version "7.0.0"
304 |   resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-7.0.0.tgz#e9096c5afd071a3fce56e6252bb321583c124673"
305 |   integrity sha512-+ZT+iBxVUQ1asugqnD6oWoRiS25AkjNfG085dKJGtGxkdwLQrMKU5wJr2bOOFAXzKcTuqq+7fZlTMgG3SRfIYQ==
306 |   dependencies:
307 |     agent-base "^7.1.0"
308 |     debug "^4.3.4"
309 | 
310 | http-proxy-agent@^7.0.1:
311 |   version "7.0.2"
312 |   resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz#9a8b1f246866c028509486585f62b8f2c18c270e"
313 |   integrity sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==
314 |   dependencies:
315 |     agent-base "^7.1.0"
316 |     debug "^4.3.4"
317 | 
318 | https-proxy-agent@^7.0.2, https-proxy-agent@^7.0.3:
319 |   version "7.0.4"
320 |   resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.4.tgz#8e97b841a029ad8ddc8731f26595bad868cb4168"
321 |   integrity sha512-wlwpilI7YdjSkWaQ/7omYBMTliDcmCN8OLihO6I9B86g06lMyAoqgoDpV0XqoaPOKj+0DIdAvnsWfyAAhmimcg==
322 |   dependencies:
323 |     agent-base "^7.0.2"
324 |     debug "4"
325 | 
326 | ieee754@^1.1.13:
327 |   version "1.2.1"
328 |   resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.2.1.tgz#8eb7a10a63fff25d15a57b001586d177d1b0d352"
329 |   integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==
330 | 
331 | ip@^1.1.8:
332 |   version "1.1.9"
333 |   resolved "https://registry.yarnpkg.com/ip/-/ip-1.1.9.tgz#8dfbcc99a754d07f425310b86a99546b1151e396"
334 |   integrity sha512-cyRxvOEpNHNtchU3Ln9KC/auJgup87llfQpQ+t5ghoC/UhL16SWzbueiCsdTnWmqAWl7LadfuwhlqmtOaqMHdQ==
335 | 
336 | ip@^2.0.0:
337 |   version "2.0.1"
338 |   resolved "https://registry.yarnpkg.com/ip/-/ip-2.0.1.tgz#e8f3595d33a3ea66490204234b77636965307105"
339 |   integrity sha512-lJUL9imLTNi1ZfXT+DU6rBBdbiKGBuay9B6xGSPVjUeQwaH1RIGqef8RZkUtHioLmSNpPR5M4HVKJGm1j8FWVQ==
340 | 
341 | is-fullwidth-code-point@^3.0.0:
342 |   version "3.0.0"
343 |   resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d"
344 |   integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==
345 | 
346 | jsonfile@^4.0.0:
347 |   version "4.0.0"
348 |   resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
349 |   integrity sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==
350 |   optionalDependencies:
351 |     graceful-fs "^4.1.6"
352 | 
353 | lru-cache@^6.0.0:
354 |   version "6.0.0"
355 |   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94"
356 |   integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==
357 |   dependencies:
358 |     yallist "^4.0.0"
359 | 
360 | lru-cache@^7.14.1:
361 |   version "7.18.3"
362 |   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.18.3.tgz#f793896e0fd0e954a59dfdd82f0773808df6aa89"
363 |   integrity sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==
364 | 
365 | ms@2.1.2:
366 |   version "2.1.2"
367 |   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
368 |   integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==
369 | 
370 | netmask@^2.0.2:
371 |   version "2.0.2"
372 |   resolved "https://registry.yarnpkg.com/netmask/-/netmask-2.0.2.tgz#8b01a07644065d536383835823bc52004ebac5e7"
373 |   integrity sha512-dBpDMdxv9Irdq66304OLfEmQ9tbNRFnFTuZiLo+bD+r332bBmMJ8GBLXklIXXgxd3+v9+KUnZaUR5PJMa75Gsg==
374 | 
375 | once@^1.3.1, once@^1.4.0:
376 |   version "1.4.0"
377 |   resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1"
378 |   integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==
379 |   dependencies:
380 |     wrappy "1"
381 | 
382 | pac-proxy-agent@^7.0.1:
383 |   version "7.0.1"
384 |   resolved "https://registry.yarnpkg.com/pac-proxy-agent/-/pac-proxy-agent-7.0.1.tgz#6b9ddc002ec3ff0ba5fdf4a8a21d363bcc612d75"
385 |   integrity sha512-ASV8yU4LLKBAjqIPMbrgtaKIvxQri/yh2OpI+S6hVa9JRkUI3Y3NPFbfngDtY7oFtSMD3w31Xns89mDa3Feo5A==
386 |   dependencies:
387 |     "@tootallnate/quickjs-emscripten" "^0.23.0"
388 |     agent-base "^7.0.2"
389 |     debug "^4.3.4"
390 |     get-uri "^6.0.1"
391 |     http-proxy-agent "^7.0.0"
392 |     https-proxy-agent "^7.0.2"
393 |     pac-resolver "^7.0.0"
394 |     socks-proxy-agent "^8.0.2"
395 | 
396 | pac-resolver@^7.0.0:
397 |   version "7.0.0"
398 |   resolved "https://registry.yarnpkg.com/pac-resolver/-/pac-resolver-7.0.0.tgz#79376f1ca26baf245b96b34c339d79bff25e900c"
399 |   integrity sha512-Fd9lT9vJbHYRACT8OhCbZBbxr6KRSawSovFpy8nDGshaK99S/EBhVIHp9+crhxrsZOuvLpgL1n23iyPg6Rl2hg==
400 |   dependencies:
401 |     degenerator "^5.0.0"
402 |     ip "^1.1.8"
403 |     netmask "^2.0.2"
404 | 
405 | pend@~1.2.0:
406 |   version "1.2.0"
407 |   resolved "https://registry.yarnpkg.com/pend/-/pend-1.2.0.tgz#7a57eb550a6783f9115331fcf4663d5c8e007a50"
408 |   integrity sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==
409 | 
410 | playwright-core@1.52.0:
411 |   version "1.52.0"
412 |   resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.52.0.tgz#238f1f0c3edd4ebba0434ce3f4401900319a3dca"
413 |   integrity sha512-l2osTgLXSMeuLZOML9qYODUQoPPnUsKsb5/P6LJ2e6uPKXUdPK5WYhN4z03G+YNbWmGDY4YENauNu4ZKczreHg==
414 | 
415 | playwright@1.52.0:
416 |   version "1.52.0"
417 |   resolved "https://registry.yarnpkg.com/playwright/-/playwright-1.52.0.tgz#26cb9a63346651e1c54c8805acfd85683173d4bd"
418 |   integrity sha512-JAwMNMBlxJ2oD1kce4KPtMkDeKGHQstdpFPcPH3maElAXon/QZeTvtsfXmTMRyO9TslfoYOXkSsvao2nE1ilTw==
419 |   dependencies:
420 |     playwright-core "1.52.0"
421 |   optionalDependencies:
422 |     fsevents "2.3.2"
423 | 
424 | progress@2.0.3:
425 |   version "2.0.3"
426 |   resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8"
427 |   integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==
428 | 
429 | proxy-agent@6.4.0:
430 |   version "6.4.0"
431 |   resolved "https://registry.yarnpkg.com/proxy-agent/-/proxy-agent-6.4.0.tgz#b4e2dd51dee2b377748aef8d45604c2d7608652d"
432 |   integrity sha512-u0piLU+nCOHMgGjRbimiXmA9kM/L9EHh3zL81xCdp7m+Y2pHIsnmbdDoEDoAz5geaonNR6q6+yOPQs6n4T6sBQ==
433 |   dependencies:
434 |     agent-base "^7.0.2"
435 |     debug "^4.3.4"
436 |     http-proxy-agent "^7.0.1"
437 |     https-proxy-agent "^7.0.3"
438 |     lru-cache "^7.14.1"
439 |     pac-proxy-agent "^7.0.1"
440 |     proxy-from-env "^1.1.0"
441 |     socks-proxy-agent "^8.0.2"
442 | 
443 | proxy-from-env@^1.1.0:
444 |   version "1.1.0"
445 |   resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2"
446 |   integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==
447 | 
448 | pump@^3.0.0:
449 |   version "3.0.0"
450 |   resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64"
451 |   integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==
452 |   dependencies:
453 |     end-of-stream "^1.1.0"
454 |     once "^1.3.1"
455 | 
456 | queue-tick@^1.0.1:
457 |   version "1.0.1"
458 |   resolved "https://registry.yarnpkg.com/queue-tick/-/queue-tick-1.0.1.tgz#f6f07ac82c1fd60f82e098b417a80e52f1f4c142"
459 |   integrity sha512-kJt5qhMxoszgU/62PLP1CJytzd2NKetjSRnyuj31fDd3Rlcz3fzlFdFLD1SItunPwyqEOkca6GbV612BWfaBag==
460 | 
461 | require-directory@^2.1.1:
462 |   version "2.1.1"
463 |   resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42"
464 |   integrity sha1-jGStX9MNqxyXbiNE/+f3kqam30I=
465 | 
466 | semver@7.6.0:
467 |   version "7.6.0"
468 |   resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.0.tgz#1a46a4db4bffcccd97b743b5005c8325f23d4e2d"
469 |   integrity sha512-EnwXhrlwXMk9gKu5/flx5sv/an57AkRplG3hTK68W7FRDN+k+OWBj65M7719OkA82XLBxrcX0KSHj+X5COhOVg==
470 |   dependencies:
471 |     lru-cache "^6.0.0"
472 | 
473 | smart-buffer@^4.2.0:
474 |   version "4.2.0"
475 |   resolved "https://registry.yarnpkg.com/smart-buffer/-/smart-buffer-4.2.0.tgz#6e1d71fa4f18c05f7d0ff216dd16a481d0e8d9ae"
476 |   integrity sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==
477 | 
478 | socks-proxy-agent@^8.0.2:
479 |   version "8.0.2"
480 |   resolved "https://registry.yarnpkg.com/socks-proxy-agent/-/socks-proxy-agent-8.0.2.tgz#5acbd7be7baf18c46a3f293a840109a430a640ad"
481 |   integrity sha512-8zuqoLv1aP/66PHF5TqwJ7Czm3Yv32urJQHrVyhD7mmA6d61Zv8cIXQYPTWwmg6qlupnPvs/QKDmfa4P/qct2g==
482 |   dependencies:
483 |     agent-base "^7.0.2"
484 |     debug "^4.3.4"
485 |     socks "^2.7.1"
486 | 
487 | socks@^2.7.1:
488 |   version "2.7.1"
489 |   resolved "https://registry.yarnpkg.com/socks/-/socks-2.7.1.tgz#d8e651247178fde79c0663043e07240196857d55"
490 |   integrity sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ==
491 |   dependencies:
492 |     ip "^2.0.0"
493 |     smart-buffer "^4.2.0"
494 | 
495 | source-map@~0.6.1:
496 |   version "0.6.1"
497 |   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
498 |   integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
499 | 
500 | streamx@^2.13.0:
501 |   version "2.16.1"
502 |   resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.16.1.tgz#2b311bd34832f08aa6bb4d6a80297c9caef89614"
503 |   integrity sha512-m9QYj6WygWyWa3H1YY69amr4nVgy61xfjys7xO7kviL5rfIEc2naf+ewFiOA+aEJD7y0JO3h2GoiUv4TDwEGzQ==
504 |   dependencies:
505 |     fast-fifo "^1.1.0"
506 |     queue-tick "^1.0.1"
507 |   optionalDependencies:
508 |     bare-events "^2.2.0"
509 | 
510 | streamx@^2.15.0:
511 |   version "2.15.0"
512 |   resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.15.0.tgz#f58c92e6f726b5390dcabd6dd9094d29a854d698"
513 |   integrity sha512-HcxY6ncGjjklGs1xsP1aR71INYcsXFJet5CU1CHqihQ2J5nOsbd4OjgjHO42w/4QNv9gZb3BueV+Vxok5pLEXg==
514 |   dependencies:
515 |     fast-fifo "^1.1.0"
516 |     queue-tick "^1.0.1"
517 | 
518 | string-width@^4.1.0, string-width@^4.2.0:
519 |   version "4.2.2"
520 |   resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.2.tgz#dafd4f9559a7585cfba529c6a0a4f73488ebd4c5"
521 |   integrity sha512-XBJbT3N4JhVumXE0eoLU9DCjcaF92KLNqTmFCnG1pf8duUxFGwtP6AD6nkjw9a3IdiRtL3E2w3JDiE/xi3vOeA==
522 |   dependencies:
523 |     emoji-regex "^8.0.0"
524 |     is-fullwidth-code-point "^3.0.0"
525 |     strip-ansi "^6.0.0"
526 | 
527 | string-width@^4.2.3:
528 |   version "4.2.3"
529 |   resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
530 |   integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
531 |   dependencies:
532 |     emoji-regex "^8.0.0"
533 |     is-fullwidth-code-point "^3.0.0"
534 |     strip-ansi "^6.0.1"
535 | 
536 | strip-ansi@^6.0.0:
537 |   version "6.0.0"
538 |   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.0.tgz#0b1571dd7669ccd4f3e06e14ef1eed26225ae532"
539 |   integrity sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==
540 |   dependencies:
541 |     ansi-regex "^5.0.0"
542 | 
543 | strip-ansi@^6.0.1:
544 |   version "6.0.1"
545 |   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
546 |   integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
547 |   dependencies:
548 |     ansi-regex "^5.0.1"
549 | 
550 | tar-fs@3.0.5:
551 |   version "3.0.5"
552 |   resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-3.0.5.tgz#f954d77767e4e6edf973384e1eb95f8f81d64ed9"
553 |   integrity sha512-JOgGAmZyMgbqpLwct7ZV8VzkEB6pxXFBVErLtb+XCOqzc6w1xiWKI9GVd6bwk68EX7eJ4DWmfXVmq8K2ziZTGg==
554 |   dependencies:
555 |     pump "^3.0.0"
556 |     tar-stream "^3.1.5"
557 |   optionalDependencies:
558 |     bare-fs "^2.1.1"
559 |     bare-path "^2.1.0"
560 | 
561 | tar-stream@^3.1.5:
562 |   version "3.1.6"
563 |   resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-3.1.6.tgz#6520607b55a06f4a2e2e04db360ba7d338cc5bab"
564 |   integrity sha512-B/UyjYwPpMBv+PaFSWAmtYjwdrlEaZQEhMIBFNC5oEG8lpiW8XjcSdmEaClj28ArfKScKHs2nshz3k2le6crsg==
565 |   dependencies:
566 |     b4a "^1.6.4"
567 |     fast-fifo "^1.2.0"
568 |     streamx "^2.15.0"
569 | 
570 | through@^2.3.8:
571 |   version "2.3.8"
572 |   resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5"
573 |   integrity sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==
574 | 
575 | tslib@^2.0.1:
576 |   version "2.6.1"
577 |   resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.6.1.tgz#fd8c9a0ff42590b25703c0acb3de3d3f4ede0410"
578 |   integrity sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig==
579 | 
580 | typescript@^5.8.3:
581 |   version "5.8.3"
582 |   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.8.3.tgz#92f8a3e5e3cf497356f4178c34cd65a7f5e8440e"
583 |   integrity sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==
584 | 
585 | unbzip2-stream@1.4.3:
586 |   version "1.4.3"
587 |   resolved "https://registry.yarnpkg.com/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz#b0da04c4371311df771cdc215e87f2130991ace7"
588 |   integrity sha512-mlExGW4w71ebDJviH16lQLtZS32VKqsSfk80GCfUlwT/4/hNRFsoscrF/c++9xinkMzECL1uL9DDwXqFWkruPg==
589 |   dependencies:
590 |     buffer "^5.2.1"
591 |     through "^2.3.8"
592 | 
593 | undici-types@~6.19.2:
594 |   version "6.19.8"
595 |   resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02"
596 |   integrity sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==
597 | 
598 | universalify@^0.1.0:
599 |   version "0.1.2"
600 |   resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66"
601 |   integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==
602 | 
603 | wrap-ansi@^7.0.0:
604 |   version "7.0.0"
605 |   resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
606 |   integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
607 |   dependencies:
608 |     ansi-styles "^4.0.0"
609 |     string-width "^4.1.0"
610 |     strip-ansi "^6.0.0"
611 | 
612 | wrappy@1:
613 |   version "1.0.2"
614 |   resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
615 |   integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==
616 | 
617 | y18n@^5.0.5:
618 |   version "5.0.8"
619 |   resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55"
620 |   integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==
621 | 
622 | yallist@^4.0.0:
623 |   version "4.0.0"
624 |   resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
625 |   integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
626 | 
627 | yargs-parser@^21.1.1:
628 |   version "21.1.1"
629 |   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35"
630 |   integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==
631 | 
632 | yargs@17.7.2, yargs@^17.0.0:
633 |   version "17.7.2"
634 |   resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.2.tgz#991df39aca675a192b816e1e0363f9d75d2aa269"
635 |   integrity sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==
636 |   dependencies:
637 |     cliui "^8.0.1"
638 |     escalade "^3.1.1"
639 |     get-caller-file "^2.0.5"
640 |     require-directory "^2.1.1"
641 |     string-width "^4.2.3"
642 |     y18n "^5.0.5"
643 |     yargs-parser "^21.1.1"
644 | 
645 | yauzl@^2.10.0:
646 |   version "2.10.0"
647 |   resolved "https://registry.yarnpkg.com/yauzl/-/yauzl-2.10.0.tgz#c7eb17c93e112cb1086fa6d8e51fb0667b79a5f9"
648 |   integrity sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g==
649 |   dependencies:
650 |     buffer-crc32 "~0.2.3"
651 |     fd-slicer "~1.1.0"
652 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | yarn-debug.log*
 5 | yarn-error.log*
 6 | 
 7 | # Dependency directories
 8 | node_modules/
 9 | 
10 | # Yarn Integrity file
11 | .yarn-integrity
12 | 
13 | # build output
14 | /dist/
15 | /test-results/
16 | 
17 | **/.DS_Store


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/.vscode/launch.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     // Use IntelliSense to learn about possible attributes.
 3 |     // Hover to view descriptions of existing attributes.
 4 |     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 5 |     "version": "0.2.0",
 6 |     "configurations": [
 7 |         // From https://github.com/microsoft/vscode-recipes/tree/master/debugging-jest-tests
 8 |         {
 9 |             "type": "node",
10 |             "request": "launch",
11 |             "name": "Jest All",
12 |             "program": "${workspaceFolder}/node_modules/.bin/jest",
13 |             "args": ["--runInBand"],
14 |             "console": "integratedTerminal",
15 |             "internalConsoleOptions": "neverOpen",
16 |             "disableOptimisticBPs": true,
17 |             "windows": {
18 |               "program": "${workspaceFolder}/node_modules/jest/bin/jest",
19 |             }
20 |           },
21 |           {
22 |             "type": "node",
23 |             "request": "launch",
24 |             "name": "Jest Current File",
25 |             "program": "${workspaceFolder}/node_modules/.bin/jest",
26 |             "args": [
27 |               "${fileBasenameNoExtension}",
28 |               "--config",
29 |               "jest.config.js"
30 |             ],
31 |             "console": "integratedTerminal",
32 |             "internalConsoleOptions": "neverOpen",
33 |             "disableOptimisticBPs": true,
34 |             "windows": {
35 |               "program": "${workspaceFolder}/node_modules/jest/bin/jest",
36 |             }
37 |           }
38 |     ]
39 | }
40 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/README.md:
--------------------------------------------------------------------------------
 1 | # typescript-selenium-webdriver-sample
 2 | 
 3 | This sample demonstrates how you might set up a CI build for a simple, static html page to perform end to end accessibility tests in a browser, including how to suppress pre-existing or third-party failures using [Jest Snapshot Testing](https://jestjs.io/docs/en/snapshot-testing). 
 4 | 
 5 | This sample uses Selenium WebDriver for browser automation and uses the corresponding `@axe-core/webdriverjs` library to integrate Axe and Selenium. But you don't have to use Selenium to use Axe! If you prefer a different browser automation tool, you can still follow the same concepts from this sample by using the integration library appropriate for your framework:
 6 | 
 7 | * For **Playwright**, see our [typescript-playwright-sample](../typescript-playwright-sample/README.md)
 8 | * For **Puppeteer**, see our [typescript-playwright-sample](../typescript-playwright-sample/README.md) and use [@axe-core/puppeteer](https://www.npmjs.com/package/@axe-core/puppeteer)
 9 | * For **Cypress**, use [cypress-axe](https://www.npmjs.com/package/cypress-axe)
10 | * For **WebdriverIO**, use [@axe-core/webdriverio](https://www.npmjs.com/package/@axe-core/webdriverio)
11 | * For **Protractor**, keep using `@axe-core/webdriverjs` like the sample shows, but instead of creating your own Webdriver object, pass [`browser.webdriver`](https://www.protractortest.org/#/api?view=ProtractorBrowser) to `@axe-core/webdriverjs`.
12 | 
13 | ## Getting Started
14 | 
15 | The individual files in the sample contain comments that explain the important parts of each file in context.
16 | 
17 | Some good places to start reading are:
18 | 
19 | * [tests/index.test.ts](./tests/index.test.ts): Jest test file that opens [src/index.html](./src/index.html) in a browser with Selenium and runs accessibility scans against it with `@axe-core/webdriverjs`
20 | * [azure-pipelines.yml](./azure-pipelines.yml): Azure Pipelines config file that sets up our Continuous Integration and Pull Request builds
21 | * [jest.config.js](./jest.config.js): Jest configuration file that enables TypeScript (using ts-jest) and test result reporting in Azure Pipelines (using jest-junit)
22 | 
23 | ## Tools and libraries used
24 | 
25 | * [TypeScript](https://www.typescriptlang.org/) to author our test code
26 | * [Jest](https://jestjs.io/) as our test framework, with [Jest Snapshot Testing](https://jestjs.io/docs/en/snapshot-testing) for baselining and [ts-jest](https://www.npmjs.com/package/ts-jest) for TypeScript support
27 | * [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver) to automate browsing to the page from the tests
28 | * [node-chromedriver](https://github.com/giggio/node-chromedriver) to enable Selenium to drive Chrome
29 | * [@axe-core/webdriverjs](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/webdriverjs) to run an axe accessibility scan on the page from the Selenium browser
30 | * [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) to run the tests in a CI build with every Pull Request
31 | * [axe-sarif-converter](https://github.com/microsoft/axe-sarif-converter) to convert axe results to SARIF format
32 | * [SARIF SAST Scans Tab](https://marketplace.visualstudio.com/items?itemName=sariftools.scans) to visualize the results in Azure Pipelines
33 | 
34 | ## See it in action in Azure Pipelines
35 | 
36 | [![Build Status](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_apis/build/status/25?branchName=main)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/latest?definitionId=25&branchName=main)
37 | 
38 | <!--
39 |   Note to maintainers: The below example images/links come from a specific build instead of the most recent build so we can link to specific tabs.
40 |   If you update the links such that they point to a different build, make sure to mark that build as Retained so the links don't expire in a month.
41 | -->
42 | The accessibility tests run as part of the `yarn test` build step:
43 | 
44 | [![Screenshot of "yarn test" build logs in sample build](./assets/screenshot-logs-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=2228)
45 | 
46 | The test pass/fail results display in the Tests tab of the build logs:
47 | 
48 | [![Screenshot of Tests tab in sample build](./assets/screenshot-tests-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=2228&view=ms.vss-test-web.build-test-results-tab)
49 | 
50 | Detailed accessibility scan information also appears in the Scans tab, courtesy of the [SARIF SAST Scans Tab extension](https://marketplace.visualstudio.com/items?itemName=sariftools.scans):
51 | 
52 | [![Screenshot of Scans tab in sample build](./assets/screenshot-scans-tab.png)](https://dev.azure.com/accessibility-insights/axe-pipelines-samples/_build/results?buildId=2228&view=sariftools.sarif-viewer-build-tab.sariftools.sarif-viewer-build-tab)
53 | 
54 | ## See it in action on your local machine
55 | 
56 | 1. Install the stable version of [Chrome](https://www.google.com/chrome/)
57 | 1. Clone this sample repository
58 | 
59 |    ```sh
60 |    git clone https://github.com/microsoft/axe-pipelines-samples
61 |    ```
62 | 
63 | 1. Install the dependencies
64 | 
65 |    ```sh
66 |    cd ./axe-pipelines-samples/typescript-selenium-webdriver-sample
67 |    yarn install # or npm install, whichever your project prefers
68 |    ```
69 | 
70 | 1. Run the tests!
71 | 
72 |    ```sh
73 |    yarn test # or npm test
74 |    ```
75 | 
76 |    ![Screenshot of yarn test command showing all tests passing](./assets/screenshot-yarn-test-success.png)
77 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/assets/screenshot-logs-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-selenium-webdriver-sample/assets/screenshot-logs-tab.png


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/assets/screenshot-scans-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-selenium-webdriver-sample/assets/screenshot-scans-tab.png


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/assets/screenshot-tests-tab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-selenium-webdriver-sample/assets/screenshot-tests-tab.png


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/assets/screenshot-yarn-test-success.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/microsoft/axe-pipelines-samples/32d272945fc3056c0cc35740e85b0a8306346cb4/typescript-selenium-webdriver-sample/assets/screenshot-yarn-test-success.png


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/azure-pipelines.yml:
--------------------------------------------------------------------------------
  1 | # Copyright (c) Microsoft Corporation. All rights reserved.
  2 | # Licensed under the MIT License.
  3 | 
  4 | # This file defines an Azure Pipelines build, which you can configure on https://dev.azure.com
  5 | # to run automatically with each Pull Request update and/or each commit to your repository.
  6 | # In this example, we do not change the default "trigger" behavior, so this build gets run
  7 | # for all commits/PRs to all branches of the axe-pipelines-samples repository.
  8 | #
  9 | # If you already have an Azure Pipelines build for your project, we recommend integrating
 10 | # your new accessibility tests into it, rather than creating a separate pipeline. Pipelines
 11 | # builds are usually defined in files like this one named "azure-pipelines.yml" or "build.yaml",
 12 | # but some projects use different file names.
 13 | #
 14 | # If you are using an Azure Pipelines build with tasks configured using the GUI on https://dev.azure.com,
 15 | # instead of a checked in YAML file, you can add the same tasks listed below from the GUI. However, we
 16 | # strongly recommend switching to using a checked in YAML file.
 17 | #
 18 | # Most TypeScript projects with an Azure Pipelines build will already have most of the steps
 19 | # shown below, with the exception of the final "PublishBuildArtifact" task; you'll probably
 20 | # have to add that.
 21 | #
 22 | # If you *don't* already have an Azure Pipelines build, we recommend following Azure Pipelines'
 23 | # documentation at https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline
 24 | # (using this sample as your starter code).
 25 | #
 26 | # For more information, see:
 27 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started
 28 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/customize-pipeline
 29 | 
 30 | # The browser automation tool we're using, Selenium, works with many different browsers. Here, we show
 31 | # an example of using the same test code with different combinations of browsers and OSes.
 32 | #
 33 | # For more information, see:
 34 | # * https://docs.microsoft.com/en-us/azure/devops/pipelines/get-started-multiplatform
 35 | parameters:
 36 | - name: strategy
 37 |   type: object
 38 |   default:
 39 |   - name: win_chrome
 40 |     imageName: windows-2022-secure
 41 |     browser: chrome
 42 |     os: windows
 43 |   - name: linux_firefox
 44 |     imageName: ubuntu-22.04-secure
 45 |     browser: firefox
 46 |     os: linux
 47 | 
 48 | # The `resources` specify the location and version of the 1ES PT.
 49 | resources:
 50 |   repositories:
 51 |   - repository: 1esPipelines
 52 |     type: git
 53 |     name: 1ESPipelineTemplates/1ESPipelineTemplates
 54 |     ref: refs/tags/release
 55 | 
 56 | extends:
 57 |   template: v1/1ES.Unofficial.PipelineTemplate.yml@1esPipelines
 58 |   parameters:
 59 |     settings:
 60 |       skipBuildTagsForGitHubPullRequests: true
 61 |       
 62 |     pool:
 63 |       name: $(a11yInsightsPool)  # Name of your hosted pool
 64 |       image: windows-2022-secure  # Name of the image in your pool. If not specified, first image of the pool is used
 65 |       os: windows  # OS of the image. Allowed values: windows, linux, macOS
 66 | 
 67 |     stages:
 68 |     - stage: Stage
 69 |       jobs:
 70 |       - ${{ each item in parameters.strategy }}:
 71 |         - job: Job_${{ item.name }}
 72 |           pool:
 73 |             name: $(a11yInsightsPool)
 74 |             image: ${{ item.imageName }}
 75 |             os: ${{ item.os }}
 76 |             
 77 |           variables:
 78 |           # This will be sent to the build agent as an environment variable which our test code will be able to see.
 79 |           # We'll use this environment variable in webdriver-factory.ts to determine which browser the tests will use.
 80 |             SELENIUM_BROWSER: ${{ item.browser }}
 81 | 
 82 |           templateContext:
 83 |             # If you are adding tests to an existing project that already uses Azure Pipelines, this is probably the only
 84 |             # new task you'll need to add.
 85 |             #
 86 |             # This task is how the "Scans" tab in our Azure Pipelines build results page gets its data. It requires using
 87 |             # PublishBuildArtifacts rather than the newer PublishPipelineArtifacts.
 88 |             outputs:
 89 |             # The exact name "CodeAnalysisLogs" is required for the Sarif Results Viewer Extension for Azure Pipelines
 90 |             # to find the .sarif files our accessibility test produces.
 91 |             - output: buildArtifacts
 92 |               displayName: publish sarif results
 93 |               # "test-results" is not a required convention; it just happens to be where our tests write .sarif files to.
 94 |               PathtoPublish: $(Build.SourcesDirectory)/typescript-selenium-webdriver-sample/test-results
 95 |               ArtifactName: CodeAnalysisLogs
 96 |               condition: succeededOrFailed()
 97 |         
 98 |           steps:
 99 |           # This task makes sure Node.js is installed on the build agent.
100 |           #
101 |           # It is a good idea to test against a specific, known version of Node; this makes it easier for other users
102 |           # to reproduce your build results.
103 |           - task: NodeTool@0
104 |             displayName: install node 20.17.0
105 |             inputs:
106 |               versionSpec: "20.17.0"
107 | 
108 |             # This task installs dependencies specified in your package.json file.
109 |             #
110 |             # Our sample uses Yarn for this, but if your project uses NPM instead, that's also fine.
111 |           - script: yarn install --frozen-lockfile # or "npm install --ci"
112 |             displayName: yarn install
113 |             # workingDirectory should match where your package.json file is located. It defaults to the root of the repository.
114 |             workingDirectory: $(Build.SourcesDirectory)/typescript-selenium-webdriver-sample
115 | 
116 |             # This task runs the tests specified by jest.config.js, including our example accessibility tests.
117 |             #
118 |             # If your project already uses npm instead of yarn, or if your project already runs "jest" directly here,
119 |             # those are both fine.
120 |             #
121 |             # The 2>&1 is a workaround for facebook/jest#5064
122 |           - script: yarn test --ci 2>&1 # or "npm run test -- --ci 2>&1"
123 |             displayName: yarn test
124 |             workingDirectory: $(Build.SourcesDirectory)/typescript-selenium-webdriver-sample
125 | 
126 |             # This task is how the "Tests" tab in our Azure Pipelines build results page gets its data
127 |           - task: PublishTestResults@2
128 |             displayName: publish test results
129 |             inputs:
130 |               testResultsFiles: $(Build.SourcesDirectory)/typescript-selenium-webdriver-sample/test-results/junit.xml
131 |               testRunTitle: typescript-selenium-webdriver-sample (${{ item.imageName }} ${{ item.browser }})
132 |             condition: succeededOrFailed()
133 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/jest.config.js:
--------------------------------------------------------------------------------
 1 | // Copyright (c) Microsoft Corporation. All rights reserved.
 2 | // Licensed under the MIT License.
 3 | module.exports = {
 4 |     // This enables TypeScript support in Jest
 5 |     preset: 'ts-jest',
 6 | 
 7 |     reporters: [
 8 |         // This enables console output for local development and build log output in Pipelines.
 9 |         'default',
10 | 
11 |         // This is to populate the Tests tab on the Build Results page in Azure Pipelines.
12 |         // See the "publish test results" step in ./azure-pipelines.yml.
13 |         [
14 |             'jest-junit',
15 |             {
16 |                 outputDirectory: './test-results/',
17 |                 outputName: 'junit.xml',
18 |             },
19 |         ],
20 |     ],
21 | };
22 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "typescript-selenium-webdriver-sample",
 3 |     "version": "0.0.0",
 4 |     "description": "Sample project that demonstrates accessibility testing with TypeScript, Jest, Selenium, @axe-core/webdriverjs, SARIF, and Azure Pipelines.",
 5 |     "private": true,
 6 |     "devDependencies": {
 7 |         "@axe-core/webdriverjs": "^4.10.1",
 8 |         "@types/jest": "^29.5.14",
 9 |         "@types/node": "^20.8.10",
10 |         "@types/selenium-webdriver": "^4.1.28",
11 |         "axe-sarif-converter": "^3.0.0",
12 |         "chromedriver": "^135.0.4",
13 |         "cross-env": "^7.0.3",
14 |         "geckodriver": "^5.0.0",
15 |         "jest": "^29.7.0",
16 |         "jest-junit": "^16.0.0",
17 |         "selenium-webdriver": "^4.33.0",
18 |         "ts-jest": "^29.3.4",
19 |         "typescript": "^5.8.3"
20 |     },
21 |     "scripts": {
22 |         "test": "jest",
23 |         "test:firefox": "cross-env SELENIUM_BROWSER=firefox jest",
24 |         "test:chrome": "cross-env SELENIUM_BROWSER=chrome jest"
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/src/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en-US">
 3 |     <head>
 4 |         <title>Example page with some accessibility issues</title>
 5 |     </head>
 6 |     <body>
 7 |         <main>
 8 |             <h1>This is a static sample page with some accessibility issues</h1>
 9 |             <ul id="example-accessibility-violations">
10 |                 <li>This text box has no accessible label: <input type="text"></li>
11 |                 <li>This text's color contrast is too low: <span style="color: #A2A2A2">low-contrast text</span></li>
12 |                 <li>This text has an invalid "role" attribute: <span role="invalid">span with invalid role</a></li>
13 |             </ul>
14 |         </main>
15 |     </body>
16 | </html>
17 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/tests/__snapshots__/index.test.ts.snap:
--------------------------------------------------------------------------------
 1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
 2 | 
 3 | exports[`index.html has only those accessibility violations present in snapshot 1`] = `
 4 | [
 5 |   {
 6 |     "rule": "aria-roles",
 7 |     "targets": [
 8 |       [
 9 |         "span[role="invalid"]",
10 |       ],
11 |     ],
12 |   },
13 |   {
14 |     "rule": "color-contrast",
15 |     "targets": [
16 |       [
17 |         "li:nth-child(2) > span",
18 |       ],
19 |     ],
20 |   },
21 |   {
22 |     "rule": "label",
23 |     "targets": [
24 |       [
25 |         "input",
26 |       ],
27 |     ],
28 |   },
29 | ]
30 | `;
31 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/tests/index.test.ts:
--------------------------------------------------------------------------------
  1 | // Copyright (c) Microsoft Corporation. All rights reserved.
  2 | // Licensed under the MIT License.
  3 | import * as Axe from 'axe-core';
  4 | import { convertAxeToSarif } from 'axe-sarif-converter';
  5 | import AxeWebdriverjs from '@axe-core/webdriverjs';
  6 | import * as fs from 'fs';
  7 | import * as path from 'path';
  8 | import { By, ThenableWebDriver, until } from 'selenium-webdriver';
  9 | import { promisify } from 'util';
 10 | import { createWebdriverFromEnvironmentVariableSettings } from './webdriver-factory';
 11 | import { afterAll, beforeAll, beforeEach, describe, expect, it } from '@jest/globals';
 12 | 
 13 | // The default timeout for tests/fixtures (5 seconds) is not always enough to start/quit/navigate a browser instance.
 14 | const TEST_TIMEOUT_MS = 30000;
 15 | 
 16 | describe('index.html', () => {
 17 |     let driver: ThenableWebDriver;
 18 | 
 19 |     // Starting a browser instance is time-consuming, so we share one browser instance between
 20 |     // all tests in the file (by initializing it in beforeAll rather than beforeEach)
 21 |     beforeAll(async () => {
 22 |         // The helper method we're using here is just an example; if you already have a test suite with
 23 |         // logic for initializing a Selenium WebDriver, you can keep using that. For example, if you are
 24 |         // using Protractor, you would want to use the webdriver instance that Protractor maintains in its
 25 |         // global "browser" variable, like this:
 26 |         //
 27 |         //     driver = browser.webdriver;
 28 |         driver = createWebdriverFromEnvironmentVariableSettings();
 29 |     }, TEST_TIMEOUT_MS);
 30 | 
 31 |     afterAll(async () => {
 32 |         driver && await driver.quit();
 33 |     }, TEST_TIMEOUT_MS);
 34 | 
 35 |     beforeEach(async () => {
 36 |         // For simplicity, we're pointing our test browser directly to a static html file on disk.
 37 |         //
 38 |         // In a project with more complex hosting needs, you might instead start up a localhost http server
 39 |         // from your test's beforeAll block, and point your test cases to a http://localhost link.
 40 |         //
 41 |         // Some common node.js libraries for hosting this sort of localhost http server include Express.js,
 42 |         // http-server, and Koa. See https://jestjs.io/docs/en/testing-frameworks for more examples.
 43 |         const pageUnderTest = 'file://' + path.join(__dirname, '..', 'src', 'index.html');
 44 |         await driver.get(pageUnderTest);
 45 | 
 46 |         // Checking for a known element on the page in beforeEach serves two purposes:
 47 |         // * It acts as a sanity check that our browser automation setup basically works
 48 |         // * It ensures that the page is loaded before we run our accessibility scans
 49 |         await driver.wait(until.elementLocated(By.css('h1')));
 50 |     }, TEST_TIMEOUT_MS);
 51 | 
 52 |     // This test case shows the most basic example: run a scan, fail the test if there are any failures.
 53 |     // This is the way to go if you have no known/pre-existing violations you need to temporarily baseline.
 54 |     it('has no accessibility violations in the h1 element', async () => {
 55 |         const accessibilityScanResults = await new AxeWebdriverjs(driver)
 56 |             // You can use any CSS selector in place of "h1" here
 57 |             .include('h1')
 58 |             // This withTags directive restricts Axe to only run tests that detect known violations of
 59 |             // WCAG 2.1 A and AA rules (similar to what Accessibility Insights reports). If you omit
 60 |             // this, Axe will additionally run several "best practice" rules, which are good ideas to
 61 |             // check for periodically but may report false positives in certain edge cases.
 62 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 63 |             .analyze();
 64 | 
 65 |         await exportAxeAsSarifTestResult('index-h1-element.sarif', accessibilityScanResults);
 66 | 
 67 |         expect(accessibilityScanResults.violations).toEqual([]);
 68 |     }, TEST_TIMEOUT_MS);
 69 | 
 70 |     // If you want to run a scan of a page but need to exclude an element with known issues (eg, a third-party
 71 |     // component you don't control fixing yourself), you can exclude it specifically and still scan the rest
 72 |     // of the page.
 73 |     it('has no accessibility violations outside of the known example violations', async () => {
 74 |         const accessibilityScanResults = await new AxeWebdriverjs(driver)
 75 |             .exclude('#example-accessibility-violations')
 76 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 77 |             .analyze();
 78 | 
 79 |         await exportAxeAsSarifTestResult('index-except-examples.sarif', accessibilityScanResults);
 80 | 
 81 |         expect(accessibilityScanResults.violations).toEqual([]);
 82 |     }, TEST_TIMEOUT_MS);
 83 | 
 84 |     // If you want to more precisely baseline a particular set of known issues, one option is to use Jest
 85 |     // Snapshot Testing (https://jestjs.io/docs/snapshot-testing) with the scan results object.
 86 |     it('has only those accessibility violations present in snapshot', async () => {
 87 |         const accessibilityScanResults = await new AxeWebdriverjs(driver)
 88 |             .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
 89 |             .analyze();
 90 | 
 91 |         await exportAxeAsSarifTestResult('index-page.sarif', accessibilityScanResults);
 92 | 
 93 |         // Snapshotting the entire violations array like this will show the full available information in
 94 |         // your test output for any new violations that might occur.
 95 |         //
 96 |         //     expect(accessibilityScanResults.violations).toMatchSnapshot();
 97 |         //
 98 |         // However, since the "full available information" includes contextual information like "a snippet
 99 |         // of the HTML containing the violation", snapshotting the whole violations array is prone to failing
100 |         // when unrelated changes are made to the element (or even to unrelated ancestors of the element in
101 |         // the DOM).
102 |         //
103 |         // To avoid that, you can create a helper function to capture a "fingerprint" of a given violation,
104 |         // and snapshot that instead. The Jest Snapshot log output will only include the information from your
105 |         // fingerprint, but you can still use the exported .sarif files to see complete failure information
106 |         // in a SARIF viewer (https://sarifweb.azurewebsites.net/#Viewers) or a text editor.
107 |         expect(accessibilityScanResults.violations.map(getViolationFingerprint)).toMatchSnapshot();
108 |     }, TEST_TIMEOUT_MS);
109 | 
110 |     // You can make your "fingerprint" function as specific as you like. This one considers a violation to be
111 |     // "the same" if it corresponds the same Axe rule on the same set of elements.
112 |     const getViolationFingerprint = (violation: Axe.Result) => ({
113 |         rule: violation.id,
114 |         targets: violation.nodes.map(node => node.target),
115 |     });
116 | 
117 |     // SARIF is a general-purpose log format for code analysis tools.
118 |     //
119 |     // Exporting axe results as .sarif files lets our Azure Pipelines build results page show a nice visualization
120 |     // of any accessibility failures we find using the Sarif Results Viewer Tab extension
121 |     // (https://marketplace.visualstudio.com/items?itemName=sariftools.sarif-viewer-build-tab)
122 |     async function exportAxeAsSarifTestResult(sarifFileName: string, axeResults: Axe.AxeResults): Promise<void> {
123 |         // We use the axe-sarif-converter package for the conversion step, then write the results
124 |         // to a file that we'll be publishing from a CI build step in azure-pipelines.yml
125 |         const sarifResults = convertAxeToSarif(axeResults);
126 | 
127 |         // This directory should be .gitignore'd and should be published as a build artifact in azure-pipelines.yml
128 |         const testResultsDirectory = path.join(__dirname, '..', 'test-results');
129 |         await promisify(fs.mkdir)(testResultsDirectory, { recursive: true });
130 | 
131 |         const sarifResultFile = path.join(testResultsDirectory, sarifFileName);
132 |         await promisify(fs.writeFile)(
133 |             sarifResultFile,
134 |             JSON.stringify(sarifResults, null, 2));
135 | 
136 |         console.log(`Exported axe results to ${sarifResultFile}`);
137 |     }
138 | });
139 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/tests/webdriver-factory.ts:
--------------------------------------------------------------------------------
 1 | // Copyright (c) Microsoft Corporation. All rights reserved.
 2 | // Licensed under the MIT License.
 3 | import * as webdriver from 'selenium-webdriver';
 4 | import * as chrome from 'selenium-webdriver/chrome';
 5 | import * as firefox from 'selenium-webdriver/firefox';
 6 | import * as path from 'path';
 7 | 
 8 | export function createWebdriverFromEnvironmentVariableSettings(): webdriver.ThenableWebDriver {
 9 |     // Selenium WebDriver implementations generally require that you use a version of the webdriver
10 |     // that exactly matches the version of the browser it is driving.
11 |     //
12 |     // Some Azure Pipelines build agents come pre-installed with common browsers and their matching
13 |     // webdriver versions. To detect whether pre-installed webdrivers are available, we check for
14 |     // whether the environment variables ChromeWebDriver and GeckoWebDriver are defined; the
15 |     // vmImages we use in azure-pipelines.yml come with those environment variables pre-set.
16 |     // See https://docs.microsoft.com/en-us/azure/devops/pipelines/test/continuous-test-selenium
17 |     //
18 |     // For local development, where most developers won't have webdrivers pre-installed, we fall
19 |     // back to the chromedriver and geckodriver npm packages, which come bundled with one particular
20 |     // version of the corresponding webdrivers. These packages need to be kept up to date over time
21 |     // with the current stable versions of Chrome/Firefox. This strategy means individual developers
22 |     // on your team won't have to manually keep separate global webdriver installations up to date.
23 |     const azurePipelinesAgentChromeDriverPath = webdriverPathFromEnvVar('ChromeWebDriver', 'chromedriver.exe');
24 |     const chromeDriverPath = azurePipelinesAgentChromeDriverPath || require('chromedriver').path;
25 | 
26 |     const azurePipelinesAgentGeckoDriverPath = webdriverPathFromEnvVar('GeckoWebDriver', 'geckodriver.exe');
27 |     const geckoDriverPath = azurePipelinesAgentGeckoDriverPath || require('geckodriver').path;
28 | 
29 |     // Headless browsers generally use small window sizes by default. Some of the axe checks require
30 |     // elements to be present in the viewport to be assessable, so using a viewport size based on your
31 |     // most common usage is a good idea to prevent axe from having to do extra work to scroll items into
32 |     // view and avoid issues with elements not fitting into the viewport.
33 |     const windowSize = {width: 1920, height: 1080};
34 |  
35 |     return new webdriver.Builder()
36 |         // forBrowser sets the *default* browser the tests will use. You can override the defaults
37 |         // by setting the SELENIUM_BROWSER environment variable. This project's package.json includes
38 |         // two npm run scripts ("test:firefox" and "test:chrome") that show examples of using this.
39 |         .forBrowser('chrome')
40 |         .setChromeService(new chrome.ServiceBuilder(chromeDriverPath))
41 |         // You can run accessibility scans on head-ful browsers, too; we recommend using headless
42 |         // browsers unless your project strictly requires head-ful testing, since it will generally
43 |         // be faster, more reliable, and easier to run in non-graphical environments (eg, Docker).
44 |         .setChromeOptions(new chrome.Options().addArguments('-headless').windowSize(windowSize) as chrome.Options)
45 |         .setFirefoxService(new firefox.ServiceBuilder(geckoDriverPath))
46 |         .setFirefoxOptions(new firefox.Options().addArguments('-headless').windowSize(windowSize))
47 |         .build();
48 | }
49 | 
50 | // selenium-webdriver expects paths like "C:\webdrivers-dir\webdriver.exe", but the Azure Pipelines
51 | // environment variables are in form "C:\webdrivers-dir" - this formats them like Selenium expects
52 | function webdriverPathFromEnvVar(directoryEnvironmentVariable: string, binary: string): (string | null) {
53 |     const directory = process.env[directoryEnvironmentVariable];
54 |     return directory ? path.join(directory, binary) : null;
55 | }
56 | 


--------------------------------------------------------------------------------
/typescript-selenium-webdriver-sample/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |     "compilerOptions": {
3 |         "outDir": "./test-results/"
4 |     },
5 |     "exclude": [
6 |         "node_modules"
7 |     ]
8 | }
9 | 


--------------------------------------------------------------------------------
/windows-app-resources/README.md:
--------------------------------------------------------------------------------
 1 | # WindowsAppResources
 2 | 
 3 | Windows applications can be scanned for accessibility issues using the tools in the [Axe.Windows](https://github.com/microsoft/axe-windows) repo. These tools do not currently produce Sarif files. The general pattern is as follows:
 4 | 
 5 | - Use your favorite framework (eg, [Appium with WinAppDriver](https://github.com/appium/appium/blob/master/docs/en/drivers/windows.md) or similar framework) to get your application to the state that needs to be scanned
 6 | - Trigger a scan using the Axe.Windows tools.
 7 | - Consume the scan results--this will vary depending on your test framework.
 8 | 
 9 | ## Testing from .NET code
10 | 
11 | If your tests are written in .NET Core or .NET Framework, you can trigger a scan by using the [axe-windows automation layer](https://github.com/microsoft/axe-windows/blob/main/docs/AutomationReference.md). Results will be returned as a .NET object, which you can then consume as you wish. You also have the option to automatically create an A11yTest file (openable in [Accessibility Insights for Windows](https://accessibilityinsights.io/docs/en/windows/overview)) if any errors are found. An example of this usage can be found [here](https://github.com/microsoft/accessibility-insights-windows/tree/main/src/UITests). Your project can directly reference the Axe.Windows package from [NuGet](https://www.nuget.org/packages/Axe.Windows/).
12 | 
13 | ## Other testing options
14 | 
15 | It is possible to use the Axe.Windows CLI to trigger scans from any scripting system that can start a process. These results will always be returned as an A11yTest file. Documentation of the CLI can be found [here](https://github.com/microsoft/axe-windows/tree/main/src/CLI). The Axe.Windows CLI can be downloaded from the [Axe.Windows release page](https://github.com/microsoft/axe-windows/releases/latest).
16 | 


--------------------------------------------------------------------------------