python-tuf/tests/repository_data/README.md
Vladimir Diaz 67af7a0da6
Add first draft of README for unit tests
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2017-12-14 11:57:59 -05:00

1.5 KiB

Unit and integration testing

Running the tests

The unit and integration tests can be executed by invoking tox from any path under the project directory.

$ tox

Or by invoking aggregate_tests.py from the tests directory.

$ python aggregate_tests.py

Note: integration tests end in _integration.py.

If you wish to run a particular unit test, navigate to the tests directory and run that specific unit test. For example:

$ python test_updater.py

It it also possible to run the test cases of a unit test. For instance:

$ python -m unittest test_updater.TestMultiRepoUpdater.test_get_one_valid_targetinfo

Setup

The unit and integration tests operate on static metadata available in the repository_data directory. Before running the tests, static metadata is first copied to temporary directories and modified, as needed, by the tests.

The test modules typically spawn HTTP(S) servers that serve metadata and target files for the the unit tests. The map file specifies the location of the test repositories and other properties. For specific targets and metadata provided by the tests repositories, please inspect their respective metadata.