The zope.pytestlayer distribution

Integration of zope.testrunner-style test layers into the pytest framework

This package is compatible with Python versions 3.7 - 3.12 including PyPy3.

It was formerly known as gocept.pytestlayer.

Quick start

• Make sure your test files follow the conventions of pytest's test discovery

  In particular, a file named tests.py will not be recognized.

• Add a buildout section to create the pytest runner:

  [buildout]
  parts += pytest
  
  [pytest]
  recipe = zc.recipe.egg
  eggs = zope.pytestlayer
         pytest
         <YOUR PACKAGE HERE>
  

zope.pytestlayer registers itself as a pytest plugin. This way, nothing more is needed to run an existing Zope or Plone test suite.

Advanced usage

Version 2.1 reintroduced fixture.create() to be able to define the name of the generated to pytest fixtures. So it is possible to use them in function style tests.

Example (Code has to be in contest.py!):

from .testing import FUNCTIONAL_LAYER
import zope.pytestlayer.fixture

globals().update(zope.pytestlayer.fixture.create(
    FUNCTIONAL_LAYER,
    session_fixture_name='functional_session',
    class_fixture_name='functional_class',
    function_fixture_name='functional'))

This creates three fixtures with the given names and the scopes in the argument name. The session and class fixtures run setUp() and tearDown() of the layer if it has not been run before while the function fixture runs testSetUp() and testTearDown() of the layer. The function fixture depends on the session one. The fixtures return the instance of the layer. So you can use the functional fixture like this:

def test_mymodule__my_function__1(functional):
    assert functional['app'] is not None

Not supported use cases

• Inheriting from a base class while changing the layer. See commit f879f9e.
• Mixing classes inheriting unittest.TestCase and a test_suite() function (e. g. to create a DocTestSuite or a DocFileSuite) in a single module (aka file).
  • This is a limitation of the pytest test discovery which ignores the doctests in this case.
  • Solution: Put the classes and test_suite() into different modules.
• A doctest.DocFileSuite which does not have a layer is silently skipped. Use the built-in doctest abilities of pytest to run those tests.