15. End-to-End Tests for Socorro

15.1. Summary

This directory holds Socorro client-based end-to-end tests, which is why they’re different than the rest of the code in this repository.

To review the specific-Python packages the tests use, please review requirements/requirements.txt.

15.2. Clone the repository

If you have cloned this project already, then you can skip this; otherwise you’ll need to clone this repo using Git. If you do not know how to clone a GitHub repository, check out this help page from GitHub.

If you think you would like to contribute to the tests by writing or maintaining them in the future, it would be a good idea to create a fork of this repository first, and then clone that. GitHub also has great instructions for forking a repository.

15.3. Set up and run Socorro tests

Review the documentation for pytest-selenium and decide which browser environment you wish to target.

An additional constraint for Firefox users: since version 48, Firefox now uses GeckoDriver and the Marionette-backed WebDriver. You will need to make sure the geckodriver binary (available here) is in your path. For best results it’s recommended that you use the latest stable Firefox version and the latest geckodriver release.

If you have multiple versions of Firefox installed, you can specify which to use by modifying your PATH variable so that the directory containing the target binary is prioritized.

15.3.1. Running the tests on stage

$ docker build -t socorro-tests .
$ docker run -it socorro-tests

15.3.2. Running tests against localhost

$ docker build -t socorro-tests .
$ docker run -it socorro-tests pytest --base-url "http://localhost:8000"

15.3.3. Running tests against production

$ docker build -t socorro-tests .
$ docker run -it socorro-tests pytest --base-url "https://crash-stats.mozilla.com"

15.3.4. Running tests on Sauce Labs

To use Sauce Labs instead of an instance of Firefox running locally, do the following:

Create a text file called .saucelabs and put it in your home directory. Get a username and key for Sauce Labs and then add the following details to the .saucelabs file:

[credentials]
username = <SauceLabs user name>
key = <SauceLabs API key>

Then you can run the tests against Sauce Labs using Docker by passing the --driver SauceLabs argument as shown below. The --mount argument is important, as it allows your .saucelabs file to be accessed by the Docker container:

$ docker build -t socorro-tests .
$ docker run -it \
  --mount type=bind,source=$HOME/.saucelabs,destination=/src/.saucelabs,readonly \
  socorro-tests pytest --driver SauceLabs

To run them against different environments, such as production, change the last command, like so:

$ docker run -it \
  --mount type=bind,source=$HOME/.saucelabs,destination=/src/.saucelabs,readonly \
  socorro-tests pytest --base-url "https://crash-stats.mozilla.com" --driver SauceLabs

15.3.5. Running tests locally

Install Pipenv, and then using it, create a virtual environment with all the necessary Python package dependencies. Note that Python 2 is currently required for these tests.

$ pip install pipenv
$ pipenv --two install -r requirements.txt

Then, you can run the tests using Pipenv:

$ pipenv run pytest

15.3.6. Running specific tests

You can run tests in a given file:

$ docker run -it socorro-tests pytest tests/test_search.py

You can run tests that match a specific name:

$ docker run -it socorro-tests pytest tests/test_search::TestSuperSearch::test_search_for_unrealistic_data

Output

Output of a test run should look something like this:

======================== test session starts =========================
platform linux2 -- Python 2.7.3 -- pytest-2.2.4
collected 73 items

tests/test_crash_reports.py .........................xx..........x.xx....x.
tests/test_layout.py xx
tests/test_search.py .........x.x.
tests/test_smoke_tests.py ...........

============== 63 passed, 10 xfailed in 970.27 seconds ===============

The pytest plugin that we use for running tests has a number of advanced command-line options available. To see the options available, run pytest --help. The full documentation for the plugin can be found here.

Troubleshooting

If the test run hangs with Firefox open but no URL gets entered in the address box, some combinations of the Firefox version, and the Python Selenium bindings version may not be compatible. Upgrading each of them to latest often fixes it.