Changeset 12930 for main/waeup.kofa/trunk/docs/source

Timestamp:

13 May 2015, 13:01:01 (9 years ago)

Author:

Henrik Bettermann

Message:

Integrate first Python test into handbook.

Location:

main/waeup.kofa/trunk/docs/source/userdocs

Files:

• testing.rst (modified) (4 diffs)
• users.rst (modified) (2 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/testing.rst

@@ -27 +27 @@
 manually.
 
-What we test: "unit" and "functional" Tests
+What we test: "Unit" and "Functional" Tests
 -------------------------------------------
 
@@ -47 +47 @@
 
 There are also two different ways to integrate tests, either
-functional or unit, into a Python package: *doc tests* (or doctests)
+functional or unit, into a Python package: *Doctest tests* (or doctests)
 and *Python tests*. Python test modules are a collection of
 isolatable Python test cases. A test case combines a collection of
-unit test methods which are being executed by the testrunner one
+test methods which are being executed by the testrunner one
 after the other. Python test modules are automatically identified by
 means of their filenames which start with ``test_``. In contrast,
@@ -86 +86 @@
 
 
-Doctests
-========
+Doctest Tests
+=============
 
 Browsing
@@ -159 +159 @@
 ============
 
+There are hundreds of Python test cases in Kofa with many test
+methods each. Here we present only a few of them. The test methods
+are easy to read. In most cases they are functional and certain
+methods and properties of a test browser are called. Most important
+are `browser.open()` (opens a web page), `browser.getControl()`
+(gets a control button), `browser.getLink()` (gets a link) and
+`browser.contents` (is the HTML content of the opened page).
+
+.. _test_suspended_officer:
+
+Suspended Officer Account Test
+------------------------------
+
+The first test can be found in
+`waeup.kofa.browser.tests.test_browser.SupplementaryBrowserTests`:
+
 .. literalinclude:: ../../../src/waeup/kofa/browser/tests/test_browser.py
    :pyobject: test_suspended_officer
+
+The test makes sure that a suspended officers can't login but see a
+proper warning message when trying to login. Furthermore, suspended
+officer accounts are clearly marked and a warning message shows up
+if a manager accesses an suspended account, see :ref:`Officers
+<officers>`.

main/waeup.kofa/trunk/docs/source/userdocs/users.rst

@@ -44 +44 @@
 serves as user title.
 
+.. _officers:
 
 Officers
@@ -51 +52 @@
 
    :ref:`Officers Doctests <userscontainer_txt>`
+
+   :ref:`Officers Python Test <test_suspended_officer>`
 
 Officers are users with a dedicated user account object stored in the