Migrate python tests to pytest with Tox

Author: davehunt

.gitignore

@@ -45,6 +45,8 @@ java/client/build/
 java/client/log.txt
 java/client/iedriver.log
 java/server/build/
+__pycache__
+.tox
 *.pyc
 dist/
 py/selenium/webdriver/firefox/amd64/
@@ -71,6 +73,7 @@ ipch/
 /iedriver.log
 /phantomjsdriver.log
 geckodriver.log
+ghostdriver.log
 .tags
 .ruby-version
 GPATH

.travis.yml

@@ -1,9 +1,6 @@
 language: java
 sudo: required
-
-jdk:
-  - oraclejdk8
-
+jdk: oraclejdk8
 notifications:
   email: false
   irc:
@@ -13,53 +10,79 @@ notifications:
     on_failure: always
     use_notice: true
     skip_join: true
-
+env:
+  global:
+    - DISPLAY=:99.0
+  matrix:
+    - TASK=build
+    - TASK=rb TARGET=unit-test
+    - TASK=rb TARGET=chrome-test
+    - TASK=rb TARGET=firefox-test
+    - TASK=rb TARGET=phantomjs-test
+    - TASK=py TOXENV=py27-chrome
+    - TASK=py TOXENV=py27-firefox
+    - TASK=py TOXENV=py27-marionette
+    - TASK=py TOXENV=py27-phantomjs
+matrix:
+  fast_finish: true
+  allow_failures:
+    - env: TASK=rb TARGET=firefox-test
+    - env: TASK=rb TARGET=phantomjs-test
+    - env: TASK=py TOXENV=py27-chrome
+    - env: TASK=py TOXENV=py27-firefox
+    - env: TASK=py TOXENV=py27-marionette
 before_script:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
-
+  - sh -e /etc/init.d/xvfb start
 script:
-  - export CHROME_REVISION=`curl -s http://commondatastorage.googleapis.com/chromium-browser-snapshots/Linux_x64/LAST_CHANGE`
-  - export CHROMEDRIVER_VERSION=`curl -s http://chromedriver.storage.googleapis.com/LATEST_RELEASE`
-
-  - curl -L -O "http://commondatastorage.googleapis.com/chromium-browser-snapshots/Linux_x64/${CHROME_REVISION}/chrome-linux.zip"
-  - unzip chrome-linux.zip
-
-  - curl -L -O "http://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip"
-  - unzip chromedriver_linux64.zip
-
-  - chmod +x chromedriver
-  - mv chromedriver chrome-linux/chromedriver
-  - export PATH=$PATH:$PWD/chrome-linux
-
-  - export CHROME_BINARY=$PWD/chrome-linux/chrome
-  - export CHROMEDRIVER=$PWD/chrome-linux/chromedriver
-
-  - export PY_FILES_CHANGED=`git diff --name-only $TRAVIS_COMMIT_RANGE | grep ^py/`
-  - echo "PY_FILES_CHANGED: $PY_FILES_CHANGED"
-  - export RB_FILES_CHANGED=`git diff --name-only $TRAVIS_COMMIT_RANGE | grep ^rb/`
-  - echo "RB_FILES_CHANGED: $RB_FILES_CHANGED"
-
-  - ./go clean build
   - |
