DC/OS test harness.
A shakedown is a period of testing or a trial journey undergone by a ship, aircraft or other craft and its crew before being declared operational. — https://en.wikipedia.org/wiki/Shakedown_(testing)
Shakedown requires Python 3.4+.
The recommended Shakedown installation method is via the PyPI Python Package Index repository at https://pypi.python.org/pypi/dcos-shakedown. To install the latest version and all required modules:
pip install dcos-shakedown
To pull and install from our master
branch on GitHub:
git clone github.com:mesosphere/shakedown.git
cd shakedown
pip install -e .
If you'd like to isolate your Shakedown Python environment, you can do so using the virtualenv tool. To create a new virtual environment in $HOME/shakedown
:
pip install virtualenv
virtualenv $HOME/shakedown
source $HOME/shakedown/bin/activate
pip install dcos-shakedown
This virtual environment can then be activated in new terminal sessions with:
source $HOME/shakedown/bin/activate
shakedown --dcos-url=http://dcos.example.com [options] [path_to_tests]
--dcos-url
is required.- tests within the current working directory will be auto-discovered unless specified.
- arguments can be stored in a
~/.shakedown
TOML file (command-line takes precedence) shakedown --help
is your friend.
Shakedown is a testing tool as well as a library. Many helper functions are available via from shakedown import *
in your tests. See the API documentation for more information.
Shakedown is licensed under the Apache License, Version 2.0. For additional information, see the LICENSE file included at the root of this repository.
Please report issues and submit feature requests for Shakedown by creating an issue in the DC/OS JIRA with the "Shakedown" component.
See the CONTRIBUTING file in the root of this repository.