Getting started

Here is a step by step guide in order to install and try Testplan in your local environment!

Supported Python Versions

Testplan is tested to work with Python 3.7 and 3.8, 3.10 and 3.11 so we recommend choosing one of those.

Install testplan

Testplan is not yet available from pypi.org but one can still install it from the latest github package. A link for our lates package can be obtained from: https://github.com/morganstanley/testplan/releases/tag/latest

Install from archive:

python3.7 -m pip install https://github.com/morganstanley/testplan/releases/download/latest/testplan-21.9.29-py3-none-any.whl

Run testplan

Our examples

There are some ready made examples demonstrating testplan functonality/features and can be found within the repo under examples directory.

On Ubuntu/MacOS/etc:

# See all the examples categories.
cd examples
ls

# Run an example demonstrating testplan assertions.
cd Assertions/Basic
./test_plan_basic.py

# Create a pdf report and open in automatically.
./test_plan.py --pdf report.pdf -b

On Windows:

# See all the examples categories.
cd examples
dir

# Run an example demonstrating testplan assertions.
cd Assertions\Basic
python test_plan_basic.py

# Create a pdf report and open in automatically.
python test_plan.py --pdf report.pdf -b

Also find all our downloadable examples here.

Working with the source

You will need a working python 3.7+ interrpreter preferably a venv, and for the interactive ui you need node installed. We are using doit as the taskrunner doit list can show all the commands.

git clone https://github.com/morganstanley/testplan.git
cd testplan

# install all dev requirements
pip install -r requirements-txt  # this install testplan in editable mode

#build the interactive UI (if you do not like it is opening a browserwindow remove the `-o`)
doit build_ui -o

Internal tests

To verify the correct setup process you can execute the internal unit/functional tests. Some tests may be skipped due to optional dependency packages (i.e sklearn used on ‘Data Science’ examples category).

doit test

Writing custom drivers

Testplan drivers are designed to be able to be inherited/extended and create new ones based on the user specific environment. Here is a section explaining how to create drivers for custom applications and services. You can contribute missing drivers or improvements to the existing ones by following the contribution process.