From 67af7a0da676b0b59d08dc94376dbd7c60cf0d97 Mon Sep 17 00:00:00 2001 From: Vladimir Diaz Date: Thu, 14 Dec 2017 11:57:59 -0500 Subject: [PATCH] Add first draft of README for unit tests Signed-off-by: Vladimir Diaz --- tests/repository_data/README.md | 48 +++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 tests/repository_data/README.md diff --git a/tests/repository_data/README.md b/tests/repository_data/README.md new file mode 100644 index 00000000..d214100f --- /dev/null +++ b/tests/repository_data/README.md @@ -0,0 +1,48 @@ +# 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](https://github.com/theupdateframework/tuf/tree/develop/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](https://github.com/theupdateframework/tuf/tree/develop/tests/repository_data/). +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](https://github.com/theupdateframework/tuf/tree/develop/tests/repository_data) +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](https://github.com/theupdateframework/tuf/tree/develop/tests/repository_data/repository). +