Merge pull request #647 from seleniumbase/make-edge-work-again

Bring back support for Microsoft Edge

Author: mdmintz

README.md

@@ -292,7 +292,7 @@ Here are some useful command-line options that come with ``pytest``:
 -s  # See print statements. (Should be on by default with pytest.ini present.)
 --junit-xml=report.xml  # Creates a junit-xml report after tests finish.
 --pdb  # If a test fails, pause run and enter debug mode. (Don't use with CI!)
--m=MARKER  # Only run tests that are marked with the specified pytest marker.
+-m=MARKER  # Run tests with the specified pytest marker.
 ```
 
 SeleniumBase provides additional ``pytest`` command-line options for tests:

help_docs/customizing_test_runs.md

@@ -87,7 +87,7 @@ Here are some useful command-line options that come with ``pytest``:
 -s  # See print statements. (Should be on by default with pytest.ini present.)
 --junit-xml=report.xml  # Creates a junit-xml report after tests finish.
 --pdb  # If a test fails, pause run and enter debug mode. (Don't use with CI!)
--m=MARKER  # Only run tests that are marked with the specified pytest marker.
+-m=MARKER  # Run tests with the specified pytest marker.
 ```
 
 SeleniumBase provides additional ``pytest`` command-line options for tests:

requirements.txt

@@ -14,6 +14,7 @@ chardet==3.0.4
 urllib3==1.25.10
 requests==2.24.0
 selenium==3.141.0
+msedge-selenium-tools==3.141.2
 pluggy==0.13.1
 attrs>=19.3.0
 py==1.8.1;python_version<"3.5"

seleniumbase/console_scripts/run.py

@@ -456,28 +456,28 @@ def show_options():
     print('--slow  (Slow down the automation. Faster than using Demo Mode.)')
     print('--reuse-session / --rs  (Reuse the browser session between tests.)')
     print('--crumbs  (Delete all cookies between tests reusing a session.)')
-    print("--guest  (Enable Chrome's Guest mode.)")
+    print('--maximize  (Start tests with the web browser window maximized.)')
     print("--incognito  (Enable Chrome's Incognito mode.)")
-    print('-m MARKER  (Only run tests with the specified pytest marker.)')
+    print("--guest  (Enable Chrome's Guest mode.)")
+    print('-m MARKER  (Run tests with the specified pytest marker.)')
     print('-n NUM  (Multithread the tests using that many threads.)')
     print('-v  (Verbose mode. Print the full name of each test run.)')
+    print('--check-js  (Check for JavaScript errors after page loads.)')
+    print('--html=report.html  (Create a detailed pytest-html report.)')
     print("--agent=STRING  (Modify the web browser's User-Agent string.)")
     print('--mobile  (Use the mobile device emulator while running tests.)')
     print('--metrics=STRING  (Set mobile "CSSWidth,CSSHeight,PixelRatio".)')
-    print('--maximize  (Start tests with the web browser window maximized.)')
     print('--ad-block  (Block some types of display ads after page loads.)')
-    print('--check-js  (Check for JavaScript errors after page loads.)')
     print('--pdb  (Enter Debug Mode if a test fails. h: Help. c: Continue.')
     print('       interact: Interactive Mode. CTRL-D: Exit Interactive Mode.)')
-    print('--html=report.html  (Create a detailed pytest-html report.)')
     print('--archive-logs  (Archive old log files instead of deleting them.)')
     print('--disable-csp  (Disable the Content Security Policy of websites.)')
+    print('--save-screenshot  (Save a screenshot at the end of each test.)')
     print('--proxy=SERVER:PORT  (Set a proxy server:port combo for tests.)')
     print("--settings-file=FILE  (Override default SeleniumBase settings.)")
     print('--env=ENV  (Set the test env. Access with "self.env" in tests.)')
     print('--data=DATA  (Extra test data. Access with "self.data" in tests.)')
     print('--collect-only -q  (Show discovered tests without running them.)')
-    print('--save-screenshot  (Save a screenshot at the end of each test.)')
     print('-x  (Stop running tests after the first failure is reached.)')
     print("")
     line = 'For the full list of ' + c1 + 'command-line options' + cr

seleniumbase/console_scripts/sb_install.py

