Merge pull request #791 from seleniumbase/simplified-cli

Add shortcuts for selecting the browser type

Author: mdmintz

README.md

@@ -361,6 +361,11 @@ The code above will leave your browser window open in case there's a failure. (i
 
 ```bash
 --browser=BROWSER  # (The web browser to use. Default: "chrome".)
+--chrome  # (Shortcut for "--browser=chrome". On by default.)
+--edge  # (Shortcut for "--browser=edge".)
+--firefox  # (Shortcut for "--browser=firefox".)
+--opera  # (Shortcut for "--browser=opera".)
+--safari  # (Shortcut for "--browser=safari".)
 --cap-file=FILE  # (The web browser's desired capabilities to use.)
 --cap-string=STRING  # (The web browser's desired capabilities to use.)
 --settings-file=FILE  # (Override default SeleniumBase settings.)

examples/pytest.ini

@@ -0,0 +1,45 @@
+[pytest]
+
+# Let console output be seen. Don't override the pytest plugin.
+addopts = --capture=no --ignore conftest.py -p no:cacheprovider
+
+# Ignore warnings such as DeprecationWarning and PytestUnknownMarkWarning
+filterwarnings =
+    ignore::pytest.PytestWarning
+    ignore:.*U.*mode is deprecated:DeprecationWarning
+
+# Configure the junit_family option explicitly:
+junit_family = legacy
+
+# Set pytest discovery rules:
+# (Most of the rules here are similar to the default rules.)
+# (unittest.TestCase rules override the rules here for classes and functions.)
+python_files = test_*.py *_test.py *_tests.py *_suite.py
+python_classes = Test* *Test* *Test *Tests *Suite
+python_functions = test_*
+
+# Here are some common pytest markers:
+# (Some are used in the example tests.)
+# (pytest v4.5.0 and newer requires marker registration to prevent warnings.)
+# (Future versions of pytest may turn those marker warnings into errors.)
+markers =
+    marker1: custom marker
+    marker2: custom marker
+    marker3: custom marker
+    marker_test_suite: custom marker
+    expected_failure: custom marker
+    local: custom marker
+    remote: custom marker
+    offline: custom marker
+    develop: custom marker
+    qa: custom marker
+    ci: custom marker
+    e2e: custom marker
+    ready: custom marker
+    smoke: custom marker
+    deploy: custom marker
+    active: custom marker
+    master: custom marker
+    release: custom marker
+    staging: custom marker
+    production: custom marker

examples/test_hack_search.py

@@ -17,8 +17,10 @@ def test_hack_search(self):
         self.highlight('[value="Bing Search"]')
         self.click('[value="Bing Search"]')
         self.highlight("h1.b_logo")
-        self.js_click('a[href*="github.com/seleniumbase/SeleniumBase"]')
+        self.highlight_click('a[href*="github.com/seleniumbase/SeleniumBase"]')
         self.assert_element('[href="/seleniumbase/SeleniumBase"]')
         self.assert_true("seleniumbase/SeleniumBase" in self.get_current_url())
         self.click('a[title="examples"]')
-        self.assert_text('examples', 'strong.final-path')
+        self.assert_text("examples", "strong.final-path")
+        self.highlight_click('[title="test_hack_search.py"]')
+        self.assert_text("test_hack_search.py", "strong.final-path")

help_docs/customizing_test_runs.md

@@ -91,6 +91,11 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 
 ```bash
 --browser=BROWSER  # (The web browser to use. Default: "chrome".)
+--chrome  # (Shortcut for "--browser=chrome". On by default.)
+--edge  # (Shortcut for "--browser=edge".)
+--firefox  # (Shortcut for "--browser=firefox".)
+--opera  # (Shortcut for "--browser=opera".)
+--safari  # (Shortcut for "--browser=safari".)
 --cap-file=FILE  # (The web browser's desired capabilities to use.)
 --cap-string=STRING  # (The web browser's desired capabilities to use.)
 --settings-file=FILE  # (Override default SeleniumBase settings.)

requirements.txt

@@ -1,8 +1,9 @@
-pip>=20.3.3
+pip>=20.3.4;python_version<"3.6"
+pip>=21.0;python_version>="3.6"
 packaging>=20.8
 setuptools>=44.1.1;python_version<"3.5"
 setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"
