summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/serial/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'testing/web-platform/tests/serial/README.md')
-rw-r--r--testing/web-platform/tests/serial/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/testing/web-platform/tests/serial/README.md b/testing/web-platform/tests/serial/README.md
new file mode 100644
index 0000000000..7040cf0a9d
--- /dev/null
+++ b/testing/web-platform/tests/serial/README.md
@@ -0,0 +1,20 @@
+# Web Serial Testing
+
+Automated testing for the [Web Serial API] relies on a test-only interface which
+must be provided by browsers under test. This is similar to [WebUSB] however
+there is no separate specification of the API other than the tests themselves
+and the Chromium implementation.
+
+Tests in this suite include `resources/automation.js` to detect and load the
+test API as needed.
+
+The Chromium implementation is provided by
+`../resources/chromium/fake-serial.js` using [MojoJS].
+
+Tests with the "-manual" suffix do not use the test-only interface and expect a
+real hardware device to be connected. The specific characteristics of the device
+are described in each test.
+
+[MojoJS]: https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/testing/web_platform_tests.md#mojojs
+[WebUSB]: ../webusb
+[Web Serial API]: https://wicg.github.io/serial