summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/common/reftest-wait.js
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /testing/web-platform/tests/common/reftest-wait.js
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/web-platform/tests/common/reftest-wait.js')
-rw-r--r--testing/web-platform/tests/common/reftest-wait.js39
1 files changed, 39 insertions, 0 deletions
diff --git a/testing/web-platform/tests/common/reftest-wait.js b/testing/web-platform/tests/common/reftest-wait.js
new file mode 100644
index 0000000000..64fe9bfd7f
--- /dev/null
+++ b/testing/web-platform/tests/common/reftest-wait.js
@@ -0,0 +1,39 @@
+/**
+ * Remove the `reftest-wait` class on the document element.
+ * The reftest runner will wait with taking a screenshot while
+ * this class is present.
+ *
+ * See https://web-platform-tests.org/writing-tests/reftests.html#controlling-when-comparison-occurs
+ */
+function takeScreenshot() {
+ document.documentElement.classList.remove("reftest-wait");
+}
+
+/**
+ * Call `takeScreenshot()` after a delay of at least |timeout| milliseconds.
+ * @param {number} timeout - milliseconds
+ */
+function takeScreenshotDelayed(timeout) {
+ setTimeout(function() {
+ takeScreenshot();
+ }, timeout);
+}
+
+/**
+ * Ensure that a precondition is met before waiting for a screenshot.
+ * @param {bool} condition - Fail the test if this evaluates to false
+ * @param {string} msg - Error message to write to the screenshot
+ */
+function failIfNot(condition, msg) {
+ const fail = () => {
+ (document.body || document.documentElement).textContent = `Precondition Failed: ${msg}`;
+ takeScreenshot();
+ };
+ if (!condition) {
+ if (document.readyState == "interactive") {
+ fail();
+ } else {
+ document.addEventListener("DOMContentLoaded", fail, false);
+ }
+ }
+}