-    if [[ $PY_FILES_CHANGED == py/* ]]; then
-      pip install --user virtualenv
-      export PATH=$PATH:$HOME/.local/bin
-      ./go py_prep_for_install_release //py:phantomjs_test:run
-    else
-      echo 'no Python files changed - skipping Python test suite'
-    fi
+      if [[ $TARGET+$TOXENV == *"chrome"* ]]; then
+        sudo apt-get -y purge chromium-browser
+        export CHROME_REVISION=`curl -s http://commondatastorage.googleapis.com/chromium-browser-snapshots/Linux_x64/LAST_CHANGE`
+        curl -L -O "http://commondatastorage.googleapis.com/chromium-browser-snapshots/Linux_x64/${CHROME_REVISION}/chrome-linux.zip"
+        unzip chrome-linux.zip
+        sudo ln -sf $PWD/chrome-linux/chrome-wrapper /usr/local/bin/chrome
+        export CHROMEDRIVER_VERSION=`curl -s http://chromedriver.storage.googleapis.com/LATEST_RELEASE`
+        curl -L -O "http://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip"
+        unzip chromedriver_linux64.zip && chmod +x chromedriver && sudo mv chromedriver /usr/local/bin
+      fi
   - |
-    if [[ $RB_FILES_CHANGED == rb/* ]]; then
-      export PHANTOMJS_NAME=phantomjs-2.1.1-linux-x86_64
-      curl -L -O "https://cnpmjs.org/mirrors/phantomjs/${PHANTOMJS_NAME}.tar.bz2"
-      tar -xvjf $PHANTOMJS_NAME.tar.bz2
-      chmod +x $PHANTOMJS_NAME/bin/phantomjs
-      mv $PHANTOMJS_NAME/bin/phantomjs chrome-linux/phantomjs
-      export PHANTOMJS_BINARY=$PWD/chrome-linux/phantomjs
-      rvm install 2.2.3
-      rvm use 2.2.3
-      ./go //rb:unit-test //rb:firefox-test //rb:phantomjs-test //rb:chrome-test
-    else
-      echo 'no Ruby files changed - skipping Ruby test suite'
-    fi
+      if [[ $TOXENV == *"firefox"* ]]; then
+        sudo apt-get -y purge firefox
+        pip install --user mozdownload mozinstall
+        mozdownload --version 47.0.1 --destination firefox.tar.bz2
+        mozinstall firefox.tar.bz2
+      fi
+  - |
+      if [[ $TARGET == *"firefox"* ]] || [[ $TOXENV == *"marionette"* ]]; then
+        export GECKODRIVER_VERSION=v0.10.0
+        curl -L -o geckodriver.tar.gz https://github.com/mozilla/geckodriver/releases/download/${GECKODRIVER_VERSION}/geckodriver-${GECKODRIVER_VERSION}-linux64.tar.gz
+        gunzip -c geckodriver.tar.gz | tar xopf -
+        chmod +x geckodriver && sudo mv geckodriver /usr/local/bin
+        sudo apt-get -y purge firefox
+        pip install --user mozdownload mozinstall
+        mozdownload --version latest --destination firefox.tar.bz2
+        mozinstall firefox.tar.bz2
+      fi
+  - |
+      if [[ $TARGET+$TOXENV == *"phantomjs"* ]]; then
+        export PHANTOMJS_NAME=phantomjs-2.1.1-linux-x86_64
+        curl -L -O "https://cnpmjs.org/mirrors/phantomjs/${PHANTOMJS_NAME}.tar.bz2"
+        tar -xvjf $PHANTOMJS_NAME.tar.bz2
+        chmod +x $PHANTOMJS_NAME/bin/phantomjs
+      fi
+  - |
+      if [[ $TASK == "build" ]]; then
+        ./go build
+      fi
+  - |
+      if [[ $TASK == "py" ]]; then
+        ./go py_prep_for_install_release
+        pip install --user tox-travis
+        tox -- --verbose --instafail
+      fi
+  - |
+      if [[ $TASK == "rb" ]]; then
+        rvm install 2.2.3
+        rvm use 2.2.3
+        ./go //rb:$TARGET
+      fi

conftest.py

@@ -0,0 +1,78 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+import pytest
+
+from selenium import webdriver
+from selenium.webdriver import DesiredCapabilities
+
+drivers = (
+    'BlackBerry',
+    'Chrome',
+    'Edge',
+    'Firefox',
+    'Ie',
+    'Marionette',
+    'PhantomJS',
+    'Remote',
+    'Safari',
+)
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        '--driver',
+        action='append',
+        choices=drivers,
+        dest='drivers',
+        metavar='DRIVER',
+        help='driver to run tests against ({0})'.format(', '.join(drivers)))
+
+
+def pytest_ignore_collect(path, config):
+    _drivers = set(drivers).difference(config.getoption('drivers') or drivers)
+    return len([d for d in _drivers if d.lower() in str(path)]) > 0
+
+
+@pytest.yield_fixture(scope='function')
+def driver(request):
+    kwargs = {}
+
+    try:
+        driver_class = request.param
+    except AttributeError:
+        raise Exception('This test requires a --driver to be specified.')
+
+    skip = request.node.get_marker('ignore_{0}'.format(driver_class.lower()))
+    if skip is not None:
+        reason = skip.kwargs.get('reason') or skip.name
+        pytest.skip(reason)
+
+    if driver_class == 'BlackBerry':
+        kwargs.update({'device_password': 'password'})
+    if driver_class == 'Firefox':
+        kwargs.update({'capabilities': {'marionette': False}})
+    if driver_class == 'Marionette':
+        driver_class = 'Firefox'
+        kwargs.update({'capabilities': {'marionette': True}})
+    if driver_class == 'Remote':
+        # TODO start remote server
+        # request.getfuncargvalue('server')
+        kwargs.update({'desired_capabilities': DesiredCapabilities.FIREFOX})
+    driver = getattr(webdriver, driver_class)(**kwargs)
+    yield driver
+    driver.quit()

py/build.desc

@@ -10,7 +10,6 @@
 
 py_test(
   name = "firefox_test",
-  ff_specific_tests = [ "test/selenium/webdriver/firefox/ff_*_tests.py" ],
   deps = [ ":test_ff" ],
   resources = [
     { "//javascript/firefox-driver:webdriver_prefs" : "selenium/webdriver/firefox/webdriver_prefs.json" },
@@ -20,13 +19,11 @@ py_test(
 
 py_test(
   name = "marionette_test",
-  marionette_specific_tests = [ "test/selenium/webdriver/firefox/mn_*_tests.py" ],
   deps = [ ":test_marionette" ],
   browsers = [ "marionette" ])
 
 py_test(
   name = "phantomjs_test",
-  gd_specific_tests = [ "test/selenium/webdriver/phantomjs/*_tests.py" ],
   deps = [ ":test_phantomjs" ],
   browsers = [ "phantomjs" ])
 
@@ -37,7 +34,6 @@ py_test(
 
 py_test(
   name = "chrome_test",
-  chrome_specific_tests = [ "test/selenium/webdriver/chrome/*_tests.py" ],
   deps = [ ":test_chrome" ],
   browsers = [ "chrome" ])
 
@@ -53,7 +49,6 @@ py_test(
 
 py_test(
   name = "remote_firefox_test",
-  remote_firefox_specific_tests = [ "test/selenium/webdriver/remote/*_tests.py" ],
   deps = [ ":test_remote_firefox" ],
   browsers = [ "remote_firefox" ])
 
@@ -62,20 +57,8 @@ py_test(
   deps = [ ":test_safari" ],
   browsers = [ "safari" ])
 
-py_env(
-  name = "test_env",
-  packages = [
-    "third_party/py/py-1.4.31-py2.py3-none-any.whl",
-    "third_party/py/pytest-2.8.6-py2.py3-none-any.whl",
-  ],
-  dest = "build/python")
-
 py_test(
   name = "test",
-  common_tests = [
-    "test/selenium/webdriver/common/*_tests.py",
-    "test/selenium/webdriver/support/*_tests.py"
-  ],
   browsers = [
     "chrome",
     "ff",

py/conftest.py

@@ -0,0 +1,40 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+import pytest
+
+from test.selenium.webdriver.common.webserver import SimpleWebServer
+from test.selenium.webdriver.common.network import get_lan_ip
+
+
+@pytest.yield_fixture(autouse=True, scope='session')
+def webserver():
+    webserver = SimpleWebServer(host=get_lan_ip())
+    webserver.start()
+    yield webserver
+    webserver.stop()
+
+
+@pytest.fixture
+def pages(driver, webserver):
+    class Pages(object):
+        def url(self, name):
+            return webserver.where_is(name)
+
+        def load(self, name):
+            driver.get(self.url(name))
+    return Pages()