@@ -41,7 +41,7 @@
 LOCAL_PATH = "/usr/local/bin/"  # On Mac and Linux systems
 DEFAULT_CHROMEDRIVER_VERSION = "2.44"
 DEFAULT_GECKODRIVER_VERSION = "v0.26.0"
-DEFAULT_EDGEDRIVER_VERSION = "79.0.309.65"
+DEFAULT_EDGEDRIVER_VERSION = "84.0.522.52"
 DEFAULT_OPERADRIVER_VERSION = "v.81.0.4044.113"
 
 

seleniumbase/core/browser_launcher.py

@@ -234,8 +234,6 @@ def _set_chrome_options(
             chrome_options = _add_chrome_proxy_extension(
                 chrome_options, proxy_string, proxy_user, proxy_pass)
         chrome_options.add_argument('--proxy-server=%s' % proxy_string)
-    else:
-        chrome_options.add_argument("--no-proxy-server")
     if headless:
         if not proxy_auth:
             # Headless Chrome doesn't support extensions, which are
@@ -699,16 +697,54 @@ def get_local_driver(
                     sys.argv = sys_args  # Put back the original sys args
             return webdriver.Chrome(executable_path=LOCAL_EDGEDRIVER,
                                     options=chrome_options)
-        except Exception as e:
-            if headless:
-                raise Exception(e)
+        except Exception:
+            from msedge.selenium_tools import Edge, EdgeOptions
             if LOCAL_EDGEDRIVER and os.path.exists(LOCAL_EDGEDRIVER):
                 try:
                     make_driver_executable_if_not(LOCAL_EDGEDRIVER)
                 except Exception as e:
                     logging.debug("\nWarning: Could not make edgedriver"
                                   " executable: %s" % e)
-            return webdriver.Chrome(executable_path=LOCAL_EDGEDRIVER)
+            edge_options = EdgeOptions()
+            edge_options.use_chromium = True
+            edge_options.add_experimental_option(
+                "useAutomationExtension", False)
+            edge_options.add_experimental_option(
+                "excludeSwitches", ["enable-automation", "enable-logging"])
+            if guest_mode:
+                edge_options.add_argument("--guest")
+            if headless:
+                edge_options.add_argument("--headless")
+            if mobile_emulator:
+                emulator_settings = {}
+                device_metrics = {}
+                if type(device_width) is int and (
+                        type(device_height) is int and (
+                        type(device_pixel_ratio) is int)):
+                    device_metrics["width"] = device_width
+                    device_metrics["height"] = device_height
+                    device_metrics["pixelRatio"] = device_pixel_ratio
+                else:
+                    device_metrics["width"] = 411
+                    device_metrics["height"] = 731
+                    device_metrics["pixelRatio"] = 3
+                emulator_settings["deviceMetrics"] = device_metrics
+                if user_agent:
+                    emulator_settings["userAgent"] = user_agent
+                edge_options.add_experimental_option(
+                    "mobileEmulation", emulator_settings)
+                edge_options.add_argument("--enable-sync")
+            if proxy_string:
+                if proxy_auth:
+                    edge_options = _add_chrome_proxy_extension(
+                        edge_options, proxy_string, proxy_user, proxy_pass)
+                edge_options.add_argument('--proxy-server=%s' % proxy_string)
+            if user_agent:
+                edge_options.add_argument("--user-agent=%s" % user_agent)
+            capabilities = edge_options.to_capabilities()
+            capabilities["platform"] = ''
+            return Edge(
+                executable_path=LOCAL_EDGEDRIVER, capabilities=capabilities)
     elif browser_name == constants.Browser.SAFARI:
         arg_join = " ".join(sys.argv)
         if ("-n" in sys.argv) or ("-n=" in arg_join) or (arg_join == "-c"):

setup.py

@@ -54,7 +54,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.46.0',
+    version='1.46.1',
     description='Web Automation and Testing Framework - seleniumbase.io',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -106,6 +106,7 @@
         'urllib3==1.25.10',  # Must stay in sync with "requests"
         'requests==2.24.0',
         'selenium==3.141.0',
+        'msedge-selenium-tools==3.141.2',
         'pluggy==0.13.1',
         'attrs>=19.3.0',
         'py==1.8.1;python_version<"3.5"',