forked from orbit-oss/flask
e6f9d2b414
* Clean up tutorial docs for installable app pattern - reading sequentially through the tutorial works. - fixes references to `export FLASK_APP=flaskr.flaskr` * Fixes titles for each section of flaskr tutorial * Revert grammar * Emphasize the Packaging Guide - adds more general packaging resource - removes the emphasis put on setuptools * rephrase and remove note admonitions - expanded on few points - removed note blocks, they are unneccessary * Remove note about reinstalling to update cli - I had mistakenly thought it was necessary to re-install the app to update the cli. - the `--editable` flag detects the change and the cli updates without issue.
96 lines
2.9 KiB
ReStructuredText
96 lines
2.9 KiB
ReStructuredText
.. _tutorial-testing:
|
|
|
|
Bonus: Testing the Application
|
|
==============================
|
|
|
|
Now that you have finished the application and everything works as
|
|
expected, it's probably not a bad idea to add automated tests to simplify
|
|
modifications in the future. The application above is used as a basic
|
|
example of how to perform unit testing in the :ref:`testing` section of the
|
|
documentation. Go there to see how easy it is to test Flask applications.
|
|
|
|
Adding tests to flaskr
|
|
----------------------
|
|
|
|
Assuming you have seen the :ref:`testing` section and have either written
|
|
your own tests for ``flaskr`` or have followed along with the examples
|
|
provided, you might be wondering about ways to organize the project.
|
|
|
|
One possible and recommended project structure is::
|
|
|
|
flaskr/
|
|
flaskr/
|
|
__init__.py
|
|
static/
|
|
templates/
|
|
tests/
|
|
test_flaskr.py
|
|
setup.py
|
|
MANIFEST.in
|
|
|
|
For now go ahead a create the :file:`tests/` directory as well as the
|
|
:file:`test_flaskr.py` file.
|
|
|
|
Running the tests
|
|
-----------------
|
|
|
|
At this point you can run the tests. Here ``pytest`` will be used.
|
|
|
|
.. note:: Make sure that ``pytest`` is installed in the same virtualenv
|
|
as flaskr. Otherwise ``pytest`` test will not be able to import the
|
|
required components to test the application::
|
|
|
|
pip install -e .
|
|
pip install pytest
|
|
|
|
Run and watch the tests pass, within the top-level :file:`flaskr/`
|
|
directory as::
|
|
|
|
py.test
|
|
|
|
Testing + setuptools
|
|
--------------------
|
|
|
|
One way to handle testing is to integrate it with ``setuptools``. Here
|
|
that requires adding a couple of lines to the :file:`setup.py` file and
|
|
creating a new file :file:`setup.cfg`. One benefit of running the tests
|
|
this way is that you do not have to install ``pytest``. Go ahead and
|
|
update the :file:`setup.py` file to contain::
|
|
|
|
from setuptools import setup
|
|
|
|
setup(
|
|
name='flaskr',
|
|
packages=['flaskr'],
|
|
include_package_data=True,
|
|
install_requires=[
|
|
'flask',
|
|
],
|
|
setup_requires=[
|
|
'pytest-runner',
|
|
],
|
|
tests_require=[
|
|
'pytest',
|
|
],
|
|
)
|
|
|
|
Now create :file:`setup.cfg` in the project root (alongside
|
|
:file:`setup.py`)::
|
|
|
|
[aliases]
|
|
test=pytest
|
|
|
|
Now you can run::
|
|
|
|
python setup.py test
|
|
|
|
This calls on the alias created in :file:`setup.cfg` which in turn runs
|
|
``pytest`` via ``pytest-runner``, as the :file:`setup.py` script has
|
|
been called. (Recall the `setup_requires` argument in :file:`setup.py`)
|
|
Following the standard rules of test-discovery your tests will be
|
|
found, run, and hopefully pass.
|
|
|
|
This is one possible way to run and manage testing. Here ``pytest`` is
|
|
used, but there are other options such as ``nose``. Integrating testing
|
|
with ``setuptools`` is convenient because it is not necessary to actually
|
|
download ``pytest`` or any other testing framework one might use.
|