z3c.testsetup 0.6

Registering doctests

In this example directory, there is a simple doctest doctest01.txt (please ignore the pipes on the left):

>>> print_file(os.path.join(cavepath, 'doctest01.txt'))
|  A doctest
|  =========
|
|  :doctest:
|
|  This is a simple doctest.
|
|    >>> 1+1
|    2
|

Important to note: the doctest is marked by a special marker that tells the testsetup machinery that the file contains doctest examples that should be registered during test runs:

:doctest:

Without this marker, a testfile won’t be registered during tests! This is the only difference compared to ‘normal’ doctests when you use z3c.testsetup. If you want to disable a test, just turn :doctest: into :nodoctest: (or something else) and the file will be ignored.

Running the tests

Now that we have a doctest available, we can write a testsetup routine that collects all tests, registers them and passes them to the testrunner:

>>> print open(os.path.join(cavepath, 'simplesetup01.py')).read()
import z3c.testsetup
test_suite = z3c.testsetup.register_all_tests(
    'z3c.testsetup.tests.othercave')

This is all we need in simple cases. We use register_all_tests(<dotted_pkg_name>) to tell the setup machinery, where to look for test files. Note that also files in subpackages will be found, registered and executed when they are marked approriately.

Let’s start the testrunner and see what it gives:

>>> import sys
>>> sys.argv = [sys.argv[0],]
>>> defaults = [
...     '--path', cavepath,
...     '--tests-pattern', '^simplesetup01$',
...     ]
>>> from z3c.testsetup import testrunner
>>> testrunner.run(defaults)
Running z3c...layer.DefaultZCMLLayer [...ftesting.zcml] tests:
  Set up z3c...layer.DefaultZCMLLayer [...ftesting.zcml] in 2.146 seconds.
  Ran 3 tests with 0 failures and 0 errors in 0.009 seconds.
Running z3c...layer.DefaultZCMLLayer [...ftesting2.zcml] tests:
  Tear down z3c...layer.DefaultZCMLLayer [...ftesting.zcml] ... not supported
  Running in a subprocess.
  Set up z3c...layer.DefaultZCMLLayer [...ftesting2.zcml] in 0.040 seconds.
  Ran 1 tests with 0 failures and 0 errors in 0.011 seconds.
  Tear down z3c...layer.DefaultZCMLLayer [...ftesting2.zcml] ... not supported
Running z3c.testsetup.tests.othercave.testing.FunctionalLayer1 tests:
  Running in a subprocess.
  Set up z3c.testsetup.tests.othercave.testing.FunctionalLayer1 in 1.797 seconds.
  Ran 1 tests with 0 failures and 0 errors in 0.013 seconds.
  Tear down z3c.testsetup.tests.othercave.testing.FunctionalLayer1 in 0.001 seconds.
Running z3c.testsetup.tests.othercave.testing.UnitLayer2 tests:
  Running in a subprocess.
  Set up z3c.testsetup.tests.othercave.testing.UnitLayer1 in 0.000 seconds.
  Set up z3c.testsetup.tests.othercave.testing.UnitLayer2 in 0.000 seconds.
    Running testSetUp of UnitLayer1
    Running testSetUp of UnitLayer2
    Running testTearDown of UnitLayer2
    Running testTearDown of UnitLayer1
  Ran 1 tests with 0 failures and 0 errors in 0.009 seconds.
  Tear down z3c.testsetup.tests.othercave.testing.UnitLayer2 in 0.000 seconds.
  Tear down z3c.testsetup.tests.othercave.testing.UnitLayer1 in 0.000 seconds.
Running zope.testing.testrunner.layer.UnitTests tests:
  Running in a subprocess.
  Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
    Custom setUp for  <DocTest doctest05.txt from ...doctest05.txt:0 (2 examples)>
    Custom tearDown for  <DocTest doctest05.txt from ...doctest05.txt:0 (2 examples)>
  Ran 7 tests with 0 failures and 0 errors in 0.011 seconds.
  Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
Total: 13 tests, 0 failures, 0 errors in 11.798 seconds.
False

As we can see, there were regular unittests as well as functional tests run. Some of the unittests used their own layer (UnitLayer1). Layers are shown in the output. In this example, the functional tests use different ZCML-files for configuration which results in separate test layers.

Finding doctests in Python modules

The doctest file described above was a pure .txt file. By default z3c.testsetup looks for doctests in files with filename extension .txt, .rst and .py. This means, that also doctests in Python modules are found just fine as in the following example:

