Py safari options (#10385)

MWschutte · AutomatedTester · web-flow · commit 203dadb4112b · 2022-03-01T14:57:01.000Z
* Add safari options

Include the Automatic Profiling and Automatic Inspection option to safarie options. Also add's the options to set browser name to Safari Technology Preview

* Add safari options unit tests

* Fix flake8 style error

There where some blank lines containing whitespaces which is against the flake8 style convention.

Co-authored-by: David Burns &lt;david.burns@theautomatedtester.co.uk&gt;
diff --git a/py/selenium/webdriver/safari/options.py b/py/selenium/webdriver/safari/options.py
@@ -31,6 +31,12 @@ def to_capabilities(self) -> dict:
 class Options(ArgOptions):
     KEY = "safari.options"
 
+    # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
+    AUTOMATIC_INSPECTION = 'safari:automaticInspection'
+    AUTOMATIC_PROFILING = 'safari:automaticProfiling'
+
+    SAFARI_TECH_PREVIEW = 'Safari Technology Preview'
+
     def __init__(self):
         super(Options, self).__init__()
         self._binary_location = None
@@ -78,3 +84,51 @@ def to_capabilities(self) -> dict:
     @property
     def default_capabilities(self) -> dict:
         return DesiredCapabilities.SAFARI.copy()
+
+    @property
+    def automatic_inspection(self) -> bool:
+        """:Returns: The option Automatic Inspection value """
+        return self._caps.get(self.AUTOMATIC_INSPECTION)
+
+    @automatic_inspection.setter
+    def automatic_inspection(self, value: bool):
+        """
+        Sets the option Automatic Inspection to value
+
+        :Args:
+         - value: boolean value
+
+        """
+        self.set_capability(self.AUTOMATIC_INSPECTION, value)
+
+    @property
+    def automatic_profiling(self) -> bool:
+        """:Returns: The options Automatic Profiling value """
+        return self._caps.get(self.AUTOMATIC_PROFILING)
+
+    @automatic_profiling.setter
+    def automatic_profiling(self, value: bool):
+        """
+        Sets the option Automatic Profiling to value
+
+        :Args:
+         - value: boolean value
+
+        """
+        self.set_capability(self.AUTOMATIC_PROFILING, value)
+
+    @property
+    def use_technology_preview(self) -> bool:
+        """:Returns: whether BROWSER_NAME is equal to Safari Technology Preview"""
+        return self._caps.get('browserName') == self.SAFARI_TECH_PREVIEW
+
+    @use_technology_preview.setter
+    def use_technology_preview(self, value: bool):
+        """
+        Sets browser name to Safari Technology Preview if value else to safari.
+
+        :Args:
+         - value: boolean value
+
+        """
+        self.set_capability('browserName', self.SAFARI_TECH_PREVIEW if value else 'safari')
diff --git a/py/test/unit/selenium/webdriver/safari/safari_options_tests.py b/py/test/unit/selenium/webdriver/safari/safari_options_tests.py
@@ -55,3 +55,27 @@ def test_starts_with_default_capabilities(options):
 def test_is_a_baseoptions(options):
     from selenium.webdriver.common.options import BaseOptions
     assert isinstance(options, BaseOptions)
+
+
+def test_can_set_automatic_inspection(options):
+    options.automatic_inspection = True
+    assert options.automatic_inspection is True
+    assert options._caps.get(Options.AUTOMATIC_INSPECTION) is True
+
+
+def test_can_set_automatic_profiling(options):
+    options.automatic_profiling = True
+    assert options.automatic_profiling is True
+    assert options._caps.get(Options.AUTOMATIC_PROFILING) is True
+
+
+def test_setting_technology_preview_changes_browser_name(options):
+    from selenium.webdriver import DesiredCapabilities
+    BROWSER_NAME = 'browserName'
+    assert options._caps.get(BROWSER_NAME) == DesiredCapabilities.SAFARI[BROWSER_NAME]
+
+    options.use_technology_preview = True
+    assert options._caps.get(BROWSER_NAME) == options.SAFARI_TECH_PREVIEW
+
+    options.use_technology_preview = False
+    assert options._caps.get(BROWSER_NAME) == DesiredCapabilities.SAFARI[BROWSER_NAME]
