Re-format page on accessibility testing and update web test section.
Specifically:
* Mentions of specific locations in the code now link to that part of
the code.
* Command line examples that span multiple commands were condensed
into a single line for easier copying into terminals.
* A Markdown formatter was run over the file, mostly just changing
line lengths to get closer to 80 characters.
Change-Id: I3d6694fc186008866441bf7a8255d63c10687d53
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1579861
Reviewed-by: Katie Dektar <[email protected]>
Commit-Queue: Aran Gilman <[email protected]>
Cr-Commit-Position: refs/heads/master@{#655831}
diff --git a/docs/accessibility/tests.md b/docs/accessibility/tests.md
index 9376333..a5b5bb5 100644
--- a/docs/accessibility/tests.md
+++ b/docs/accessibility/tests.md
@@ -1,47 +1,47 @@
# Accessibility
-Here's a quick overview of all of the locations in the codebase where
-you'll find accessibility tests, and a brief overview of the purpose of
-all of them.
+Here's a quick overview of all of the locations in the codebase where you'll
+find accessibility tests, and a brief overview of the purpose of all of them.
-## Layout Tests
+## Web Tests
-This is the primary place where we test accessibility code in Blink. This
-code should have no platform-specific code. Use this to test anything
-where there's any interesting web platform logic, or where you need to be
-able to query things synchronously from the renderer thread to test them.
+This is the primary place where we test accessibility code in Blink. This code
+should have no platform-specific code. Use this to test anything where there's
+any interesting web platform logic, or where you need to be able to query things
+synchronously from the renderer thread to test them.
-Don't add tests for trivial features like ARIA attributes that we just
-expose directly to the next layer up. In those cases the Blink tests are
-trivial and it's more valuable to test these features at a higher level
-where we can ensure they actually work.
+Don't add tests for trivial features like ARIA attributes that we just expose
+directly to the next layer up. In those cases the Blink tests are trivial and
+it's more valuable to test these features at a higher level where we can ensure
+they actually work.
-Note that many of these tests are inherited from WebKit and the coding style
-has evolved a lot since then. Look for more recent tests as a guide if writing
-a new one.
+Note that many of these tests are inherited from WebKit and the coding style has
+evolved a lot since then. Look for more recent tests as a guide if writing a new
+one.
Test files:
-```
-third_party/blink/web_tests/accessibility
-```
+[third_party/blink/web_tests/accessibility](https://cs.chromium.org/chromium/src/third_party/blink/web_tests/accessibility/)
Source code to AccessibilityController and WebAXObjectProxy:
-```
-content/shell/test_runner
-```
+[content/shell/test_runner](https://cs.chromium.org/chromium/src/content/shell/test_runner/)
To run all accessibility web tests:
+
```
-autoninja -C out/release blink_tests
-third_party/blink/tools/run_web_tests.py --build-directory=out --target=release accessibility/
+autoninja -C out/release blink_tests third_party/blink/tools/run_web_tests.py \
+ --build-directory=out --target=release accessibility/
```
To run just one test by itself without the script:
+
```
-autoninja -C out/release blink_tests
-out/release/content_shell --run-web-tests third_party/blink/web_tests/accessibility/name-calc-inputs.html
+autoninja -C out/release blink_tests && out/release/content_shell \
+ --run-web-tests third_party/blink/web_tests/accessibility/name-calc-inputs.html
```
+For information on modifying or adding web tests, see the main
+[web tests documentation](https://chromium.googlesource.com/chromium/src/+/master/docs/testing/web_tests.md).
+
## DumpAccessibilityTree tests
This is the best way to write both cross-platform and platform-specific tests
@@ -53,32 +53,30 @@
[More documentation on DumpAccessibilityTree](../../content/test/data/accessibility/readme.md)
Test files:
-```
-content/test/data/accessibility
-```
+[content/test/data/accessibility](https://cs.chromium.org/chromium/src/content/test/data/accessibility/)
Test runner:
-```
-content/browser/accessibility/dump_accessibility_tree_browsertest.cc
-```
+[content/browser/accessibility/dump_accessibility_tree_browsertest.cc](https://cs.chromium.org/chromium/src/content/browser/accessibility/dump_accessibility_tree_browsertest.cc)
To run all tests:
+
```
-autoninja -C out/release content_browsertests
-out/release/content_browsertests --gtest_filter="DumpAccessibilityTree*"
+autoninja -C out/release content_browsertests && \
+ out/release/content_browsertests --gtest_filter="DumpAccessibilityTree*"
```
## Other content_browsertests
-There are many other tests in content/ that relate to accessibility.
-All of these tests work by launching a full multi-process browser shell,
-loading a web page in a renderer, then accessing the resulting accessibility
-tree from the browser process, and running some test from there.
+There are many other tests in content/ that relate to accessibility. All of
+these tests work by launching a full multi-process browser shell, loading a web
+page in a renderer, then accessing the resulting accessibility tree from the
+browser process, and running some test from there.
To run all tests:
+
```
-autoninja -C out/release content_browsertests
-out/release/content_browsertests --gtest_filter="*ccessib*"
+autoninja -C out/release content_browsertests && \
+ out/release/content_browsertests --gtest_filter="*ccessib*"
```
## Accessibility unittests
@@ -87,33 +85,33 @@
accessibility infrastructure.
Code location:
-```
-ui/accessibility
-```
+[ui/accessibility](https://cs.chromium.org/chromium/src/ui/accessibility/)
To run all tests:
+
```
-autoninja -C out/release accessibility_unittests
-out/release/accessibility_unittests
+autoninja -C out/release accessibility_unittests && \
+ out/release/accessibility_unittests
```
## ChromeVox tests
ChromeVox tests are part of the browser_tests suite. You must build with
-```target_os = "chromeos"``` in your GN args.
+`target_os = "chromeos"` in your GN args.
To run all tests:
+
```
-autoninja -C out/release browser_tests
-out/release/browser_tests --test-launcher-jobs=20 --gtest_filter=ChromeVox*
+autoninja -C out/release browser_tests && \
+ out/release/browser_tests --test-launcher-jobs=20 --gtest_filter=ChromeVox*
```
### Select-To-Speak tests
```
-autoninja -C out/release unit_tests browser_tests
-out/release/unit_tests --gtest_filter=*SelectToSpeak*
-out/release/browser_tests --gtest_filter=*SelectToSpeak*
+autoninja -C out/Default unit_tests browser_tests && \
+ out/Default/unit_tests --gtest_filter=*SelectToSpeak* && \
+ out/Default/browser_tests --gtest_filter=*SelectToSpeak*
```
## Performance tests
@@ -122,26 +120,21 @@
## Other locations of accessibility tests:
-Even this isn't a complete list. The tests described above cover more
-than 90% of the accessibility tests, and the remainder are scattered
-throughout the codebase. Here are a few other locations to check:
+Even this isn't a complete list. The tests described above cover more than 90%
+of the accessibility tests, and the remainder are scattered throughout the
+codebase. Here are a few other locations to check:
-```
-chrome/android/javatests/src/org/chromium/chrome/browser/accessibility
-chrome/browser/accessibility
-chrome/browser/chromeos/accessibility/
-ui/chromeos
-ui/views/accessibility
-```
+* [chrome/android/javatests/src/org/chromium/chrome/browser/accessibility](https://cs.chromium.org/chromium/src/chrome/android/javatests/src/org/chromium/chrome/browser/accessibility/)
+* [chrome/browser/accessibility](https://cs.chromium.org/chromium/src/chrome/browser/accessibility/)
+* [chrome/browser/chromeos/accessibility/](https://cs.chromium.org/chromium/src/chrome/browser/chromeos/accessibility/)
+* [ui/chromeos](https://cs.chromium.org/chromium/src/ui/chromeos/)
+* [ui/views/accessibility](https://cs.chromium.org/chromium/src/ui/views/accessibility/)
## Helpful flags:
Across all tests there are some helpful flags that will make testing easier.
-```
---test-launcher-jobs=10 # This will run stuff in parallel and make flakes more obvious
-```
+* Run tests multiple times in parallel (useful for finding flakes):
+ `--test-launcher-jobs=10`
-```
---gtest_filter="*Cats*" # Filter which tests run. Takes a wildcard (*) optionally.
-```
+* Filter which tests to run: `--gtest_filter="*Cats*"`
