summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/docs/writing-tests/visual.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /testing/web-platform/tests/docs/writing-tests/visual.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/web-platform/tests/docs/writing-tests/visual.md')
-rw-r--r--testing/web-platform/tests/docs/writing-tests/visual.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/testing/web-platform/tests/docs/writing-tests/visual.md b/testing/web-platform/tests/docs/writing-tests/visual.md
new file mode 100644
index 0000000000..a8ae53d071
--- /dev/null
+++ b/testing/web-platform/tests/docs/writing-tests/visual.md
@@ -0,0 +1,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.