summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki/tests.rst
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2015-05-27 03:38:39 -0700
committerSteve Piercy <web@stevepiercy.com>2015-05-27 03:38:39 -0700
commit6901d74698da7b8457f92f0771fe03015acb9261 (patch)
tree87192c5369d338a6d408015e2ff06a87fa83942a /docs/tutorials/wiki/tests.rst
parentbc30dfdfccb7304d876b0f030d2b6b9f63326169 (diff)
downloadpyramid-6901d74698da7b8457f92f0771fe03015acb9261.tar.gz
pyramid-6901d74698da7b8457f92f0771fe03015acb9261.tar.bz2
pyramid-6901d74698da7b8457f92f0771fe03015acb9261.zip
- clean up and make consistent across wiki tutorials
- update templates and static assets for new design
Diffstat (limited to 'docs/tutorials/wiki/tests.rst')
-rw-r--r--docs/tutorials/wiki/tests.rst44
1 files changed, 21 insertions, 23 deletions
diff --git a/docs/tutorials/wiki/tests.rst b/docs/tutorials/wiki/tests.rst
index e724f3e18..e255812fc 100644
--- a/docs/tutorials/wiki/tests.rst
+++ b/docs/tutorials/wiki/tests.rst
@@ -2,38 +2,36 @@
Adding Tests
============
-We will now add tests for the models and the views and a few functional
-tests in the ``tests.py``. Tests ensure that an application works, and
-that it continues to work after some changes are made in the future.
+We will now add tests for the models and the views and a few functional tests
+in ``tests.py``. Tests ensure that an application works, and that it
+continues to work when changes are made in the future.
-
-Test the Models
+Test the models
===============
-We write tests for the model classes and the appmaker. Changing
-``tests.py``, we'll write a separate test class for each model class, and
+We write tests for the ``model`` classes and the ``appmaker``. Changing
+``tests.py``, we'll write a separate test class for each ``model`` class, and
we'll write a test class for the ``appmaker``.
To do so, we'll retain the ``tutorial.tests.ViewTests`` class that was
-generated as part of the ``zodb`` scaffold. We'll add three test
-classes: one for the ``Page`` model named ``PageModelTests``, one for the
-``Wiki`` model named ``WikiModelTests``, and one for the appmaker named
-``AppmakerTests``.
+generated as part of the ``zodb`` scaffold. We'll add three test classes: one
+for the ``Page`` model named ``PageModelTests``, one for the ``Wiki`` model
+named ``WikiModelTests``, and one for the appmaker named ``AppmakerTests``.
-Test the Views
+Test the views
==============
We'll modify our ``tests.py`` file, adding tests for each view function we
-added above. As a result, we'll *delete* the ``ViewTests`` test in the file,
-and add four other test classes: ``ViewWikiTests``, ``ViewPageTests``,
-``AddPageTests``, and ``EditPageTests``. These test the ``view_wiki``,
-``view_page``, ``add_page``, and ``edit_page`` views respectively.
-
+added previously. As a result, we'll *delete* the ``ViewTests`` class that
+the ``zodb`` scaffold provided, and add four other test classes:
+``ViewWikiTests``, ``ViewPageTests``, ``AddPageTests``, and ``EditPageTests``.
+These test the ``view_wiki``, ``view_page``, ``add_page``, and ``edit_page``
+views.
Functional tests
================
-We test the whole application, covering security aspects that are not
+We'll test the whole application, covering security aspects that are not
tested in the unit tests, like logging in, logging out, checking that
the ``viewer`` user cannot add or edit pages, but the ``editor`` user
can, and so on.
@@ -41,14 +39,14 @@ can, and so on.
View the results of all our edits to ``tests.py``
=================================================
-Once we're done with the ``tests.py`` module, it will look a lot like the
-below:
+Open the ``tutorial/tests.py`` module, and edit it such that it appears as
+follows:
.. literalinclude:: src/tests/tutorial/tests.py
:linenos:
:language: python
-Running the Tests
+Running the tests
=================
We can run these tests by using ``setup.py test`` in the same way we did in
@@ -62,7 +60,7 @@ Change the ``requires`` list in ``setup.py`` to include ``WebTest``.
:lines: 11-22
:emphasize-lines: 11
-After we've added a dependency on WebTest in ``setup.py``, we need to rerun
+After we've added a dependency on WebTest in ``setup.py``, we need to run
``setup.py develop`` to get WebTest installed into our virtualenv. Assuming
our shell's current working directory is the "tutorial" distribution
directory:
@@ -94,7 +92,7 @@ On Windows:
c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q
-The expected result looks something like:
+The expected result should look like the following:
.. code-block:: text