-setuptools>=51.3.3;python_version>="3.6"
+setuptools>=52.0.0;python_version>="3.6"
 setuptools-scm>=5.0.1
 wheel>=0.36.2
 attrs>=20.3.0
@@ -57,7 +58,7 @@ pygments==2.7.4;python_version>="3.5"
 traitlets==4.3.3;python_version<"3.7"
 traitlets==5.0.5;python_version>="3.7"
 prompt-toolkit==1.0.18;python_version<"3.6"
-prompt-toolkit==3.0.11;python_version>="3.6"
+prompt-toolkit==3.0.13;python_version>="3.6"
 ipython==5.10.0;python_version<"3.5"
 ipython==6.5.0;python_version>="3.5" and python_version<"3.6"
 ipython==7.16.1;python_version>="3.6" and python_version<"3.7"
@@ -77,7 +78,7 @@ toml==0.10.2
 Pillow==6.2.2;python_version<"3.5"
 Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"
 Pillow==8.1.0;python_version>="3.6"
-rich==9.8.2;python_version>="3.6" and python_version<"4.0"
+rich==9.9.0;python_version>="3.6" and python_version<"4.0"
 zipp==1.2.0;python_version<"3.6"
 zipp==3.4.0;python_version>="3.6"
 flake8==3.7.9;python_version<"3.5"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.52.6"
+__version__ = "1.53.0"

seleniumbase/console_scripts/run.py

@@ -65,16 +65,16 @@ def show_basic_usage():
     sc += ("\n")
     sc += ("COMMANDS:\n")
     sc += ("      install         [DRIVER] [OPTIONS]\n")
-    sc += ("      mkdir           [DIRECTORY]\n")
-    sc += ("      mkfile          [FILE.py]\n")
+    sc += ("      mkdir           [DIRECTORY] [OPTIONS]\n")
+    sc += ("      mkfile          [FILE.py] [OPTIONS]\n")
     sc += ("      options         (List common pytest options)\n")
     sc += ("      print           [FILE] [OPTIONS]\n")
     sc += ("      translate       [SB_FILE.py] [LANG] [ACTION]\n")
     sc += ("      convert         [WEBDRIVER_UNITTEST_FILE.py]\n")
     sc += ("      extract-objects [SB_FILE.py]\n")
     sc += ("      inject-objects  [SB_FILE.py] [OPTIONS]\n")
     sc += ("      objectify       [SB_FILE.py] [OPTIONS]\n")
-    sc += ("      revert-objects  [SB_FILE.py]\n")
+    sc += ("      revert-objects  [SB_FILE.py] [OPTIONS]\n")
     sc += ("      encrypt         (OR: obfuscate)\n")
     sc += ("      decrypt         (OR: unobfuscate)\n")
     sc += ("      download server (Selenium Server JAR file)\n")
@@ -159,8 +159,8 @@ def show_mkfile_usage():
     print(sc)
     print("")
     print("  Usage:")
-    print("           seleniumbase mkfile [FILE.py]")
-    print("           OR:    sbase mkfile [FILE.py]")
+    print("           seleniumbase mkfile [FILE.py] [OPTIONS]")
+    print("           OR:    sbase mkfile [FILE.py] [OPTIONS]")
     print("  Example:")
     print("           sbase mkfile new_test.py")
     print("  Options:")

seleniumbase/fixtures/base_case.py

@@ -5969,7 +5969,13 @@ def __jquery_slow_scroll_to(self, selector, by=By.CSS_SELECTOR):
             """jQuery([document.documentElement, document.body]).animate({
             scrollTop: jQuery('%s').offset().top - 130}, %s);
             """ % (selector, scroll_time_ms))
-        self.safe_execute_script(scroll_script)
+        if js_utils.is_jquery_activated(self.driver):
+            self.execute_script(scroll_script)
+        else:
+            try:
+                self.safe_execute_script(scroll_script)
+            except Exception:
+                self.__slow_scroll_to_element(element)
         self.sleep(sleep_time)
 
     def __jquery_click(self, selector, by=By.CSS_SELECTOR):