>>> print_file(os.path.join(cavepath, 'doctest08.py'))
|  """
|  Doctests in a Python module
|  ===========================
|
|  We can place doctests also in Python modules.
|
|  :doctest:
|
|  Here the Cave class is defined::
|
|    >>> from z3c.testsetup.tests.othercave.doctest08 import Cave
|    >>> Cave
|    <class 'z3c.testsetup...doctest08.Cave'>
|
|  """
|  class Cave(object):
|      """A Cave.
|
|      A cave has a number::
|
|        >>> hasattr(Cave, 'number')
|        True
|
|      """
|      number = None
|
|      def __init__(self, number):
|          """Create a Cave.
|
|          We have to give a number if we create a cave::
|
|            >>> c = Cave(12)
|            >>> c.number
|            12
|
|          """
|          self.number = number
|

Here we placed the marker string :doctest: into the docstring of the module. Without it, the module would not have been considered a testfile.

Note that you have to import the entities (classes, functions, etc.) from the very same file if you want to use them.

Registering regular python unittests

z3c.testsetup provides also (limited) support for regular unittest deployments as usually written in Python. An example file looks like this:

>>> print_file(os.path.join(cavepath, 'pythontest1.py'))
|  """
|  Tests with real TestCase objects.
|
|  :unittest:
|
|  """
|
|  import unittest
|
|  class TestTest(unittest.TestCase):
|
|      def setUp(self):
|          pass
|
|      def testFoo(self):
|          self.assertEqual(2, 1+1)
|
|

The module contains a marker :unittest: in its module docstring instead of the :doctest: marker used in the other examples above. This means that the file is registered as a regular unittest. (It is also the replacement for the formely used :Test-Layer: python marker.)

If you use unittests instead of doctests, then you are mainly on your own with setting up and tearing down tests. All this should be done by the test cases themselves.

The only advantage of using z3c.testsetup here is, that those tests are found and run automatically when they provide the marker.

Setting up a self-defined layer: :layer:

Starting with z3c.testsetup 0.3 there is reasonable support for setting up layers per testfile. This way you can easily create setup-functions that are only run before/after certain sets tests.

Overall, use of layers is the recommended way from now on.

We can tell z3c.testsetup to use a certain layer using the :layer: marker as in the following example (see tests/othercave/doctest02.txt):

A doctests with layer
=====================
<BLANKLINE>
:doctest:
:layer: z3c.testsetup.tests.othercave.testing.UnitLayer2
<BLANKLINE>
  >>> 1+1
  2

The :doctest: marker was used here as well, because without it the file would not have been detected as a registerable doctest file (we want developers to be explicit about that).

The :layer: <DOTTED_NAME_OF_LAYER_DEF> marker then tells, where the testsetup machinery can find the layer definition. It is given in dotted name notation and points to a layer you defined yourself.

How does the layer definition look like? It is defined as regualr Python code:

>>> print open(os.path.join(cavepath, 'testing.py')).read()
import os
...
class UnitLayer1(object):
    """This represents a layer.
    A layer is a way to have common setup and teardown that happens
    once for a whole group of tests.
<BLANKLINE>
    It must be an object with a `setUp` and a `tearDown` method, which
    are run once before or after all the tests applied to a layer
    respectively.
<BLANKLINE>
    Optionally you can additionally define `testSetUp` and
    `testTearDown` methods, which are run before and after each single
    test.
<BLANKLINE>
    This class is not instantiated. Therefore we use classmethods.
    """
<BLANKLINE>
    @classmethod
    def setUp(self):
        """This gets run once for the whole test run, or at most once per
        TestSuite that depends on the layer.
        (The latter can happen if multiple suites depend on the layer
        and the testrunner decides to tear down the layer after first
        suite finishes.)
        """
<BLANKLINE>
    @classmethod
    def tearDown(self):
        """This gets run once for the whole test run, or at most
        once per TestSuite that depends on the layer,
        after all tests in the suite have finished.
        """
<BLANKLINE>
    @classmethod
    def testSetUp(self):
        """This method is run before each single test in the current
        layer. It is optional.
        """
        print "    Running testSetUp of UnitLayer1"
<BLANKLINE>
    @classmethod
    def testTearDown(self):
        """This method is run before each single test in the current
        layer. It is optional.
        """
        print "    Running testTearDown of UnitLayer1"
<BLANKLINE>
class UnitLayer2(UnitLayer1):
    """This Layer inherits ``UnitLayer1``.
<BLANKLINE>
    This way we define nested setups. During test runs the testrunner
    will first call the setup methods of ``UnitTest1`` and then those
    of this class. Handling of teardown-methods will happen the other
    way round.
    """
