Skip to content

Commit

Permalink
Add README for the Reporting API in WPT
Browse files Browse the repository at this point in the history
Change-Id: Ia83f04680f54099997d0ae71cda025ad773e2868
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3421157
Reviewed-by: Rodney Ding <rodneyding@google.com>
Commit-Queue: Ian Clelland <iclelland@chromium.org>
Cr-Commit-Position: refs/heads/main@{#964455}
  • Loading branch information
clelland authored and mattwoodrow committed Feb 15, 2022
1 parent 1e3c796 commit 48a8618
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions reporting/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 48a8618

Please sign in to comment.