Thank you for checking out Mozilla's Webmaker test suite! Mozilla and the Web QA team are grateful for the help and hard work of many contributors like yourself. The following contributors have submitted pull requests to webmaker-tests:

https://github.com/mozilla/webmaker-tests/contributors

We love working with contributors to improve the Selenium test coverage for webmaker-tests but it does require a few skills. You will need to be familiar with Python, Selenium, and have a working knowledge of GitHub.

If you are comfortable with Python, it's worth having a look at the Selenium framework to understand the basic concepts of browser-based testing and the page objects pattern.

If you need to brush up on programming but are eager to start contributing immediately, please consider helping out by doing manual testing. You can help find bugs in Mozilla Firefox or find bugs in the Mozilla web sites tested by the Web QA team. We have many projects that would be thrilled to have your help!

To brush up on Python skills before engaging with us, Dive Into Python or [Codecademy][codcad]is an excellent resource. MIT also has lecture notes on Python available through their open courseware. The programming concepts you will need to know include functions, working with classes, and the basics of object-oriented programming.

While we take great pains to keep our documentation updated, the best source of information is those of us who work on the project. Don't be afraid to join us in irc.mozilla.org #mozwebqa to ask questions about our Selenium tests. Mozilla also hosts the #mozillians chat room to answer your general questions about contributing to Mozilla.

This repository contains Selenium tests used to test https://www.webmaker.org/

Mozilla maintains a guide to running Automated tests on our QMO website:

https://quality.mozilla.org/docs/webqa/running-webqa-automated-tests/

This wiki page has some advanced instructions specific to Windows:

https://wiki.mozilla.org/QA_SoftVision_Team/WebQA_Automation

###You will need to install the following:

If you have cloned this project already then you can skip this! GitHub has excellent guides for Windows, MacOSX, and Linux.

Before you will be able to run these tests you will need to have [Python 2.6.8+][Python] installed. [Python]: http://www.python.org/download/releases/2.6.8/

####Virtualenv and Virtualenvwrapper (Optional/Intermediate level) While most of us have had some experience using virtual machines, virtualenv is something else entirely. It's used to keep libraries that you install from clashing and messing up your local environment. After installing virtualenv, installing virtualenvwrapper will give you some nice commands to use with virtualenvwrapper. virtualenv will allow you to install Python modules and run your tests in a sandboxed environment.

note

This is not necessary but is really helpful if you are working on multiple Python projects that use different versions of modules.

Run

easy_install pip

followed by

sudo pip install -r requirements.txt

Be sure to retrieve and initialize the git submodules:

git submodule update --init

note

If you are running on Ubuntu/Debian you will need to do following first

sudo apt-get install python-setuptools

to install the required Python libraries.

Some of the tests in webmaker-tests require accounts for https://www.webmaker.org. You may either use or existing persona account (this is not recommended as data may be altered) or create a new account using a service like 10minutemail.com.

Copy webmaker-tests/credentials.yaml to a location outside of webmaker-tests and update the 'default' user in credentials.yaml with those credentials.

Before each test run, clean up the repo: find . ( -name 'results*' -or -name '*.pyc' ) -print0 | xargs -0 rm -Rf

Note: If you are running tests on a Mac, run: find . -name 'results*' -or -name '*.pyc' -print0 | xargs -0 rm -Rf

To run tests locally it is as simple as calling py.test with several flags. To run testcases that do not modify or delete data:

py.test --driver=firefox --baseurl=http://webmaker.mofostaging.net --credentials=/full/path/to/credentials.yaml .

Output

Output of a test run should look something like this:

============================= test session starts ==============================
collected 15 items 

tests/test_about_page.py ..
tests/test_account.py ..
tests/test_profile.py ...x.x
tests/test_search.py ...
==================== 13 passed, 2 xpassed in 172.03 seconds ====================

Note "~" will not resolve to the home directory when used in the py.test command line.

Some options for py.test are pre-specified by the file webmaker-tests/mozwebqa.cfg

The mozwebqa plugin has advanced command line options for reporting and using browsers. See the documentation on [davehunt's pytest mozwebqa github][pymozwebqa]. [pymozwebqa]: https://github.com/davehunt/pytest-mozwebqa

Troubleshooting

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

If you want to get involved and add more tests, then there's just a few things we'd like to ask you to do:

1. Use the template files for all new tests and page objects
2. Follow our simple style guide
3. Fork this project with your own GitHub account
4. Make sure all tests are passing, and submit a pull request with your changes
5. Always feel free to reach out to us and ask questions. We'll do our best to help get you started and unstuck

This software is licensed under the MPL 2.0:

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.