Use focal (20.04), latest geckodriver in the CI tests, drop sudo.

Ignore test failures due to incompatibility with the current alpha.

Author: gunesacar

.travis.yml

@@ -1,12 +1,20 @@
 sudo: false
 language: python
 os: linux
-dist: trusty
-group: deprecated-2017Q4
+dist: focal
+services:
+  - xvfb
+addons:
+  apt:
+    sources:
+      - sourceline: 'deb https://deb.torproject.org/torproject.org focal main'
+    packages:
+    - tor
+    - tor-geoipdb
 env:
   global:
     - DOWNLOAD_DIR=${HOME}/download
-    - STABLE=10.0
+    - STABLE=10.0.1
     - EXPERIMENTAL=10.5a1
     - TBB_DIST_URL=https://www.torproject.org/dist/torbrowser/
   matrix:
@@ -16,27 +24,22 @@ cache:
   - ${DOWNLOAD_DIR}
 matrix:
   include:
-    - python: "2.7"
+    - python: "3.6"
       env: VERSION_ARCH="${EXPERIMENTAL}/tor-browser-linux64-${EXPERIMENTAL}_en-US.tar.xz"
-    - python: "2.7"
+    - python: "3.6"
       env: VERSION_ARCH="${EXPERIMENTAL}/tor-browser-linux64-${EXPERIMENTAL}_zh-CN.tar.xz"
-    - python: "2.7"
+    - python: "3.6"
       env: VERSION_ARCH="${EXPERIMENTAL}/tor-browser-linux64-${EXPERIMENTAL}_ar.tar.xz"
-    - python: "2.7"
+    - python: "3.6"
       env: VERSION_ARCH="${STABLE}/tor-browser-linux64-${STABLE}_en-US.tar.xz"
-    - python: "2.7"
+    - python: "3.6"
       env: VERSION_ARCH="${STABLE}/tor-browser-linux64-${STABLE}_zh-CN.tar.xz"
-    - python: "2.7"
-      env: VERSION_ARCH="${STABLE}/tor-browser-linux64-${STABLE}_ar.tar.xz"
     - python: "3.6"
+      env: VERSION_ARCH="${STABLE}/tor-browser-linux64-${STABLE}_ar.tar.xz"
+    - python: "2.7"
       env: VERSION_ARCH="${STABLE}/tor-browser-linux64-${STABLE}_en-US.tar.xz"
   exclude:
     - env: TRAVIS_EXTRA_JOB_WORKAROUND=true
-before_install:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
-  - sudo apt-get -qq update
-  - sudo apt-get install -y tor
 install:
   - pip install -r requirements-travis.txt
   - pip install .

README.md

