summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/reporting/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /testing/web-platform/tests/reporting/README.md
parentInitial commit. (diff)
downloadthunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.tar.xz
thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/web-platform/tests/reporting/README.md')
-rw-r--r--testing/web-platform/tests/reporting/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/testing/web-platform/tests/reporting/README.md b/testing/web-platform/tests/reporting/README.md
new file mode 100644
index 0000000000..52f08265c5
--- /dev/null
+++ b/testing/web-platform/tests/reporting/README.md
@@ -0,0 +1,19 @@
+Tests for the [Reporting API](https://w3c.github.io/reporting/).
+
+The tests in this directory validate the generic functionaity of the Reporting
+API. Since reports are not actually generated by that specification, these tests
+occasionally make use of other integrations, like CSP or Permissions Policy.
+
+## Testing integration with the Reporting API
+
+More comprehensive tests for other specifications' generated reports should be
+in those specs' respective directories.
+
+There are two general methods of testing reporting integration:
+
+* The simpler is with the ReportingObserver interface, generating reports
+ within a document and reading them from script running in that document.
+* For reports which cannot be observed from a document, there is a reporting
+ collector provided which can receive reports sent over HTTP and then serve
+ them in response to queries from the test script. See resources/README.md for
+ details.