PyPI 官网下载 | z3c.testsetup-0.8.1.tar.gz

Detailed documentation ********************** The package works in two steps: 1) It looks for testfiles in a given package. 2) It registers the tests according to your specifications. Initial notes ============= * Between version 0.2 and 0.3 of ``z3c.testsetup`` a new set of testfile markers was introduced. If you are still using ``Test-Layer: unit`` or similar, please read the README.txt in the source directory carefully to learn how to switch to the new names. (Or see further down this page when reading it on pypi). * Zope integration note: if you want zope integration or functional tests, you have to make sure, that the ``zope.app.testing`` and ``zope.component`` packages are available during test runs. ``z3c.testsetup`` does **not** depend on it to make it usable for plain python packages. If you want zope integration/functional tests, this is almost always already the case, so you don't need to care about this. * If you download the source code, you can look at the examples used for testing and at text files that test technical aspects of z3c.testsetup. This can be handy when you want detailed knowledge about specific features. Basic Example ============= Before we can find, register and execute tests, we first have to write them down. z3c.testsetup includes examples used for testing (you can find them all in the ``tests/`` subdirectory if you've downloaded the source code): >>> import os >>> import z3c.testsetup >>> pkgpath = os.path.dirname(z3c.testsetup.__file__) >>> cavepath = os.path.join(pkgpath, 'tests', 'othercave') 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. .. note:: How to disable markers or make them invisible All markers can be written as restructured text comments (two leading dots followed by whitespace) like this:: .. :doctest: and will still work. This way you can make the markers disappear from autogenerated docs etc. 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...testrunner.layer.UnitTests tests: Running in a subprocess. Set up zope...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 4 tests with 0 failures and 0 errors in 0.011 seconds. Tear down zope...testrunner.layer.UnitTests in 0.000 seconds. Total: 10 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):