From deb0dc316b64d5fb7bd0e15a1bafe269d3b33fbc Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 7 Nov 2008 10:47:28 +0000 Subject: 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``. --- docs/api/testing.rst | 10 ++++++++++ docs/index.rst | 2 ++ docs/narr/unittesting.rst | 13 +++++++++++++ 3 files changed, 25 insertions(+) create mode 100644 docs/api/testing.rst create mode 100644 docs/narr/unittesting.rst (limited to 'docs') 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 + -- cgit v1.2.3