File: visual.md

package info (click to toggle)
thunderbird 1%3A140.4.0esr-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,609,432 kB
  • sloc: cpp: 7,672,442; javascript: 5,901,613; ansic: 3,898,954; python: 1,413,343; xml: 653,997; asm: 462,286; java: 180,927; sh: 113,489; makefile: 20,460; perl: 14,288; objc: 13,059; yacc: 4,583; pascal: 3,352; lex: 1,720; ruby: 1,222; exp: 762; sql: 715; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (27 lines) | stat: -rw-r--r-- 1,197 bytes parent folder | download | duplicates (29)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Visual Tests

Visual tests are typically used when testing rendering of things that
cannot be tested with [reftests](reftests).

Their main advantage of over manual tests is they can be verified using
browser-specific and platform-specific screenshots; note, however, that many
browser vendors treat them identically to manual tests hence they are
similarly discouraged as they very infrequently, if ever, get run by them.

## Writing a Visual Test

Visuals tests are test files which have `-visual` at the end of their
filename, before the extension. There is nothing needed in them to
make them work.

They should follow the [general test guidelines](general-guidelines),
especially noting the requirement to be self-describing (i.e., they
must give a clear pass condition in their rendering).

Similarly, they should consider the [rendering test guidelines](rendering),
especially those about color, to ensure those running the test don't
incorrectly judge its result.

The screenshot for comparison is taken at the same point as when screenshots
for [reftest comparisons](reftests) are taken, including potentially waiting
for any `class="reftest-wait"` to be removed from the root element.