seleniumbase/plugins/pytest_plugin.py

@@ -18,6 +18,11 @@ def pytest_addoption(parser):
     """
     This plugin adds the following command-line options to pytest:
     --browser=BROWSER  (The web browser to use. Default: "chrome".)
+    --chrome  (Shortcut for "--browser=chrome". On by default.)
+    --edge  (Shortcut for "--browser=edge".)
+    --firefox  (Shortcut for "--browser=firefox".)
+    --opera  (Shortcut for "--browser=opera".)
+    --safari  (Shortcut for "--browser=safari".)
     --settings-file=FILE  (Override default SeleniumBase settings.)
     --env=ENV  (Set the test env. Access with "self.env" in tests.)
     --data=DATA  (Extra test data. Access with "self.data" in tests.)
@@ -93,6 +98,31 @@ def pytest_addoption(parser):
                      help="""Specifies the web browser to use. Default: Chrome.
                           If you want to use Firefox, explicitly indicate that.
                           Example: (--browser=firefox)""")
+    parser.addoption('--chrome',
+                     action="store_true",
+                     dest='use_chrome',
+                     default=False,
+                     help="""Shortcut for --browser=chrome. On by default.)""")
+    parser.addoption('--edge',
+                     action="store_true",
+                     dest='use_edge',
+                     default=False,
+                     help="""Shortcut for --browser=edge.)""")
+    parser.addoption('--firefox',
+                     action="store_true",
+                     dest='use_firefox',
+                     default=False,
+                     help="""Shortcut for --browser=firefox.)""")
+    parser.addoption('--opera',
+                     action="store_true",
+                     dest='use_opera',
+                     default=False,
+                     help="""Shortcut for --browser=opera.)""")
+    parser.addoption('--safari',
+                     action="store_true",
+                     dest='use_safari',
+                     default=False,
+                     help="""Shortcut for --browser=safari.)""")
     parser.addoption('--with-selenium',
                      action="store_true",
                      dest='with_selenium',
@@ -503,20 +533,90 @@ def pytest_addoption(parser):
                      help="""Setting this overrides the default timeout
                           by the multiplier when waiting for page elements.
                           Unused when tests override the default value.""")
-    for arg in sys.argv:
+
+    sys_argv = sys.argv
+    sb_config._browser_shortcut = None
+
+    # SeleniumBase does not support pytest-timeout due to hanging browsers.
+    for arg in sys_argv:
         if "--timeout=" in arg:
             raise Exception(
                 "\n\n  Don't use --timeout=s from pytest-timeout! "
                 "\n  It's not thread-safe for WebDriver processes! "
                 "\n  Use --time-limit=s from SeleniumBase instead!\n")
 
-    if "--dashboard" in sys.argv:
-        arg_join = " ".join(sys.argv)
-        if ("-n" in sys.argv) or ("-n=" in arg_join):
+    # The SeleniumBase Dashboard does not yet support multi-threadeded tests.
+    if "--dashboard" in sys_argv:
+        arg_join = " ".join(sys_argv)
+        if ("-n" in sys_argv) or ("-n=" in arg_join):
             raise Exception(
                 "\n\n  Multi-threading is not yet supported using --dashboard"
                 "\n  (You can speed up tests using --reuse-session / --rs)\n")
 
+    # As a shortcut, you can use "--edge" instead of "--browser=edge", etc,
+    # but you can only specify one default browser for tests. (Default: chrome)
+    browser_changes = 0
+    browser_set = None
+    browser_list = []
+    if "--browser=chrome" in sys_argv or "--browser chrome" in sys_argv:
+        browser_changes += 1
+        browser_set = "chrome"
+        browser_list.append("--browser=chrome")
+    if "--browser=edge" in sys_argv or "--browser edge" in sys_argv:
+        browser_changes += 1
+        browser_set = "edge"
+        browser_list.append("--browser=edge")
+    if "--browser=firefox" in sys_argv or "--browser firefox" in sys_argv:
+        browser_changes += 1
+        browser_set = "firefox"
+        browser_list.append("--browser=firefox")
+    if "--browser=opera" in sys_argv or "--browser opera" in sys_argv:
+        browser_changes += 1
+        browser_set = "opera"
+        browser_list.append("--browser=opera")
+    if "--browser=safari" in sys_argv or "--browser safari" in sys_argv:
+        browser_changes += 1
+        browser_set = "safari"
+        browser_list.append("--browser=safari")
+    if "--browser=ie" in sys_argv or "--browser ie" in sys_argv:
+        browser_changes += 1
+        browser_set = "ie"
+        browser_list.append("--browser=ie")
+    if "--browser=phantomjs" in sys_argv or "--browser phantomjs" in sys_argv:
+        browser_changes += 1
+        browser_set = "phantomjs"
+        browser_list.append("--browser=phantomjs")
+    if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
+        browser_changes += 1
+        browser_set = "remote"
+        browser_list.append("--browser=remote")
+    if "--chrome" in sys_argv and not browser_set == "chrome":
+        browser_changes += 1
+        sb_config._browser_shortcut = "chrome"
+        browser_list.append("--chrome")
+    if "--edge" in sys_argv and not browser_set == "edge":
+        browser_changes += 1
+        sb_config._browser_shortcut = "edge"
+        browser_list.append("--edge")
+    if "--firefox" in sys_argv and not browser_set == "firefox":
+        browser_changes += 1
+        sb_config._browser_shortcut = "firefox"
+        browser_list.append("--firefox")
+    if "--opera" in sys_argv and not browser_set == "opera":
+        browser_changes += 1
+        sb_config._browser_shortcut = "opera"
+        browser_list.append("--opera")
+    if "--safari" in sys_argv and not browser_set == "safari":
+        browser_changes += 1
+        sb_config._browser_shortcut = "safari"
+        browser_list.append("--safari")
+    if browser_changes > 1:
+        message = "\n\n  Too many browser types were entered!"
+        message += "\n  There were %s found: %s" % (
+            browser_changes, ", ".join(browser_list))
+        message += "\n  Please enter ONLY ONE and try again!\n"
+        raise Exception(message)
+
 
 def pytest_configure(config):
     """ This runs after command-line options have been parsed. """
@@ -527,6 +627,8 @@ def pytest_configure(config):
     sb_config.item_count_untested = 0
     sb_config.is_pytest = True
     sb_config.browser = config.getoption('browser')
+    if sb_config._browser_shortcut:
+        sb_config.browser = sb_config._browser_shortcut
     sb_config.data = config.getoption('data')
     sb_config.var1 = config.getoption('var1')
     sb_config.var2 = config.getoption('var2')

setup.py

@@ -102,11 +102,12 @@
     ],
     python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*',
     install_requires=[
-        'pip>=20.3.3',
+        'pip>=20.3.4;python_version<"3.6"',
+        'pip>=21.0;python_version>="3.6"',
         'packaging>=20.8',
         'setuptools>=44.1.1;python_version<"3.5"',
         'setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"',
-        'setuptools>=51.3.3;python_version>="3.6"',
+        'setuptools>=52.0.0;python_version>="3.6"',
         'setuptools-scm>=5.0.1',
         'wheel>=0.36.2',
         'attrs>=20.3.0',
@@ -162,7 +163,7 @@
         'traitlets==5.0.5;python_version>="3.7"',
         'ipython==5.10.0;python_version<"3.5"',
         'prompt-toolkit==1.0.18;python_version<"3.6"',
-        'prompt-toolkit==3.0.11;python_version>="3.6"',
+        'prompt-toolkit==3.0.13;python_version>="3.6"',
         'ipython==6.5.0;python_version>="3.5" and python_version<"3.6"',
         'ipython==7.16.1;python_version>="3.6" and python_version<"3.7"',
         'ipython==7.19.0;python_version>="3.7"',
@@ -181,7 +182,7 @@
         'Pillow==6.2.2;python_version<"3.5"',
         'Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"',
         'Pillow==8.1.0;python_version>="3.6"',
-        'rich==9.8.2;python_version>="3.6" and python_version<"4.0"',
+        'rich==9.9.0;python_version>="3.6" and python_version<"4.0"',
         'zipp==1.2.0;python_version<"3.6"',
         'zipp==3.4.0;python_version>="3.6"',
         'flake8==3.7.9;python_version<"3.5"',