Merge pull request #1614 from seleniumbase/refactoring-and-removing-old-drivers

Refactoring and removing deprecated drivers

Author: mdmintz

.travis.yml

@@ -21,9 +21,8 @@ install:
   - "sudo rm -f /etc/boto.cfg"
 before_script:
   - "flake8 --exclude=temp"
-  # - "wget https://chromedriver.storage.googleapis.com/2.44/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
-  # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.27.0/geckodriver-v0.27.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
-  # - "wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2 && tar -xvf ./phantomjs-2.1.1-linux-x86_64.tar.bz2 && export PATH=$PWD/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
+  # - "wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
+  # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.32.0/geckodriver-v0.32.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
   - "seleniumbase"
   - "seleniumbase install chromedriver"
   # - "seleniumbase install geckodriver"

Dockerfile

@@ -88,8 +88,8 @@ RUN cd /SeleniumBase && pip3 install .
 #=====================
 # Download WebDrivers
 #=====================
-RUN wget https://github.com/mozilla/geckodriver/releases/download/v0.31.0/geckodriver-v0.31.0-linux64.tar.gz
-RUN tar -xvzf geckodriver-v0.31.0-linux64.tar.gz
+RUN wget https://github.com/mozilla/geckodriver/releases/download/v0.32.0/geckodriver-v0.32.0-linux64.tar.gz
+RUN tar -xvzf geckodriver-v0.32.0-linux64.tar.gz
 RUN chmod +x geckodriver
 RUN mv geckodriver /usr/local/bin/
 RUN wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip

examples/pure_python.py renamed to examples/raw_call.py