<BLANKLINE>
    @classmethod
    def setUp(self):
        pass
<BLANKLINE>
    @classmethod
    def testSetUp(self):
        print "    Running testSetUp of UnitLayer2"
<BLANKLINE>
    @classmethod
    def testTearDown(self):
        print "    Running testTearDown of UnitLayer2"

In a layer you can do all the special stuff that is needed to run a certain group of tests properly. Our setup here is special in that we defined a nested one: UnitLayer2 inherits UnitLayer1 so that during test runs the appropriate setup and teardown methods are called (see testrunner output above).

More about test layers can be found at the documentation of testrunner layers API.

Specifying a ZCML file: :zcml-layer:

When it comes to integration tests which use zope’s component architecture, we need to specify a ZCML file which configures the test environment for us. We can do that using the

:zcml-layer: <ZCML-file-name>

marker. It expects a ZCML filename as argument and sets up a ZCML-layered testsuite for us. An example setup might look like so (see tests/othercave/doctest03.txt):

A doctest with a ZCML-layer
===========================

:doctest:
:zcml-layer: ftesting.zcml

  >>> 1+1
  2

Here we say that the the local file ftesting.zcml should be used as ZCML configuration. As we can see in the above output of testruner, this file is indeed read during test runs and used by a ZCML layer called DefaultZCMLLayer. This layer is in fact only a zope.app.testing.functional.ZCMLLayer.

The ZCML file is looked up in the same directory as the doctest file. (You can use relative paths like ../ftesting.zcml just fine, btw).

When using the :zcml-layer: marker, the concerned tests are set up via special methods and functions from zope.app.testing. This way you get ‘functional’ or ‘integration’ tests out of the box: in the beginning an empty ZODB db is setup, getRootFolder, sync and other functions are pulled into the test namespace and several things more.

If you want a plain setup instead then use your own layer definition using :layer: and remove the :zcml-layer: marker.

Setting up a functional ZCML layer: :functional-zcml-layer:

Sometimes we want tests to be registered using the FunctionalDocFileSuite function from zope.app.testing.functional (other tests are set up using zope.testing.doctest.DocFileSuite). This function pulls in even more functions into globs, like http (a HTTPCaller instance), wraps your setUp and tearDown methods into ZODB-setups and several things more. See the definition in http://svn.zope.org/zope.app.testing/trunk/src/zope/app/testing/functional.py?view=auto.

This setup needs also a ZCML configuration file, which can be specified via:

:functional-zcml-layer: <ZCML-file-name>

If a functional ZCML layer is specified in a testfile this way, it will override any simple :zcml-layer: or :layer: definition.

An example setup might look like this (see tests/othercave/doctest04.txt):

>>> print_file(os.path.join(cavepath, 'doctest04.txt'))
|  A functional doctest with ZCML-layer
|  ====================================
|
|  :doctest:
|  :functional-zcml-layer: ftesting.zcml
|
|  We didn't define a real environment in ftesting.zcml, but in
|  functional tests certain often needed functions should be available
|  automatically::
|
|    >>> getRootFolder()
|    <zope...folder.Folder object at 0x...>
|

The placeholder between zope and folder was used because the location of the Folder class changed recently. This way we cover setups with old packages as well as recent ones.

Specifying test setup/teardown methods: :setup: and :teardown:

We can specify a setUp(test) and tearDown(test) method for the examples in a doctest file, which will be executed once for the whole doctest file. This can be done using:

:setup: <dotted.name.of.callable>
:teardown: <dotted.name.of.callable>

The callables denoted by the dotted names must accept a test parameter which will be the whole test suite of examples in the current doctest file. setup/teardown can be used to set up (and remove) a temporary directory, to monkeypatch a mailer, etcetera.

An example can be found in doctest05.txt:

>>> print_file(os.path.join(cavepath, 'doctest05.txt'))
|  A doctest with custom setup/teardown functions
|  ==============================================
|
|  :doctest:
|  :setup: z3c.testsetup.tests.othercave.testing.setUp
|  :teardown: z3c.testsetup.tests.othercave.testing.tearDown
|
|    >>> 1+1
|    2
|
|  We make use of a function registered during custom setup::
|
|    >>> myfunc(2)
|    4
|

The setup/teardown functions denoted in the example look like this:

>>> print open(os.path.join(cavepath, 'testing.py'), 'rb').read()
import os
...
def setUp(test):
    print "    Custom setUp for ", test
    # We register a function that will be available during tests.
     test.globs['myfunc'] = lambda x: 2*x