@@ -84,7 +84,7 @@ Check the [examples](https://github.com/webfp/tor-browser-selenium/tree/master/e
 ## Compatibility
 [Tested](https://travis-ci.org/webfp/tor-browser-selenium) with the following Tor Browser Bundle versions on Debian and Ubuntu:
 
-* 10.0
+* 10.0.1
 * 10.5a1
 
 Windows and macOS are not supported.
@@ -97,15 +97,17 @@ Solutions to potential issues:
 * Outdated (or incompatible) Python `selenium` package: This is the source of various obscure errors. Make sure you have `selenium` version **3.3** or above.
 * No display: When running on a cloud machine, follow the [headless.py example](https://github.com/webfp/tor-browser-selenium/blob/master/examples/headless.py#L10) to start a virtual display.
 * Outdated Tor Browser Bundle: Download and use a more recent TBB version.
-* Make sure you install geckodriver version v0.23.0 or newer.
+* Make sure you install the latest geckodriver version.
 * Port conflict with other (`Tor`) process: Pick a different SOCKS and controller port using `socks_port` argument.
-* Use `tbb_logfile_path` argument of TorBrowserDriver to debug obscure errors. This can help with problems due to missing display, missing libraries (e.g. when the LD_LIBRARY_PATH is not set correctly) or other errors that Tor Browser logs to standard output.
+* Use `tbb_logfile_path` argument of TorBrowserDriver to debug obscure errors. This can help with problems due to missing display, missing libraries (e.g. when the LD_LIBRARY_PATH is not set correctly) or other errors that Tor Browser logs to standard output/error.
 * When you use `LAUNCH_NEW_TBB_TOR` option and get the following [error message](https://github.com/webfp/tor-browser-selenium/issues/62) during the initialization, it's likely that Tor failed to bootstrap (due to network etc.):
 
  ```
  Can't load the profile. Profile Dir: /tmp/tmpO7i1lL/webdriver-py-profilecopy If you specified a log_file in the FirefoxBinary constructor, check it for details
  ```
 * `driver.get_cookies()` returns an empty list. This is due to Private Browsing Mode (PBM), which Selenium uses under the hood. See [#79](https://github.com/webfp/tor-browser-selenium/issues/79) for a possible solution.
+* WebGL is not supported in the headless mode started with `headless=True` due to Firefox bug [#1375585](https://bugzilla.mozilla.org/show_bug.cgi?id=1375585). To enable WebGL in a headless setting, use `pyvirtualdisplay` following the [headless.py](https://github.com/webfp/tor-browser-selenium/tree/master/examples/headless.py) example.
+* `set_security_level` doesn't work with the current alpha (10.5a1).
 
 ## Credits
 We greatly benefited from the following two projects:

tbselenium/common.py

@@ -51,3 +51,5 @@
 USE_STEM = 2  # use tor started with Stem
 
 TRAVIS = "CI" in environ and "TRAVIS" in environ
+# TODO: remove once the issue is resolved
+CI_ALPHA_TEST = "a" in environ.get('VERSION_ARCH', '').split("/")[0]

tbselenium/test/test_env.py

@@ -3,16 +3,20 @@
 from distutils.version import LooseVersion
 
 
+# https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html
+MINIMUM_SELENIUM_VERSION = "3.14"
+
+
 class EnvironmentTest(unittest.TestCase):
 
     def test_selenium_version(self):
         import selenium
         pkg_ver = selenium.__version__
-        self.assertGreaterEqual(LooseVersion(pkg_ver), LooseVersion("2.45"))
+        self.assertGreaterEqual(LooseVersion(pkg_ver), LooseVersion(MINIMUM_SELENIUM_VERSION))
 
     def test_geckodriver_version(self):
         """Make sure that the right geckodriver version is installed."""
-        GECKODRIVER_VERSION_STR = "geckodriver 0.24.0"
+        GECKODRIVER_VERSION_STR = "geckodriver 0.27.0"
         gd_v_out = check_output(["geckodriver", "-V"]).decode("utf-8")
         self.assertIn(GECKODRIVER_VERSION_STR, gd_v_out.split("\n")[0])
 

tbselenium/test/test_set_security_level.py

@@ -1,9 +1,10 @@
 import unittest
+import pytest
 from selenium.common.exceptions import NoSuchElementException, TimeoutException
 from selenium.webdriver.common.by import By
 from tbselenium.test.fixtures import TBDriverFixture
 from tbselenium.test import TBB_PATH
-from tbselenium.common import CHECK_TPO_URL
+from tbselenium.common import CHECK_TPO_URL, CI_ALPHA_TEST
 from tbselenium.utils import set_security_level
 from tbselenium.utils import SECURITY_HIGH, SECURITY_MEDIUM, SECURITY_LOW
 
@@ -33,6 +34,9 @@ def test_set_security_medium(self):
             except (NoSuchElementException, TimeoutException):
                 pass
 
+    @pytest.mark.skipif(
+        CI_ALPHA_TEST,
+        reason="Not compatible with the current alpha (10.5a1)")
     def test_set_security_high(self):
         with TBDriverFixture(TBB_PATH) as driver:
             set_security_level(driver, SECURITY_HIGH)

travis.sh

@@ -7,7 +7,7 @@ echo ${TBB_DIST_URL}/${VERSION_ARCH}
 tar -xf ${DOWNLOAD_DIR}/$TARBALL -C $HOME
 echo `which curl`
 
-geckodriver_url="https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-linux64.tar.gz"
+geckodriver_url="https://github.com/mozilla/geckodriver/releases/download/v0.27.0/geckodriver-v0.27.0-linux64.tar.gz"
 geckodriver_tarball=`basename ${geckodriver_url}`
 echo $geckodriver_tarball
 wget -P ${DOWNLOAD_DIR} $geckodriver_url