Installation

First, install with pip:

$ pip install onslaught

Running

Now run it against your projects:

$ onslaught /path/to/my/project

-or:

$ cd /path/to/my/project ; onslaught

This runs a series of “test phases” and then generates coverage reports. The output is concise; details for a test phase are only displayed if that phase fails.

(Onslaught never modifies the project directory, nor the current directory.)

Diagnosis

Each run of onslaught on a project will create a fresh directory at ~/.onslaught/results/${PROJECT_NAME}. If this directory exists when starting a new onslaught run, it is removed, so that the contents of this directory are always self-consistent and are specific to the last run.

This results directory has a few important subdirectories:

logs/

This contains a main.log that describes high level operation, including all subcommand arguments, so you can rerun any of these commands manually. It also contains a log for each subcommand run separately, prefixed with a decimal ordering, so you can always see the complete output of each command.

coverage/

The HTML generated coverage report. Open index.html with your browser. Notice you can sort the table by clicking column headers or using the keybindings (help found by clicking keyboard icon).

dist/

This contains the result of ./setup.py sdist, so you can interactively test the same source distribution that is used for installation and unit testing by onslaught.

venv/

This is the virtualenv used to test the package installation. You could interactively experiment with your project here.