forked from orbit-oss/flask
Added make target for test coverage, documented make commands
This commit is contained in:
parent
4f83f705e7
commit
5cadd4a348
4 changed files with 25 additions and 9 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -11,3 +11,5 @@ _mailinglist
|
|||
.tox
|
||||
.cache/
|
||||
.idea/
|
||||
.coverage
|
||||
htmlcov
|
||||
|
|
|
|||
|
|
@ -31,18 +31,12 @@ Submitting patches
|
|||
- Try to follow `PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_, but you
|
||||
may ignore the line-length-limit if following it would make the code uglier.
|
||||
|
||||
|
||||
Running the testsuite
|
||||
---------------------
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
You probably want to set up a `virtualenv
|
||||
<https://virtualenv.readthedocs.io/en/latest/index.html>`_.
|
||||
|
||||
The minimal requirement for running the testsuite is ``py.test``. You can
|
||||
install it with::
|
||||
|
||||
pip install pytest
|
||||
|
||||
Clone this repository::
|
||||
|
||||
git clone https://github.com/pallets/flask.git
|
||||
|
|
@ -52,11 +46,21 @@ Install Flask as an editable package using the current source::
|
|||
cd flask
|
||||
pip install --editable .
|
||||
|
||||
Running the testsuite
|
||||
---------------------
|
||||
|
||||
The minimal requirement for running the testsuite is ``pytest``. You can
|
||||
install it with::
|
||||
|
||||
pip install pytest
|
||||
|
||||
Then you can run the testsuite with::
|
||||
|
||||
py.test
|
||||
|
||||
With only py.test installed, a large part of the testsuite will get skipped
|
||||
**Shortcut**: ``make test`` will ensure ``pytest`` is installed, and run it.
|
||||
|
||||
With only pytest installed, a large part of the testsuite will get skipped
|
||||
though. Whether this is relevant depends on which part of Flask you're working
|
||||
on. Travis is set up to run the full testsuite when you submit your pull
|
||||
request anyways.
|
||||
|
|
@ -69,6 +73,8 @@ of ``pytest``. You can install it with::
|
|||
The ``tox`` command will then run all tests against multiple combinations
|
||||
Python versions and dependency versions.
|
||||
|
||||
**Shortcut**: ``make tox-test`` will ensure ``tox`` is installed, and run it.
|
||||
|
||||
Running test coverage
|
||||
---------------------
|
||||
Generating a report of lines that do not have unit test coverage can indicate where
|
||||
|
|
@ -87,3 +93,4 @@ Generate a HTML report can be done using this command::
|
|||
|
||||
Full docs on ``coverage.py`` are here: https://coverage.readthedocs.io
|
||||
|
||||
**Shortcut**: ``make cov`` will ensure ``pytest-cov`` is installed, run it, display the results, *and* save the HTML report.
|
||||
|
|
|
|||
5
Makefile
5
Makefile
|
|
@ -7,8 +7,13 @@ test:
|
|||
FLASK_DEBUG= py.test tests examples
|
||||
|
||||
tox-test:
|
||||
pip install -r test-requirements.txt -q
|
||||
tox
|
||||
|
||||
cov:
|
||||
pip install -r test-requirements.txt -q
|
||||
FLASK_DEBUG= py.test --cov-report term --cov-report html --cov=flask --cov=examples tests examples
|
||||
|
||||
audit:
|
||||
python setup.py audit
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1,3 @@
|
|||
tox
|
||||
pytest
|
||||
pytest-cov
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue