Add Testdriver extension for Global Privacy Control control

Author: bvandersloot-mozilla

docs/writing-tests/testdriver.md

@@ -192,6 +192,14 @@ the global scope.
 .. js:autofunction:: test_driver.clear_display_features
 ```
 
+### Global Privacy Control ###
+
+```eval_rst
+.. js:autofunction:: test_driver.set_global_privacy_control
+.. js:autofunction:: test_driver.set_global_privacy_control
+```
+
+
 ### Using test_driver in other browsing contexts ###
 
 Testdriver can be used in browsing contexts (i.e. windows or frames)

resources/testdriver.js

@@ -1407,6 +1407,32 @@
             return window.test_driver_internal.set_permission(permission_params, context);
         },
 
+        /**
+         * Gets the current globally-applied privacy control status
+         *
+         * @returns {Promise} Fulfils with an object with boolean property `gpc`
+         *                    that encodes the current "do not sell or share"
+         *                    signal the browser is configured to convey.
+         */
+        get_global_privacy_control: function() {
+            return window.test_driver_internal.get_global_privacy_control();
+        },
+
+        /**
+         * Gets the current globally-applied privacy control status
+         *
+         * @param {bool} newValue - The a boolean that is true if the browers
+         *                          should convey a "do not sell or share" signal
+         *                          and false otherwise
+         *
+         * @returns {Promise} Fulfils with an object with boolean property `gpc`
+         *                    that encodes the new "do not sell or share"
+         *                    after applying the new value.
+         */
+        set_global_privacy_control: function(newValue) {
+            return window.test_driver_internal.set_global_privacy_control(newValue);
+        },
+
         /**
          * Creates a virtual authenticator
          *
@@ -2364,6 +2390,14 @@
             throw new Error("set_permission() is not implemented by testdriver-vendor.js");
         },
 
+        async set_global_privacy_control(newValue, context=null) {
+            throw new Error("set_global_privacy_control() is not implemented by testdriver-vendor.js");
+        },
+
+        async get_global_privacy_control(context=null) {
+            throw new Error("get_global_privacy_control() is not implemented by testdriver-vendor.js");
+        },
+
         async add_virtual_authenticator(config, context=null) {
             throw new Error("add_virtual_authenticator() is not implemented by testdriver-vendor.js");
         },

tools/wptrunner/wptrunner/executors/actions.py

@@ -183,6 +183,30 @@ def __call__(self, payload):
         self.logger.debug("Setting permission %s to %s" % (name, state))
         self.protocol.set_permission.set_permission(descriptor, state)
 
+
+class SetGlobalPrivacyControlAction:
+    name = "set_global_privacy_control"
+
+    def __init__(self, logger, protocol):
+        self.logger = logger
+        self.protocol = protocol
+
+    def __call__(self, payload):
+        gpc = payload["gpc"]
+        return self.protocol.global_privacy_control.set_global_privacy_control(gpc)
+
+class GetGlobalPrivacyControlAction:
+    name = "get_global_privacy_control"
+
+    def __init__(self, logger, protocol):
+        self.logger = logger
+        self.protocol = protocol
+
+    def __call__(self, payload):
+        return self.protocol.global_privacy_control.get_global_privacy_control()
+
+
+
 class AddVirtualAuthenticatorAction:
     name = "add_virtual_authenticator"
 
@@ -586,4 +610,6 @@ def __call__(self, payload):
            RemoveVirtualPressureSourceAction,
            SetProtectedAudienceKAnonymityAction,
            SetDisplayFeaturesAction,
-           ClearDisplayFeaturesAction]
+           ClearDisplayFeaturesAction,
+           GetGlobalPrivacyControlAction,
+           SetGlobalPrivacyControlAction]

tools/wptrunner/wptrunner/executors/executormarionette.py

@@ -34,6 +34,7 @@
                        DevicePostureProtocolPart,
                        DisplayFeaturesProtocolPart,
                        GenerateTestReportProtocolPart,
+                       GlobalPrivacyControlProtocolPart,
                        PrefsProtocolPart,
                        PrintProtocolPart,
                        Protocol,
@@ -620,6 +621,29 @@ def set_permission(self, descriptor, state):
             raise NotImplementedError("set_permission not yet implemented") from e
 
 
+class MarionetteGlobalPrivacyControlProtocolPart(GlobalPrivacyControlProtocolPart):
+    def setup(self):
+        self.marionette = self.parent.marionette
+
+    def set_global_privacy_control(self, gpc):
+        body = {
+            "gpc": gpc,
+        }
+        try:
+            return self.marionette._send_message("WebDriver:SetGlobalPrivacyControl", body)["value"]
+        except errors.UnsupportedOperationException as e:
+            raise NotImplementedError("set_global_privacy_control not yet implemented") from e
+
+    def get_global_privacy_control(self):
+        try:
+            return self.marionette._send_message("WebDriver:GetGlobalPrivacyControl")["value"]
+        except errors.UnsupportedOperationException as e:
+            raise NotImplementedError("get_global_privacy_control not yet implemented") from e
+
+
+
+
+
 class MarionettePrintProtocolPart(PrintProtocolPart):
     def setup(self):
         self.marionette = self.parent.marionette
@@ -795,6 +819,7 @@ class MarionetteProtocol(Protocol):
                   MarionetteGenerateTestReportProtocolPart,
                   MarionetteVirtualAuthenticatorProtocolPart,
                   MarionetteSetPermissionProtocolPart,
+                  MarionetteGlobalPrivacyControlProtocolPart,
                   MarionettePrintProtocolPart,
                   MarionetteDebugProtocolPart,
                   MarionetteAccessibilityProtocolPart,

tools/wptrunner/wptrunner/executors/protocol.py

@@ -736,6 +736,20 @@ def set_permission(self, descriptor, state):
         pass
 
 
+class GlobalPrivacyControlProtocolPart(ProtocolPart):
+    """Protocol part for reading and writing the GPC signal"""
+    __metaclass__ = ABCMeta
+
+    name = "global_privacy_control"
+
+    @abstractmethod
+    def set_global_privacy_control(self, value):
+        pass
+
+    @abstractmethod
+    def get_global_privacy_control(self):
+        pass
+
 class ActionSequenceProtocolPart(ProtocolPart):
     """Protocol part for performing trusted clicks"""
     __metaclass__ = ABCMeta

tools/wptrunner/wptrunner/testdriver-extra.js

@@ -536,6 +536,14 @@
         return create_context_action("set_permission", context, {permission_params});
     };
 
+    window.test_driver_internal.get_global_privacy_control = function(context=null) {
+        return create_context_action("get_global_privacy_control", context, {});
+    };
+
+    window.test_driver_internal.set_global_privacy_control = function(gpc, context=null) {
+        return create_context_action("set_global_privacy_control", context, {gpc});
+    };
+
     window.test_driver_internal.add_virtual_authenticator = function(config, context=null) {
         return create_context_action("add_virtual_authenticator", context, {config});
     };