How To Test Guide#

Note

You need to install dev tools first by running

pipenv install --dev

Test Style Guide#

We use pytest testing framework to test our code. We use coverage to provide test coverage report. Please RTFM.

Run Test#

Run the following command in project root directory:

pipenv run test

Note

All dataset will be downloaded to local disk and will not be removed after test. This speed up testing and is the desired behavior.

Generate Test Coverage Report#

Run the following command in project root directory:

pipenv run test-coverage

Todo

Add more test writing guide line.