testdriver.js: Make set_permission() take a PermissionDescriptor, not…

… a name

Making the public API take a permission name only works for permissions that
take a `PermissionDescriptor`, and makes it impossible to set permissions
that require extra information (i.e. they take a `MidiPermissionDescriptor`
or a `PushPermissionDescriptor` instead).

Instead of taking a string corresponding to a permission name, take a
`PermissionDescriptor` directly so that all required information can be
specified.

While here, make `set_permission.html` an HTTPS test, as some permissions
are only available in a secure context (such as "push", which is being used
to test setting a permission that requires extra parameters in the
descriptor).

Fixes #20672.

infrastructure/testdriver/set_permission.html → infrastructure/testdriver/set_permission.https.html

@@ -8,10 +8,10 @@
 
 <script>
 promise_test(t => {
-  return test_driver.set_permission("ambient-light-sensor", "granted", true);
+  return test_driver.set_permission({name: "ambient-light-sensor"}, "granted", true);
 }, "Grant Permission for one realm");
 
 promise_test(t => {
-  return test_driver.set_permission("ambient-light-sensor", "denied");
+  return test_driver.set_permission({name: "push", userVisibleOnly: true}, "denied");
 }, "Deny Permission, omit one realm");
 </script>

resources/testdriver.js

@@ -216,7 +216,9 @@
          * This function simulates a user setting a permission into a particular state as described
          * in {@link https://w3c.github.io/permissions/#set-permission-command}
          *
-         * @param {String} name - the name of the permission
+         * @param {Object} descriptor - a [PermissionDescriptor]{@link
+         *                              https://w3c.github.io/permissions/#dictdef-permissiondescriptor}
+         *                              object
          * @param {String} state - the state of the permission
          * @param {boolean} one_realm - Optional. Whether the permission applies to only one realm
          *
@@ -226,12 +228,10 @@
          * @returns {Promise} fulfilled after the permission is set, or rejected if setting the
          *                    permission fails
          */
-        set_permission: function(name, state, one_realm) {
+        set_permission: function(descriptor, state, one_realm) {
             let permission_params = {
-              descriptor: {
-                name: name
-              },
-              state: state,
+              descriptor,
+              state,
               oneRealm: one_realm,
             };
             return window.test_driver_internal.set_permission(permission_params);

tools/wptrunner/wptrunner/executors/base.py

@@ -782,7 +782,7 @@ def __call__(self, payload):
         state = permission_params["state"]
         one_realm = permission_params.get("oneRealm", False)
         self.logger.debug("Setting permission %s to %s, oneRealm=%s" % (name, state, one_realm))
-        self.protocol.set_permission.set_permission(name, state, one_realm)
+        self.protocol.set_permission.set_permission(descriptor, state, one_realm)
 
 class AddVirtualAuthenticatorAction(object):
     def __init__(self, logger, protocol):

tools/wptrunner/wptrunner/executors/executorwebdriver.py

@@ -208,11 +208,9 @@ class WebDriverSetPermissionProtocolPart(SetPermissionProtocolPart):
     def setup(self):
         self.webdriver = self.parent.webdriver
 
-    def set_permission(self, name, state, one_realm):
+    def set_permission(self, descriptor, state, one_realm):
         permission_params_dict = {
-            "descriptor": {
-                "name": name
-            },
+            "descriptor": descriptor,
             "state": state,
         }
         if one_realm is not None:

tools/wptrunner/wptrunner/executors/protocol.py

@@ -312,10 +312,10 @@ class SetPermissionProtocolPart(ProtocolPart):
     name = "set_permission"
 
     @abstractmethod
-    def set_permission(self, name, state, one_realm=False):
+    def set_permission(self, descriptor, state, one_realm=False):
         """Set permission state.
 
-        :param name: The name of the permission to set.
+        :param descriptor: A PermissionDescriptor object.
         :param state: The state to set the permission to.
         :param one_realm: Whether to set the permission for only one realm."""
         pass