Running Fabric’s Tests

Fabric is maintained with 100% passing tests. Where possible, patches should include tests covering the changes, making things far easier to verify & merge.

When developing on Fabric, it works best to establish a virtualenv to install the dependencies in isolation for running tests.

First-time Setup

  • Fork the repository on GitHub
  • Clone your new fork (e.g. git clone git@github.com:<your_username>/fabric.git)
  • cd fabric
  • virtualenv env
  • . env/bin/activate
  • pip install -r requirements.txt
  • python setup.py develop

Running Tests

Once your virtualenv is activated (. env/bin/activate) & you have the latest requirements, running tests is just:

nosetests tests/

You should always run tests on master (or the release branch you’re working with) to ensure they’re passing before working on your own changes/tests.

Alternatively, if you’ve run python setup.py develop on your Fabric clone, you can also run:

fab test

This adds additional flags which enable running doctests & adds nice coloration.