blob: 6316f54d3ff38515b6080766cdbae86fb0f669d2 [file] [log] [blame] [view]
Darwin Huanga8cd38182019-01-10 11:05:101# Web Tests (formerly known as "Layout Tests" or "LayoutTests")
pwnallae101a5f2016-11-08 00:24:382
Kent Tamura59ffb022018-11-27 05:30:563Web tests are used by Blink to test many components, including but not
4limited to layout and rendering. In general, web tests involve loading pages
pwnallae101a5f2016-11-08 00:24:385in a test renderer (`content_shell`) and comparing the rendered output or
6JavaScript output against an expected output file.
7
Kent Tamura59ffb022018-11-27 05:30:568This document covers running and debugging existing web tests. See the
9[Writing Web Tests documentation](./writing_web_tests.md) if you find
10yourself writing web tests.
pwnall4ea2eb32016-11-29 02:47:2511
Kent Tamura59ffb022018-11-27 05:30:5612Note that we changed the term "layout tests" to "web tests".
Kent Tamuraa045a7f2018-04-25 05:08:1113Please assume these terms mean the identical stuff. We also call it as
14"WebKit tests" and "WebKit layout tests".
15
Matt Falkenhagencef09742020-01-06 05:43:3816["Web platform tests"](./web_platform_tests.md) (WPT) are the preferred form of
17web tests and are located at
18[web_tests/external/wpt](/third_party/blink/web_tests/external/wpt).
19Tests that should work across browsers go there. Other directories are for
20Chrome-specific tests only.
21
Yoshisato Yanagisawa638e2ee02021-12-09 05:52:0822Note: if you are looking for a guide for the Web Platform Test, you should read
23["Web platform tests"](./web_platform_tests.md) (WPT). This document does not
24cover WPT specific features/behaviors.
25
pwnallae101a5f2016-11-08 00:24:3826[TOC]
27
Kent Tamura59ffb022018-11-27 05:30:5628## Running Web Tests
pwnallae101a5f2016-11-08 00:24:3829
Stephen McGruer7878d062021-01-15 20:23:2030### Supported Platforms
31
32* Linux
33* MacOS
34* Windows
35* Fuchsia
36
37Android is [not supported](https://crbug.com/567947).
38
pwnallae101a5f2016-11-08 00:24:3839### Initial Setup
40
Kent Tamura59ffb022018-11-27 05:30:5641Before you can run the web tests, you need to build the `blink_tests` target
pwnallae101a5f2016-11-08 00:24:3842to get `content_shell` and all of the other needed binaries.
43
44```bash
kyle Ju8f7d38df2018-11-26 16:51:2245autoninja -C out/Default blink_tests
pwnallae101a5f2016-11-08 00:24:3846```
47
pwnallae101a5f2016-11-08 00:24:3848On **Mac**, you probably want to strip the content_shell binary before starting
49the tests. If you don't, you'll have 5-10 running concurrently, all stuck being
50examined by the OS crash reporter. This may cause other failures like timeouts
51where they normally don't occur.
52
53```bash
Fangzhen Song2f09f202021-09-17 23:56:4354strip ./out/Default/Content\ Shell.app/Contents/MacOS/Content\ Shell
pwnallae101a5f2016-11-08 00:24:3855```
56
57### Running the Tests
58
Robert Ma7ed16792020-06-16 16:38:5259The test runner script is in `third_party/blink/tools/run_web_tests.py`.
pwnallae101a5f2016-11-08 00:24:3860
Dirk Pranke341ad9c2021-09-01 20:42:5761To specify which build directory to use (e.g. out/Default, etc.)
Jocelyn Trancfb81012022-08-05 17:39:4562you should pass the `-t` or `--target` parameter. If no directory is specified,
63`out/Release` will be used. To use the build in `out/Default`, use:
pwnallae101a5f2016-11-08 00:24:3864
65```bash
Robert Ma7ed16792020-06-16 16:38:5266third_party/blink/tools/run_web_tests.py -t Default
pwnallae101a5f2016-11-08 00:24:3867```
68
Robert Ma7ed16792020-06-16 16:38:5269*** promo
Gabriel Charette45cbb4a72021-03-19 15:08:1270* Windows users need to use `third_party\blink\tools\run_web_tests.bat` instead.
Robert Macca3b252020-11-23 20:11:3671* Linux users should not use `testing/xvfb.py`; `run_web_tests.py` manages Xvfb
72 itself.
Robert Ma7ed16792020-06-16 16:38:5273***
74
pwnallae101a5f2016-11-08 00:24:3875Tests marked as `[ Skip ]` in
Kent Tamura59ffb022018-11-27 05:30:5676[TestExpectations](../../third_party/blink/web_tests/TestExpectations)
Xianzhu Wang15355b22019-11-02 23:20:0277won't be run by default, generally because they cause some intractable tool error.
pwnallae101a5f2016-11-08 00:24:3878To force one of them to be run, either rename that file or specify the skipped
Xianzhu Wang15355b22019-11-02 23:20:0279test on the command line (see below) or in a file specified with --test-list
80(however, --skip=always can make the tests marked as `[ Skip ]` always skipped).
81Read the [Web Test Expectations documentation](./web_test_expectations.md) to
82learn more about TestExpectations and related files.
pwnallae101a5f2016-11-08 00:24:3883
pwnall4ea2eb32016-11-29 02:47:2584*** promo
85Currently only the tests listed in
Weizhong Xiaa33c6162022-05-03 02:11:2786[Default.txt](../../third_party/blink/web_tests/SmokeTests/Default.txt) are run
87on the Fuchsia bots, since running all web tests takes too long on Fuchshia.
88Most developers focus their Blink testing on Linux. We rely on the fact that the
Stephen McGruer7878d062021-01-15 20:23:2089Linux and Fuchsia behavior is nearly identical for scenarios outside those
90covered by the smoke tests.
pwnall4ea2eb32016-11-29 02:47:2591***
pwnallae101a5f2016-11-08 00:24:3892
Weizhong Xiaa33c6162022-05-03 02:11:2793*** promo
94Similar to Fuchsia's case, the tests listed in [Mac.txt]
95(../../third_party/blink/web_tests/SmokeTests/Mac.txt)
96are run on older mac version bots. By doing this we reduced the resources needed to run
97the tests. This relies on the fact that the majority of web tests will behavior similarly on
98different mac versions.
99***
100
pwnallae101a5f2016-11-08 00:24:38101To run only some of the tests, specify their directories or filenames as
Kent Tamura59ffb022018-11-27 05:30:56102arguments to `run_web_tests.py` relative to the web test directory
103(`src/third_party/blink/web_tests`). For example, to run the fast form tests,
pwnallae101a5f2016-11-08 00:24:38104use:
105
106```bash
Robert Ma7ed16792020-06-16 16:38:52107third_party/blink/tools/run_web_tests.py fast/forms
pwnallae101a5f2016-11-08 00:24:38108```
109
110Or you could use the following shorthand:
111
112```bash
Robert Ma7ed16792020-06-16 16:38:52113third_party/blink/tools/run_web_tests.py fast/fo\*
pwnallae101a5f2016-11-08 00:24:38114```
115
116*** promo
Kent Tamura59ffb022018-11-27 05:30:56117Example: To run the web tests with a debug build of `content_shell`, but only
pwnallae101a5f2016-11-08 00:24:38118test the SVG tests and run pixel tests, you would run:
119
120```bash
Robert Ma7ed16792020-06-16 16:38:52121third_party/blink/tools/run_web_tests.py -t Default svg
pwnallae101a5f2016-11-08 00:24:38122```
123***
124
125As a final quick-but-less-robust alternative, you can also just use the
Xianzhu Wang0a37e9d2019-03-27 21:27:29126content_shell executable to run specific tests by using (example on Windows):
pwnallae101a5f2016-11-08 00:24:38127
128```bash
Xianzhu Wang61d49d52021-07-31 16:44:53129out\Default\content_shell.exe --run-web-tests <url>|<full_test_source_path>|<relative_test_path>
pwnallae101a5f2016-11-08 00:24:38130```
131
132as in:
133
134```bash
Xianzhu Wang61d49d52021-07-31 16:44:53135out\Default\content_shell.exe --run-web-tests \
136 c:\chrome\src\third_party\blink\web_tests\fast\forms\001.html
pwnallae101a5f2016-11-08 00:24:38137```
Xianzhu Wang0a37e9d2019-03-27 21:27:29138or
139
140```bash
Xianzhu Wang61d49d52021-07-31 16:44:53141out\Default\content_shell.exe --run-web-tests fast\forms\001.html
Xianzhu Wang0a37e9d2019-03-27 21:27:29142```
pwnallae101a5f2016-11-08 00:24:38143
144but this requires a manual diff against expected results, because the shell
Xianzhu Wang0a37e9d2019-03-27 21:27:29145doesn't do it for you. It also just dumps the text result only (as the dump of
146pixels and audio binary data is not human readable).
Jeonghee Ahn2cbb9cb2019-09-23 02:52:57147See [Running Web Tests Using the Content Shell](./web_tests_in_content_shell.md)
Xianzhu Wang0a37e9d2019-03-27 21:27:29148for more details of running `content_shell`.
pwnallae101a5f2016-11-08 00:24:38149
Mathias Bynens172fc6b2018-09-05 09:39:43150To see a complete list of arguments supported, run:
151
152```bash
Robert Ma7ed16792020-06-16 16:38:52153third_party/blink/tools/run_web_tests.py --help
Mathias Bynens172fc6b2018-09-05 09:39:43154```
pwnallae101a5f2016-11-08 00:24:38155
156*** note
157**Linux Note:** We try to match the Windows render tree output exactly by
158matching font metrics and widget metrics. If there's a difference in the render
159tree output, we should see if we can avoid rebaselining by improving our font
Kent Tamura59ffb022018-11-27 05:30:56160metrics. For additional information on Linux web tests, please see
Jeonghee Ahn2cbb9cb2019-09-23 02:52:57161[docs/web_tests_linux.md](./web_tests_linux.md).
pwnallae101a5f2016-11-08 00:24:38162***
163
164*** note
165**Mac Note:** While the tests are running, a bunch of Appearance settings are
166overridden for you so the right type of scroll bars, colors, etc. are used.
167Your main display's "Color Profile" is also changed to make sure color
168correction by ColorSync matches what is expected in the pixel tests. The change
169is noticeable, how much depends on the normal level of correction for your
170display. The tests do their best to restore your setting when done, but if
171you're left in the wrong state, you can manually reset it by going to
172System Preferences → Displays → Color and selecting the "right" value.
173***
174
175### Test Harness Options
176
177This script has a lot of command line flags. You can pass `--help` to the script
178to see a full list of options. A few of the most useful options are below:
179
180| Option | Meaning |
181|:----------------------------|:--------------------------------------------------|
182| `--debug` | Run the debug build of the test shell (default is release). Equivalent to `-t Debug` |
183| `--nocheck-sys-deps` | Don't check system dependencies; this allows faster iteration. |
184| `--verbose` | Produce more verbose output, including a list of tests that pass. |
Takahiro Aoyagi96517392022-01-05 05:19:44185| `--reset-results` | Overwrite the current baselines (`-expected.{png`&#124;`txt`&#124;`wav}` files) with actual results, or create new baselines if there are no existing baselines. |
Quinten Yearsley17bf9b432018-01-02 22:02:45186| `--fully-parallel` | Run tests in parallel using as many child processes as the system has cores. |
pwnallae101a5f2016-11-08 00:24:38187| `--driver-logging` | Print C++ logs (LOG(WARNING), etc). |
188
189## Success and Failure
190
191A test succeeds when its output matches the pre-defined expected results. If any
192tests fail, the test script will place the actual generated results, along with
193a diff of the actual and expected results, into
Xiaohan Wangd54343362022-12-09 17:20:42194`src/out/Default/layout-test-results/`, and by default launch a browser with a
pwnallae101a5f2016-11-08 00:24:38195summary and link to the results/diffs.
196
197The expected results for tests are in the
Kent Tamura59ffb022018-11-27 05:30:56198`src/third_party/blink/web_tests/platform` or alongside their respective
pwnallae101a5f2016-11-08 00:24:38199tests.
200
201*** note
202Tests which use [testharness.js](https://github.com/w3c/testharness.js/)
203do not have expected result files if all test cases pass.
204***
205
206A test that runs but produces the wrong output is marked as "failed", one that
207causes the test shell to crash is marked as "crashed", and one that takes longer
208than a certain amount of time to complete is aborted and marked as "timed out".
209A row of dots in the script's output indicates one or more tests that passed.
210
211## Test expectations
212
213The
Kent Tamura59ffb022018-11-27 05:30:56214[TestExpectations](../../third_party/blink/web_tests/TestExpectations) file (and related
215files) contains the list of all known web test failures. See the
216[Web Test Expectations documentation](./web_test_expectations.md) for more
pwnall4ea2eb32016-11-29 02:47:25217on this.
pwnallae101a5f2016-11-08 00:24:38218
219## Testing Runtime Flags
220
Kent Tamura59ffb022018-11-27 05:30:56221There are two ways to run web tests with additional command-line arguments:
pwnallae101a5f2016-11-08 00:24:38222
Xianzhu Wang3ee2c99d82022-08-10 17:07:21223### --flag-specific
pwnallae101a5f2016-11-08 00:24:38224
Xianzhu Wang61d49d52021-07-31 16:44:53225```bash
Xianzhu Wang3ee2c99d82022-08-10 17:07:21226third_party/blink/tools/run_web_tests.py --flag-specific=blocking-repaint
227```
228It requires that `web_tests/FlagSpecificConfig` contains an entry like:
229
230```json
231{
232 "name": "blocking-repaint",
233 "args": ["--blocking-repaint", "--another-flag"]
234}
Xianzhu Wang61d49d52021-07-31 16:44:53235```
pwnallae101a5f2016-11-08 00:24:38236
Xianzhu Wang3ee2c99d82022-08-10 17:07:21237This tells the test harness to pass `--blocking-repaint --another-flag` to the
Xianzhu Wang61d49d52021-07-31 16:44:53238content_shell binary.
pwnallae101a5f2016-11-08 00:24:38239
Xianzhu Wang61d49d52021-07-31 16:44:53240It will also look for flag-specific expectations in
241`web_tests/FlagExpectations/blocking-repaint`, if this file exists. The
242suppressions in this file override the main TestExpectations files.
243However, `[ Slow ]` in either flag-specific expectations or base expectations
244is always merged into the used expectations.
pwnallae101a5f2016-11-08 00:24:38245
Xianzhu Wang61d49d52021-07-31 16:44:53246It will also look for baselines in `web_tests/flag-specific/blocking-repaint`.
247The baselines in this directory override the fallback baselines.
Xianzhu Wang15355b22019-11-02 23:20:02248
Weizhong Xia53c492162021-09-09 17:08:24249*** note
250[BUILD.gn](../../BUILD.gn) assumes flag-specific builders always runs on linux bots, so
251flag-specific test expectations and baselines are only downloaded to linux bots.
252If you need run flag-specific builders on other platforms, please update
253BUILD.gn to download flag-specific related data to that platform.
254***
255
Xianzhu Wang3ee2c99d82022-08-10 17:07:21256You can also use `--additional-driver-flag` to specify additional command-line
257arguments to content_shell, but the test harness won't use any flag-specific
258test expectations or baselines.
259
Xianzhu Wang61d49d52021-07-31 16:44:53260### Virtual test suites
Xianzhu Wang15355b22019-11-02 23:20:02261
Xianzhu Wang61d49d52021-07-31 16:44:53262A *virtual test suite* can be defined in
263[web_tests/VirtualTestSuites](../../third_party/blink/web_tests/VirtualTestSuites),
264to run a subset of web tests with additional flags, with
265`virtual/<prefix>/...` in their paths. The tests can be virtual tests that
266map to real base tests (directories or files) whose paths match any of the
267specified bases, or any real tests under `web_tests/virtual/<prefix>/`
268directory. For example, you could test a (hypothetical) new mode for
269repainting using the following virtual test suite:
pwnallae101a5f2016-11-08 00:24:38270
Xianzhu Wang61d49d52021-07-31 16:44:53271```json
272{
273 "prefix": "blocking_repaint",
Weizhong Xia5ab16822022-03-23 21:02:51274 "platforms": ["Linux", "Mac", "Win"],
Xianzhu Wang61d49d52021-07-31 16:44:53275 "bases": ["compositing", "fast/repaint"],
276 "args": ["--blocking-repaint"]
277}
278```
pwnallae101a5f2016-11-08 00:24:38279
Xianzhu Wang61d49d52021-07-31 16:44:53280This will create new "virtual" tests of the form
281`virtual/blocking_repaint/compositing/...` and
282`virtual/blocking_repaint/fast/repaint/...` which correspond to the files
283under `web_tests/compositing` and `web_tests/fast/repaint`, respectively,
284and pass `--blocking-repaint` to `content_shell` when they are run.
pwnallae101a5f2016-11-08 00:24:38285
Yoshisato Yanagisawaf702d7e2021-10-12 01:47:57286Note that you can run the tests with the following command line:
287
288```bash
289third_party/blink/tools/run_web_tests.py virtual/blocking_repaint/compositing \
290 virtual/blocking_repaint/fast/repaint
291```
292
Xianzhu Wang61d49d52021-07-31 16:44:53293These virtual tests exist in addition to the original `compositing/...` and
294`fast/repaint/...` tests. They can have their own expectations in
295`web_tests/TestExpectations`, and their own baselines. The test harness will
296use the non-virtual expectations and baselines as a fallback. If a virtual
297test has its own expectations, they will override all non-virtual
298expectations. otherwise the non-virtual expectations will be used. However,
299`[ Slow ]` in either virtual or non-virtual expectations is always merged
300into the used expectations. If a virtual test is expected to pass while the
301non-virtual test is expected to fail, you need to add an explicit `[ Pass ]`
302entry for the virtual test.
pwnallae101a5f2016-11-08 00:24:38303
Xianzhu Wang61d49d52021-07-31 16:44:53304This will also let any real tests under `web_tests/virtual/blocking_repaint`
305directory run with the `--blocking-repaint` flag.
Xianzhu Wang5d682c82019-10-29 05:08:19306
Weizhong Xia5ab16822022-03-23 21:02:51307The "platforms" configuration can be used to skip tests on some platforms. If
308a virtual test suites uses more than 5% of total test time, we should consider
309to skip the test suites on some platforms.
310
Xianzhu Wang61d49d52021-07-31 16:44:53311The "prefix" value should be unique. Multiple directories with the same flags
312should be listed in the same "bases" list. The "bases" list can be empty,
313in case that we just want to run the real tests under `virtual/<prefix>`
314with the flags without creating any virtual tests.
pwnallae101a5f2016-11-08 00:24:38315
Xianzhu Wang112e68282022-11-09 22:20:50316A virtual test suite can have an optional `exclusive_tests` field to specify
317all (with `"ALL"`) or a subset of `bases` tests that will be exclusively run
318under this virtual suite. The specified base tests will be skipped. Corresponding
319virtual tests under other virtual suites that don't specify the tests in their
320`exclusive_tests` list will be skipped, too. For example (unrelated fields
321are omitted):
322
323```json
324{
325 "prefix": "v1",
326 "bases": ["a"],
327}
328{
329 "prefix": "v2",
330 "bases": ["a/a1", "a/a2"],
331 "exclusive_tests": "ALL",
332}
333{
334 "prefix": "v3",
335 "bases": ["a"],
336 "exclusive_tests": ["a/a1"],
337}
338```
Jonathan Lee35bedec92023-01-26 18:58:20339
Xianzhu Wang112e68282022-11-09 22:20:50340Suppose there are directories `a/a1`, `a/a2` and `a/a3`, we will run the
341following tests:
Jonathan Lee35bedec92023-01-26 18:58:20342
Xianzhu Wang112e68282022-11-09 22:20:50343| Suite | a/a1 | a/a2 | a/a3 |
344| ---------: | :-----: | :-----: | :--: |
345| base | skipped | skipped | run |
346| virtual/v1 | skipped | skipped | run |
347| virtual/v2 | run | run | n/a |
348| virtual/v3 | run | skipped | run |
349
350
Xianzhu Wang61d49d52021-07-31 16:44:53351### Choosing between flag-specific and virtual test suite
352
353For flags whose implementation is still in progress, flag-specific expectations
354and virtual test suites represent two alternative strategies for testing both
Xianzhu Wangadb0670a22020-07-16 23:04:58355the enabled code path and not-enabled code path. They are preferred to only
356setting a [runtime enabled feature](../../third_party/blink/renderer/platform/RuntimeEnabledFeatures.md)
357to `status: "test"` if the feature has substantially different code path from
358production because the latter would cause loss of test coverage of the production
359code path.
360
361Consider the following when choosing between virtual test suites and
Jonathan Lee35bedec92023-01-26 18:58:20362flag-specific suites:
pwnallae101a5f2016-11-08 00:24:38363
364* The
365 [waterfall builders](https://dev.chromium.org/developers/testing/chromium-build-infrastructure/tour-of-the-chromium-buildbot)
366 and [try bots](https://dev.chromium.org/developers/testing/try-server-usage)
367 will run all virtual test suites in addition to the non-virtual tests.
Jonathan Lee35bedec92023-01-26 18:58:20368 Conversely, a flag-specific configuration won't automatically cause the bots
369 to test your flag - if you want bot coverage without virtual test suites, you
370 will need to follow [these instructions](#running-a-new-flag_specific-suite-in-cq_ci).
pwnallae101a5f2016-11-08 00:24:38371
372* Due to the above, virtual test suites incur a performance penalty for the
373 commit queue and the continuous build infrastructure. This is exacerbated by
374 the need to restart `content_shell` whenever flags change, which limits
375 parallelism. Therefore, you should avoid adding large numbers of virtual test
376 suites. They are well suited to running a subset of tests that are directly
377 related to the feature, but they don't scale to flags that make deep
378 architectural changes that potentially impact all of the tests.
379
Jeff Carpenter489d4022018-05-15 00:23:00380* Note that using wildcards in virtual test path names (e.g.
Xianzhu Wang61d49d52021-07-31 16:44:53381 `virtual/blocking_repaint/fast/repaint/*`) is not supported in
382 `run_web_tests.py` command line , but you can still use
383 `virtual/blocking_repaint` to run all real and virtual tests
Xianzhu Wang5d682c82019-10-29 05:08:19384 in the suite or `virtual/blocking_repaint/fast/repaint/dir` to run real
385 or virtual tests in the suite under a specific directory.
Jeff Carpenter489d4022018-05-15 00:23:00386
Xianzhu Wanga617a142020-05-07 21:57:47387*** note
388We can run a virtual test with additional flags. Both the virtual args and the
389additional flags will be applied. The fallback order of baselines and
390expectations will be: 1) flag-specific virtual, 2) non-flag-specific virtual,
3913) flag-specific base, 4) non-flag-specific base
392***
393
Jonathan Lee35bedec92023-01-26 18:58:20394### Running a New Flag-Specific Suite in CQ/CI
395
396Assuming you have already created a `FlagSpecificConfig` entry:
397
3981. File a resource request ([internal
399 docs](https://g3doc.corp.google.com/company/teams/chrome/ops/business/resources/resource-request-program.md?cl=head&polyglot=chrome-browser#i-need-new-resources))
400 for increased capacity in the `chromium.tests` swarming pool and wait for
401 approval.
4021. Define a new dedicated
403 [Buildbot test suite](https://source.chromium.org/chromium/chromium/src/+/main:testing/buildbot/test_suites.pyl;l=1516-1583;drc=0694b605fb77c975a065a3734bdcf3bd81fd8ca4;bpv=0;bpt=0)
404 with `--flag-specific` and possibly other special configurations (e.g., fewer shards).
4051. Add the Buildbot suite to the relevant `*-blink-rel` builder's
406 composition suite first
407 ([example](https://source.chromium.org/chromium/chromium/src/+/main:testing/buildbot/test_suites.pyl;l=5779-5780;drc=0694b605fb77c975a065a3734bdcf3bd81fd8ca4;bpv=0;bpt=0)).
4081. Add the flag-specific step name to the relevant builder in
409 [`builders.json`](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/tools/blinkpy/common/config/builders.json;l=127-129;drc=ff938aaff9566b2cc442476a51835e0b90b1c6f6;bpv=0;bpt=0).
410 `rebaseline-cl` and the WPT importer will now create baselines for that suite.
4111. Rebaseline the new suite and add any necessary suppressions under
412 `FlagExpectations/`.
4131. Enable the flag-specific suite for CQ/CI by adding the Buildbot suite to the
414 desired builder.
415 This could be an existing CQ builder like
416 [`linux-rel`](https://source.chromium.org/chromium/chromium/src/+/main:testing/buildbot/test_suites.pyl;l=5828-5829;drc=0694b605fb77c975a065a3734bdcf3bd81fd8ca4;bpv=0;bpt=0)
417 or a dedicated builder like
418 [`linux-blink-web-tests-force-accessibility-rel`](https://source.chromium.org/chromium/chromium/src/+/main:infra/config/subprojects/chromium/try/tryserver.chromium.accessibility.star;drc=adad4c6d55e69783ba1f16d30f4bc7367e2e626a;bpv=0;bpt=0), which has customized location filters.
419
pwnallae101a5f2016-11-08 00:24:38420## Tracking Test Failures
421
Kent Tamura59ffb022018-11-27 05:30:56422All bugs, associated with web test failures must have the
pwnallae101a5f2016-11-08 00:24:38423[Test-Layout](https://crbug.com/?q=label:Test-Layout) label. Depending on how
424much you know about the bug, assign the status accordingly:
425
426* **Unconfirmed** -- You aren't sure if this is a simple rebaseline, possible
427 duplicate of an existing bug, or a real failure
428* **Untriaged** -- Confirmed but unsure of priority or root cause.
429* **Available** -- You know the root cause of the issue.
430* **Assigned** or **Started** -- You will fix this issue.
431
Kent Tamura59ffb022018-11-27 05:30:56432When creating a new web test bug, please set the following properties:
pwnallae101a5f2016-11-08 00:24:38433
434* Components: a sub-component of Blink
435* OS: **All** (or whichever OS the failure is on)
436* Priority: 2 (1 if it's a crash)
437* Type: **Bug**
438* Labels: **Test-Layout**
439
Mathias Bynens172fc6b2018-09-05 09:39:43440You can also use the _Layout Test Failure_ template, which pre-sets these
pwnallae101a5f2016-11-08 00:24:38441labels for you.
442
Kent Tamura59ffb022018-11-27 05:30:56443## Debugging Web Tests
pwnallae101a5f2016-11-08 00:24:38444
Kent Tamura59ffb022018-11-27 05:30:56445After the web tests run, you should get a summary of tests that pass or
Mathias Bynens172fc6b2018-09-05 09:39:43446fail. If something fails unexpectedly (a new regression), you will get a
447`content_shell` window with a summary of the unexpected failures. Or you might
448have a failing test in mind to investigate. In any case, here are some steps and
449tips for finding the problem.
pwnallae101a5f2016-11-08 00:24:38450
451* Take a look at the result. Sometimes tests just need to be rebaselined (see
452 below) to account for changes introduced in your patch.
453 * Load the test into a trunk Chrome or content_shell build and look at its
454 result. (For tests in the http/ directory, start the http server first.
455 See above. Navigate to `http://localhost:8000/` and proceed from there.)
456 The best tests describe what they're looking for, but not all do, and
457 sometimes things they're not explicitly testing are still broken. Compare
458 it to Safari, Firefox, and IE if necessary to see if it's correct. If
459 you're still not sure, find the person who knows the most about it and
460 ask.
461 * Some tests only work properly in content_shell, not Chrome, because they
462 rely on extra APIs exposed there.
Kent Tamura59ffb022018-11-27 05:30:56463 * Some tests only work properly when they're run in the web-test
pwnallae101a5f2016-11-08 00:24:38464 framework, not when they're loaded into content_shell directly. The test
465 should mention that in its visible text, but not all do. So try that too.
466 See "Running the tests", above.
467* If you think the test is correct, confirm your suspicion by looking at the
468 diffs between the expected result and the actual one.
469 * Make sure that the diffs reported aren't important. Small differences in
470 spacing or box sizes are often unimportant, especially around fonts and
471 form controls. Differences in wording of JS error messages are also
472 usually acceptable.
Robert Ma7ed16792020-06-16 16:38:52473 * `third_party/blink/tools/run_web_tests.py path/to/your/test.html` produces
474 a page listing all test results. Those which fail their expectations will
475 include links to the expected result, actual result, and diff. These
476 results are saved to `$root_build_dir/layout-test-results`.
jonross26185702019-04-08 18:54:10477 * Alternatively the `--results-directory=path/for/output/` option allows
478 you to specify an alternative directory for the output to be saved to.
pwnallae101a5f2016-11-08 00:24:38479 * If you're still sure it's correct, rebaseline the test (see below).
480 Otherwise...
481* If you're lucky, your test is one that runs properly when you navigate to it
482 in content_shell normally. In that case, build the Debug content_shell
483 project, fire it up in your favorite debugger, and load the test file either
qyearsley23599b72017-02-16 19:10:42484 from a `file:` URL.
pwnallae101a5f2016-11-08 00:24:38485 * You'll probably be starting and stopping the content_shell a lot. In VS,
486 to save navigating to the test every time, you can set the URL to your
qyearsley23599b72017-02-16 19:10:42487 test (`file:` or `http:`) as the command argument in the Debugging section of
pwnallae101a5f2016-11-08 00:24:38488 the content_shell project Properties.
489 * If your test contains a JS call, DOM manipulation, or other distinctive
490 piece of code that you think is failing, search for that in the Chrome
491 solution. That's a good place to put a starting breakpoint to start
492 tracking down the issue.
493 * Otherwise, you're running in a standard message loop just like in Chrome.
494 If you have no other information, set a breakpoint on page load.
Kent Tamura59ffb022018-11-27 05:30:56495* If your test only works in full web-test mode, or if you find it simpler to
pwnallae101a5f2016-11-08 00:24:38496 debug without all the overhead of an interactive session, start the
Kent Tamuracd3ebc42018-05-16 06:44:22497 content_shell with the command-line flag `--run-web-tests`, followed by the
Kent Tamura59ffb022018-11-27 05:30:56498 URL (`file:` or `http:`) to your test. More information about running web tests
499 in content_shell can be found [here](./web_tests_in_content_shell.md).
pwnallae101a5f2016-11-08 00:24:38500 * In VS, you can do this in the Debugging section of the content_shell
501 project Properties.
502 * Now you're running with exactly the same API, theme, and other setup that
Kent Tamura59ffb022018-11-27 05:30:56503 the web tests use.
pwnallae101a5f2016-11-08 00:24:38504 * Again, if your test contains a JS call, DOM manipulation, or other
505 distinctive piece of code that you think is failing, search for that in
506 the Chrome solution. That's a good place to put a starting breakpoint to
507 start tracking down the issue.
508 * If you can't find any better place to set a breakpoint, start at the
509 `TestShell::RunFileTest()` call in `content_shell_main.cc`, or at
510 `shell->LoadURL() within RunFileTest()` in `content_shell_win.cc`.
Kent Tamura59ffb022018-11-27 05:30:56511* Debug as usual. Once you've gotten this far, the failing web test is just a
pwnallae101a5f2016-11-08 00:24:38512 (hopefully) reduced test case that exposes a problem.
513
514### Debugging HTTP Tests
515
Yoshisato Yanagisawa638e2ee02021-12-09 05:52:08516Note: HTTP Tests mean tests under `web_tests/http/tests/`,
517which is a subset of WebKit Layout Tests originated suite.
518If you want to debug WPT's HTTP behavior, you should read
519["Web platform tests"](./web_platform_tests.md) instead.
520
521
pwnallae101a5f2016-11-08 00:24:38522To run the server manually to reproduce/debug a failure:
523
524```bash
Robert Ma7ed16792020-06-16 16:38:52525third_party/blink/tools/run_blink_httpd.py
pwnallae101a5f2016-11-08 00:24:38526```
527
Kent Tamura59ffb022018-11-27 05:30:56528The web tests are served from `http://127.0.0.1:8000/`. For example, to
pwnallae101a5f2016-11-08 00:24:38529run the test
Kent Tamura59ffb022018-11-27 05:30:56530`web_tests/http/tests/serviceworker/chromium/service-worker-allowed.html`,
pwnallae101a5f2016-11-08 00:24:38531navigate to
532`http://127.0.0.1:8000/serviceworker/chromium/service-worker-allowed.html`. Some
Mathias Bynens172fc6b2018-09-05 09:39:43533tests behave differently if you go to `127.0.0.1` vs. `localhost`, so use
534`127.0.0.1`.
pwnallae101a5f2016-11-08 00:24:38535
Kent Tamurae81dbff2018-04-20 17:35:34536To kill the server, hit any key on the terminal where `run_blink_httpd.py` is
Mathias Bynens172fc6b2018-09-05 09:39:43537running, use `taskkill` or the Task Manager on Windows, or `killall` or
538Activity Monitor on macOS.
pwnallae101a5f2016-11-08 00:24:38539
Kent Tamura59ffb022018-11-27 05:30:56540The test server sets up an alias to the `web_tests/resources` directory. For
Mathias Bynens172fc6b2018-09-05 09:39:43541example, in HTTP tests, you can access the testing framework using
pwnallae101a5f2016-11-08 00:24:38542`src="/js-test-resources/js-test.js"`.
543
544### Tips
545
546Check https://test-results.appspot.com/ to see how a test did in the most recent
547~100 builds on each builder (as long as the page is being updated regularly).
548
549A timeout will often also be a text mismatch, since the wrapper script kills the
550content_shell before it has a chance to finish. The exception is if the test
551finishes loading properly, but somehow hangs before it outputs the bit of text
552that tells the wrapper it's done.
553
554Why might a test fail (or crash, or timeout) on buildbot, but pass on your local
555machine?
556* If the test finishes locally but is slow, more than 10 seconds or so, that
557 would be why it's called a timeout on the bot.
558* Otherwise, try running it as part of a set of tests; it's possible that a test
559 one or two (or ten) before this one is corrupting something that makes this
560 one fail.
561* If it consistently works locally, make sure your environment looks like the
562 one on the bot (look at the top of the stdio for the webkit_tests step to see
563 all the environment variables and so on).
564* If none of that helps, and you have access to the bot itself, you may have to
565 log in there and see if you can reproduce the problem manually.
566
Will Chen22b488502017-11-30 21:37:15567### Debugging DevTools Tests
pwnallae101a5f2016-11-08 00:24:38568
Will Chen22b488502017-11-30 21:37:15569* Do one of the following:
Mathias Bynens172fc6b2018-09-05 09:39:43570 * Option A) Run from the `chromium/src` folder:
Weizhong Xia91b53362022-01-05 17:13:35571 `third_party/blink/tools/run_web_tests.py --additional-driver-flag='--remote-debugging-port=9222' --additional-driver-flag='--debug-devtools' --timeout-ms=6000000`
Will Chen22b488502017-11-30 21:37:15572 * Option B) If you need to debug an http/tests/inspector test, start httpd
573 as described above. Then, run content_shell:
Tim van der Lippeae606432020-06-03 15:30:25574 `out/Default/content_shell --remote-debugging-port=9222 --additional-driver-flag='--debug-devtools' --run-web-tests http://127.0.0.1:8000/path/to/test.html`
Will Chen22b488502017-11-30 21:37:15575* Open `http://localhost:9222` in a stable/beta/canary Chrome, click the single
576 link to open the devtools with the test loaded.
577* In the loaded devtools, set any required breakpoints and execute `test()` in
578 the console to actually start the test.
579
580NOTE: If the test is an html file, this means it's a legacy test so you need to add:
pwnallae101a5f2016-11-08 00:24:38581* Add `window.debugTest = true;` to your test code as follows:
582
583 ```javascript
584 window.debugTest = true;
585 function test() {
586 /* TEST CODE */
587 }
Kim Paulhamus61d60c32018-02-09 18:03:49588 ```
pwnallae101a5f2016-11-08 00:24:38589
Steve Kobese123a3d42017-07-20 01:20:30590## Bisecting Regressions
591
592You can use [`git bisect`](https://git-scm.com/docs/git-bisect) to find which
Kent Tamura59ffb022018-11-27 05:30:56593commit broke (or fixed!) a web test in a fully automated way. Unlike
Steve Kobese123a3d42017-07-20 01:20:30594[bisect-builds.py](http://dev.chromium.org/developers/bisect-builds-py), which
595downloads pre-built Chromium binaries, `git bisect` operates on your local
596checkout, so it can run tests with `content_shell`.
597
598Bisecting can take several hours, but since it is fully automated you can leave
599it running overnight and view the results the next day.
600
Kent Tamura59ffb022018-11-27 05:30:56601To set up an automated bisect of a web test regression, create a script like
Steve Kobese123a3d42017-07-20 01:20:30602this:
603
Mathias Bynens172fc6b2018-09-05 09:39:43604```bash
Steve Kobese123a3d42017-07-20 01:20:30605#!/bin/bash
606
607# Exit code 125 tells git bisect to skip the revision.
608gclient sync || exit 125
Max Morozf5b31fcd2018-08-10 21:55:48609autoninja -C out/Debug -j100 blink_tests || exit 125
Steve Kobese123a3d42017-07-20 01:20:30610
Kent Tamuraa045a7f2018-04-25 05:08:11611third_party/blink/tools/run_web_tests.py -t Debug \
Steve Kobese123a3d42017-07-20 01:20:30612 --no-show-results --no-retry-failures \
Kent Tamura59ffb022018-11-27 05:30:56613 path/to/web/test.html
Steve Kobese123a3d42017-07-20 01:20:30614```
615
616Modify the `out` directory, ninja args, and test name as appropriate, and save
617the script in `~/checkrev.sh`. Then run:
618
Mathias Bynens172fc6b2018-09-05 09:39:43619```bash
Steve Kobese123a3d42017-07-20 01:20:30620chmod u+x ~/checkrev.sh # mark script as executable
621git bisect start <badrev> <goodrev>
622git bisect run ~/checkrev.sh
623git bisect reset # quit the bisect session
624```
625
Kent Tamura59ffb022018-11-27 05:30:56626## Rebaselining Web Tests
pwnallae101a5f2016-11-08 00:24:38627
Xianzhu Wang61d49d52021-07-31 16:44:53628See [How to rebaseline](./web_test_expectations.md#How-to-rebaseline).
Xianzhu Wang95d0bac32017-06-05 21:09:39629
pwnallae101a5f2016-11-08 00:24:38630## Known Issues
631
632See
633[bugs with the component Blink>Infra](https://bugs.chromium.org/p/chromium/issues/list?can=2&q=component%3ABlink%3EInfra)
Kent Tamura59ffb022018-11-27 05:30:56634for issues related to Blink tools, include the web test runner.
pwnallae101a5f2016-11-08 00:24:38635
pwnallae101a5f2016-11-08 00:24:38636* If QuickTime is not installed, the plugin tests
637 `fast/dom/object-embed-plugin-scripting.html` and
638 `plugins/embed-attributes-setting.html` are expected to fail.