blob: 2ac25b01db311672837a40535104c3d031112591 [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
Jonathan Lee1124233e2023-07-24 18:20:4122*** promo
23Consider running WPTs with [`wptrunner`](web_platform_tests_wptrunner.md), the
24harness developed by the WPT project that Chromium now supports.
25***
26
Yoshisato Yanagisawa638e2ee02021-12-09 05:52:0827Note: if you are looking for a guide for the Web Platform Test, you should read
28["Web platform tests"](./web_platform_tests.md) (WPT). This document does not
29cover WPT specific features/behaviors.
30
pwnallae101a5f2016-11-08 00:24:3831[TOC]
32
Kent Tamura59ffb022018-11-27 05:30:5633## Running Web Tests
pwnallae101a5f2016-11-08 00:24:3834
Stephen McGruer7878d062021-01-15 20:23:2035### Supported Platforms
36
37* Linux
38* MacOS
39* Windows
40* Fuchsia
41
42Android is [not supported](https://crbug.com/567947).
43
pwnallae101a5f2016-11-08 00:24:3844### Initial Setup
45
Kent Tamura59ffb022018-11-27 05:30:5646Before you can run the web tests, you need to build the `blink_tests` target
pwnallae101a5f2016-11-08 00:24:3847to get `content_shell` and all of the other needed binaries.
48
49```bash
kyle Ju8f7d38df2018-11-26 16:51:2250autoninja -C out/Default blink_tests
pwnallae101a5f2016-11-08 00:24:3851```
52
pwnallae101a5f2016-11-08 00:24:3853On **Mac**, you probably want to strip the content_shell binary before starting
54the tests. If you don't, you'll have 5-10 running concurrently, all stuck being
55examined by the OS crash reporter. This may cause other failures like timeouts
56where they normally don't occur.
57
58```bash
Fangzhen Song2f09f202021-09-17 23:56:4359strip ./out/Default/Content\ Shell.app/Contents/MacOS/Content\ Shell
pwnallae101a5f2016-11-08 00:24:3860```
61
62### Running the Tests
63
Robert Ma7ed16792020-06-16 16:38:5264The test runner script is in `third_party/blink/tools/run_web_tests.py`.
pwnallae101a5f2016-11-08 00:24:3865
Dirk Pranke341ad9c2021-09-01 20:42:5766To specify which build directory to use (e.g. out/Default, etc.)
Jocelyn Trancfb81012022-08-05 17:39:4567you should pass the `-t` or `--target` parameter. If no directory is specified,
Thiago Perrottae7e240c2023-07-14 18:37:5768`out/Release` will be used. To use the built-in `out/Default`, use:
pwnallae101a5f2016-11-08 00:24:3869
70```bash
Robert Ma7ed16792020-06-16 16:38:5271third_party/blink/tools/run_web_tests.py -t Default
pwnallae101a5f2016-11-08 00:24:3872```
73
Robert Ma7ed16792020-06-16 16:38:5274*** promo
Gabriel Charette45cbb4a72021-03-19 15:08:1275* Windows users need to use `third_party\blink\tools\run_web_tests.bat` instead.
Robert Macca3b252020-11-23 20:11:3676* Linux users should not use `testing/xvfb.py`; `run_web_tests.py` manages Xvfb
77 itself.
Robert Ma7ed16792020-06-16 16:38:5278***
79
pwnallae101a5f2016-11-08 00:24:3880Tests marked as `[ Skip ]` in
Kent Tamura59ffb022018-11-27 05:30:5681[TestExpectations](../../third_party/blink/web_tests/TestExpectations)
Xianzhu Wang15355b22019-11-02 23:20:0282won't be run by default, generally because they cause some intractable tool error.
pwnallae101a5f2016-11-08 00:24:3883To force one of them to be run, either rename that file or specify the skipped
Xianzhu Wang15355b22019-11-02 23:20:0284test on the command line (see below) or in a file specified with --test-list
85(however, --skip=always can make the tests marked as `[ Skip ]` always skipped).
86Read the [Web Test Expectations documentation](./web_test_expectations.md) to
87learn more about TestExpectations and related files.
pwnallae101a5f2016-11-08 00:24:3888
pwnall4ea2eb32016-11-29 02:47:2589*** promo
90Currently only the tests listed in
An Sung65d9eab2023-07-26 01:38:4391[Default.txt](../../third_party/blink/web_tests/TestLists/Default.txt) are run
Weizhong Xiaa33c6162022-05-03 02:11:2792on the Fuchsia bots, since running all web tests takes too long on Fuchshia.
93Most developers focus their Blink testing on Linux. We rely on the fact that the
Stephen McGruer7878d062021-01-15 20:23:2094Linux and Fuchsia behavior is nearly identical for scenarios outside those
95covered by the smoke tests.
pwnall4ea2eb32016-11-29 02:47:2596***
pwnallae101a5f2016-11-08 00:24:3897
Weizhong Xiaa33c6162022-05-03 02:11:2798*** promo
99Similar to Fuchsia's case, the tests listed in [Mac.txt]
An Sung65d9eab2023-07-26 01:38:43100(../../third_party/blink/web_tests/TestLists/Mac.txt)
Weizhong Xiaa33c6162022-05-03 02:11:27101are run on older mac version bots. By doing this we reduced the resources needed to run
102the tests. This relies on the fact that the majority of web tests will behavior similarly on
103different mac versions.
104***
105
pwnallae101a5f2016-11-08 00:24:38106To run only some of the tests, specify their directories or filenames as
Kent Tamura59ffb022018-11-27 05:30:56107arguments to `run_web_tests.py` relative to the web test directory
108(`src/third_party/blink/web_tests`). For example, to run the fast form tests,
pwnallae101a5f2016-11-08 00:24:38109use:
110
111```bash
Robert Ma7ed16792020-06-16 16:38:52112third_party/blink/tools/run_web_tests.py fast/forms
pwnallae101a5f2016-11-08 00:24:38113```
114
115Or you could use the following shorthand:
116
117```bash
Robert Ma7ed16792020-06-16 16:38:52118third_party/blink/tools/run_web_tests.py fast/fo\*
pwnallae101a5f2016-11-08 00:24:38119```
120
121*** promo
Kent Tamura59ffb022018-11-27 05:30:56122Example: To run the web tests with a debug build of `content_shell`, but only
pwnallae101a5f2016-11-08 00:24:38123test the SVG tests and run pixel tests, you would run:
124
125```bash
Robert Ma7ed16792020-06-16 16:38:52126third_party/blink/tools/run_web_tests.py -t Default svg
pwnallae101a5f2016-11-08 00:24:38127```
128***
129
130As a final quick-but-less-robust alternative, you can also just use the
Xianzhu Wang0a37e9d2019-03-27 21:27:29131content_shell executable to run specific tests by using (example on Windows):
pwnallae101a5f2016-11-08 00:24:38132
133```bash
Xianzhu Wang61d49d52021-07-31 16:44:53134out\Default\content_shell.exe --run-web-tests <url>|<full_test_source_path>|<relative_test_path>
pwnallae101a5f2016-11-08 00:24:38135```
136
137as in:
138
139```bash
Xianzhu Wang61d49d52021-07-31 16:44:53140out\Default\content_shell.exe --run-web-tests \
141 c:\chrome\src\third_party\blink\web_tests\fast\forms\001.html
pwnallae101a5f2016-11-08 00:24:38142```
Xianzhu Wang0a37e9d2019-03-27 21:27:29143or
144
145```bash
Xianzhu Wang61d49d52021-07-31 16:44:53146out\Default\content_shell.exe --run-web-tests fast\forms\001.html
Xianzhu Wang0a37e9d2019-03-27 21:27:29147```
pwnallae101a5f2016-11-08 00:24:38148
149but this requires a manual diff against expected results, because the shell
Xianzhu Wang0a37e9d2019-03-27 21:27:29150doesn't do it for you. It also just dumps the text result only (as the dump of
151pixels and audio binary data is not human readable).
Jeonghee Ahn2cbb9cb2019-09-23 02:52:57152See [Running Web Tests Using the Content Shell](./web_tests_in_content_shell.md)
Xianzhu Wang0a37e9d2019-03-27 21:27:29153for more details of running `content_shell`.
pwnallae101a5f2016-11-08 00:24:38154
Mathias Bynens172fc6b2018-09-05 09:39:43155To see a complete list of arguments supported, run:
156
157```bash
Robert Ma7ed16792020-06-16 16:38:52158third_party/blink/tools/run_web_tests.py --help
Mathias Bynens172fc6b2018-09-05 09:39:43159```
pwnallae101a5f2016-11-08 00:24:38160
161*** note
162**Linux Note:** We try to match the Windows render tree output exactly by
163matching font metrics and widget metrics. If there's a difference in the render
164tree output, we should see if we can avoid rebaselining by improving our font
Kent Tamura59ffb022018-11-27 05:30:56165metrics. For additional information on Linux web tests, please see
Jeonghee Ahn2cbb9cb2019-09-23 02:52:57166[docs/web_tests_linux.md](./web_tests_linux.md).
pwnallae101a5f2016-11-08 00:24:38167***
168
169*** note
170**Mac Note:** While the tests are running, a bunch of Appearance settings are
171overridden for you so the right type of scroll bars, colors, etc. are used.
172Your main display's "Color Profile" is also changed to make sure color
173correction by ColorSync matches what is expected in the pixel tests. The change
174is noticeable, how much depends on the normal level of correction for your
175display. The tests do their best to restore your setting when done, but if
176you're left in the wrong state, you can manually reset it by going to
177System Preferences → Displays → Color and selecting the "right" value.
178***
179
180### Test Harness Options
181
182This script has a lot of command line flags. You can pass `--help` to the script
183to see a full list of options. A few of the most useful options are below:
184
185| Option | Meaning |
186|:----------------------------|:--------------------------------------------------|
187| `--debug` | Run the debug build of the test shell (default is release). Equivalent to `-t Debug` |
188| `--nocheck-sys-deps` | Don't check system dependencies; this allows faster iteration. |
189| `--verbose` | Produce more verbose output, including a list of tests that pass. |
Takahiro Aoyagi96517392022-01-05 05:19:44190| `--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:45191| `--fully-parallel` | Run tests in parallel using as many child processes as the system has cores. |
pwnallae101a5f2016-11-08 00:24:38192| `--driver-logging` | Print C++ logs (LOG(WARNING), etc). |
193
194## Success and Failure
195
196A test succeeds when its output matches the pre-defined expected results. If any
197tests fail, the test script will place the actual generated results, along with
198a diff of the actual and expected results, into
Xiaohan Wangd54343362022-12-09 17:20:42199`src/out/Default/layout-test-results/`, and by default launch a browser with a
pwnallae101a5f2016-11-08 00:24:38200summary and link to the results/diffs.
201
202The expected results for tests are in the
Kent Tamura59ffb022018-11-27 05:30:56203`src/third_party/blink/web_tests/platform` or alongside their respective
pwnallae101a5f2016-11-08 00:24:38204tests.
205
206*** note
207Tests which use [testharness.js](https://github.com/w3c/testharness.js/)
208do not have expected result files if all test cases pass.
209***
210
211A test that runs but produces the wrong output is marked as "failed", one that
212causes the test shell to crash is marked as "crashed", and one that takes longer
213than a certain amount of time to complete is aborted and marked as "timed out".
214A row of dots in the script's output indicates one or more tests that passed.
215
216## Test expectations
217
218The
Kent Tamura59ffb022018-11-27 05:30:56219[TestExpectations](../../third_party/blink/web_tests/TestExpectations) file (and related
220files) contains the list of all known web test failures. See the
221[Web Test Expectations documentation](./web_test_expectations.md) for more
pwnall4ea2eb32016-11-29 02:47:25222on this.
pwnallae101a5f2016-11-08 00:24:38223
224## Testing Runtime Flags
225
Kent Tamura59ffb022018-11-27 05:30:56226There are two ways to run web tests with additional command-line arguments:
pwnallae101a5f2016-11-08 00:24:38227
Xianzhu Wang3ee2c99d82022-08-10 17:07:21228### --flag-specific
pwnallae101a5f2016-11-08 00:24:38229
Xianzhu Wang61d49d52021-07-31 16:44:53230```bash
Xianzhu Wang3ee2c99d82022-08-10 17:07:21231third_party/blink/tools/run_web_tests.py --flag-specific=blocking-repaint
232```
233It requires that `web_tests/FlagSpecificConfig` contains an entry like:
234
235```json
236{
237 "name": "blocking-repaint",
238 "args": ["--blocking-repaint", "--another-flag"]
239}
Xianzhu Wang61d49d52021-07-31 16:44:53240```
pwnallae101a5f2016-11-08 00:24:38241
Xianzhu Wang3ee2c99d82022-08-10 17:07:21242This tells the test harness to pass `--blocking-repaint --another-flag` to the
Xianzhu Wang61d49d52021-07-31 16:44:53243content_shell binary.
pwnallae101a5f2016-11-08 00:24:38244
Xianzhu Wang61d49d52021-07-31 16:44:53245It will also look for flag-specific expectations in
246`web_tests/FlagExpectations/blocking-repaint`, if this file exists. The
247suppressions in this file override the main TestExpectations files.
248However, `[ Slow ]` in either flag-specific expectations or base expectations
249is always merged into the used expectations.
pwnallae101a5f2016-11-08 00:24:38250
Xianzhu Wang61d49d52021-07-31 16:44:53251It will also look for baselines in `web_tests/flag-specific/blocking-repaint`.
252The baselines in this directory override the fallback baselines.
Xianzhu Wang15355b22019-11-02 23:20:02253
Weizhong Xia53c492162021-09-09 17:08:24254*** note
255[BUILD.gn](../../BUILD.gn) assumes flag-specific builders always runs on linux bots, so
256flag-specific test expectations and baselines are only downloaded to linux bots.
Thiago Perrottae7e240c2023-07-14 18:37:57257If you need run flag-specific builderst-n other platforms, please update
Weizhong Xia53c492162021-09-09 17:08:24258BUILD.gn to download flag-specific related data to that platform.
259***
260
Xianzhu Wang3ee2c99d82022-08-10 17:07:21261You can also use `--additional-driver-flag` to specify additional command-line
262arguments to content_shell, but the test harness won't use any flag-specific
263test expectations or baselines.
264
Xianzhu Wang61d49d52021-07-31 16:44:53265### Virtual test suites
Xianzhu Wang15355b22019-11-02 23:20:02266
Xianzhu Wang61d49d52021-07-31 16:44:53267A *virtual test suite* can be defined in
268[web_tests/VirtualTestSuites](../../third_party/blink/web_tests/VirtualTestSuites),
269to run a subset of web tests with additional flags, with
270`virtual/<prefix>/...` in their paths. The tests can be virtual tests that
271map to real base tests (directories or files) whose paths match any of the
272specified bases, or any real tests under `web_tests/virtual/<prefix>/`
273directory. For example, you could test a (hypothetical) new mode for
274repainting using the following virtual test suite:
pwnallae101a5f2016-11-08 00:24:38275
Xianzhu Wang61d49d52021-07-31 16:44:53276```json
277{
278 "prefix": "blocking_repaint",
Weizhong Xia5ab16822022-03-23 21:02:51279 "platforms": ["Linux", "Mac", "Win"],
Xianzhu Wang61d49d52021-07-31 16:44:53280 "bases": ["compositing", "fast/repaint"],
281 "args": ["--blocking-repaint"]
282}
283```
pwnallae101a5f2016-11-08 00:24:38284
Xianzhu Wang61d49d52021-07-31 16:44:53285This will create new "virtual" tests of the form
286`virtual/blocking_repaint/compositing/...` and
287`virtual/blocking_repaint/fast/repaint/...` which correspond to the files
288under `web_tests/compositing` and `web_tests/fast/repaint`, respectively,
289and pass `--blocking-repaint` to `content_shell` when they are run.
pwnallae101a5f2016-11-08 00:24:38290
Yoshisato Yanagisawaf702d7e2021-10-12 01:47:57291Note that you can run the tests with the following command line:
292
293```bash
294third_party/blink/tools/run_web_tests.py virtual/blocking_repaint/compositing \
295 virtual/blocking_repaint/fast/repaint
296```
297
Xianzhu Wang61d49d52021-07-31 16:44:53298These virtual tests exist in addition to the original `compositing/...` and
299`fast/repaint/...` tests. They can have their own expectations in
300`web_tests/TestExpectations`, and their own baselines. The test harness will
301use the non-virtual expectations and baselines as a fallback. If a virtual
302test has its own expectations, they will override all non-virtual
Thiago Perrottae7e240c2023-07-14 18:37:57303expectations. Otherwise the non-virtual expectations will be used. However,
Xianzhu Wang61d49d52021-07-31 16:44:53304`[ Slow ]` in either virtual or non-virtual expectations is always merged
305into the used expectations. If a virtual test is expected to pass while the
306non-virtual test is expected to fail, you need to add an explicit `[ Pass ]`
307entry for the virtual test.
pwnallae101a5f2016-11-08 00:24:38308
Xianzhu Wang61d49d52021-07-31 16:44:53309This will also let any real tests under `web_tests/virtual/blocking_repaint`
310directory run with the `--blocking-repaint` flag.
Xianzhu Wang5d682c82019-10-29 05:08:19311
Weizhong Xia5ab16822022-03-23 21:02:51312The "platforms" configuration can be used to skip tests on some platforms. If
313a virtual test suites uses more than 5% of total test time, we should consider
314to skip the test suites on some platforms.
315
Xianzhu Wang61d49d52021-07-31 16:44:53316The "prefix" value should be unique. Multiple directories with the same flags
317should be listed in the same "bases" list. The "bases" list can be empty,
318in case that we just want to run the real tests under `virtual/<prefix>`
319with the flags without creating any virtual tests.
pwnallae101a5f2016-11-08 00:24:38320
Xianzhu Wang112e68282022-11-09 22:20:50321A virtual test suite can have an optional `exclusive_tests` field to specify
322all (with `"ALL"`) or a subset of `bases` tests that will be exclusively run
323under this virtual suite. The specified base tests will be skipped. Corresponding
324virtual tests under other virtual suites that don't specify the tests in their
325`exclusive_tests` list will be skipped, too. For example (unrelated fields
326are omitted):
327
328```json
329{
330 "prefix": "v1",
331 "bases": ["a"],
332}
333{
334 "prefix": "v2",
335 "bases": ["a/a1", "a/a2"],
336 "exclusive_tests": "ALL",
337}
338{
339 "prefix": "v3",
340 "bases": ["a"],
341 "exclusive_tests": ["a/a1"],
342}
343```
Jonathan Lee35bedec92023-01-26 18:58:20344
Xianzhu Wang112e68282022-11-09 22:20:50345Suppose there are directories `a/a1`, `a/a2` and `a/a3`, we will run the
346following tests:
Jonathan Lee35bedec92023-01-26 18:58:20347
Xianzhu Wang112e68282022-11-09 22:20:50348| Suite | a/a1 | a/a2 | a/a3 |
349| ---------: | :-----: | :-----: | :--: |
350| base | skipped | skipped | run |
351| virtual/v1 | skipped | skipped | run |
352| virtual/v2 | run | run | n/a |
353| virtual/v3 | run | skipped | run |
354
Yotam Hacohena949ab1a2023-07-19 21:18:14355In a similar manner, a virtual test suite can also have an optional
356`skip_base_tests` field to specify all (with `"ALL"`) or a subset of `bases`
357tests that will be run under this virtual while the base tests will be skipped.
358This will not affect other virtual suites.
359
360```json
361{
362 "prefix": "v1",
363 "bases": ["a/a1"],
364}
365{
366 "prefix": "v2",
367 "bases": ["a/a1"],
368 "skip_base_tests": "ALL",
369}
370```
371Suppose there are directories `a/a1` and `a/a2` we will run the following tests:
372
373| Suite | a/a1 | a/a2 |
374| ---------: | :-----: | :-----: |
375| base | skipped | run |
376| virtual/v1 | run | n/a |
377| virtual/v2 | run | n/a |
378
Xianzhu Wang112e68282022-11-09 22:20:50379
Xianzhu Wang61d49d52021-07-31 16:44:53380### Choosing between flag-specific and virtual test suite
381
382For flags whose implementation is still in progress, flag-specific expectations
383and virtual test suites represent two alternative strategies for testing both
Thiago Perrottae7e240c2023-07-14 18:37:57384the enabled code path and non-enabled code path. They are preferred to only
Xianzhu Wangadb0670a22020-07-16 23:04:58385setting a [runtime enabled feature](../../third_party/blink/renderer/platform/RuntimeEnabledFeatures.md)
386to `status: "test"` if the feature has substantially different code path from
387production because the latter would cause loss of test coverage of the production
388code path.
389
390Consider the following when choosing between virtual test suites and
Jonathan Lee35bedec92023-01-26 18:58:20391flag-specific suites:
pwnallae101a5f2016-11-08 00:24:38392
393* The
394 [waterfall builders](https://dev.chromium.org/developers/testing/chromium-build-infrastructure/tour-of-the-chromium-buildbot)
395 and [try bots](https://dev.chromium.org/developers/testing/try-server-usage)
396 will run all virtual test suites in addition to the non-virtual tests.
Jonathan Lee35bedec92023-01-26 18:58:20397 Conversely, a flag-specific configuration won't automatically cause the bots
398 to test your flag - if you want bot coverage without virtual test suites, you
399 will need to follow [these instructions](#running-a-new-flag_specific-suite-in-cq_ci).
pwnallae101a5f2016-11-08 00:24:38400
401* Due to the above, virtual test suites incur a performance penalty for the
402 commit queue and the continuous build infrastructure. This is exacerbated by
403 the need to restart `content_shell` whenever flags change, which limits
404 parallelism. Therefore, you should avoid adding large numbers of virtual test
405 suites. They are well suited to running a subset of tests that are directly
406 related to the feature, but they don't scale to flags that make deep
407 architectural changes that potentially impact all of the tests.
408
Jeff Carpenter489d4022018-05-15 00:23:00409* Note that using wildcards in virtual test path names (e.g.
Xianzhu Wang61d49d52021-07-31 16:44:53410 `virtual/blocking_repaint/fast/repaint/*`) is not supported in
411 `run_web_tests.py` command line , but you can still use
412 `virtual/blocking_repaint` to run all real and virtual tests
Xianzhu Wang5d682c82019-10-29 05:08:19413 in the suite or `virtual/blocking_repaint/fast/repaint/dir` to run real
414 or virtual tests in the suite under a specific directory.
Jeff Carpenter489d4022018-05-15 00:23:00415
Xianzhu Wanga617a142020-05-07 21:57:47416*** note
417We can run a virtual test with additional flags. Both the virtual args and the
418additional flags will be applied. The fallback order of baselines and
419expectations will be: 1) flag-specific virtual, 2) non-flag-specific virtual,
4203) flag-specific base, 4) non-flag-specific base
421***
422
Jonathan Lee35bedec92023-01-26 18:58:20423### Running a New Flag-Specific Suite in CQ/CI
424
425Assuming you have already created a `FlagSpecificConfig` entry:
426
4271. File a resource request ([internal
428 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))
429 for increased capacity in the `chromium.tests` swarming pool and wait for
430 approval.
4311. Define a new dedicated
432 [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)
433 with `--flag-specific` and possibly other special configurations (e.g., fewer shards).
4341. Add the Buildbot suite to the relevant `*-blink-rel` builder's
435 composition suite first
436 ([example](https://source.chromium.org/chromium/chromium/src/+/main:testing/buildbot/test_suites.pyl;l=5779-5780;drc=0694b605fb77c975a065a3734bdcf3bd81fd8ca4;bpv=0;bpt=0)).
4371. Add the flag-specific step name to the relevant builder in
438 [`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).
439 `rebaseline-cl` and the WPT importer will now create baselines for that suite.
4401. Rebaseline the new suite and add any necessary suppressions under
441 `FlagExpectations/`.
4421. Enable the flag-specific suite for CQ/CI by adding the Buildbot suite to the
443 desired builder.
444 This could be an existing CQ builder like
445 [`linux-rel`](https://source.chromium.org/chromium/chromium/src/+/main:testing/buildbot/test_suites.pyl;l=5828-5829;drc=0694b605fb77c975a065a3734bdcf3bd81fd8ca4;bpv=0;bpt=0)
446 or a dedicated builder like
447 [`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.
448
pwnallae101a5f2016-11-08 00:24:38449## Tracking Test Failures
450
Kent Tamura59ffb022018-11-27 05:30:56451All bugs, associated with web test failures must have the
pwnallae101a5f2016-11-08 00:24:38452[Test-Layout](https://crbug.com/?q=label:Test-Layout) label. Depending on how
453much you know about the bug, assign the status accordingly:
454
455* **Unconfirmed** -- You aren't sure if this is a simple rebaseline, possible
456 duplicate of an existing bug, or a real failure
457* **Untriaged** -- Confirmed but unsure of priority or root cause.
458* **Available** -- You know the root cause of the issue.
459* **Assigned** or **Started** -- You will fix this issue.
460
Kent Tamura59ffb022018-11-27 05:30:56461When creating a new web test bug, please set the following properties:
pwnallae101a5f2016-11-08 00:24:38462
463* Components: a sub-component of Blink
464* OS: **All** (or whichever OS the failure is on)
465* Priority: 2 (1 if it's a crash)
466* Type: **Bug**
467* Labels: **Test-Layout**
468
Mathias Bynens172fc6b2018-09-05 09:39:43469You can also use the _Layout Test Failure_ template, which pre-sets these
pwnallae101a5f2016-11-08 00:24:38470labels for you.
471
Kent Tamura59ffb022018-11-27 05:30:56472## Debugging Web Tests
pwnallae101a5f2016-11-08 00:24:38473
Kent Tamura59ffb022018-11-27 05:30:56474After the web tests run, you should get a summary of tests that pass or
Mathias Bynens172fc6b2018-09-05 09:39:43475fail. If something fails unexpectedly (a new regression), you will get a
476`content_shell` window with a summary of the unexpected failures. Or you might
477have a failing test in mind to investigate. In any case, here are some steps and
478tips for finding the problem.
pwnallae101a5f2016-11-08 00:24:38479
480* Take a look at the result. Sometimes tests just need to be rebaselined (see
481 below) to account for changes introduced in your patch.
482 * Load the test into a trunk Chrome or content_shell build and look at its
483 result. (For tests in the http/ directory, start the http server first.
484 See above. Navigate to `http://localhost:8000/` and proceed from there.)
485 The best tests describe what they're looking for, but not all do, and
486 sometimes things they're not explicitly testing are still broken. Compare
487 it to Safari, Firefox, and IE if necessary to see if it's correct. If
488 you're still not sure, find the person who knows the most about it and
489 ask.
490 * Some tests only work properly in content_shell, not Chrome, because they
491 rely on extra APIs exposed there.
Kent Tamura59ffb022018-11-27 05:30:56492 * Some tests only work properly when they're run in the web-test
pwnallae101a5f2016-11-08 00:24:38493 framework, not when they're loaded into content_shell directly. The test
494 should mention that in its visible text, but not all do. So try that too.
495 See "Running the tests", above.
496* If you think the test is correct, confirm your suspicion by looking at the
497 diffs between the expected result and the actual one.
498 * Make sure that the diffs reported aren't important. Small differences in
499 spacing or box sizes are often unimportant, especially around fonts and
500 form controls. Differences in wording of JS error messages are also
501 usually acceptable.
Robert Ma7ed16792020-06-16 16:38:52502 * `third_party/blink/tools/run_web_tests.py path/to/your/test.html` produces
503 a page listing all test results. Those which fail their expectations will
504 include links to the expected result, actual result, and diff. These
505 results are saved to `$root_build_dir/layout-test-results`.
jonross26185702019-04-08 18:54:10506 * Alternatively the `--results-directory=path/for/output/` option allows
507 you to specify an alternative directory for the output to be saved to.
pwnallae101a5f2016-11-08 00:24:38508 * If you're still sure it's correct, rebaseline the test (see below).
509 Otherwise...
510* If you're lucky, your test is one that runs properly when you navigate to it
511 in content_shell normally. In that case, build the Debug content_shell
512 project, fire it up in your favorite debugger, and load the test file either
qyearsley23599b72017-02-16 19:10:42513 from a `file:` URL.
pwnallae101a5f2016-11-08 00:24:38514 * You'll probably be starting and stopping the content_shell a lot. In VS,
515 to save navigating to the test every time, you can set the URL to your
qyearsley23599b72017-02-16 19:10:42516 test (`file:` or `http:`) as the command argument in the Debugging section of
pwnallae101a5f2016-11-08 00:24:38517 the content_shell project Properties.
518 * If your test contains a JS call, DOM manipulation, or other distinctive
519 piece of code that you think is failing, search for that in the Chrome
520 solution. That's a good place to put a starting breakpoint to start
521 tracking down the issue.
522 * Otherwise, you're running in a standard message loop just like in Chrome.
523 If you have no other information, set a breakpoint on page load.
Kent Tamura59ffb022018-11-27 05:30:56524* If your test only works in full web-test mode, or if you find it simpler to
pwnallae101a5f2016-11-08 00:24:38525 debug without all the overhead of an interactive session, start the
Kent Tamuracd3ebc42018-05-16 06:44:22526 content_shell with the command-line flag `--run-web-tests`, followed by the
Kent Tamura59ffb022018-11-27 05:30:56527 URL (`file:` or `http:`) to your test. More information about running web tests
528 in content_shell can be found [here](./web_tests_in_content_shell.md).
pwnallae101a5f2016-11-08 00:24:38529 * In VS, you can do this in the Debugging section of the content_shell
530 project Properties.
531 * Now you're running with exactly the same API, theme, and other setup that
Kent Tamura59ffb022018-11-27 05:30:56532 the web tests use.
pwnallae101a5f2016-11-08 00:24:38533 * Again, if your test contains a JS call, DOM manipulation, or other
534 distinctive piece of code that you think is failing, search for that in
535 the Chrome solution. That's a good place to put a starting breakpoint to
536 start tracking down the issue.
537 * If you can't find any better place to set a breakpoint, start at the
538 `TestShell::RunFileTest()` call in `content_shell_main.cc`, or at
539 `shell->LoadURL() within RunFileTest()` in `content_shell_win.cc`.
Kent Tamura59ffb022018-11-27 05:30:56540* Debug as usual. Once you've gotten this far, the failing web test is just a
pwnallae101a5f2016-11-08 00:24:38541 (hopefully) reduced test case that exposes a problem.
542
543### Debugging HTTP Tests
544
Yoshisato Yanagisawa638e2ee02021-12-09 05:52:08545Note: HTTP Tests mean tests under `web_tests/http/tests/`,
546which is a subset of WebKit Layout Tests originated suite.
547If you want to debug WPT's HTTP behavior, you should read
548["Web platform tests"](./web_platform_tests.md) instead.
549
550
pwnallae101a5f2016-11-08 00:24:38551To run the server manually to reproduce/debug a failure:
552
553```bash
Robert Ma7ed16792020-06-16 16:38:52554third_party/blink/tools/run_blink_httpd.py
pwnallae101a5f2016-11-08 00:24:38555```
556
Kent Tamura59ffb022018-11-27 05:30:56557The web tests are served from `http://127.0.0.1:8000/`. For example, to
pwnallae101a5f2016-11-08 00:24:38558run the test
Kent Tamura59ffb022018-11-27 05:30:56559`web_tests/http/tests/serviceworker/chromium/service-worker-allowed.html`,
pwnallae101a5f2016-11-08 00:24:38560navigate to
561`http://127.0.0.1:8000/serviceworker/chromium/service-worker-allowed.html`. Some
Mathias Bynens172fc6b2018-09-05 09:39:43562tests behave differently if you go to `127.0.0.1` vs. `localhost`, so use
563`127.0.0.1`.
pwnallae101a5f2016-11-08 00:24:38564
Kent Tamurae81dbff2018-04-20 17:35:34565To kill the server, hit any key on the terminal where `run_blink_httpd.py` is
Mathias Bynens172fc6b2018-09-05 09:39:43566running, use `taskkill` or the Task Manager on Windows, or `killall` or
567Activity Monitor on macOS.
pwnallae101a5f2016-11-08 00:24:38568
Kent Tamura59ffb022018-11-27 05:30:56569The test server sets up an alias to the `web_tests/resources` directory. For
Mathias Bynens172fc6b2018-09-05 09:39:43570example, in HTTP tests, you can access the testing framework using
pwnallae101a5f2016-11-08 00:24:38571`src="/js-test-resources/js-test.js"`.
572
573### Tips
574
575Check https://test-results.appspot.com/ to see how a test did in the most recent
576~100 builds on each builder (as long as the page is being updated regularly).
577
578A timeout will often also be a text mismatch, since the wrapper script kills the
579content_shell before it has a chance to finish. The exception is if the test
580finishes loading properly, but somehow hangs before it outputs the bit of text
581that tells the wrapper it's done.
582
583Why might a test fail (or crash, or timeout) on buildbot, but pass on your local
584machine?
585* If the test finishes locally but is slow, more than 10 seconds or so, that
586 would be why it's called a timeout on the bot.
587* Otherwise, try running it as part of a set of tests; it's possible that a test
588 one or two (or ten) before this one is corrupting something that makes this
589 one fail.
590* If it consistently works locally, make sure your environment looks like the
591 one on the bot (look at the top of the stdio for the webkit_tests step to see
592 all the environment variables and so on).
593* If none of that helps, and you have access to the bot itself, you may have to
594 log in there and see if you can reproduce the problem manually.
595
Will Chen22b488502017-11-30 21:37:15596### Debugging DevTools Tests
pwnallae101a5f2016-11-08 00:24:38597
Will Chen22b488502017-11-30 21:37:15598* Do one of the following:
Mathias Bynens172fc6b2018-09-05 09:39:43599 * Option A) Run from the `chromium/src` folder:
Weizhong Xia91b53362022-01-05 17:13:35600 `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:15601 * Option B) If you need to debug an http/tests/inspector test, start httpd
602 as described above. Then, run content_shell:
Tim van der Lippeae606432020-06-03 15:30:25603 `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:15604* Open `http://localhost:9222` in a stable/beta/canary Chrome, click the single
605 link to open the devtools with the test loaded.
606* In the loaded devtools, set any required breakpoints and execute `test()` in
607 the console to actually start the test.
608
609NOTE: If the test is an html file, this means it's a legacy test so you need to add:
pwnallae101a5f2016-11-08 00:24:38610* Add `window.debugTest = true;` to your test code as follows:
611
612 ```javascript
613 window.debugTest = true;
614 function test() {
615 /* TEST CODE */
616 }
Kim Paulhamus61d60c32018-02-09 18:03:49617 ```
pwnallae101a5f2016-11-08 00:24:38618
Steve Kobese123a3d42017-07-20 01:20:30619## Bisecting Regressions
620
621You can use [`git bisect`](https://git-scm.com/docs/git-bisect) to find which
Kent Tamura59ffb022018-11-27 05:30:56622commit broke (or fixed!) a web test in a fully automated way. Unlike
Steve Kobese123a3d42017-07-20 01:20:30623[bisect-builds.py](http://dev.chromium.org/developers/bisect-builds-py), which
624downloads pre-built Chromium binaries, `git bisect` operates on your local
625checkout, so it can run tests with `content_shell`.
626
627Bisecting can take several hours, but since it is fully automated you can leave
628it running overnight and view the results the next day.
629
Kent Tamura59ffb022018-11-27 05:30:56630To set up an automated bisect of a web test regression, create a script like
Steve Kobese123a3d42017-07-20 01:20:30631this:
632
Mathias Bynens172fc6b2018-09-05 09:39:43633```bash
Steve Kobese123a3d42017-07-20 01:20:30634#!/bin/bash
635
636# Exit code 125 tells git bisect to skip the revision.
637gclient sync || exit 125
Max Morozf5b31fcd2018-08-10 21:55:48638autoninja -C out/Debug -j100 blink_tests || exit 125
Steve Kobese123a3d42017-07-20 01:20:30639
Kent Tamuraa045a7f2018-04-25 05:08:11640third_party/blink/tools/run_web_tests.py -t Debug \
Steve Kobese123a3d42017-07-20 01:20:30641 --no-show-results --no-retry-failures \
Kent Tamura59ffb022018-11-27 05:30:56642 path/to/web/test.html
Steve Kobese123a3d42017-07-20 01:20:30643```
644
645Modify the `out` directory, ninja args, and test name as appropriate, and save
646the script in `~/checkrev.sh`. Then run:
647
Mathias Bynens172fc6b2018-09-05 09:39:43648```bash
Steve Kobese123a3d42017-07-20 01:20:30649chmod u+x ~/checkrev.sh # mark script as executable
650git bisect start <badrev> <goodrev>
651git bisect run ~/checkrev.sh
652git bisect reset # quit the bisect session
653```
654
Kent Tamura59ffb022018-11-27 05:30:56655## Rebaselining Web Tests
pwnallae101a5f2016-11-08 00:24:38656
Xianzhu Wang61d49d52021-07-31 16:44:53657See [How to rebaseline](./web_test_expectations.md#How-to-rebaseline).
Xianzhu Wang95d0bac32017-06-05 21:09:39658
pwnallae101a5f2016-11-08 00:24:38659## Known Issues
660
661See
662[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:56663for issues related to Blink tools, include the web test runner.
pwnallae101a5f2016-11-08 00:24:38664
pwnallae101a5f2016-11-08 00:24:38665* If QuickTime is not installed, the plugin tests
666 `fast/dom/object-embed-plugin-scripting.html` and
667 `plugins/embed-attributes-setting.html` are expected to fail.