feat: Add missing platformVersion and browserName options (#925)

mykola-mokhnach · web-flow · commit d93a6caadb07 · 2023-10-13T07:27:15.000-07:00
diff --git a/appium/options/android/espresso/base.py b/appium/options/android/espresso/base.py
@@ -108,6 +108,7 @@
 from appium.options.common.locale_option import LocaleOption
 from appium.options.common.orientation_option import OrientationOption
 from appium.options.common.other_apps_option import OtherAppsOption
+from appium.options.common.platform_version_option import PlatformVersionOption
 from appium.options.common.skip_log_capture_option import SkipLogCaptureOption
 from appium.options.common.system_port_option import SystemPortOption
 from appium.options.common.udid_option import UdidOption
@@ -154,6 +155,7 @@ class EspressoOptions(
     EnforceAppInstallOption,
     LocaleScriptOption,
     AdbPortOption,
+    PlatformVersionOption,
     RemoteAdbHostOption,
     AdbExecTimeoutOption,
     ClearDeviceLogsOnStartOption,
diff --git a/appium/options/android/uiautomator2/base.py b/appium/options/android/uiautomator2/base.py
@@ -108,6 +108,7 @@
 from appium.options.common.locale_option import LocaleOption
 from appium.options.common.orientation_option import OrientationOption
 from appium.options.common.other_apps_option import OtherAppsOption
+from appium.options.common.platform_version_option import PlatformVersionOption
 from appium.options.common.skip_log_capture_option import SkipLogCaptureOption
 from appium.options.common.system_port_option import SystemPortOption
 from appium.options.common.udid_option import UdidOption
@@ -144,6 +145,7 @@ class UiAutomator2Options(
     SkipDeviceInitializationOption,
     AppPackageOption,
     AppActivityOption,
+    PlatformVersionOption,
     AppWaitActivityOption,
     AppWaitPackageOption,
     AppWaitDurationOption,
diff --git a/appium/options/common/base.py b/appium/options/common/base.py
@@ -21,6 +21,7 @@
 from selenium.webdriver.common.options import BaseOptions
 
 from .automation_name_option import AutomationNameOption
+from .browser_name_option import BROWSER_NAME, BrowserNameOption
 from .event_timings_option import EventTimingsOption
 from .full_reset_option import FullResetOption
 from .new_command_timeout_option import NewCommandTimeoutOption
@@ -34,6 +35,7 @@
 
 class AppiumOptions(
     BaseOptions,
+    BrowserNameOption,
     AutomationNameOption,
     EventTimingsOption,
     PrintPageSourceOnFindFailureOption,
@@ -45,7 +47,7 @@ class AppiumOptions(
     W3C_CAPABILITY_NAMES = frozenset(
         [
             'acceptInsecureCerts',
-            'browserName',
+            BROWSER_NAME,
             'browserVersion',
             PLATFORM_NAME,
             'pageLoadStrategy',
diff --git a/appium/options/common/browser_name_option.py b/appium/options/common/browser_name_option.py
@@ -0,0 +1,38 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from .supports_capabilities import SupportsCapabilities
+
+BROWSER_NAME = 'browserName'
+
+
+class BrowserNameOption(SupportsCapabilities):
+    @property
+    def browser_name(self) -> Optional[str]:
+        """
+        The name of the browser to run the test on.
+        """
+        return self.get_capability(BROWSER_NAME)
+
+    @browser_name.setter
+    def browser_name(self, value: str) -> None:
+        """
+        Set the name of the browser to run the test on.
+        """
+        self.set_capability(BROWSER_NAME, value)
diff --git a/appium/options/common/platform_version_option.py b/appium/options/common/platform_version_option.py
@@ -0,0 +1,40 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from .supports_capabilities import SupportsCapabilities
+
+PLATFORM_VERSION = 'platformVersion'
+
+
+class PlatformVersionOption(SupportsCapabilities):
+    @property
+    def platform_version(self) -> Optional[str]:
+        """
+        The platform version of an emulator or a real device.
+        This capability is used for device autodetection if udid is not provided.
+        """
+        return self.get_capability(PLATFORM_VERSION)
+
+    @platform_version.setter
+    def platform_version(self, value: str) -> None:
+        """
+        Set the platform version of an emulator or a real device.
+        This capability is used for device autodetection if udid is not provided.
+        """
+        self.set_capability(PLATFORM_VERSION, value)
diff --git a/appium/options/ios/xcuitest/base.py b/appium/options/ios/xcuitest/base.py
@@ -30,6 +30,7 @@
 from appium.options.common.locale_option import LocaleOption
 from appium.options.common.orientation_option import OrientationOption
 from appium.options.common.other_apps_option import OtherAppsOption
+from appium.options.common.platform_version_option import PlatformVersionOption
 from appium.options.common.skip_log_capture_option import SkipLogCaptureOption
 from appium.options.common.udid_option import UdidOption
 
@@ -120,6 +121,7 @@ class XCUITestOptions(
     AppiumOptions,
     AppOption,
     BundleIdOption,
+    PlatformVersionOption,
     ClearSystemFilesOption,
     OrientationOption,
     UdidOption,