@@ -1,5 +1,5 @@
-"""Running tests with pure "python" instead of directly calling "pytest".
-To run, use: "python pure_python.py".
+"""Calling tests with "python" instead of directly using "pytest".
+To run, use: "python raw_call.py".
 Two examples: pytest.main() and subprocess.call()."""
 import pytest
 import subprocess

help_docs/webdriver_installation.md

@@ -1,59 +1,50 @@
 <!-- SeleniumBase Docs -->
 
-## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Installing webdrivers
+## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Installing webdrivers
 
 To run web automation, you'll need webdrivers for each browser you plan on using.  With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
 
 You can also download drivers manually with these commands:
 
 ```bash
-sbase get chromedriver
-sbase get geckodriver
-sbase get edgedriver
+seleniumbase get chromedriver
+seleniumbase get geckodriver
+seleniumbase get edgedriver
 ```
 
-* To get the latest ``chromedriver`` when you don't have the latest Chrome, use:
+After running the commands above, web drivers will get downloaded into the ``seleniumbase/drivers/`` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
 
-```bash
-sbase get chromedriver latest
-```
+If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
 
-* You can also get a specific version of chromedriver for a specific version of Chrome:
+* You can also download specific versions of drivers. Examples:
 
 ```bash
-sbase get chromedriver 107.0.5304.62
-
 sbase get chromedriver 107
+sbase get chromedriver 107.0.5304.62
+sbase get chromedriver latest
+sbase get chromedriver latest-1
+sbase get edgedriver 106.0.1370.42
 ```
 
-* On Linux, you can run the following two commands (once you've installed SeleniumBase) to automatically upgrade your Chromedriver to match your version of Chrome: (``wget`` downloads the file, and ``pytest`` runs it.)
+(NOTE: ``sbase`` is a shortcut for ``seleniumbase``)
 
-```bash
-wget https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/examples/upgrade_chromedriver.py
-pytest upgrade_chromedriver.py -s
-```
+--------
 
-* If you run a test without the correct webdriver available, the driver will be downloaded automatically.
-
-If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for remote webdriver), you'll need to put the drivers on your System PATH. On macOS and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
+If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for ``remote`` webdriver), you'll need to put the drivers on your System PATH. On macOS and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
 
 Here's where you can go to manually get web drivers from the source:
 
 * For Chrome, get [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) on your System PATH.
 
-* For Firefox, get [Geckodriver](https://github.com/mozilla/geckodriver/releases) on your System PATH.
+* For Edge, get [Edge Driver (Microsoft WebDriver)](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) on your System PATH.
 
-* For Microsoft Edge, get [Edge Driver (Microsoft WebDriver)](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) on your System PATH.
+* For Firefox, get [Geckodriver](https://github.com/mozilla/geckodriver/releases) on your System PATH.
 
 * For Safari, get [Safari Driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md) on your System PATH.
 
-* For Opera, get [Opera Chromium Driver](https://github.com/operasoftware/operachromiumdriver/releases) on your System PATH..
-
-* For PhantomJS headless browser automation, get [PhantomJS](http://phantomjs.org/download.html) on your System PATH. (NOTE: <i>PhantomJS is no longer officially supported by SeleniumHQ</i>)
-
 **macOS shortcuts**:
 
-* You can also install drivers by using ``brew`` (aka ``homebrew``), but you'll need to install that first. [Brew installation instructions are here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md).
+* You can also install drivers by using ``brew`` (aka ``homebrew``):
 
 ```bash
 brew install --cask chromedriver
@@ -71,7 +62,7 @@ brew upgrade geckodriver
 
 **Linux shortcuts**:
 
-If you still need the web drivers, here are some scripts to help you get chromedriver and geckodriver on a Linux machine:
+If you still need the web drivers, here are some scripts to help you get ``chromedriver`` and ``geckodriver`` on a Linux machine:
 
 ```bash
 wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip
@@ -87,6 +78,6 @@ mv geckodriver /usr/local/bin/
 chmod +x /usr/local/bin/geckodriver
 ```
 
-* If you wish to verify that web drivers are working, **[follow these instructions](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md)**.
+To verify that web drivers are working, **[follow these instructions](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md)**.
 
-[<img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" title="SeleniumBase" width="280">](https://github.com/seleniumbase/SeleniumBase)
+[<img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" title="SeleniumBase" width="280">](https://github.com/seleniumbase/SeleniumBase)

integrations/linux/Linuxfile.sh

@@ -61,14 +61,6 @@ sudo apt-get install -y --force-yes libmysqlclient-dev
 sudo apt-get install -y --force-yes python-dev
 sudo apt-get install -y --force-yes python-MySQLdb
 
-# Install PhantomJS
-# cd ~
-# export PHANTOM_JS="phantomjs-2.1.1-linux-x86_64"
-# sudo wget https://bitbucket.org/ariya/phantomjs/downloads/$PHANTOM_JS.tar.bz2
-# sudo tar xvjf $PHANTOM_JS.tar.bz2
-# sudo mv -f $PHANTOM_JS /usr/local/share
-# sudo ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/local/bin
-
 # Install Chrome
 cd /tmp
 sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.8.5"
+__version__ = "4.8.6"

seleniumbase/behave/behave_sb.py

@@ -8,7 +8,7 @@
 behave -D agent="User Agent String" -D demo
 ****************************************************************
 -D browser=BROWSER  (The web browser to use. Default: "chrome".)
--D chrome  (Shortcut for "-D browser=chrome". On by default.)
+-D chrome  (Shortcut for "-D browser=chrome". Default.)
 -D edge  (Shortcut for "-D browser=edge".)
 -D firefox  (Shortcut for "-D browser=firefox".)
 -D safari  (Shortcut for "-D browser=safari".)

seleniumbase/core/browser_launcher.py

@@ -1633,44 +1633,6 @@ def get_remote_driver(
                 desired_capabilities=capabilities,
                 keep_alive=True,
             )
-    elif browser_name == constants.Browser.PHANTOM_JS:
-        if selenium4_or_newer:
-            message = (
-                "\n"
-                "PhantomJS is no longer available for Selenium 4!\n"
-                'Try using "--headless" mode with Chrome instead!'
-            )
-            raise Exception(message)
-        capabilities = webdriver.DesiredCapabilities.PHANTOMJS
-        for key in desired_caps.keys():
-            capabilities[key] = desired_caps[key]
-        with warnings.catch_warnings():
-            # Ignore "PhantomJS has been deprecated" UserWarning
-            warnings.simplefilter("ignore", category=UserWarning)
-            return webdriver.Remote(
-                command_executor=address,
-                desired_capabilities=capabilities,
-                keep_alive=True,
-            )
-    elif browser_name == constants.Browser.ANDROID:
-        capabilities = webdriver.DesiredCapabilities.ANDROID
-        if selenium4_or_newer:
-            remote_options = ArgOptions()
-            remote_options.set_capability("cloud:options", desired_caps)
-            return webdriver.Remote(
-                command_executor=address,
-                options=remote_options,
-                keep_alive=True,
-            )
-        else:
-            warnings.simplefilter("ignore", category=DeprecationWarning)
-            for key in desired_caps.keys():
-                capabilities[key] = desired_caps[key]
-            return webdriver.Remote(
-                command_executor=address,
-                desired_capabilities=capabilities,
-                keep_alive=True,
-            )
     elif browser_name == constants.Browser.IPHONE:
         capabilities = webdriver.DesiredCapabilities.IPHONE
         if selenium4_or_newer:
@@ -2412,18 +2374,6 @@ def get_local_driver(
         except Exception:
             # Opera support was dropped! Downgrade to Python 3.6 to use it!
             return webdriver.Opera()
-    elif browser_name == constants.Browser.PHANTOM_JS:
-        if selenium4_or_newer:
-            message = (
-                "\n"
-                "PhantomJS is no longer available for Selenium 4!\n"
-                'Try using "--headless" mode with Chrome instead!'
-            )
-            raise Exception(message)
-        with warnings.catch_warnings():
-            # Ignore "PhantomJS has been deprecated" UserWarning
-            warnings.simplefilter("ignore", category=UserWarning)
-            return webdriver.PhantomJS()
     elif browser_name == constants.Browser.GOOGLE_CHROME:
         try:
             chrome_options = _set_chrome_options(

seleniumbase/drivers/ReadMe.md

@@ -1,30 +1,27 @@
-### <img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase webdriver storage
+### <img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase webdriver storage
 
-* You need a different webdriver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.
+To run web automation, you'll need webdrivers for each browser you plan on using.  With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
+
+You can also download drivers manually with these commands:
 
 ```bash
 seleniumbase get chromedriver
 seleniumbase get geckodriver
 seleniumbase get edgedriver
-seleniumbase get iedriver
-seleniumbase get operadriver
 ```
 
-After running the commands above, web drivers will get downloaded into this folder. SeleniumBase will then use those drivers during tests if present. (The drivers don't come with SeleniumBase by default.)
-
-* If you have the latest version of Chrome installed, get the latest chromedriver (<i>otherwise it defaults to chromedriver 72.0.3626.69 for compatibility reasons</i>):
-
-```bash
-sbase get chromedriver latest
-```
+After running the commands above, web drivers will get downloaded into the ``seleniumbase/drivers/`` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
 
 If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
 
 * You can also download specific versions of drivers. Examples:
 
 ```bash
-sbase get chromedriver 101
-sbase get chromedriver 101.0.4951.41
+sbase get chromedriver 107
+sbase get chromedriver 107.0.5304.62
+sbase get chromedriver latest
 sbase get chromedriver latest-1
-sbase get edgedriver 101.0.1210.32
+sbase get edgedriver 106.0.1370.42
 ```
+
+(NOTE: ``sbase`` is a shortcut for ``seleniumbase``)

seleniumbase/fixtures/constants.py

@@ -310,9 +310,7 @@ class ValidBrowsers:
         "firefox",
         "ie",
         "opera",
-        "phantomjs",
         "safari",
-        "android",
         "iphone",
         "ipad",
         "remote",
@@ -325,9 +323,7 @@ class Browser:
     FIREFOX = "firefox"
     INTERNET_EXPLORER = "ie"
     OPERA = "opera"
-    PHANTOM_JS = "phantomjs"
     SAFARI = "safari"
-    ANDROID = "android"
     IPHONE = "iphone"
     IPAD = "ipad"
     REMOTE = "remote"
@@ -338,9 +334,7 @@ class Browser:
         "firefox": None,
         "ie": None,
         "opera": None,
-        "phantomjs": None,
         "safari": None,
-        "android": None,
         "iphone": None,
         "ipad": None,
         "remote": None,
@@ -352,9 +346,7 @@ class Browser:
         "firefox": None,
         "ie": None,
         "opera": None,
-        "phantomjs": None,
         "safari": None,
-        "android": None,
         "iphone": None,
         "ipad": None,
         "remote": None,