Add sslib master tox build + flesh out test docs #915
Conversation
lukpueh
force-pushed
the
tox-with-sslib-master
branch
from
08b0f4f to
81ff59e
Compare
Add a tox build that runs tests against securesystemslib's tip of development, i.e. master branch, to ease preparation of tuf for a new securesystmeslib release. The tox build is run on travis but is allowed to fail. This commit also fleshes out the testing section of the contribution documentation. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
lukpueh
force-pushed
the
tox-with-sslib-master
branch
from
81ff59e to
593490d
Compare
|
Oh, this looks great. Thanks @lukpueh |
|
@aditya, would you mind taking a quick look at this PR, especially the updated "Testing" section of the contribution doc? |
docs/CONTRIBUTORS.rst
Outdated
| $ python aggregate_tests.py | ||
|
|
||
|
|
||
| To run the tests, measuring code coverage, the script can be run with the |
There was a problem hiding this comment.
Should coverage be added to dev-requirements.txt?
There was a problem hiding this comment.
Good thinking! It probably should be, although dev-requirements.txt pins all dependencies, and that IMHO doesn't make sense for a development tool.
Maybe we can adopt a requirements hierarchy similar to the one proposed in in-toto/in-toto@06a2898. I'd leave that for another PR though.
As a temporary fix we could either add it to dev-requirements.txt pinned or unpinned (maybe with a TODO comment), or add a note to CONTRIBUTORS.rst, telling contributors to install it separately when running tests with coverage. I tend towards the second for above reasons. What do you think?
There was a problem hiding this comment.
Agreed, the second option is better as sometimes temporary fixes have a bad habit of becoming permanent!
Add hint to install `coverage` before using it. This should be installed via dev-requirements.txt, however it does not seem to fit in there, because dev-requirements.txt pins all its dependencies which does not seem to make sense for a development tool. Maybe a hierarchy of requirements.txt similar to in-toto/in-toto@06a2898 could be established. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
|
Thanks for the review, @aditya! |
Fixes issue #:
None. Suggested by @joshuagl in #913
Description of the changes being introduced by the pull request:
Add a tox build that runs tests against
securesystemslib's tip of development, i.e. itsmasterbranch, to ease preparation oftuffor a newsecuresystmeslibrelease.The tox build is run on travis but is allowed to fail.
This PR also fleshes out the testing section of the contribution documentation.
Please verify and check that the pull request fulfills the following
requirements: