summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2008-11-07 10:47:28 +0000
committerChris McDonough <chrism@agendaless.com>2008-11-07 10:47:28 +0000
commitdeb0dc316b64d5fb7bd0e15a1bafe269d3b33fbc (patch)
tree669d3eb3f6d00ce866b1d48fc977ca372aebc396 /docs
parent569ba5128fb1fd028e0fe879e810f855a61c8a03 (diff)
downloadpyramid-deb0dc316b64d5fb7bd0e15a1bafe269d3b33fbc.tar.gz
pyramid-deb0dc316b64d5fb7bd0e15a1bafe269d3b33fbc.tar.bz2
pyramid-deb0dc316b64d5fb7bd0e15a1bafe269d3b33fbc.zip
Features
- Added a ``repoze.bfg.testing`` module to attempt to make it slightly easier to write unittest-based automated tests of BFG applications. Information about this class is in the documentation. - The default template renderer now supports testing better by looking for ``ITestingTemplateRenderer`` using a relative pathname. This is exposed indirectly through the API named ``registerTemplate`` in ``repoze.bfg.testing``. Deprecations - The names ``repoze.bfg.interfaces.ITemplate`` , ``repoze.bfg.interfaces.ITemplateFactory`` and ``repoze.bfg.interfaces.INodeTemplate`` have been deprecated. These should now be imported as ``repoze.bfg.interfaces.ITemplateRenderer`` and ``repoze.bfg.interfaces.ITemplateRendererFactory``, and ``INodeTemplateRenderer`` respectively. - The name ``repoze.bfg.chameleon_zpt.ZPTTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_zpt.ZPTTemplateRenderer``. - The name ``repoze.bfg.chameleon_genshi.GenshiTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_genshi.GenshiTemplateRenderer``. - The name ``repoze.bfg.xslt.XSLTemplateFactory`` is deprecated. Use ``repoze.bfg.xslt.XSLTemplateRenderer``.
Diffstat (limited to 'docs')
-rw-r--r--docs/api/testing.rst10
-rw-r--r--docs/index.rst2
-rw-r--r--docs/narr/unittesting.rst13
3 files changed, 25 insertions, 0 deletions
diff --git a/docs/api/testing.rst b/docs/api/testing.rst
new file mode 100644
index 000000000..da0a128d9
--- /dev/null
+++ b/docs/api/testing.rst
@@ -0,0 +1,10 @@
+.. _testing_module:
+
+:mod:`repoze.bfg.testing`
+==========================
+
+.. automodule:: repoze.bfg.testing
+
+ .. autoclass:: BFGTestCase
+ :members:
+
diff --git a/docs/index.rst b/docs/index.rst
index e89c18494..0c8fd295e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,6 +35,7 @@ Narrative documentation in chapter form explaining how to use
narr/security
narr/events
narr/environment
+ narr/unittesting
changes
glossary
@@ -72,6 +73,7 @@ Per-module :mod:`repoze.bfg` API documentation.
api/router
api/security
api/template
+ api/testing
api/traversal
api/location
api/urldispatch
diff --git a/docs/narr/unittesting.rst b/docs/narr/unittesting.rst
new file mode 100644
index 000000000..0ef04083f
--- /dev/null
+++ b/docs/narr/unittesting.rst
@@ -0,0 +1,13 @@
+.. _unittesting_chapter:
+
+Unit Testing
+============
+
+:mod:`repoze.bfg` provides helper facilities for writing
+``unittest.TestCase`` -derived tests. A base class for these types of
+tests as well as functions that help test BFG applications
+specifically exist. See the :ref:`testing_module` chapter for the
+API.
+
+XXX
+