[py]: Deprecate non W3C capability implicit conversion

symonk · symonk · commit 6f77a1e4630d · 2022-08-31T20:15:26.000+01:00
diff --git a/py/selenium/webdriver/remote/webdriver.py b/py/selenium/webdriver/remote/webdriver.py
@@ -75,7 +75,6 @@
     'platform': 'platformName'
 }
 
-
 cdp = None
 
 
@@ -104,7 +103,11 @@ def _make_w3c_caps(caps):
         caps['proxy']['proxyType'] = caps['proxy']['proxyType'].lower()
     for k, v in caps.items():
         if v and k in _OSS_W3C_CONVERSION:
-            always_match[_OSS_W3C_CONVERSION[k]] = v.lower() if k == 'platform' else v
+            # Todo: Remove in 4.7.0 (Deprecated in 4.5.0)
+            w3c_equivalent = _OSS_W3C_CONVERSION[k]
+            warnings.warn(f"{k} is not a w3c capability.  use `{w3c_equivalent}` instead.  This will no longer be"
+                          f" converted in 4.7.0", DeprecationWarning, stacklevel=2)
+            always_match[w3c_equivalent] = v.lower() if k == 'platform' else v
         if k in _W3C_CAPABILITY_NAMES or ':' in k:
             always_match[k] = v
     if profile:
@@ -1191,7 +1194,8 @@ def _get_cdp_details(self):
         http = urllib3.PoolManager()
         _firefox = False
         if self.caps.get("browserName") == "chrome":
-            debugger_address = self.caps.get(f"{self.vendor_prefix}:{self.caps.get('browserName')}Options").get("debuggerAddress")
+            debugger_address = self.caps.get(f"{self.vendor_prefix}:{self.caps.get('browserName')}Options").get(
+                "debuggerAddress")
         else:
             _firefox = True
             debugger_address = self.caps.get("moz:debuggerAddress")
diff --git a/py/test/unit/selenium/webdriver/remote/new_session_tests.py b/py/test/unit/selenium/webdriver/remote/new_session_tests.py
@@ -22,9 +22,9 @@
 import pytest
 
 from selenium.webdriver import DesiredCapabilities
+from selenium.webdriver.remote import webdriver
 from selenium.webdriver.remote.command import Command
 from selenium.webdriver.remote.webdriver import WebDriver
-from selenium.webdriver.remote import webdriver
 
 
 def test_converts_oss_capabilities_to_w3c(mocker):
@@ -36,6 +36,17 @@ def test_converts_oss_capabilities_to_w3c(mocker):
     mock.assert_called_with(Command.NEW_SESSION, expected_params)
 
 
+@pytest.mark.parametrize("oss_name, val, w3c_name", (
+    ('acceptSslCerts', True, 'acceptInsecureCerts'),
+    ("version", '11', "browserVersion"),
+    ("platform", 'windows', 'platformName')))
+def test_non_compliant_w3c_caps_is_deprecated(oss_name, val, w3c_name):
+    from selenium.webdriver.remote.webdriver import _make_w3c_caps
+    msg = f"{oss_name} is not a w3c capability.  use `{w3c_name}` instead.  This will no longer be converted in 4.7.0"
+    with pytest.warns(DeprecationWarning, match=msg):
+        _ = _make_w3c_caps({oss_name: val})
+
+
 def test_converts_proxy_type_value_to_lowercase_for_w3c(mocker):
     mock = mocker.patch('selenium.webdriver.remote.webdriver.WebDriver.execute')
     oss_caps = {'proxy': {'proxyType': 'MANUAL', 'httpProxy': 'foo'}}
