[testdriver] Add test_driver.bidi.bluetooth.simulate_adapter (#49193)

Add `test_driver.bidi.bluetooth.simulate_adapter` method matching [`bluetooth.simulateAdapter`](https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-simulateAdapter-command)WebDriver BiDi command and extend the documentation. RFC is not required, as the method matches a WebDriver BiDi command. --------- Co-authored-by: Alex Rudenko <[email protected]>
web-platform-tests · Nov 16, 2024 · 6cf69a4 · 6cf69a4
1 parent f15ff9f
commit 6cf69a4
Show file tree

Hide file tree

Showing 8 changed files with 153 additions and 3 deletions.
diff --git a/docs/writing-tests/testdriver.md b/docs/writing-tests/testdriver.md
@@ -278,3 +278,11 @@ const event = await log_entry_promise;
 .. js:autofunction:: test_driver.bidi.log.entry_added.on
 .. js:autofunction:: test_driver.bidi.log.entry_added.once
 ```
+
+### Bluetooth ###
+
+The module provides access to [Web Bluetooth](https://webbluetoothcg.github.io/web-bluetooth).
+
+```eval_rst
+.. js:autofunction:: test_driver.bidi.bluetooth.simulate_adapter
+```
diff --git a/...ructure/metadata/infrastructure/testdriver/bidi/bluetooth/simulate_adapter.https.html.ini b/...ructure/metadata/infrastructure/testdriver/bidi/bluetooth/simulate_adapter.https.html.ini
@@ -0,0 +1 @@
+disabled: https://github.com/web-platform-tests/wpt/issues/47544
diff --git a/infrastructure/testdriver/bidi/bluetooth/simulate_adapter.https.html b/infrastructure/testdriver/bidi/bluetooth/simulate_adapter.https.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<meta charset="utf-8"/>
+<title>TestDriver bidi.bluetooth.simulate_adapter method</title>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
+
+<script>
+    promise_test(async (t) => {
+        await test_driver.bidi.bluetooth.simulate_adapter({
+            state: "absent"
+        });
+
+        assert_equals(false, await navigator.bluetooth.getAvailability(),
+            "Assert bluetooth is not available");
+    }, "simulate bluetooth adapter 'absent'");
+
+    promise_test(async (t) => {
+        await test_driver.bidi.bluetooth.simulate_adapter({
+            state: "powered-off"
+        });
+
+        assert_equals(true, await navigator.bluetooth.getAvailability(),
+            "Assert bluetooth available");
+    }, "simulate bluetooth adapter 'powered-off'");
+
+    promise_test(async (t) => {
+        await test_driver.bidi.bluetooth.simulate_adapter({
+            state: "powered-on"
+        });
+
+        assert_equals(true, await navigator.bluetooth.getAvailability(),
+            "Assert bluetooth available");
+    }, "simulate bluetooth adapter 'powered-on'");
+</script>
diff --git a/resources/testdriver.js b/resources/testdriver.js
@@ -58,7 +58,35 @@
              * be specified by its ID (a string) or using a `WindowProxy`
              * object.
              */
-
+            /**
+             * `bluetooth <https://webbluetoothcg.github.io/web-bluetooth>`_ module.
+             */
+            bluetooth: {
+                /**
+                 * Creates a simulated bluetooth adapter with the given params. Matches the
+                 * `bluetooth.simulateAdapter <https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-simulateAdapter-command>`_
+                 * WebDriver BiDi command.
+                 *
+                 * @example
+                 * await test_driver.bidi.bluetooth.simulate_adapter({
+                 *     state: "powered-on"
+                 * });
+                 *
+                 * @param {object} params - Parameters for the command.
+                 * @param {string} params.state The state of the simulated bluetooth adapter.
+                 * Matches the
+                 * `bluetooth.SimulateAdapterParameters:state <https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-simulateAdapter-command>`_
+                 * value.
+                 * @param {Context} [params.context] The optional context parameter specifies in
+                 * which browsing context the simulated bluetooth adapter should be set. If not
+                 * provided, the current browsing context is used.
+                 * @returns {Promise} fulfilled after the simulated bluetooth adapter is created
+                 * and set, or rejected if the operation fails.
+                 */
+                simulate_adapter: function (params) {
+                    return window.test_driver_internal.bidi.bluetooth.simulate_adapter(params);
+                }
+            },
             /**
              * `log <https://w3c.github.io/webdriver-bidi/#module-log>`_ module.
              */
@@ -1287,6 +1315,12 @@
         in_automation: false,
 
         bidi: {
+            bluetooth: {
+                simulate_adapter: function () {
+                    throw new Error(
+                        "bidi.bluetooth.simulate_adapter is not implemented by testdriver-vendor.js");
+                }
+            },
             log: {
                 entry_added: {
                     async subscribe() {

diff --git a/tools/wptrunner/wptrunner/executors/asyncactions.py b/tools/wptrunner/wptrunner/executors/asyncactions.py
@@ -7,6 +7,32 @@ def do_delayed_imports():
     global webdriver
     import webdriver
 
+
+class BidiBluetoothSimulateAdapterAction:
+    name = "bidi.bluetooth.simulate_adapter"
+
+    def __init__(self, logger, protocol):
+        do_delayed_imports()
+        self.logger = logger
+        self.protocol = protocol
+
+    async def __call__(self, payload):
+        if payload["context"] is None:
+            raise ValueError("Missing required parameter: context")
+
+        context = payload["context"]
+        if isinstance(context, str):
+            pass
+        elif isinstance(context, webdriver.bidi.protocol.BidiWindow):
+            # Context can be a serialized WindowProxy.
+            context = context.browsing_context
+        else:
+            raise ValueError("Unexpected context type: %s" % context)
+
+        state = payload["state"]
+        return await self.protocol.bidi_bluetooth.simulate_adapter(context, state)
+
+
 class BidiSessionSubscribeAction:
     name = "bidi.session.subscribe"
 
@@ -49,4 +75,7 @@ async def __call__(self, payload):
                                                                    origin)
 
 
-async_actions = [BidiPermissionsSetPermissionAction, BidiSessionSubscribeAction]
+async_actions = [
+    BidiBluetoothSimulateAdapterAction,
+    BidiPermissionsSetPermissionAction,
+    BidiSessionSubscribeAction]
diff --git a/tools/wptrunner/wptrunner/executors/executorwebdriver.py b/tools/wptrunner/wptrunner/executors/executorwebdriver.py
@@ -37,6 +37,7 @@
                        RPHRegistrationsProtocolPart,
                        FedCMProtocolPart,
                        VirtualSensorProtocolPart,
+                       BidiBluetoothProtocolPart,
                        BidiBrowsingContextProtocolPart,
                        BidiEventsProtocolPart,
                        BidiPermissionsProtocolPart,
@@ -115,6 +116,21 @@ def wait(self):
         return False
 
 
+class WebDriverBidiBluetoothProtocolPart(BidiBluetoothProtocolPart):
+    def __init__(self, parent):
+        super().__init__(parent)
+        self.webdriver = None
+
+    def setup(self):
+        self.webdriver = self.parent.webdriver
+
+    async def simulate_adapter(self,
+          context: str,
+          state: str) -> None:
+        await self.webdriver.bidi_session.bluetooth.simulate_adapter(
+            context=context, state=state)
+
+
 class WebDriverBidiBrowsingContextProtocolPart(BidiBrowsingContextProtocolPart):
     def __init__(self, parent):
         super().__init__(parent)
@@ -692,7 +708,8 @@ def after_connect(self):
 
 class WebDriverBidiProtocol(WebDriverProtocol):
     enable_bidi = True
-    implements = [WebDriverBidiBrowsingContextProtocolPart,
+    implements = [WebDriverBidiBluetoothProtocolPart,
+                  WebDriverBidiBrowsingContextProtocolPart,
                   WebDriverBidiEventsProtocolPart,
                   WebDriverBidiPermissionsProtocolPart,
                   WebDriverBidiScriptProtocolPart,

diff --git a/tools/wptrunner/wptrunner/executors/protocol.py b/tools/wptrunner/wptrunner/executors/protocol.py
@@ -331,6 +331,23 @@ def get_computed_role(self, element):
         pass
 
 
+class BidiBluetoothProtocolPart(ProtocolPart):
+    """Protocol part for managing BiDi events"""
+    __metaclass__ = ABCMeta
+    name = "bidi_bluetooth"
+
+    @abstractmethod
+    async def simulate_adapter(self,
+                               context: str,
+                               state: str) -> None:
+        """
+        Creates a simulated bluetooth adapter.
+        :param context: Browsing context to set the simulated adapter to.
+        :param state: The state of the simulated bluetooth adapter.
+        """
+        pass
+
+
 class BidiBrowsingContextProtocolPart(ProtocolPart):
     """Protocol part for managing BiDi events"""
     __metaclass__ = ABCMeta

diff --git a/tools/wptrunner/wptrunner/testdriver-extra.js b/tools/wptrunner/wptrunner/testdriver-extra.js
@@ -208,6 +208,14 @@
 
     window.test_driver_internal.in_automation = true;
 
+    window.test_driver_internal.bidi.bluetooth.simulate_adapter = function (params) {
+        return create_action("bidi.bluetooth.simulate_adapter", {
+            // Default to the current window.
+            context: window,
+            ...params
+        });
+    }
+
     window.test_driver_internal.bidi.log.entry_added.subscribe =
         function (params) {
             return subscribe({