<BLANKLINE>
def tearDown(test):
    print "    Custom tearDown for ", test
    del test.globs['myfunc'] # unregister function
...

As we can see, there is a function myfunc pulled into the namespace of the doctest. We could, however, do arbitrary other things here, set up a relational test database or whatever.

Deprecated :Test-Layer: marker

If you still mark your testfiles with the :Test-Layer: marker, update your testfiles as follows:

• :Test-Layer: unit

  Change to: :doctest:

• :Test-Layer: python

  Change to: :unittest:

• :Test-Layer: functional

  Change to: :functional-zcml-layer: <ZCML-FILE>

  The ZCML file must explicitly be given.

If you used custom setups passed to register_all_tests, consider declaring those setup/teardown functions in the appropriate doctest files using :setup: and :teardown:.

You might also get better structured test suites when using the new layer markers :layer:, :zcml-layer: and functional-zcml-layer:.

Deprectated parameters for register_all_tests()

The following register_all_tests-parameters are deprecated, starting with z3c.testsetup 0.3:

• filter_func

  and related (ufilter_func, pfilter_func, etc.)

• All testtype specific parameters

  Support for testfile specific parameters (uextensions, fextensions, etc.) is running out and its use deprecated.

Bug fixes

• Checkers are now applied to non-functional doctests too. Thanks to Jonathan Ballet for patches.

• Normal UnitTest layers are now registered correctly.

• :layer: now detects functional ZCML layers. If the defined layer is derived from zope.testing.functional.ZCMLLayer, then the test is set up with the same kind of testcase as :functional-zcml-layer:.

• Reordered and cleaned up the documentation.

Feature changes

• By default, functional layer tests now use the allow_teardown=True option of the ZCMLLayer. This prevents the zcml layer from running in a subprocess which throws off profiling and thus code coverage tools. Running it in a subprocess is only normally needed when you do things like adding an interface to a class after the fact in your code. You can overrid it in the register_all_tests() call by setting allow_teardown=False.

Bug fixes

• Made z3c.testsetup selftests work with zope.testing >= 3.7.3. Thanks to Jonathan Ballet for pointing to that problem.

• Ignore *nix hidden test files (i.e. such starting with a dot in filename) by default. Thanks to Jonathan Ballet for patch.

• ZCML files registered via the default layer are now separated from each other, even if they own the same filename. Therefore you can now register a default layer with an ftesting.zcml in one subpackage while having another ftesting.zcml in another package. This was not handled correctly before. Many thanks go to Jonathan Ballet who contributed a patch.

Feature Changes

• Added z3c.testsetup.testrunner that provides wrappers for zope.testing.testrunner``s ``run() and run_internal() functions. Using it, one can make sure that running testrunners inside tests will work regardless of which version of zope.testing is used during testruns.

Bug fixes

• Updated doctest examples to reflect new zope.testing behaviour.

• z3c.testsetup really shouldn’t require zope.app.testing any more. If you use it in an environment without this package, then you cannot register functional tests, which is determined when loading register_all_tests from z3c.testsetup.

• Broken modules are ignored while scanning for tests.

• Modules are not loaded anymore if their source code does not provide a suitable marker string. For this to work, the default checker method isTestModule now expects a martian.scan.ModuleInfo as argument and not a real module. Module infos can be easily created by using module_info_from_dotted_name and module_info_from_package from the martian.scan package.

Feature Changes

• New set of testfile markers:

  • :doctest:

    marks a testfile as a doctest.

  • :unittest:

    marks a testfile as a regular unittest.

  • :layer: dotted.name.to.layer.def

    applies the given layer definition to the tests in the doctest file.

  • :zcml-layer: filename.zcml

    sets up a ZCML layer with the given filename and applies this layer to the doctests in the doctest file.

  • :functional-zcml-layer: filename.zcml

    sets up a ZCML layer with the given filename and applies this layer to the doctests in the doctest file. Furthermore the tests are set up as functional doc tests.

  • :setup: dotted.name.to.setup.function

    applies the setUp function denoted by the dotted name to the tests in the doctest file.

  • :teardown: dotted.name.to.teardown.function

    applies the tearDown function denoted by the dotted name to the tests in the doctests file.

  See the examples in tests/othercave and README.txt to learn more about using these new directives.

  The old :test-layer: marker is still supported but it is deprecated now and will vanish at least with the 0.5 version of z3c.testsetup.

Feature Changes

• An ftesting.zcml in the root of a handled package is now taken as default layer for functional doctests if it exists.

Bug fixes