Package: plone.testing
IntroductionTable of contentsIntroductionCompatibilityDefinitionsInstallation and usageCoverage reportingOptional dependenciesAdding a test buildout to your packageLayersLayer basicsWriting layersAdvanced - overriding basesLayer combinationsLayer resourcesWriting testsPython testsunittestTest modules, classes and functionsTest suitesDoctestsDocstring doctestsFile doctestsDoctest fixtures and layersZope testing toolsTest cleanupEvent testingMock requestsRegistering componentsLoading ZCMLInstalling a Zope productFunctional testingLayer referenceZope Component ArchitectureUnit testingEvent testingLayer cleanupBasic ZCML directivesZCML files helper classHelper functionsZope SecuritySecurity checker isolationHelper functionsZope PublisherPublisher directivesZODBEmpty ZODB sandboxHelper functionsZopeStartupIntegration testFunctional testingIntegration and functional testing with custom fixturesHTTP WSGI server thread (fixture only)HTTP WSGI server functional testingHelper functionsZServerStartupIntegration testFunctional testingIntegration and functional testing with custom fixturesHTTP ZServer thread (fixture only)HTTP ZServer functional testingFTP server thread (fixture only)FTP server functional testingHelper functionsChangelog9.0.1 (2023-11-30)9.0.0 (2023-10-25)8.0.4 (2023-09-21)8.0.3 (2021-06-14)8.0.2 (2020-10-12)8.0.1 (2020-06-16)8.0.0 (2020-04-21)7.0.3 (2019-12-10)7.0.2 (2019-07-06)7.0.1 (2019-03-03)7.0.0 (2018-10-17)6.1.0 (2018-10-05)6.0.0 (2018-02-05)5.1.1 (2017-04-19)5.1 (2017-04-13)5.0.0 (2016-02-19)4.2.0 (2016-02-18)4.1.0 (2016-01-08)4.0.15 (2015-08-14)4.0.14 (2015-07-29)4.0.13 (2015-03-13)4.0.12 (2014-09-07)4.0.11 (2014-02-22)4.0.10 (2014-02-11)4.0.9 (2014-01-28)4.0.8 (2013-03-05)4.0.7 (2012-12-09)4.0.6 (2012-10-15)4.0.5 (2012-10-15)4.0.4 (2012-08-04)4.0.3 (2011-11-24)4.0.2 (2011-08-31)4.0.1 - 2011-05-204.0 - 2011-05-134.0a6 - 2011-04-064.0a5 - 2011-03-024.0a4 - 2011-01-114.0a3 - 2010-12-141.0a2 - 2010-09-051.0a1 - 2010-08-01Detailed documentationLayer base classUsingLayeras a base classOverriding the default list of basesInconsistent basesUsing the resource managerAsymmetric deletionDoctest layer helperZope Component Architecture layersUnit testingEvent testingLayer cleanupBasic ZCML directivesConfiguration registry sandboxingZCML files helper classSecurityLayersZope Publisher layersZCML directivesZope Object Database layersEmpty ZODB layerExtending the ZODB layerStackingDemoStoragestoragesZope WSGI layersStartupIntegration testFunctional testingThe test browserHTTP serverZope 2 layersStartupIntegration testFunctional testingThe test browserHTTP serverFTP serverplone.testingprovides tools for writing unit and integration tests in a Zope and Plone environment.
It is not tied to Plone, and it does not depend on Zope (although it has some optional Zope-only features).plone.testingbuilds onzope.testing, in particular its layers concept.
This package also aims to promote some “good practice” for writing tests of various types.NoteIf you are working with Plone, there is a complementary packageplone.app.testing, which builds onplone.testingto provide additional layers useful for testing Plone add-ons.If you are new to automated testing and test driven development, you should spend some time learning about those concepts.
Some useful references include:The Wikipedia article on unit testingThe Dive Into Python chapter on testingBear in mind that different Python frameworks have slightly different takes on how to approach testing.
Therefore, you may find examples that are different to those shown below.
The core concepts should be consistent, however.Compatibilityplone.testing7.x has been tested with Python 2.7 and 3.6.
If you’re using the optional Zope layers, you must use Zope version 4 or later.
Look at olderplone.testingversions for supporting older Zope versions.DefinitionsIn this documentation, we will use a number of testing-related terms.
The following definitions apply:Unit testAn automated test (i.e. one written in code) that tests a single unit (normally a function) in isolation.
A unit test attempts to prove that the given function works as expected and gives the correct output given a particular input.
It is common to have a number of unit tests for a single function, testing different inputs, including boundary cases and errors.
Unit tests are typically quick to write and run.Integration testAn automated test that tests how a number of units interact.
In a Zope context, this often pertains to how a particular object or view interacts with the Zope framework, the ZODB persistence engine, and so on.
Integration tests usually require some setup and can be slower to run than unit tests.
It is common to have fewer integration tests than unit test.Functional testAn automated test that tests a feature in an “end-to-end” fashion.
In a Zope context, that normally means that it invokes an action in the same way that a user would, i.e. through a web request.
Functional tests are normally slower to run than either unit or integration tests, and can be significantly slower to run.
It is therefore common to have only a few functional tests for each major feature, relying on unit and integration tests for the bulk of testing.Black box testingTesting which only considers the system’s defined inputs and outputs.
For example, a functional test is normally a black box test that provides inputs only through the defined interface (e.g. URLs published in a web application), and makes assertions only on end outputs (e.g. the response returned for requests to those URLs).White box testingTesting which examines the internal state of a system to make assertions.
Authors of unit and integration tests normally have significant knowledge of the implementation of the code under test, and can examine such things as data in a database or changes to the system’s environment to determine if the test succeeded or failed.AssertionA check that determines whether a test succeeds or fails.
For example, if a unit test for the functionfoo()expects it to return the value 1, an assertion could be written to verify this fact.
A test is said tofailif any of its assertions fail.
A test always contains one or more assertions.Test caseA single unit, integration or functional test.
Often shortened to justtest.
A test case sets up, executes and makes assertions against a single scenario that bears testing.Test fixtureThe state used as a baseline for one or more tests.
The test fixture isset upbefore each test is executed, andtorn downafterwards.
This is a pre-requisite fortest isolation- the principle that tests should be independent of one another.LayerThe configuration of a test fixture shared by a number of tests.
All test cases that belong to a particular layer will be executed together.
The layer isset uponce before the tests are executed, andtorn downonce after.
Layers may depend on one another.
Anybase layersare set up before and torn down after a particularchild layeris used.
The test runner will order test execution to minimise layer setup and tear-down.Test suiteA collection of test cases (and layers) that are executed together.Test runnerThe program which executes tests.
This is responsible for calling layer and test fixture set-up and tear-down methods.
It also reports on the test run, usually by printing output to the console.CoverageTo have confidence in your code, you should ensure it is adequately covered by tests.
That is, each line of code, and each possible branching point (loops,ifstatements) should be executed by a test.
This is known ascoverage, and is normally measured as a percentage of lines of non-test code covered by tests.
Coverage can be measured by the test runner, which keeps track of which lines of code were executed in a given test run.DoctestA style of testing where tests are written as examples that could be typed into the interactive Python interpreter.
The test runner executes each example and checks the actual output against the expected output.
Doctests can either be placed in the docstring of a method, or in a separate file.
The use of doctests is largely a personal preference.
Some developers like to write documentation as doctests, which has the advantage that code samples can be automatically tested for correctness.
You can read more about doctests onWikipedia.Installation and usageTo useplone.testingin your own package, you need to add it as a dependency.
Most people prefer to keep test-only dependencies separate, so that they do not need to be installed in scenarios (such as on a production server) where the tests will not be run.
This can be achieved using atestextra.Insetup.py, add or modify theextras_requireoption, like so::extras_require = {
    'test': [
            'plone.testing',
        ]
},You can add other test-only dependencies to that list as well, of course.To run tests, you need a test runner.
If you are usingzc.buildout, you can install a test runner using thezc.recipe.testrunnerrecipe.
For example, you could add the following to yourbuildout.cfg::[test]
recipe = zc.recipe.testrunner
eggs =
    my.package [test]
defaults = ['--auto-color', '--auto-progress']You’ll also need to add this part to thepartslist, of course::[buildout]
parts =
    ...
    testIn this example, have listed a single package to test, calledmy.package, and asked for it to be installed with the[test]extra.
This will install any regular dependencies (listed in theinstall_requiresoption insetup.py), as well as those in the list associated with thetestkey in theextras_requireoption.Note that it becomes important to properly list your dependencies here, because the test runner will only be aware of the packages explicitly listed, and their dependencies.
For example, if your package depends on Zope, you need to listZopein theinstall_requireslist insetup.py;
ditto forPlone, or indeed any other package you import from.Once you have re-run buildout, the test runner will be installed asbin/test(the executable name is taken from the name of the buildout part).
You can execute it without arguments to run all tests of each egg listed in theeggslist:$ bin/testIf you have listed several eggs, and you want to run the tests for a particular one, you can do:$ bin/test -s my.packageIf you want to run only a particular test within this package, use the-toption.
This can be passed a regular expression matching either a doctest file name or a test method name.:$ bin/test -s my.package -t test_spaceshipThere are other command line options, which you can find by running:$ bin/test --helpAlso note thedefaultsoption in the buildout configuration.
This can be used to set default command line options.
Some commonly useful options are shown above.Coverage reportingWhen writing tests, it is useful to know how well your tests cover your code.
You can create coverage reports via the excellentcoveragelibrary.
In order to use it, we need to install it and a reporting script:[buildout]
parts =
    ...
    test
    coverage
    report

[coverage]
recipe = zc.recipe.egg
eggs = coverage
initialization =
    include = '--source=${buildout:directory}/src'
    sys.argv = sys.argv[:] + ['run', include, 'bin/test', '--all']

[report]
recipe = zc.recipe.egg
eggs = coverage
scripts = coverage=report
initialization =
    sys.argv = sys.argv[:] + ['html', '-i']This will run thebin/testscript with arguments like–allto run all layers.
You can also specify no or some other arguments.
It will place coverage reporting information in a.coveragefile inside your buildout root.
Via the--sourceargument you specify the directories containing code you want to cover.
The coverage script would otherwise generate coverage information for all executed code, including other packages and even the standard library.Running thebin/reportscript will generate a human readable HTML representation of the run in thehtmlcovdirectory.
Open the containedindex.htmlin a browser to see the result.If you want to generate an XML representation suitable for theCoberturaplugin ofJenkins, you can add another part:[buildout]
parts =
    ...
    report-xml

[report-xml]
recipe = zc.recipe.egg
eggs = coverage
scripts = coverage=report-xml
initialization =
    sys.argv = sys.argv[:] + ['xml', '-i']This will generate acoverage.xmlfile in the buildout root.Optional dependenciesplone.testingcomes with a core set of tools for managing layers, which depends only onzope.testing.
In addition, there are several layers and helper functions which can be used in your own tests (or as bases for your own layers).
Some of these have deeper dependencies.
However, these dependencies are optional and not installed by default.
If you don’t use the relevant layers, you can safely ignore them.plone.testingdoes specify these dependencies, however, using thesetuptools“extras” feature.
You can depend on one or more extras in your ownsetup.pyinstall_requiresorextras_requireoption using the same square bracket notation shown for the[test]buildout part above.
For example, if you need both thezcaandpublisherextras, you can have the following in yoursetup.py:extras_require = {
    'test': [
            'plone.testing [zca, publisher]',
        ]
},The available extras are:zodbZODB testing.
Depends onZODB.
The relevant layers and helpers are in the moduleplone.testing.zodb.zcaZope Component Architecture testing.
Depends on core Zope Component Architecture packages such aszope.componentandzope.event.
The relevant layers and helpers are in the moduleplone.testing.zca.securitySecurity testing.
Depends onzope.security.
The relevant layers and helpers are in the moduleplone.testing.security.publisherZope Publisher testing.
Depends onzope.publisher,zope.browsermenu,zope.browserpage,zope.browserresourceandzope.securityand sets up ZCML directives.
The relevant layers and helpers are in the moduleplone.testing.publisher.zope(For backwards compatibility there is alsoz2.)Zope testing.
Depends on theZopeegg, which includes all the dependencies of the Zope application server.
The relevant layers and helpers are in the moduleplone.testing.zope.zserverTests against theZServer. (Python 2 only!) Requires additionally to use thezopeextra.
The relevant layers and helpers are in the moduleplone.testing.zserverAdding a test buildout to your packageWhen creating reusable, mostly stand-alone packages, it is often useful to be able to include a buildout with the package sources itself that can be used to create a test runner.
This is a popular approach for many Zope packages, for example.
In fact,plone.testingitself uses this kind of layout.To have a self-contained buildout in your package, the following is required:You need abuildout.cfgat the root of the package.In most cases, you always want abootstrap.pyfile to make it easier for people to set up a fresh buildout.Your package sources need to be inside asrcdirectory.
If you’re using namespace packages, that means the top level package should be in thesrcdirectory.Thesrcdirectory must be referenced insetup.py.For example,plone.testinghas the following layout:plone.testing/
plone.testing/setup.py
plone.testing/bootstrap.py
plone.testing/buildout.cfg
plone.testing/README.rst
plone.testing/src/
plone.testing/src/plone
plone.testing/src/plone/__init__.py
plone.testing/src/plone/testing/
plone.testing/src/plone/testing/*Insetup.py, the following arguments are required:packages=find_packages('src'),
package_dir={'': 'src'},This tellssetuptoolswhere to find the source code.Thebuildout.cfgforplone.testinglooks like this:[buildout]
extends =
    http://download.zope.org/Zope2/index/2.12.12/versions.cfg
parts = coverage test report report-xml
develop = .

[test]
recipe = collective.xmltestreport
eggs =
    plone.testing [test]
defaults = ['--auto-color', '--auto-progress']

[coverage]
recipe = zc.recipe.egg
eggs = coverage
initialization =
    include = '--source=${buildout:directory}/src'
    sys.argv = sys.argv[:] + ['run', include, 'bin/test', '--all', '--xml']

[report]
recipe = zc.recipe.egg
eggs = coverage
scripts = coverage=report
initialization =
    sys.argv = sys.argv[:] + ['html', '-i']

[report-xml]
recipe = zc.recipe.egg
eggs = coverage
scripts = coverage=report-xml
initialization =
    sys.argv = sys.argv[:] + ['xml', '-i']Obviously, you should adjust the package name in theeggslist and the version set in theextendsline as appropriate.You can of course also add additional buildout parts, for example to include some development/debugging tools, or even a running application server for testing purposes.Hint:If you use this package layout, you should avoid checking any files or directories generated by buildout into your version control repository.
You want to ignore:.coverage.installed.cfgbincoverage.xmldevelop-eggshtmlcovpartssrc/*.egg-infoLayersIn large part,plone.testingis about layers.
It provides:A set of layers (outlined below), which you can use or extend.A set of tools for working with layersA mini-framework to make it easy to write layers and manage shared resources associated with layers.We’ll discuss the last two items here, before showing how to write tests that use layers.Layer basicsLayers are used to create test fixtures that are shared by multiple test cases.
For example, if you are writing a set of integration tests, you may need to set up a database and configure various components to access that database.
This type of test fixture setup can be resource-intensive and time-consuming.
If it is possible to only perform the setup and tear-down once for a set of tests without losing isolation between those tests, test runs can often be sped up significantly.Layers also allow reuse of test fixtures and set-up/tear-down code.plone.testingprovides a number of useful (but optional) layers that manage test fixtures for common Zope testing scenarios, letting you focus on the actual test authoring.At the most basic, a layer is an object with the following methods and attributes:setUp()Called by the test runner when the layer is to be set up.
This is called exactly once for each layer used during a test run.tearDown()Called by the test runner when the layer is to be torn down.
As withsetUp(), this is called exactly once for each layer.testSetUp()Called immediately before each test case that uses the layer is executed.
This is useful for setting up aspects of the fixture that are managed on a per-test basis, as opposed to fixture shared among all tests.testTearDown()Called immediately after each test case that uses the layer is executed.
This is a chance to perform any post-test cleanup to ensure the fixture is ready for the next test.__bases__A tuple of base layers.Each test case is associated with zero or one layer.
(The syntax for specifying the layer is shown in the section “Writing tests” below.) All the tests associated with a given layer will be executed together.Layers can depend on one another (as indicated in the__bases__tuple), allowing one layer to build on the fixture created by another.
Base layers are set up before and torn down after their dependants.For example, if the test runner is executing some tests that belong to layer A, and some other tests that belong to layer B, both of which depend on layer C, the order of execution might be:1. C.setUp()
1.1. A.setUp()

1.1.1. C.testSetUp()
1.1.2. A.testSetUp()
1.1.3. [One test using layer A]
1.1.4. A.testTearDown()
1.1.5. C.testTearDown()

1.1.6. C.testSetUp()
1.1.7. A.testSetUp()
1.1.8. [Another test using layer A]
1.1.9. A.testTearDown()
1.1.10. C.testTearDown()

1.2. A.tearDown()
1.3. B.setUp()

1.3.1. C.testSetUp()
1.3.2. B.testSetUp()
1.3.3. [One test using layer B]
1.3.4. B.testTearDown()
1.3.5. C.testTearDown()

1.3.6. C.testSetUp()
1.3.7. B.testSetUp()
1.3.8. [Another test using layer B]
1.3.9. B.testTearDown()
1.3.10. C.testTearDown()

1.4. B.tearDown()
2. C.tearDown()A base layer may of course depend on other base layers.
In the case of nested dependencies like this, the order of set up and tear-down as calculated by the test runner is similar to the way in which Python searches for the method to invoke in the case of multiple inheritance.Writing layersThe easiest way to create a new layer is to use theLayerbase class and implement thesetUp(),tearDown(),testSetUp()andtestTearDown()methods as needed.
All four are optional.
The default implementation of each does nothing.By convention, layers are created in a module calledtesting.pyat the top level of your package.
The idea is that other packages that extend your package can reuse your layers for their own testing.A simple layer may look like this:>>> from plone.testing import Layer
>>> class SpaceShip(Layer):
...
...     def setUp(self):
...         print("Assembling space ship")
...
...     def tearDown(self):
...         print("Disasembling space ship")
...
...     def testSetUp(self):
...         print("Fuelling space ship in preparation for test")
...
...     def testTearDown(self):
...         print("Emptying the fuel tank")Before this layer can be used, it must be instantiated.
Layers are normally instantiated exactly once, since by nature they are shared between tests.
This becomes important when you start to manage resources (such as persistent data, database connections, or other shared resources) in layers.The layer instance is conventionally also found intesting.py, just after the layer class definition.:>>> SPACE_SHIP = SpaceShip()NoteSince the layer is instantiated in module scope, it will be created as soon as thetestingmodule is imported.
It is therefore very important that the layer class is inexpensive and safe to create.
In general, you should avoid doing anything non-trivial in the__init__()method of your layer class.
All setup should happen in thesetUp()method.
If youdoimplement__init__(), be sure to call thesuperversion as well.The layer shown above did not have any base layers (dependencies).
Here is an example of another layer that depends on it::>>> class ZIGSpaceShip(Layer):
...     defaultBases = (SPACE_SHIP,)
...
...     def setUp(self):
...         print("Installing main canon")

>>> ZIG = ZIGSpaceShip()Here, we have explicitly listed the base layers on whichZIGSpaceShipdepends, in thedefaultBasesattribute.
This is used by theLayerbase class to set the layer bases in a way that can also be overridden: see below.Note that we use the layerinstancein thedefaultBasestuple, not the class.
Layer dependencies always pertain to specific layer instances.
Above, we are really saying thatinstancesofZIGSpaceShipwill, by default, require theSPACE_SHIPlayer to be set up first.NoteYou may find it useful to create other layer base/mix-in classes that extendplone.testing.Layerand provide helper methods for use in your own layers.
This is perfectly acceptable, but please do not confuse a layer base class used in this manner with the concept of abase layeras described above:A class deriving fromplone.testing.Layeris known as alayer class.
It defines the behaviour of the layer by implementing the lifecycle methodssetUp(),tearDown(),testSetUp()and/ortestTearDown().A layer class can be instantiated into an actual layer.
When a layer is associated with a test, it is the layerinstancethat is used.The instance is usually a shared, module-global object, although in some cases it is useful to create copies of layers by instantiating the class more than once.Subclassing an existing layer class is just straightforward OOP reuse: the test runner is not aware of the subclassing relationship.A layerinstancecan be associated with any number of layerbases, via its__bases__property (which is usually via thedefaultBasesvariable in the class body and/or overridden using thebasesargument to theLayerconstructor).
These bases are layerinstances, not classes.
The test runner will inspect the__bases__attribute of each layer instance it sets up to calculate layer pre-requisites and dependencies.Also note that thezope.testingdocumentation contains examples of layers that are “old-style” classes where thesetUp()andtearDown()methods areclassmethodmethods and class inheritance syntax is used to specify base layers.
Whilst this pattern works, we discourage its use, because the classes created using this pattern are not really used as classes.
The concept of layer bases is slightly different from class inheritance, and using theclasskeyword to create layers with base layers leads to a number of “gotchas” that are best avoided.Advanced - overriding basesIn some cases, it may be useful to create a copy of a layer, but change its bases.
One reason to do this may if you are reusing a layer from another module, and you need to change the order in which layers are set up and torn down.Normally, of course, you would just reuse the layer instance, either directly in a test, or in thedefaultBasestuple of another layer, but if you need to change the bases, you can pass a new list of bases to the layer instance constructor::>>> class CATSMessage(Layer):
...
...     def setUp(self):
...         print("All your base are belong to us")
...
...     def tearDown(self):
...         print("For great justice")

>>> CATS_MESSAGE = CATSMessage()

>>> ZERO_WING = ZIGSpaceShip(bases=(SPACE_SHIP, CATS_MESSAGE,), name="ZIGSpaceShip:CATSMessage")Please note that when overriding bases like this, thenameargument is required.
This is because each layer (using in a given test run) must have a unique name.
The default is to use the layer class name, but this obviously only works for one instantiation.
Therefore,plone.testingrequires a name when settingbasesexplicitly.Please take great care when changing layer bases like this.
The layer implementation may make assumptions about the test fixture that was set up by its bases.
If you change the order in which the bases are listed, or remove a base altogether, the layer may fail to set up correctly.Also, bear in mind that the new layer instance is independent of the original layer instance, so any resources defined in the layer are likely to be duplicated.Layer combinationsSometimes, it is useful to be able to combine several layers into one, without adding any new fixture.
One way to do this is to use theLayerclass directly and instantiate it with new bases::>>> COMBI_LAYER = Layer(bases=(CATS_MESSAGE, SPACE_SHIP,), name="Combi")Here, we have created a “no-op” layer with two bases:CATS_MESSAGEandSPACE_SHIP, namedCombi.Please note that when usingLayerdirectly like this, thenameargument is required.
This is to allow the test runner to identify the layer correctly.
Normally, the class name of the layer is used as a basis for the name, but when using theLayerbase class directly, this is unlikely to be unique or descriptive.Layer resourcesMany layers will manage one or more resources that are used either by other layers, or by tests themselves.
Examples may include database connections, thread-local objects, or configuration data.plone.testingcontains a simple resource storage abstraction that makes it easy to access resources from dependent layers or tests.
The resource storage uses dictionary notation::>>> class WarpDrive(object):
...     """A shared resource"""
...
...     def __init__(self, maxSpeed):
...         self.maxSpeed = maxSpeed
...         self.running = False
...
...     def start(self, speed):
...         if speed > self.maxSpeed:
...             print("We need more power!")
...         else:
...             print("Going to warp at speed", speed)
...             self.running = True
...
...     def stop(self):
...         self.running = False

>>> class ConstitutionClassSpaceShip(Layer):
...     defaultBases = (SPACE_SHIP,)
...
...     def setUp(self):
...         self['warpDrive'] = WarpDrive(8.0)
...
...     def tearDown(self):
...         del self['warpDrive']

>>> CONSTITUTION_CLASS_SPACE_SHIP = ConstitutionClassSpaceShip()

>>> class GalaxyClassSpaceShip(Layer):
...     defaultBases = (CONSTITUTION_CLASS_SPACE_SHIP,)
...
...     def setUp(self):
...         # Upgrade the warp drive
...         self.previousMaxSpeed = self['warpDrive'].maxSpeed
...         self['warpDrive'].maxSpeed = 9.5
...
...     def tearDown(self):
...         # Restore warp drive to its previous speed
...         self['warpDrive'].maxSpeed = self.previousMaxSpeed

>>> GALAXY_CLASS_SPACE_SHIP = GalaxyClassSpaceShip()As shown, layers (that derive fromplone.testing.Layer) support item (dict-like) assignment, access and deletion of arbitrary resources under string keys.Important:If a layer creates a resource (by assigning an object to a key onselfas shown above) during fixture setup-up, it must also delete the resource on tear-down.
Set-up and deletion should be symmetric: if the resource is assigned duringsetUp()it should be deleted intearDown();
if it’s created intestSetUp()it should be deleted intestTearDown().A resource defined in a base layer is accessible from and through a child layer.
If a resource is set on a child using a key that also exists in a base layer, the child version will shadow the base version until the child layer is torn down (presuming it deletes the resource, which it should), but the base layer version remains intact.NoteAccessing a resource is analogous to accessing an instance variable.
For example, if a base layer assigns a resource to a given key in itssetUp()method, a child layer shadows that resource with another object under the same key, the shadowed resource will by used during thetestSetUp()andtestTearDown()lifecycle methods if implemented by thebaselayer as well.
This will be the case until the child layer “pops” the resource by deleting it, normally in itstearDown().Conversely, if (as shown above) the child layer accesses and modifies the object, it will modify the original.NoteIt is sometimes necessary (or desirable) to modify a shared resource in a child layer, as shown in the example above.  In this case, however, it is very important to restore the original state when the layer is torn down.  Otherwise, other layers or tests using the base layer directly may be affected in difficult-to-debug ways.If the same key is used in multiple base layers, the rules for choosing which version to use are similar to those that apply when choosing an attribute or method to use in the case of multiple inheritance.In the example above, we used the resource manager for thewarpDriveobject, but we assigned thepreviousMaxSpeedvariable toself.
This is becausepreviousMaxSpeedis internal to the layer and should not be shared with any other layers that happen to use this layer as a base.
Nor should it be used by any test cases.
Conversely,warpDriveis a shared resource that is exposed to other layers and test cases.The distinction becomes even more important when you consider how a test case may access the shared resource.
We’ll discuss how to write test cases that use layers shortly, but consider the following test::>>> import unittest
>>> class TestFasterThanLightTravel(unittest.TestCase):
...     layer = GALAXY_CLASS_SPACE_SHIP
...
...     def test_hyperdrive(self):
...         warpDrive = self.layer['warpDrive']
...         warpDrive.start(8)This test needs access to the shared resource.
It knows that its layer defines one calledwarpDrive.
It does not know or care that the warp drive was actually initiated by theConstitutionClassSpaceShipbase layer.If, however, the base layer had assigned the resource as an instance variable, it would not inherit to child layers (remember: layer bases are not base classes!).
The syntax to access it would be::self.layer.__bases__[0].warpDrivewhich is not only ugly, but brittle: if the list of bases is changed, the expression above may lead to an attribute error.Writing testsTests are usually written in one of two ways: As methods on a class that derives fromunittest.TestCase(this is sometimes known as “Python tests” or “JUnit-style tests”), or using doctest syntax.You should realise that although the relevant frameworks (unittestanddoctest) often talk about unit testing, these tools are also used to write integration and functional tests.
The distinction between unit, integration and functional tests is largely practical: you use the same techniques to set up a fixture or write assertions for an integration test as you would for a unit test.
The difference lies in what that fixture contains, and how you invoke the code under test.
In general, a true unit test will have a minimal or no test fixture, whereas an integration test will have a fixture that contains the components your code is integrating with.
A functional test will have a fixture that contains enough of the full system to execute and test an “end-to-end” scenario.Python testsPython tests use the Pythonunittestmodule.
They should be placed in a module or package calledtestsfor the test runner to pick them up.For small packages, a single module calledtests.pywill normally contain all tests.
For larger packages, it is common to have atestspackage that contains a number of modules with tests.
These need to start with the wordtest, e.g.tests/test_foo.pyortests/test_bar.py.
Don’t forget the__init__.pyin thetestspackage, too!unittestPlease note that thezope.testingtest runner at the time of writing (version 4.6.2) does not (yet) support the newsetUpClass(),tearDownClass(),setUpModule()andtearDownModule()hooks fromunittest.
This is not normally a problem, since we tend to use layers to manage complex fixtures, but it is important to be aware of nonetheless.Test modules, classes and functionsPython tests are written with classes that derive from the base classTestCase.
Each test is written as a method that takes no arguments and has a name starting withtest.
Other methods can be added and called from test methods as appropriate, e.g.
to share some test logic.Two special methods,setUp()andtearDown(), can also be added.
These will be called before or after each test, respectively, and provide a useful place to construct and clean up test fixtures without writing a custom layer.
They are obviously not as reusable as layers, though.Hint:Somewhat confusingly, thesetUp()andtearDown()methods in a test case class are the equivalent of thetestSetUp()andtestTearDown()methods of a layer class.A layer can be specified by setting thelayerclass attribute to a layer instance.
If layers are used in conjunction withsetUp()andtearDown()methods in the test class itself, the class’setUp()method will be called after the layer’stestSetUp()method, and the class’tearDown()method will be called before the layer’stestTearDown()method.TheTestCasebase class contains a number of methods which can be used to write assertions.
They all take the formself.assertSomething(), e.g.self.assertEqual(result, expectedValue).
See theunittestdocumentation for details.Putting this together, let’s expand on our previous example unit test::>>> import unittest

>>> class TestFasterThanLightTravel(unittest.TestCase):
...     layer = GALAXY_CLASS_SPACE_SHIP
...
...     def setUp(self):
...         self.warpDrive = self.layer['warpDrive']
...         self.warpDrive.stop()
...
...     def tearDown(self):
...         self.warpDrive.stop()
...
...     def test_warp8(self):
...         self.warpDrive.start(8)
...         self.assertEqual(self.warpDrive.running, True)
...
...     def test_max_speed(self):
...         tooFast = self.warpDrive.maxSpeed + 0.1
...         self.warpDrive.start(tooFast)
...         self.assertEqual(self.warpDrive.running, False)A few things to note:The class derives fromunittest.TestCase.Thelayerclass attribute is set to a layer instance (not a layer class!) defined previously.
This would typically be imported from atestingmodule.There are two tests here:test_warp8()andtest_max_speed().We have used theself.assertEqual()assertion in both tests to check the result of executing thestart()method on the warp drive.We have used thesetUp()method to fetch thewarpDriveresource and ensure that it is stopped before each test is executed.
Assigning a variable toselfis a useful way to provide some state to each test method, though be careful about data leaking between tests: in general, you cannot predict the order in which tests will run, and tests should always be independent.We have used thetearDown()method to make sure the warp drive is really stopped after each test.Test suitesA class like the one above is all you need: any class deriving fromTestCasein a module with a name starting withtestwill be examined for test methods.
Those tests are then collected into a test suite and executed.See theunittestdocumentation for other options.DoctestsDoctests can be written in two ways: as the contents of a docstring (usually, but not always, as a means of illustrating and testing the functionality of the method or class where the docstring appears), or as a separate text file.
In both cases, the standarddoctestmodule is used.
See its documentation for details about doctest syntax and conventions.Doctests are used in two different ways:To test documentation.
That is, to ensure that code examples contained in documentation are valid and continue to work as the software is updated.As a convenient syntax for writing tests.These two approaches use the same testing APIs and techniques.
The difference is mostly about mindset.
However, it is important to avoid falling into the trap that tests can substitute for good documentation or vice-a-versa.
Tests usually need to systematically go through inputs and outputs and cover off a number of corner cases.
Documentation should tell a compelling narrative and usually focus on the main usage scenarios.
Trying to kill these two birds with one stone normally leaves you with an unappealing pile of stones and feathers.Docstring doctestsDoctests can be added to any module, class or function docstring::def canOutrunKlingons(warpDrive):
    """Find out of the given warp drive can outrun Klingons.

    Klingons travel at warp 8

    >>> drive = WarpDrive(5)
    >>> canOutrunKlingons(drive)
    False

    We have to be faster than that to outrun them.

    >>> drive = WarpDrive(8.1)
    >>> canOutrunKlingons(drive)
    True

    We can't outrun them if we're travelling exactly the same speed

    >>> drive = WarpDrive(8.0)
    >>> canOutrunKlingons(drive)
    False

    """
    return warpDrive.maxSpeed > 8.0To add the doctests from a particular module to a test suite, you need to use thetest_suite()function hook::>>> import doctest
>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         unittest.makeSuite(TestFasterThanLightTravel), # our previous test
...         doctest.DocTestSuite('spaceship.utils'),
...     ])
...     return suiteHere, we have given the name of the module to check as a string dotted name.
It is also possible to import a module and pass it as an object.
The code above passes a list toaddTests(), making it easy to add several sets of tests to the suite: the list can be constructed from calls toDocTestSuite(),DocFileSuite()(shown below) andmakeSuite()(shown above).Remember that if you add atest_suite()function to a module that also hasTestCase-derived python tests, those tests will no longer be automatically picked up byzope.testing, so you need to add them to the test suite explicitly.The example above illustrates a documentation-oriented doctest, where the doctest forms part of the docstring of a public module.
The same syntax can be used for more systematic unit tests.
For example, we could have a modulespaceship.tests.test_spaceshipwith a set of methods like:# It's often better to put the import into each method, but here we've
# imported the code under test at module level
from spaceship.utils import WarpDrive, canOutrunKlingons

def test_canOutrunKlingons_too_small():
    """Klingons travel at warp 8.0

    >>> drive = WarpDrive(7.9)
    >>> canOutrunKlingons(drive)
    False

    """

def test_canOutrunKlingons_big():
    """Klingons travel at warp 8.0

    >>> drive = WarpDrive(8.1)
    >>> canOutrunKlingons(drive)
    True

    """

def test_canOutrunKlingons_must_be_greater():
    """Klingons travel at warp 8.0

    >>> drive = WarpDrive(8.0)
    >>> canOutrunKlingons(drive)
    False

    """Here, we have created a number of small methods that have no body.
They merely serve as a container for docstrings with doctests.
Since the module has no globals, each test must import the code under test, which helps make import errors more explicit.File doctestsDoctests contained in a file are similar to those contained in docstrings.
File doctests are better suited to narrative documentation covering the usage of an entire module or package.For example, if we had a file calledspaceship.txtwith doctests, we could add it to the test suite above with::>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         unittest.makeSuite(TestFasterThanLightTravel),
...         doctest.DocTestSuite('spaceship.utils'),
...         doctest.DocFileSuite('spaceship.txt'),
...     ])
...     return suiteBy default, the file is located relative to the module where the test suite is defined.
You can use../(even on Windows) to reference the parent directory, which is sometimes useful if the doctest is inside a module in atestspackage.NoteIf you put the doctesttest_suite()method in a module inside atestspackage, that module must have a name starting withtest.
It is common to havetests/test_doctests.pythat contains a singletest_suite()method that returns a suite of multiple doctests.It is possible to pass several tests to the suite, e.g.:>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         unittest.makeSuite(TestFasterThanLightTravel),
...         doctest.DocTestSuite('spaceship.utils'),
...         doctest.DocFileSuite('spaceship.txt', 'warpdrive.txt',),
...     ])
...     return suiteThe test runner will report each file as a separate test, i.e.
theDocFileSuite()above would add two tests to the overall suite.
Conversely, aDocTestSuite()using a module with more than one docstring containing doctests will report one test for each eligible docstring.Doctest fixtures and layersA docstring doctest will by default have access to any global symbol available in the module where the docstring is found (e.g.
anything defined or imported in the module).
The global namespace can be overridden by passing aglobskeyword argument to theDocTestSuite()constructor, or augmented by passing anextraglobsargument.
Both should be given dictionaries.A file doctest has an empty globals namespace by default.
Globals may be provided via theglobsargument toDocFileSuite().To manage a simple test fixture for a doctest, you can define set-up and tear-down functions and pass them as thesetUpandtearDownarguments respectively.
These are both passed a single argument, aDocTestobject.
The most useful attribute of this object isglobs, which is a mutable dictionary of globals available in the test.For example::>>> def setUpKlingons(doctest):
...     doctest.globs['oldStyleKlingons'] = True

>>> def tearDownKlingons(doctest):
...     doctest.globs['oldStyleKlingons'] = False

>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         doctest.DocTestSuite('spaceship.utils', setUp=setUpKlingons, tearDown=tearDownKlingons),
...     ])
...     return suiteThe same arguments are available on theDocFileSuite()constructor.
The set up method is called before each docstring in the given module for aDocTestSuite, and before each file given in aDocFileSuite.Of course, we often want to use layers with doctests too.
Unfortunately, theunittestAPI is not aware of layers, so you can’t just pass a layer to theDocTestSuite()andDocFileSuite()constructors.
Instead, you have to set alayerattribute on the suite after it has been constructed.Furthermore, to use layer resources in a doctest, we need access to the layer instance.
The easiest way to do this is to pass it as a glob, conventionally called ‘layer’.
This makes a global name ‘layer’ available in the doctest itself, giving access to the test’s layer instance.To make it easier to do this,plone.testingcomes with a helper function calledlayered().
Its first argument is a test suite.
The second argument is the layer.For example::>>> from plone.testing import layered
>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         layered(doctest.DocTestSuite('spaceship.utils'), layer=CONSTITUTION_CLASS_SPACE_SHIP),
...     ])
...     return suiteThis is equivalent to::>>> def test_suite():
...     suite = unittest.TestSuite()
...
...     spaceshipUtilTests = doctest.DocTestSuite('spaceship.utils', globs={'layer': CONSTITUTION_CLASS_SPACE_SHIP})
...     spaceshipUtilTests.layer = CONSTITUTION_CLASS_SPACE_SHIP
...     suite.addTest(spaceshipUtilTests)
...
...     return suite(In this example, we’ve opted to useaddTest()to add a single suite, instead of usingaddTests()to add multiple suites in one go).Zope testing toolsEverything described so far in this document relies only on the standardunittestanddoctestmodules andzope.testing, and you can use this package without any other dependencies.However, there are also some tools (and layers) available in this package, as well as in other packages, that are specifically useful for testing applications that use various Zope-related frameworks.Test cleanupIf a test uses a global registry, it may be necessary to clean that registry on set up and tear down of each test fixture.zope.testingprovides a mechanism to register cleanup handlers - methods that are called to clean up global state.
This can then be invoked in thesetUp()andtearDown()fixture lifecycle methods of a test case.:>>> from zope.testing import cleanupLet’s say we had a global registry, implemented as a dictionary::>>> SOME_GLOBAL_REGISTRY = {}If we wanted to clean this up on each test run, we could callclear()on the dict.
Since that’s a no-argument method, it is perfect as a cleanup handler.:>>> cleanup.addCleanUp(SOME_GLOBAL_REGISTRY.clear)We can now use thecleanUp()method to execute all registered cleanups::>>> cleanup.cleanUp()This call could be placed in asetUp()and/ortearDown()method in a test class, for example.Event testingYou may wish to test some code that useszope.eventto fire specific events.zope.componentprovides some helpers to capture and analyse events.:>>> from zope.component import eventtestingTo use this, you first need to set up event testing.
Some of the layers shown below will do this for you, but you can do it yourself by calling theeventtesting.setUp()method, e.g.
from your ownsetUp()method::>>> eventtesting.setUp()This simply registers a few catch-all event handlers.
Once you have executed the code that is expected to fire events, you can use thegetEvents()helper function to obtain a list of the event instances caught::>>> events = eventtesting.getEvents()You can now examineeventsto see what events have been caught since the last cleanup.getEvents()takes two optional arguments that can be used to filter the returned list of events.
The first (event_type) is an interface.
If given, only events providing this interface are returned.
The second (filter) is a callable taking one argument.
If given, it will be called with each captured event.
Only those events where the filter function returnsTruewill be included.Theeventtestingmodule registers a cleanup action as outlined above.
When you callcleanup.cleanUp()(oreventtesting.clearEvents(), which is the handler it registers), the events list will be cleared, ready for the next test.
Here, we’ll do it manually::>>> eventtesting.clearEvents()Mock requestsMany tests require a request object, often with particular request/form variables set.zope.publishercontains a useful class for this purpose.:>>> from zope.publisher.browser import TestRequestA simple test request can be constructed with no arguments::>>> request = TestRequest()To add a body input stream, pass aStringIOor file as the first parameter.
To set the environment (request headers), use theenvironkeyword argument.
To simulate a submitted form, use theformkeyword argument::>>> request = TestRequest(form=dict(field1='foo', field2=1))Note that theformdict contains marshalled form fields, so modifiers like:intor:booleanshould not be included in the field names, and values should be converted to the appropriate type.Registering componentsMany test fixtures will depend on having a minimum of Zope Component Architecture (ZCA) components registered.
In normal operation, these would probably be registered via ZCML, but in a unit test, you should avoid loading the full ZCML configuration of your package (and its dependencies).Instead, you can use the Python API inzope.componentto register global components instantly.
The three most commonly used functions are::>>> from zope.component import provideAdapter
>>> from zope.component import provideUtility
>>> from zope.component import provideHandlerSee thezope.componentdocumentation for details about how to use these.When registering global components like this, it is important to avoid test leakage.
Thecleanupmechanism outlined above can be used to tear down the component registry between each test.
See also theplone.testing.zca.UNIT_TESTINGlayer, described below, which performs this cleanup automatically via thetestSetUp()/testTearDown()mechanism.Alternatively, you can “stack” a new global component registry using theplone.testing.zca.pushGlobalRegistry()andplone.testing.zca.popGlobalRegistry()helpers.
This makes it possible to set up and tear down components that are specific to a given layer, and even allow tests to safely call the global component API (or load ZCML - see below) with proper tear-down.
See the layer reference below for details.Loading ZCMLIntegration tests often need to load ZCML configuration.
This can be achieved using thezope.configurationAPI.:>>> from zope.configuration import xmlconfigThexmlconfigmodule contains two methods for loading ZCML.xmlconfig.string()can be used to load a literal string of ZCML::>>> xmlconfig.string("""\
... <configure xmlns="http://namespaces.zope.org/zope" package="plone.testing">
...     <include package="zope.component" file="meta.zcml" />
... </configure>
... """)
<zope.configuration.config.ConfigurationMachine object at ...>Note that we need to set a package (used for relative imports and file locations) explicitly here, using thepackageattribute of the<configure />element.Also note that unless the optional second argument (context) is passed, a new configuration machine will be created every timestring()is called.
It therefore becomes necessary to explicitly<include />the files that contain the directives you want to use (the one inzope.componentis a common example).
Layers that set up ZCML configuration may expose a resource which can be passed as thecontextparameter, usually calledconfigurationContext- see below.To load the configuration for a particular package, usexmlconfig.file()::>>> import zope.component
>>> context = xmlconfig.file('meta.zcml', zope.component)
>>> xmlconfig.file('configure.zcml', zope.component, context=context)
<zope.configuration.config.ConfigurationMachine object at ...>This takes two required arguments: the file name and the module relative to which it is to be found.
Here, we have loaded two files:meta.zcmlandconfigure.zcml.
The first call toxmlconfig.file()creates and returns a configuration context.
We reuse that for the subsequent invocation, so that the directives configured are available.Installing a Zope productSome packages (including all those in theProducts.*namespace) have the special status of being Zope “products”.
These are recorded in a special registry, and may have aninitialize()hook in their top-level__init__.pythat needs to be called for the package to be fully configured.Zope 2 will find and execute any products during startup.
For testing, we need to explicitly list the products to install.
Provided you are usingplone.testingwith Zope, you can use the following::from plone.testing import zope

with zope.zopeApp() as app:
    zope.installProduct(app, 'Products.ZCatalog')This would normally be used during layersetUp().
Note that the basic Zope application context must have been set up before doing this.
The usual way to ensure this, is to use a layer that is based onzope.STARTUP- see below.To tear down such a layer, you should do::from plone.testing import zope

with zope.zopeApp() as app:
    zope.uninstallProduct(app, 'Products.ZCatalog')Note:Unlike the similarly-named function fromZopeTestCase, these helpers will work with any type of product.
There is no distinction between a “product” and a “package” (and noinstallPackage()).
However, you must use the full name (Products.*) when registering a product.Installing a product in this manner is independent of ZCML configuration.
However, it is almost always necessary to install the package’s ZCML configuration first.Functional testingFor functional tests that aim to simulate the browser, you can usezope.testbrowserin a Python test or doctest::>>> from zope.testbrowser.browser import Browser
>>> browser = Browser()This provides a simple API to simulate browser input, without actually running a web server thread or scripting a live browser (as tools such asSeleniumdo).
The downside is that it is not possible to test JavaScript- dependent behaviour.If you are testing a Zope application, you need to change the import location slightly, and pass the application root to the method::from plone.testing.zope import Browser
browser = Browser(app)You can get the application root from theappresource in any of the Zope layers in this package.Beyond that, thezope.testbrowserdocumentation should cover how to use the test browser.Hint:The test browser will usually commit at the end of a request.
To avoid test fixture contamination, you should use a layer that fully isolates each test, such as thezope.INTEGRATION_TESTINGlayer described below.Layer referenceplone.testingcomes with several layers that are available to use directly or extend.
These are outlined below.Zope Component ArchitectureThe Zope Component Architecture layers are found in the moduleplone.testing.zca.
If you depend on this, you can use the[zca]extra when depending onplone.testing.Unit testingLayer:plone.testing.zca.UNIT_TESTINGClass:plone.testing.zca.UnitTestingBases:NoneResources:NoneThis layer does not set up a fixture per se, but cleans up global state before and after each test, usingzope.testing.cleanupas described above.The net result is that each test has a clean global component registry.
Thus, it is safe to use thezope.componentPython API (provideAdapter(),provideUtility(),provideHandler()and so on) to register components.Be careful with using this layer in combination with other layers.
Because it tears down the component registry between each test, it will clobber any layer that sets up more permanent test fixture in the component registry.Event testingLayer:plone.testing.zca.EVENT_TESTINGClass:plone.testing.zca.EventTestingBases:plone.testing.zca.UNIT_TESTINGResources:NoneThis layer extends thezca.UNIT_TESTINGlayer to enable theeventtestingsupport fromzope.component.
Using this layer, you can import and usezope.component.eventtesting.getEventto inspect events fired by the code under test.See above for details.Layer cleanupLayer:plone.testing.zca.LAYER_CLEANUPClass:plone.testing.zca.LayerCleanupBases:NoneResources:NoneThis layer calls the cleanup functions fromzope.testing.cleanupon setup and tear-down (but not between each test).
It is useful as a base layer for other layers that need an environment as pristine as possible.Basic ZCML directivesLayer:plone.testing.zca.ZCML_DIRECTIVESClass:plone.testing.zca.ZCMLDirectivesBases:plone.testing.zca.LAYER_CLEANUPResources:configurationContextThis registers a minimal set of ZCML directives, principally those found in thezope.componentpackage, and makes available a configuration context.
This allows custom ZCML to be loaded as described above.TheconfigurationContextresource should be used when loading custom ZCML.
To ensure isolation, you should stack this using thestackConfigurationContext()helper.
For example, if you were writing asetUp()method in a layer that hadzca.ZCML_DIRECTIVESas a base, you could do::self['configurationContext'] = context = zca.stackConfigurationContext(self.get('configurationContext'))
xmlconfig.string(someZCMLString, context=context)This will create a new configuration context with the state of the base layer’s context.
On tear-down, you should delete the layer-specific resource::del self['configurationContext']NoteIf you fail to do this, you may get problems if your layer is torn down and then needs to be set up again later.See above for more details about loading custom ZCML in a layer or test.ZCML files helper classClass:plone.testing.zca.ZCMLSandboxResources:configurationContextTheZCMLSandboxcan be instantiated with afilenameandpackagearguments:ZCML_SANDBOX = zca.ZCMLSandbox(filename="configure.zcml",
    package=my.package)That layersetUploads the ZCML file.
It avoids the need to using (and understand)configurationContextandglobalRegistryuntil you need more flexibility or modularity for your layer and tests.See above for more details about loading custom ZCML in a layer or test.Helper functionsThe following helper functions are available in theplone.testing.zcamodule.stackConfigurationContext(context=None)Create and return a copy of the passed-in ZCML configuration context, or a brand new context if it isNone.The purpose of this is to ensure that if a layer loads some ZCML files (using thezope.configurationAPI during) during itssetUp(), the state of the configuration registry (which includes registered directives as well as a list of already imported files, which will not be loaded again even if explicitly included) can be torn down duringtearDown().The usual pattern is to keep the configuration context in a layer resource calledconfigurationContext.
InsetUp(), you would then use:self['configurationContext'] = context = zca.stackConfigurationContext(self.get('configurationContext'))

# use 'context' to load some ZCMLIntearDown(), you can then simply do:del self['configurationContext']pushGlobalRegistry(new=None)Create or obtain a stack of global component registries, and push a new registry to the top of the stack.
The net result is thatzope.component.getGlobalSiteManager()and (an un-hooked)getSiteManager()will return the new registry instead of the default, module-scope one.
From this point onwards, calls toprovideAdapter(),provideUtility()and other functions that modify the global registry will use the new registry.Ifnewis not given, a new registry is created that has the previous global registry (site manager) as its sole base.
This has the effect that registrations in the previous default global registry are still available, but new registrations are confined to the new registry.Warning: If you call this function, youmustreciprocally callpopGlobalRegistry().
That is, if you “push” a registry during layersetUp(), you must “pop” it duringtearDown().
If you “push” duringtestSetUp(), you must “pop” duringtestTearDown().
If the calls to push and pop are not balanced, you will leave your global registry in a mess, which is not pretty.Returns the new default global site manager.
Also causes the site manager hook fromzope.component.hooksto be reset, clearing any local site managers as appropriate.popGlobalRegistry()Pop the global site registry, restoring the previous registry to be the default.Please heed the warning above: push and pop must be balanced.Returns the new default global site manager.
Also causes the site manager hook fromzope.component.hooksto be reset, clearing any local site managers as appropriate.Zope SecurityThe Zope Security layers build can be found in the moduleplone.testing.security.If you depend on this, you can use the[security]extra when depending onplone.testing.Security checker isolationLayer:plone.testing.security.CHECKERSClass:plone.testing.security.CheckersBases:NoneResources:NoneThis layer ensures that security checkers used byzope.securityare isolated.
Any checkers set up in a child layer will be removed cleanly during tear-down.Helper functionsThe security checker isolation outlined above is managed using two helper functions found in the moduleplone.testing.security:pushCheckers()Copy the current set of security checkers for later tear-down.popCheckers()Restore the set of security checkers to the state of the most recent call topushCheckers().Youmustkeep calls topushCheckers()andpopCheckers()in balance.
That usually means that if you call the former during layer setup, you should call the latter during layer tear-down.
Ditto for calls during test setup/tear-down or within tests themselves.Zope PublisherThe Zope Publisher layers build on the Zope Component Architecture layers.
They can be found in the moduleplone.testing.publisher.If you depend on this, you can use the[publisher]extra when depending onplone.testing.Publisher directivesLayer:plone.testing.publisher.PUBLISHER_DIRECTIVESClass:plone.testing.publisher.PublisherDirectivesBases:plone.testing.zca.ZCML_DIRECTIVESResources:NoneThis layer extends thezca.ZCML_DIRECTIVESlayer to install additional ZCML directives in thebrowsernamespace (fromzope.app.publisher.browser) as well as those fromzope.security.
This allows browser views, browser pages and other UI components to be registered, as well as the definition of new permissions.As withzca.ZCML_DIRECTIVES, you should use theconfigurationContextresource when loading ZCML strings or files, and thestackConfigurationRegistry()helper to create a layer-specific version of this resource resource.
See above.ZODBThe ZODB layers set up a test fixture with a persistent ZODB.
The ZODB instance usesDemoStorage, so it will not interfere with any “live” data.ZODB layers can be found in the moduleplone.testing.zodb.
If you depend on this, you can use the[zodb]extra when depending onplone.testing.Empty ZODB sandboxLayer:plone.testing.zodb.EMPTY_ZODBClass:plone.testing.zodb.EmptyZODBBases:NoneResources:zodbRootzodbDB(test set-up only)zodbConnection(test set-up only)This layer sets up a simple ZODB sandbox usingDemoStorage.
The ZODB root object is a simple persistent mapping, available as the resourcezodbRoot.
The ZODB database object is available as the resourcezodbDB.
The connection used in the test is available aszodbConnection.Note that thezodbConnectionandzodbRootresources are created and destroyed for each test.
You can usezodbDB(and theopen()method) if you are writing a layer based on this one and need to set up a fixture during layer set up.
Don’t forget to close the connection before concluding the test setup!A new transaction is begun for each test, and rolled back (aborted) on test tear-down.
This means that so long as you don’t usetransaction.commit()explicitly in your code, it should be safe to add or modify items in the ZODB root.If you want to create a test fixture with persistent data in your own layer based onEMPTY_ZODB, you can use the following pattern:from plone.layer import Layer
from plone.layer import zodb

class MyLayer(Layer):
    defaultBases = (zodb.EMPTY_ZODB,)

    def setUp(self):

        import transaction
        self['zodbDB'] = db = zodb.stackDemoStorage(self.get('zodbDB'), name='MyLayer')

        conn = db.open()
        root = conn.root()

        # modify the root object here

        transaction.commit()
        conn.close()

    def tearDown(self):

        self['zodbDB'].close()
        del self['zodbDB']This shadows thezodbDBresource with a new database that uses a newDemoStoragestacked on top of the underlying database storage.
The fixture is added to this storage and committed during layer setup.
(The base layer test set-up/tear-down will still begin and abort a new transaction for eachtest).
On layer tear-down, the database is closed and the resource popped, leaving the originalzodbDBdatabase with the original, pristine storage.Helper functionsOne helper function is available in theplone.testing.zodbmodule.stackDemoStorage(db=None, name=None)Create a newDemoStorageusing the storage from the passed-in database as a base.
Ifdbis None, a brand new storage is created.Anamecan be given to uniquely identify the storage.
It is optional, but it is often useful for debugging purposes to pass the name of the layer.The usual pattern is:def setUp(self):
    self['zodbDB'] = zodb.stackDemoStorage(self.get('zodbDB'), name='MyLayer')

def tearDown(self):
    self['zodbDB'].close()
    del self['zodbDB']This will shadow thezodbDBresource with an isolatedDemoStorage, creating a new one if that resource does not already exist.
All existing data continues to be available, but new changes are written to the stacked storage.
On tear-down, the stacked database is closed and the resource removed, leaving the original data.ZopeThe Zope layers provide test fixtures suitable for testing Zope applications.
They set up a Zope application root, install core Zope products, and manage security.Zope layers can be found in the moduleplone.testing.zope.
If you depend on this, you can use the[zope]extra when depending onplone.testing.StartupLayer:plone.testing.zope.STARTUPClass:plone.testing.zope.StartupBases:plone.testing.zca.LAYER_CLEANUPResources:zodbDBconfigurationContexthostportThis layer sets up a Zope environment, and is a required base for all other Zope layers.
You cannot run two instances of this layer in parallel, since Zope depends on some module-global state to run, which is managed by this layer.On set-up, the layer will configure a Zope environment with:NoteTheSTARTUPlayer is a useful base layer for your own fixtures, but should not be used directly, since it provides no test lifecycle or transaction management.
See the “Integration test” and “Functional” test sections below for examples of how to create your own layers.Debug mode enabled.ZEO client cache disabled.Some patches installed, which speed up Zope startup by disabling some superfluous aspects of Zope.One thread (this only really affects theWSGI_SERVER,ZSERVERandFTP_SERVERlayers).A pristine database usingDemoStorage, exposed as the resourcezodbDB.
Zope is configured to use this database in a way that will also work if thezodbDBresource is shadowed using the pattern shown above in the description of thezodb.EMPTY_ZODBlayer.A fake hostname and port, exposed as thehostandportresource, respectively.A minimal set of products installed (Products.OFSPandProducts.PluginIndexes, both required for Zope to start up).A stacked ZCML configuration context, exposed as the resourceconfigurationContext.
As illustrated above, you should use thezca.stackConfigurationContext()helper to stack your own configuration context if you use this.A minimal set of global Zope components configured.Note that unlike a “real” Zope site, products in theProducts.*namespace are not automatically loaded, nor is any ZCML.Integration testLayer:plone.testing.zope.INTEGRATION_TESTINGClass:plone.testing.zope.IntegrationTestingBases:plone.testing.zope.STARTUPResources:apprequestThis layer is intended for integration testing against the simpleSTARTUPfixture.
If you want to create your own layer with a more advanced, shared fixture, see “Integration and functional testing with custom fixtures” below.For each test, it exposes the Zope application root as the resourceapp.
This is wrapped in the request container, so you can doapp.REQUESTto acquire a fake request, but the request is also available as the resourcerequest.A new transaction is begun for each test and rolled back on test tear-down, meaning that so long as the code under test does not explicitly commit any changes, the test may modify the ZODB.Hint:If you want to set up a persistent test fixture in a layer based on this one (orzope.FUNCTIONAL_TESTING), you can stack a newDemoStoragein a shadowingzodbDBresource, using the pattern described above for thezodb.EMPTY_ZODBlayer.Once you’ve shadowed thezodbDBresource, you can do (e.g. in your layer’ssetUp()method):...
with zope.zopeApp() as app:
    # modify the Zope application rootThezopeApp()context manager will open a new connection to the Zope application root, accessible here asapp.
Provided the code within thewithblock does not raise an exception, the transaction will be committed and the database closed properly upon exiting the block.Functional testingLayer:plone.testing.zope.FUNCTIONAL_TESTINGClass:plone.testing.zope.FunctionalTestingBases:plone.testing.zope.STARTUPResources:apprequestThis layer is intended for functional testing against the simpleSTARTUPfixture.
If you want to create your own layer with a more advanced, shared fixture, see “Integration and functional testing with custom fixtures” below.As its name implies, this layer is intended mainly for functional end-to-end testing using tools likezope.testbrowser.
See also theBrowserobject as described under “Helper functions” below.This layer is very similar toINTEGRATION_TESTING, but is not based on it.
It sets up the same fixture and exposes the same resources.
However, instead of using a simple transaction abort to isolate the ZODB between tests, it uses a stackedDemoStoragefor each test.
This is slower, but allows test code to perform and explicit commit, as will usually happen in a functional test.Integration and functional testing with custom fixturesIf you want to extend theSTARTUPfixture for use with integration or functional testing, you should use the following pattern:Create a layer class and a “fixture” base layer instance that haszope.STARTUP(or some intermediary layer, such aszope.WSGI_SERVER_FIXTURE, shown below) as a base.Create “end user” layers by instantiating thezope.IntegrationTestingand/orFunctionalTestingclasses with this new “fixture” layer as a base.This allows the same fixture to be used regardless of the “style” of testing, minimising the amount of set-up and tear-down.
The “fixture” layers manage the fixture as part of thelayerlifecycle.
The layer class (IntegrationTestingorFunctionalTesting), manages thetestlifecycle, and the test lifecycle only.For example:from plone.testing import Layer, zope, zodb

class MyLayer(Layer):
    defaultBases = (zope.STARTUP,)

    def setUp(self):
        # Set up the fixture here
        ...

    def tearDown(self):
        # Tear down the fixture here
        ...

MY_FIXTURE = MyLayer()

MY_INTEGRATION_TESTING = zope.IntegrationTesting(bases=(MY_FIXTURE,), name="MyFixture:Integration")
MY_FUNCTIONAL_TESTING = zope.FunctionalTesting(bases=(MY_FIXTURE,), name="MyFixture:Functional")(Note that we need to give an explicit, unique name to the two layers that reuse theIntegrationTestingandFunctionalTestingclasses.)In this example, other layers could extend the “MyLayer” fixture by usingMY_FIXTUREas a base.
Tests would use eitherMY_INTEGRATION_TESTINGorMY_FUNCTIONAL_TESTINGas appropriate.
However, even if both these two layers were used, the fixture inMY_FIXTUREwould only be set up once.NoteIf you implement thetestSetUp()andtestTearDown()test lifecycle methods in your “fixture” layer (e.g. in the theMyLayerclass above), they will execute before the corresponding methods fromIntegrationTestingandFunctionalTesting.
Hence, they cannot use those layers’ resources (appandrequest).It may be preferable, therefore, to have your own “test lifecycle” layer classes that subclassIntegrationTestingand/orFunctionalTestingand call base class methods as appropriate.plone.app.testingtakes this approach, for example.HTTP WSGI server thread (fixture only)Layer:plone.testing.zope.WSGI_SERVER_FIXTUREClass:plone.testing.zope.WSGIServerBases:plone.testing.zope.STARTUPResources:hostportThis layer extends thezope.STARTUPlayer to start the Zope HTTP WSGI server in a separate thread.
This means the test site can be accessed through a web browser, and can thus be used with tools likeSelenium.NoteThis layer is useful as a fixture base layer only, because it does not manage the test lifecycle.
Use theWSGI_SERVERlayer if you want to execute functional tests against this fixture.The WSGI server’s hostname (normallylocalhost) is available through the resourcehost, whilst the port it is running on is available through the resourceport.Hint:Whilst the layer is set up, you can actually access the test Zope site through a web browser.
The default URL will behttp://localhost:55001.HTTP WSGI server functional testingLayer:plone.testing.zope.WSGI_SERVERClass:plone.testing.zope.FunctionalTestingBases:plone.testing.zope.WSGI_SERVER_FIXTUREResources:This layer provides the functional testing lifecycle against the fixture set up by thezope.WSGI_SERVER_FIXTURElayer.You can use this to run “live” functional tests against a basic Zope site.
You shouldnotuse it as a base.
Instead, create your own “fixture” layer that extendszope.WSGI_SERVER_FIXTURE, and then instantiate theFunctionalTestingclass with this extended fixture layer as a base, as outlined above.Helper functionsSeveral helper functions are available in theplone.testing.zopemodule.zopeApp(db=None, conn=Non, environ=None)This function can be used as a context manager for any code that requires access to the Zope application root.
By using it in awithblock, the database will be opened, and the application root will be obtained and request-wrapped.
When exiting thewithblock, the transaction will be committed and the database properly closed, unless an exception was raised:with zope.zopeApp() as app:
    # do something with appIf you want to use a specific database or database connection, pass either thedborconnarguments.
If the context manager opened a new connection, it will close it, but it will not close a connection passed withconn.To set keys in the (fake) request environment, pass a dictionary of environment values asenviron.Note thatzopeApp()shouldnotnormally be used in tests or test set-up/tear-down, because theINTEGRATOIN_TESTandFUNCTIONAL_TESTINGlayers both manage the application root (as theappresource) and close it for you.
It is very useful in layer setup, however.installProduct(app, product, quiet=False)Install a Zope 2 style product, ensuring that itsinitialize()function is called.
The product name must be the full dotted name, e.g.plone.app.portletsorProducts.CMFCore.
Ifquietis true, duplicate registrations will be ignored silently, otherwise a message is logged.To get hold of the application root, passed as theappargument, you would normally use thezopeApp()context manager outlined above.uninstallProduct(app, product, quiet=False)This is the reciprocal ofinstallProduct(), normally used during layer tear-down.
Again, you should usezopeApp()to obtain the application root.login(userFolder, userName)Create a new security manager that simulates being logged in as the given user.userFolderis anacl_usersobject, e.g.app['acl_users']for the root user folder.logout()Simulate being the anonymous user by unsetting the security manager.setRoles(userFolder, userName, roles)Set the roles of the given user in the given user folder to the given list of roles.makeTestRequest()Create a fake Zope request.addRequestContainer(app, environ=None)Create a fake request and wrap the given object (normally an application root) in aRequestContainerwith this request.
This makes acquisition ofapp.REQUESTpossible.
To initialise the request environment with non-default values, pass a dictionary asenviron.NoteThis method is rarely used, because both thezopeApp()context manager and the layer set-up/tear-down forzope.INTEGRATION_TESTINGandzope.FUNCTIONAL_TESTINGwill wrap theappobject before exposing it.Browser(app)Obtain a test browser client, for use withzope.testbrowser.
You should use this in conjunction with thezope.FUNCTIONAL_TESTINGlayer or a derivative.
You must pass the app root, usually obtained from theappresource of the layer, e.g.:app = self.layer['app']
browser = zope.Browser(app)You can then usebrowseras described in thezope.testbrowserdocumentation.Bear in mind that the test browser runs separately from the test fixture.
In particular, calls to helpers such aslogin()orlogout()do not affect the state that the test browser sees.
If you want to set up a persistent fixture (e.g. test content), you can do so before creating the test browser, but you will need to explicitly commit your changes, with:import transaction
transaction.commit()ZServerThe ZServer layers provide test fixtures suitable for testing Zope applications while using ZServer instead of a WSGI server.
They set up a Zope application root, install core Zope products, and manage security.ZServer layers can be found in the moduleplone.testing.zserver.
If you depend on this, you can use the[zope,zserver]extra when depending onplone.testing.StartupLayer:plone.testing.zserver.STARTUPClass:plone.testing.zserver.StartupBases:plone.testing.zca.LAYER_CLEANUPResources:zodbDBconfigurationContexthostportThis layer sets up a Zope environment for ZServer, and is a required base for all other ZServer layers.
You cannot run two instances of this layer in parallel, since Zope depends on some module-global state to run, which is managed by this layer.On set-up, the layer will configure a Zope environment with the same options aszope.Startup, see there.Integration testLayer:plone.testing.zserver.INTEGRATION_TESTINGClass:plone.testing.zserver.IntegrationTestingBases:plone.testing.zserver.STARTUPResources:apprequestThis layer is intended for integration testing against the simpleSTARTUPfixture.
If you want to create your own layer with a more advanced, shared fixture, see “Integration and functional testing with custom fixtures” below.For each test, it exposes the Zope application root as the resourceapp.
This is wrapped in the request container, so you can doapp.REQUESTto acquire a fake request, but the request is also available as the resourcerequest.A new transaction is begun for each test and rolled back on test tear-down, meaning that so long as the code under test does not explicitly commit any changes, the test may modify the ZODB.Hint:If you want to set up a persistent test fixture in a layer based on this one (orzserver.FUNCTIONAL_TESTING), you can stack a newDemoStoragein a shadowingzodbDBresource, using the pattern described above for thezodb.EMPTY_ZODBlayer.Once you’ve shadowed thezodbDBresource, you can do (e.g. in your layer’ssetUp()method):...
with zserver.zopeApp() as app:
    # modify the Zope application rootThezserver.zopeApp()context manager will open a new connection to the Zope application root, accessible here asapp.
Provided the code within thewithblock does not raise an exception, the transaction will be committed and the database closed properly upon exiting the block.Functional testingLayer:plone.testing.zserver.FUNCTIONAL_TESTINGClass:plone.testing.zserver.FunctionalTestingBases:plone.testing.zserver.STARTUPResources:apprequestIt behaves the same aszope.FunctionalTesting, see there.Integration and functional testing with custom fixturesIf you want to extend theSTARTUPfixture for use with integration or functional testing, you should use the following pattern:Create a layer class and a “fixture” base layer instance that haszserver.STARTUP(or some intermediary layer, such aszserver.ZSERVER_FIXTUREorzserver.FTP_SERVER_FIXTURE, shown below) as a base.Create “end user” layers by instantiating thezserver.IntegrationTestingand/orFunctionalTestingclasses with this new “fixture” layer as a base.This allows the same fixture to be used regardless of the “style” of testing, minimising the amount of set-up and tear-down.
The “fixture” layers manage the fixture as part of thelayerlifecycle.
The layer class (IntegrationTestingorFunctionalTesting), manages thetestlifecycle, and the test lifecycle only.For example:from plone.testing import Layer, zserver, zodb

class MyLayer(Layer):
    defaultBases = (zserver.STARTUP,)

    def setUp(self):
        # Set up the fixture here
        ...

    def tearDown(self):
        # Tear down the fixture here
        ...

MY_FIXTURE = MyLayer()

MY_INTEGRATION_TESTING = zserver.IntegrationTesting(bases=(MY_FIXTURE,), name="MyFixture:Integration")
MY_FUNCTIONAL_TESTING = zserver.FunctionalTesting(bases=(MY_FIXTURE,), name="MyFixture:Functional")(Note that we need to give an explicit, unique name to the two layers that reuse theIntegrationTestingandFunctionalTestingclasses.)In this example, other layers could extend the “MyLayer” fixture by usingMY_FIXTUREas a base.
Tests would use eitherMY_INTEGRATION_TESTINGorMY_FUNCTIONAL_TESTINGas appropriate.
However, even if both these two layers were used, the fixture inMY_FIXTUREwould only be set up once.NoteIf you implement thetestSetUp()andtestTearDown()test lifecycle methods in your “fixture” layer (e.g. in the theMyLayerclass above), they will execute before the corresponding methods fromIntegrationTestingandFunctionalTesting.
Hence, they cannot use those layers’ resources (appandrequest).It may be preferable, therefore, to have your own “test lifecycle” layer classes that subclassIntegrationTestingand/orFunctionalTestingand call base class methods as appropriate.plone.app.testingtakes this approach, for example.HTTP ZServer thread (fixture only)Layer:plone.testing.zserver.ZSERVER_FIXTUREClass:plone.testing.zserver.ZServerBases:plone.testing.zserver.STARTUPResources:hostportThis layer extends thezserver.STARTUPlayer to start the Zope HTTP server (ZServer) in a separate thread.
This means the test site can be accessed through a web browser, and can thus be used with tools likeSelenium.NoteThis layer is useful as a fixture base layer only, because it does not manage the test lifecycle.
Use theZSERVERlayer if you want to execute functional tests against this fixture.The ZServer’s hostname (normallylocalhost) is available through the resourcehost, whilst the port it is running on is available through the resourceport.Hint:Whilst the layer is set up, you can actually access the test Zope site through a web browser.
The default URL will behttp://localhost:55001.HTTP ZServer functional testingLayer:plone.testing.zserver.ZSERVERClass:plone.testing.zserver.FunctionalTestingBases:plone.testing.zserver.ZSERVER_FIXTUREResources:This layer provides the functional testing lifecycle against the fixture set up by thezserver.ZSERVER_FIXTURElayer.You can use this to run “live” functional tests against a basic Zope site.
You shouldnotuse it as a base.
Instead, create your own “fixture” layer that extendszserver.ZSERVER_FIXTURE, and then instantiate theFunctionalTestingclass with this extended fixture layer as a base, as outlined above.FTP server thread (fixture only)Layer:plone.testing.zserver.FTP_SERVER_FIXTUREClass:plone.testing.zserver.FTPServerBases:plone.testing.zserver.STARTUPResources:hostportThis layer is the FTP server equivalent of thezserver.ZSERVER_FIXTURElayer.
It can be used to functionally test Zope FTP servers.NoteThis layer is useful as a fixture base layer only, because it does not manage the test lifecycle.
Use theFTP_SERVERlayer if you want to execute functional tests against this fixture.Hint:Whilst the layer is set up, you can actually access the test Zope site through an FTP client.
The default URL will beftp://localhost:55002.WarningDo not run theFTP_SERVERandZSERVERlayers concurrently in the same process.If you need both ZServer and FTPServer running together, you can subclass theZServerlayer class (like theFTPServerlayer class does) and implement thesetUpServer()andtearDownServer()methods to set up and close down two servers on different ports.
They will then share a main loop.FTP server functional testingLayer:plone.testing.zserver.FTP_SERVERClass:plone.testing.zserver.FunctionalTestingBases:plone.testing.zserver.FTP_SERVER_FIXTUREResources:This layer provides the functional testing lifecycle against the fixture set up by thezserver.FTP_SERVER_FIXTURElayer.You can use this to run “live” functional tests against a basic Zope site.
You shouldnotuse it as a base.
Instead, create your own “fixture” layer that extendszserver.FTP_SERVER_FIXTURE, and then instantiate theFunctionalTestingclass with this extended fixture layer as a base, as outlined above.Helper functionsSeveral helper functions are available in theplone.testing.zservermodule.zopeApp(db=None, conn=Non, environ=None)This function can be used as a context manager for any code that requires access to the Zope application root.
By using it in awithblock, the database will be opened, and the application root will be obtained and request-wrapped.
When exiting thewithblock, the transaction will be committed and the database properly closed, unless an exception was raised:with zserver.zopeApp() as app:
    # do something with appIf you want to use a specific database or database connection, pass either thedborconnarguments.
If the context manager opened a new connection, it will close it, but it will not close a connection passed withconn.To set keys in the (fake) request environment, pass a dictionary of environment values asenviron.Note thatzopeApp()shouldnotnormally be used in tests or test set-up/tear-down, because theINTEGRATOIN_TESTandFUNCTIONAL_TESTINGlayers both manage the application root (as theappresource) and close it for you.
It is very useful in layer setup, however.The other helper functions defined inplone.testing.zopecan also be used in a ZServer context but together with the ZServer layers.Changelog9.0.1 (2023-11-30)Bug fixes:Remove incorrect hard dependency on five.localsitemanager. @davisagli (#86)9.0.0 (2023-10-25)Breaking changes:Drop python 2.7 support.
[gforcada] (#1)Drop ZServer support.
[gforcada] (#2)Internal:Update configuration files.
[plone devs] (5cc689e5)8.0.4 (2023-09-21)Bug fixes:Fix tests when run with ZODB 5.8.1+.
[maurits] (#581)8.0.3 (2021-06-14)Bug fixes:fix waitress deprecation warning (#77)Catch OSError in test teardown when removing a temporary directory.
Fixesissue 79.
[maurits] (#79)8.0.2 (2020-10-12)Bug fixes:updateisortconfiguration for version 5 ofisort(#75)8.0.1 (2020-06-16)Bug fixes:fix broken Flake8 job (#74)8.0.0 (2020-04-21)Breaking changes:Drop support for Python 3.4 and 3.5.
Remove “z2” extra.
[jensens] (#72)New features:Update links for further information abouttesting.
[jugmac00] (#71)Bug fixes:Fix tests when using zope.testrunner internals since its version 5.1.
[jensens] (#72)7.0.3 (2019-12-10)Bug fixes:Fix issue with test-setup when using ZServer 4.0.2.
[pbauer] (#69)7.0.2 (2019-07-06)Bug fixes:Remove theZOPETESTCASEALERTas it imports from ZopeTestCase and has side effects.
Fixes #64.
[thet] (#67)7.0.1 (2019-03-03)Bug fixes:Fixed test for ‘Connection refused’ which could be ‘Connection reset’.
[maurits] (#59)7.0.0 (2018-10-17)Breaking changes:plone.testing.z2is now a BBB shim forplone.testing.zope,
thus it switches the tests to use WSGI.
If you absolutely want to keep using ZServer please import fromplone.testing.zserver.plone.testing.z2now only contains a no-op FTPServer layer because FTP is not supported by WSGI.
If you really need it, import it fromplone.testing.zserverbut this will not work on Python 3.Default to picking a dynamical port for ZServer layers instead of a static
default port.
[Rotonen]New features:MakeZServeran optional dependency.Add support for Python 3.6.
[rudaporto, icemac]Bug fixes:Explicitly depend on ZServer on the z2 extra.
[Rotonen]6.1.0 (2018-10-05)Breaking changes:Default to picking a dynamical port for ZServer layers instead of a static
default port.
[Rotonen]Bug fixes:Pinned ZODB to < 5.4.0 for testing to avoid flaky doctest layer teardowns.
[Rotonen]Loosened doctest assertions to keep up with Zope-side changes.
[Rotonen]Fix most of the code smells Jenkins complains about.Fix the Zope exception hook when using the ZServer layer.Fix teardown of theplone.testing.security.Checkerslayer.
It was not properly restoring zope.security’s_checkersdict.6.0.0 (2018-02-05)Breaking changes:Only supportZope >= 4, no longer supportZope2.Drop support for Python 2.6.No longer use deprecated import for getSite/setSite.
[jensens]Update code to follow Plone styleguide.
[gforcada]5.1.1 (2017-04-19)Do not break on import ofplone.testing.z2when usingzope.testbrowser>= 5.0 which no longer depends onmechanize.5.1 (2017-04-13)Fix for ZODB 5: Abort transaction before DB close.
[jensens, jimfulton]Remove BBB code and imports for Zope < 2.13.
[thet]Fix issue, which prevented using layered-helper on Python 3.
[datakurre]Fix.z2.Startup.setUpZCML()to be compatible with Zope >= 4.0a2.
[icemac]Fix version pins on the package itself to be able to run the tests.
[gforcada]5.0.0 (2016-02-19)Rerelease of 4.2.0 as 5.0.0.The version 4.2.0 had changed error handling in the public api, causing exceptions where before everything continued to work.4.2.0 (2016-02-18)New:Refuse to work if user breaks test isolation.
[do3cc]Check that tests don’t run together with ZopeTestCase
[do3cc]Fixes:Fix tests for Zope 4, where the app root Control_Panel is not available anymore.
[thet]4.1.0 (2016-01-08)Fixes:Rename all txt doctest files to rst. Reformat doctests.
[thet]PEP 8.
[thet]Depend on zope.testrunner, which was moved out from zope.testing.testrunner.
[thet]Add support for Zope 4.
[thet]4.0.15 (2015-08-14)Prevent exception masking in finally clause of zopeApp context.
[do3cc]4.0.14 (2015-07-29)Rerelease for clarity due to double release of 4.0.13.
[maurits]Addedmultiinit-parameter to z2.installProduct to allow multiple initialize methods for a package
[tomgross]4.0.13 (2015-03-13)Really fix not to depend on unittest2.
[icemac]Add tox.ini
[icemac]4.0.12 (2014-09-07)Fixed AttributeError when importingplone.testing.z2ifzope.testbrowser4.x is used but notzope.app.testing.
[icemac]Broke dependency onunittest2for Python 2.7+ as all features ofunittest2are integrated inunittestthere.
[icemac]4.0.11 (2014-02-22)Fix z2.txt doctest for FTP_SERVER.
[timo]4.0.10 (2014-02-11)Read ‘FTPSERVER_HOST’ and ‘FTPSERVER_PORT’ from the environment variables if possible.
This allows us to run tests in parallel on CI servers.
[timo]4.0.9 (2014-01-28)Replace deprecated Zope2VocabularyRegistry import.
[timo]4.0.8 (2013-03-05)Factor test request creation out of addRequestContainer into makeTestRequest.
[davisagli]4.0.7 (2012-12-09)Fix quoting of urls by the testbrowser.
[do3cc]4.0.6 (2012-10-15)Update manifest.in to include content in src directory.
[esteele]4.0.5 (2012-10-15)Fixed an issue where a query string would be unquoted twice;
once while setting up the HTTP request and once in the handler (the publisher).
[malthe]4.0.4 (2012-08-04)Fixed the cache reset code.
In some situations the function does not have any defaults,
so we shouldn’t try to clear out the app reference.
[malthe]4.0.3 (2011-11-24)Fixed class names in documentation to match code.
[icemac]4.0.2 (2011-08-31)The defaults of theZPublisher.Publish.get_module_infofunction cache
a reference to the app, so make sure that gets reset when tearing down the
app. This fixes a problem where the testbrowser in the second functional
layer to be set up accessed the database from the first functional layer.
[davisagli]4.0.1 - 2011-05-20Moved readme file containing tests into the package, so tests can be run from
released source distributions. Closeshttp://dev.plone.org/plone/ticket/11821.
[hannosch]Relicense under BSD license.
Seehttp://plone.org/foundation/materials/foundation-resolutions/plone-framework-components-relicensing-policy[davisagli]4.0 - 2011-05-13Release 4.0 Final.
[esteele]Add MANIFEST.in.
[WouterVH]4.0a6 - 2011-04-06Fixed Browser cookies retrieval with Zope 2.13.
[vincentfretin]AddZCMLSandboxlayer to load a ZCML file; replacessetUpZcmlFilesandtearDownZcmlFileshelper functions.
[gotcha]4.0a5 - 2011-03-02Handle test failures due to userFolderAddUser returning the user object in
newer versions of Zope.
[esteele]AddsetUpZcmlFilesandtearDownZcmlFileshelpers to enable loading
of ZCML files without too much boilerplate.
[gotcha]Add some logging.
[gotcha]Add the[security]extra, to provide tear-down of security checkers.
[optilude]Let theIntegrationTestingandFunctionalTestinglifecycle layers
set up requestPARENTSand, if present, wire upzope.globalrequest.
[optilude]Make the test browser support IStreamIterators
[optilude]4.0a4 - 2011-01-11Make sure ZCML doesn’t load during App startup in Zope 2.13.
[davisagli]4.0a3 - 2010-12-14Ignore thetestinghomeconfiguration setting if present.
[stefan]Use the new API for getting the packages_to_initialize list in Zope 2.13.
[davisagli]De-duplicate _register_monkies and _meta_type_regs in the correct module on
teardown of the Startup layer in Zope 2.13.
[davisagli]Allow doctest suites fromzope.testingto work withplone.testing.layer.layered.
Previously, only doctest suites from the stdlib would see thelayerglobal.
[nouri]Changed documentation to advertise thecoveragelibrary for running
coverage tests instead of the built-inzope.testingsupport. This also
avoids usingz3c.coverage. The coverage tests now run at the same speed
as a normal test run, making it more likely to get executed frequently.
[hannosch]Correct license to GPL version 2 only.
[hannosch]Fix some user id vs name confusion.
[rossp]Add the option to specify ZServer host and port through environment
variables - ZSERVER_HOST and ZSERVER_PORT).
[esteele]1.0a2 - 2010-09-05Fix a problem that would cause<meta:redefinePermission />to break.
In particular fixes the use of thezope2.Publicpermission.
[optilude]Set the security implementation to “Python” for easier debugging during
the z2.STARTUP layer.
[optilude]Initialize Five in the z2.Startup layer, pushing a Zope2VocabularyRegistry on
layer set-up and restoring the previous one upon tear-down.
[dukebody]1.0a1 - 2010-08-01Initial releaseDetailed documentationLayer base classThis package provides a layer base class which can be used by the test runner.
It is available as a convenience import from the package root.:>>> from plone.testing import LayerA layer may be instantiated directly, though in this case thenameargument is required (see below).:>>> NULL_LAYER = Layer(name="Null layer")This is not very useful on its own.
It has an empty list of bases, and each of the layer lifecycle methods does nothing.:>>> NULL_LAYER.__bases__
()
>>> NULL_LAYER.__name__
'Null layer'
>>> NULL_LAYER.__module__
'plone.testing.layer'

>>> NULL_LAYER.setUp()
>>> NULL_LAYER.testSetUp()
>>> NULL_LAYER.tearDown()
>>> NULL_LAYER.testTearDown()Just about the only reason to use this directly (i.e. not as a base class) is to group together other layers.:>>> SIMPLE_LAYER = Layer(bases=(NULL_LAYER,), name="Simple layer", module='plone.testing.tests')Here, we’ve also set the module name directly.
The default for all layers is to take the module name from the stack frame where the layer was instantiated.
In doctests, that doesn’t work, though, so we fall back on the module name of the layer class.
The two are often the same, of course.This layer now has the bases, name and module we set::>>> SIMPLE_LAYER.__bases__
(<Layer 'plone.testing.layer.Null layer'>,)

>>> SIMPLE_LAYER.__name__
'Simple layer'

>>> SIMPLE_LAYER.__module__
'plone.testing.tests'Thenameargument is required when usingLayerdirectly (but not when using a subclass)::>>> Layer((SIMPLE_LAYER,))
Traceback (most recent call last):
...
ValueError: The `name` argument is required when instantiating `Layer` directly

>>> class NullLayer(Layer):
...     pass
>>> NullLayer()
<Layer 'builtins.NullLayer'>UsingLayeras a base classThe usual pattern is to useLayeras a base class for a custom layer.
This can then override the lifecycle methods as appropriate, as well as set a default list of bases.:>>> class BaseLayer(Layer):
...
...     def setUp(self):
...         print("Setting up base layer")
...
...     def tearDown(self):
...         print("Tearing down base layer")

>>> BASE_LAYER = BaseLayer()The layer name and module are taken from the class.:>>> BASE_LAYER.__bases__
()
>>> BASE_LAYER.__name__
'BaseLayer'
>>> BASE_LAYER.__module__
'builtins'We can now create a new layer that has this one as a base.
We can do this in the instance constructor, as shown above, but the most common pattern is to set the default bases in the class body, using the variabledefaultBases.We’ll also set the default name explicitly here by passing a name to the the super-constructor.
This is mostly cosmetic, but may be desirable if the class name would be misleading in the test runner output.:>>> class ChildLayer(Layer):
...     defaultBases = (BASE_LAYER,)
...
...     def __init__(self, bases=None, name='Child layer', module=None):
...         super(ChildLayer, self).__init__(bases, name, module)
...
...     def setUp(self):
...         print("Setting up child layer")
...
...     def tearDown(self):
...         print("Tearing down child layer")

>>> CHILD_LAYER = ChildLayer()Notice how the bases have now been set using the value indefaultBases.:>>> CHILD_LAYER.__bases__
(<Layer 'builtins.BaseLayer'>,)
>>> CHILD_LAYER.__name__
'Child layer'
>>> CHILD_LAYER.__module__
'builtins'Overriding the default list of basesWe can override the list of bases on a per-instance basis.
This may be dangerous, i.e.
the layer is likely to expect that its bases are set up.
Sometimes, it may be useful to inject a new base, however, especially when re-using layers from other packages.The new list of bases is passed to the constructor.
When creating a second instance of a layer (most layers are global singletons created only once), it’s useful to give the new instance a unique name, too.:>>> NEW_CHILD_LAYER = ChildLayer(bases=(SIMPLE_LAYER, BASE_LAYER,), name='New child')

>>> NEW_CHILD_LAYER.__bases__
(<Layer 'plone.testing.tests.Simple layer'>, <Layer 'builtins.BaseLayer'>)
>>> NEW_CHILD_LAYER.__name__
'New child'
>>> NEW_CHILD_LAYER.__module__
'builtins'Inconsistent basesLayer bases are maintained in an order that is semantically equivalent to the “method resolution order” Python maintains for base classes.
We can get this from thebaseResolutionOrderattribute::>>> CHILD_LAYER.baseResolutionOrder
(<Layer 'builtins.Child layer'>, <Layer 'builtins.BaseLayer'>)

>>> NEW_CHILD_LAYER.baseResolutionOrder
(<Layer 'builtins.New child'>, <Layer 'plone.testing.tests.Simple layer'>,
 <Layer 'plone.testing.layer.Null layer'>,
 <Layer 'builtins.BaseLayer'>)As with Python classes, it is possible to construct an invalid set of bases.
In this case, layer instantiation will fail.:>>> INCONSISTENT_BASE1 = Layer(name="Inconsistent 1")
>>> INCONSISTENT_BASE2 = Layer((INCONSISTENT_BASE1,), name="Inconsistent 1")
>>> INCONSISTENT_BASE3 = Layer((INCONSISTENT_BASE1, INCONSISTENT_BASE2,), name="Inconsistent 1")
Traceback (most recent call last):
...
TypeError: Inconsistent layer hierarchy!Using the resource managerLayers are also resource managers.
Resources can be set, retrieved and deleted using dictionary syntax.
Resources in base layers are available in child layers.
When an item is set on a child layer, it shadows any items with the same key in any base layer (until it is deleted), but the original item still exists.Let’s create a somewhat complex hierarchy of layers that all set resources under a key'foo'in theirsetUp()methods.:>>> class Layer1(Layer):
...     def setUp(self):
...         self['foo'] = 1
...     def tearDown(self):
...         del self['foo']
>>> LAYER1 = Layer1()

>>> class Layer2(Layer):
...     defaultBases = (LAYER1,)
...     def setUp(self):
...         self['foo'] = 2
...     def tearDown(self):
...         del self['foo']
>>> LAYER2 = Layer2()

>>> class Layer3(Layer):
...     def setUp(self):
...         self['foo'] = 3
...     def tearDown(self):
...         del self['foo']
>>> LAYER3 = Layer3()

>>> class Layer4(Layer):
...     defaultBases = (LAYER2, LAYER3,)
...     def setUp(self):
...         self['foo'] = 4
...     def tearDown(self):
...         del self['foo']
>>> LAYER4 = Layer4()

**Important:** Resources that are created in ``setUp()`` must be deleted in ``tearDown()``.
Similarly, resources created in ``testSetUp()`` must be deleted in ``testTearDown()``.
This ensures resources are properly stacked and do not leak between layers.If a test was usingLAYER4, the test runner would call each setup step in turn, starting with the “deepest” layer.
We’ll simulate that here, so that each of the resources is created.:>>> LAYER1.setUp()
>>> LAYER2.setUp()
>>> LAYER3.setUp()
>>> LAYER4.setUp()The layers are ordered in a known “resource resolution order”, which is used to determine in which order the layers shadow one another.
This is based on the same algorithm as Python’s method resolution order.:>>> LAYER4.baseResolutionOrder
(<Layer 'builtins.Layer4'>,
 <Layer 'builtins.Layer2'>,
 <Layer 'builtins.Layer1'>,
 <Layer 'builtins.Layer3'>)When fetching and item from a layer, it will be obtained according to the resource resolution order.:>>> LAYER4['foo']
4This is not terribly interesting, sinceLAYER4has the resource'foo'set directly.
Let’s tear down the layer (which deletes the resource) and see what happens.:>>> LAYER4.tearDown()
>>> LAYER4['foo']
2We can continue up the chain::>>> LAYER2.tearDown()
>>> LAYER4['foo']
1

>>> LAYER1.tearDown()
>>> LAYER4['foo']
3Once we’ve deleted the last key, we’ll get aKeyError::>>> LAYER3.tearDown()
>>> LAYER4['foo']
Traceback (most recent call last):
...
KeyError: 'foo'To guard against this, we can use theget()method.:>>> LAYER4.get('foo', -1)
-1We can also test with ‘in’::>>> 'foo' in LAYER4
FalseTo illustrate that this indeed works, let’s set the resource back on one of the bases.:>>> LAYER3['foo'] = 10
>>> LAYER4.get('foo', -1)
10Let’s now consider a special case: a base layer sets up a resource in layer setup, and uses it in test setup.
A child layer then shadows this resource in its own layer setup method.
In this case, we want the base layer’stestSetUp()to use the shadowed version that the child provided.(This is similar to how instance variables work: a base class may set an attribute onselfand use it in a method.
If a subclass then sets the same attribute to a different value and the base class method is called on an instance of the subclass, the base class attribute is used).Hint:If you definitely need to access the “original” resource in yourtestSetUp()/testTearDown()methods, you can store a reference to the resource as a layer instance variable:self.someResource = self['someResource'] = SomeResource()self.someResourcewill now be the exact resource created here, whereasself['someResource']will retain the layer shadowing semantics.
In most cases, you probablydon’twant to do this, allowing child layers to supply overridden versions of resources as appropriate.First, we’ll create some base layers.
We want to demonstrate having two “branches” of bases that both happen to define the same resource.:>>> class ResourceBaseLayer1(Layer):
...     def setUp(self):
...         self['resource'] = "Base 1"
...     def testSetUp(self):
...         print(self['resource'])
...     def tearDown(self):
...         del self['resource']

>>> RESOURCE_BASE_LAYER1 = ResourceBaseLayer1()

>>> class ResourceBaseLayer2(Layer):
...     defaultBases = (RESOURCE_BASE_LAYER1,)
...     def testSetUp(self):
...         print(self['resource'])

>>> RESOURCE_BASE_LAYER2 = ResourceBaseLayer2()

>>> class ResourceBaseLayer3(Layer):
...     def setUp(self):
...         self['resource'] = "Base 3"
...     def testSetUp(self):
...         print(self['resource'])
...     def tearDown(self):
...         del self['resource']

>>> RESOURCE_BASE_LAYER3 = ResourceBaseLayer3()We’ll then create the child layer that overrides this resource.:>>> class ResourceChildLayer(Layer):
...     defaultBases = (RESOURCE_BASE_LAYER2, RESOURCE_BASE_LAYER3)
...     def setUp(self):
...         self['resource'] = "Child"
...     def testSetUp(self):
...         print(self['resource'])
...     def tearDown(self):
...         del self['resource']

>>> RESOURCE_CHILD_LAYER = ResourceChildLayer()We’ll first set up the base layers on their own and simulate two tests.A test with RESOURCE_BASE_LAYER1 only would look like this::>>> RESOURCE_BASE_LAYER1.setUp()

>>> RESOURCE_BASE_LAYER1.testSetUp()
Base 1
>>> RESOURCE_BASE_LAYER1.testTearDown()

>>> RESOURCE_BASE_LAYER1.tearDown()A test with RESOURCE_BASE_LAYER2 would look like this::>>> RESOURCE_BASE_LAYER1.setUp()
>>> RESOURCE_BASE_LAYER2.setUp()

>>> RESOURCE_BASE_LAYER1.testSetUp()
Base 1
>>> RESOURCE_BASE_LAYER2.testSetUp()
Base 1
>>> RESOURCE_BASE_LAYER2.testTearDown()
>>> RESOURCE_BASE_LAYER1.testTearDown()

>>> RESOURCE_BASE_LAYER2.tearDown()
>>> RESOURCE_BASE_LAYER1.tearDown()A test with RESOURCE_BASE_LAYER3 only would look like this::>>> RESOURCE_BASE_LAYER3.setUp()

>>> RESOURCE_BASE_LAYER3.testSetUp()
Base 3
>>> RESOURCE_BASE_LAYER3.testTearDown()

>>> RESOURCE_BASE_LAYER3.tearDown()Now let’s set up the child layer and simulate another test.
We should now be using the shadowed resource.:>>> RESOURCE_BASE_LAYER1.setUp()
>>> RESOURCE_BASE_LAYER2.setUp()
>>> RESOURCE_BASE_LAYER3.setUp()
>>> RESOURCE_CHILD_LAYER.setUp()

>>> RESOURCE_BASE_LAYER1.testSetUp()
Child
>>> RESOURCE_BASE_LAYER2.testSetUp()
Child
>>> RESOURCE_BASE_LAYER3.testSetUp()
Child
>>> RESOURCE_CHILD_LAYER.testSetUp()
Child

>>> RESOURCE_CHILD_LAYER.testTearDown()
>>> RESOURCE_BASE_LAYER3.testTearDown()
>>> RESOURCE_BASE_LAYER2.testTearDown()
>>> RESOURCE_BASE_LAYER1.testTearDown()Finally, we’ll tear down the child layer again and simulate another test.
we should have the original resources back.
Note that the first and third layers no longer share a resource, since they don’t have a common ancestor.:>>> RESOURCE_CHILD_LAYER.tearDown()

>>> RESOURCE_BASE_LAYER1.testSetUp()
Base 1
>>> RESOURCE_BASE_LAYER2.testSetUp()
Base 1
>>> RESOURCE_BASE_LAYER2.testTearDown()
>>> RESOURCE_BASE_LAYER1.testTearDown()

>>> RESOURCE_BASE_LAYER3.testSetUp()
Base 3
>>> RESOURCE_BASE_LAYER3.testTearDown()Finally, we’ll tear down the remaining layers..:>>> RESOURCE_BASE_LAYER3.tearDown()
>>> RESOURCE_BASE_LAYER2.tearDown()
>>> RESOURCE_BASE_LAYER1.tearDown()Asymmetric deletionIt is an error to create or shadow a resource in a set-up lifecycle method and not delete it again in the tear-down.
It is also an error to delete a resource that was not explicitly created.
These two layers break those roles::>>> class BadLayer1(Layer):
...     def setUp(self):
...         pass
...     def tearDown(self):
...         del self['foo']
>>> BAD_LAYER1 = BadLayer1()

>>> class BadLayer2(Layer):
...     defaultBases = (BAD_LAYER1,)
...     def setUp(self):
...         self['foo'] = 1
...         self['bar'] = 2
>>> BAD_LAYER2 = BadLayer2()Let’s simulate a test that usesBAD_LAYER2::>>> BAD_LAYER1.setUp()
>>> BAD_LAYER2.setUp()

>>> BAD_LAYER1.testSetUp()
>>> BAD_LAYER2.testSetUp()

>>> BAD_LAYER2.testTearDown()
>>> BAD_LAYER1.testTearDown()

>>> BAD_LAYER2.tearDown()
>>> BAD_LAYER1.tearDown()
Traceback (most recent call last):
...
KeyError: 'foo'Here, we’ve got an error in the base layer.
This is because the resource is actually associated with the layer that first created it, in this caseBASE_LAYER2.
This one remains intact and orphaned::>>> 'foo' in BAD_LAYER2._resources
True
>>> 'bar' in BAD_LAYER2._resources
TrueDoctest layer helperThedoctestmodule is not aware ofzope.testing’s layers concept.
Therefore, the syntax for creating a doctest with a layer and adding it to a test suite is somewhat contrived: the test suite has to be created first, and then the layer attribute set on it::>>> class DoctestLayer(Layer):
...     pass
>>> DOCTEST_LAYER = DoctestLayer()

>>> import unittest
>>> import doctest

>>> def test_suite():
...     suite = unittest.TestSuite()
...     layerDoctest = doctest.DocFileSuite('layer.rst', package='plone.testing')
...     layerDoctest.layer = DOCTEST_LAYER
...     suite.addTest(layerDoctest)
...     return suite

>>> suite = test_suite()
>>> tests = list(suite)
>>> len(tests)
1
>>> tests[0].layer is DOCTEST_LAYER
TrueTo make this a little easier - especially when setting up multiple tests - a helper function calledlayeredis provided::>>> from plone.testing import layered

>>> def test_suite():
...     suite = unittest.TestSuite()
...     suite.addTests([
...         layered(doctest.DocFileSuite('layer.rst', package='plone.testing'), layer=DOCTEST_LAYER),
...         # repeat with more suites if necessary
...     ])
...     return suiteThis does the same as the sample above.:>>> suite = test_suite()
>>> tests = list(suite)
>>> len(tests)
1
>>> tests[0].layer is DOCTEST_LAYER
TrueIn addition, a ‘layer’ glob is added to each test in the suite.
This allows the test to access layer resources.:>>> len(list(tests[0]))
1
>>> list(tests[0])[0]._dt_test.globs['layer'] is DOCTEST_LAYER
TrueZope Component Architecture layersThe ZCA layers are found in the moduleplone.testing.zca::>>> from plone.testing import zcaFor testing, we need a testrunner::>>> from zope.testrunner import runnerUnit testingTheUNIT_TESTINGlayer is used to set up a clean component registry between each test.
It useszope.testing.cleanupto clean up all global state.It has no bases::>>> "%s.%s" % (zca.UNIT_TESTING.__module__, zca.UNIT_TESTING.__name__,)
'plone.testing.zca.UnitTesting'

>>> zca.UNIT_TESTING.__bases__
()The component registry is cleaned up between each test.:>>> from zope.interface import Interface
>>> from zope.component import provideUtility

>>> class DummyUtility(object):
...     def __init__(self, name):
...         self.name = name
...     def __repr__(self):
...         return "<%s>" % self.name

>>> provideUtility(DummyUtility("Dummy"), provides=Interface, name="test-dummy")

>>> from zope.component import queryUtility
>>> queryUtility(Interface, name="test-dummy")
<Dummy>Layer setup does nothing.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zca.UNIT_TESTING, setupLayers)
Set up plone.testing.zca.UnitTesting in ... seconds.Let’s now simulate a test.
Before any test setup has happened, our previously registered utility is still there.:>>> queryUtility(Interface, name="test-dummy")
<Dummy>On test setup, it disappears.:>>> zca.UNIT_TESTING.testSetUp()

>>> queryUtility(Interface, name="test-dummy") is None
TrueThe test would now execute. It may register some components.:>>> provideUtility(DummyUtility("Dummy2"), provides=Interface, name="test-dummy")
>>> queryUtility(Interface, name="test-dummy")
<Dummy2>On test tear-down, this disappears.:>>> zca.UNIT_TESTING.testTearDown()

>>> queryUtility(Interface, name="test-dummy") is None
TrueLayer tear-down does nothing.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zca.UnitTesting in ... seconds.Event testingTheEVENT_TESTINGlayer extends theUNIT_TESTINGlayer to add the necessary registrations forzope.component.eventtestingto work.:>>> "%s.%s" % (zca.EVENT_TESTING.__module__, zca.EVENT_TESTING.__name__,)
'plone.testing.zca.EventTesting'

>>> zca.EVENT_TESTING.__bases__
(<Layer 'plone.testing.zca.UnitTesting'>,)Before the test, the component registry is empty andgetEvents()returns nothing, even if an event is fired.:>>> from zope.component.eventtesting import getEvents

>>> class DummyEvent(object):
...     def __repr__(self):
...         return "<Dummy event>"

>>> from zope.event import notify
>>> notify(DummyEvent())

>>> getEvents()
[]Layer setup does nothing.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zca.EVENT_TESTING, setupLayers)
Set up plone.testing.zca.UnitTesting in ... seconds.
Set up plone.testing.zca.EventTesting in ... seconds.Let’s now simulate a test. On test setup, the event testing list is emptied.:>>> zca.UNIT_TESTING.testSetUp()
>>> zca.EVENT_TESTING.testSetUp()

>>> getEvents()
[]The test would now execute.
It may fire some events, which would show up in the event testing list.:>>> notify(DummyEvent())
>>> getEvents()
[<Dummy event>]On test tear-down, the list is emptied again::>>> zca.EVENT_TESTING.testTearDown()
>>> zca.UNIT_TESTING.testTearDown()

>>> getEvents()
[]Layer tear-down does nothing.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zca.EventTesting in ... seconds.
Tear down plone.testing.zca.UnitTesting in ... seconds.Layer cleanupTheLAYER_CLEANUPlayer is used to set up a clean component registry at the set-up and tear-down of a layer.
It useszope.testing.cleanupto clean up all global state.It has no bases::>>> "%s.%s" % (zca.LAYER_CLEANUP.__module__, zca.LAYER_CLEANUP.__name__,)
'plone.testing.zca.LayerCleanup'

>>> zca.LAYER_CLEANUP.__bases__
()The component registry is cleaned up on layer set-up and tear-down (but not between tests).:>>> from zope.interface import Interface
>>> from zope.component import provideUtility

>>> class DummyUtility(object):
...     def __init__(self, name):
...         self.name = name
...     def __repr__(self):
...         return "<%s>" % self.name

>>> provideUtility(DummyUtility("Dummy"), provides=Interface, name="test-dummy")

>>> from zope.component import queryUtility
>>> queryUtility(Interface, name="test-dummy")
<Dummy>

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zca.LAYER_CLEANUP, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.

>>> queryUtility(Interface, name="test-dummy") is None
TrueA sub-layer may register additional components::>>> provideUtility(DummyUtility("Dummy2"), provides=Interface, name="test-dummy2")Let’s now simulate a test. Test setup and tear-down does nothing.:>>> zca.LAYER_CLEANUP.testSetUp()

>>> queryUtility(Interface, name="test-dummy") is None
True
>>> queryUtility(Interface, name="test-dummy2")
<Dummy2>

>>> zca.LAYER_CLEANUP.testTearDown()

>>> queryUtility(Interface, name="test-dummy") is None
True
>>> queryUtility(Interface, name="test-dummy2")
<Dummy2>On tear-down, the registry is cleaned again.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zca.LayerCleanup in ... seconds.

>>> queryUtility(Interface, name="test-dummy") is None
True
>>> queryUtility(Interface, name="test-dummy2") is None
TrueBasic ZCML directivesTheZCML_DIRECTIVESlayer creates a ZCML configuration context with the basiczope.componentdirectives available.
It extends theLAYER_CLEANUPlayer.:>>> "%s.%s" % (zca.ZCML_DIRECTIVES.__module__, zca.ZCML_DIRECTIVES.__name__,)
'plone.testing.zca.ZCMLDirectives'

>>> zca.ZCML_DIRECTIVES.__bases__
(<Layer 'plone.testing.zca.LayerCleanup'>,)Before the test, we cannot use e.g. a<utility />directive without loading the necessarymeta.zcmlfiles.:>>> from zope.configuration import xmlconfig
>>> from zope.configuration.exceptions import ConfigurationError
>>> try:
...     xmlconfig.string("""\
...     <configure package="plone.testing" xmlns="http://namespaces.zope.org/zope">
...         <utility factory=".tests.DummyUtility" provides="zope.interface.Interface" name="test-dummy" />
...     </configure>""")
... except ConfigurationError as e:
...     True
TrueLayer setup creates a configuration context we can use to load further configuration.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zca.ZCML_DIRECTIVES, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zca.ZCMLDirectives in ... seconds.Let’s now simulate a test that uses this configuration context to load the same ZCML string.:>>> zca.ZCML_DIRECTIVES.testSetUp()

>>> context = zca.ZCML_DIRECTIVES['configurationContext'] # would normally be self.layer['configurationContext']
>>> xmlconfig.string("""\
... <configure package="plone.testing" xmlns="http://namespaces.zope.org/zope">
...     <utility factory=".tests.DummyUtility" provides="zope.interface.Interface" name="test-dummy" />
... </configure>""", context=context) is context
TrueThe utility is now registered::>>> queryUtility(Interface, name="test-dummy")
<Dummy utility>

>>> zca.UNIT_TESTING.testTearDown()Note that normally, we’d combine this with theUNIT_TESTINGlayer to tear down the component architecture as well.Layer tear-down deletes the configuration context.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zca.ZCMLDirectives in ... seconds.

>>> zca.ZCML_DIRECTIVES.get('configurationContext', None) is None
TrueConfiguration registry sandboxingFor simple unit tests, the full cleanup performed between each test using theUNIT_TESTINGlayer is undoubtedly the safest and most convenient way to ensure proper isolation of tests using the global component architecture.
However, if you are writing a complex layer that sets up a lot of components, you may wish to keep some components registered at the layer level, whilst still allowing tests and sub-layers to register their own components in isolation.This is a tricky problem, because the default ZCML directives and APIs (provideAdapter(),provideUtility()and so on) explicitly work on a single global adapter registry object.
To get around this, you can use two helper methods in thezcamodule to push a new global component registry before registering components, and pop the registry after.
Registries are stacked, so the components registered in a “lower” registry are automatically available in a “higher” registry.Let’s illustrate this with a layer that stacks two new global registries.
The first registry is specific to the layer, and is used to house the components registered at the layer level.
The second registry is set up and torn down for each test, allowing tests to register their own components freely.First, we’ll create a simple dummy utility to illustrate registrations.:>>> from zope.interface import Interface, implementer

>>> class IDummyUtility(Interface):
...     pass
>>> @implementer(IDummyUtility)
... class DummyUtility(object):
...     def __init__(self, name):
...         self.name = name
...     def __repr__(self):
...         return "<DummyUtility %s>" % self.nameThe two key methods are:zca.pushGlobalRegistry(), which creates a new global registry.zca.popGlobalRegistry(), which restores the previous global registry.Warning:Youmustbalance your calls to these methods.
If you callpushGlobalRegistry()insetUp(), callpopGlobalRegistry()intearDown().
Ditto fortestSetUp()andtestTearDown().Let’s now create our layer.:>>> from zope.component import provideUtility
>>> from plone.testing import Layer
>>> from plone.testing import zca

>>> class ComponentSandbox(Layer):
...     def setUp(self):
...         zca.pushGlobalRegistry()
...         provideUtility(DummyUtility("layer"), name="layer")
...     def tearDown(self):
...         zca.popGlobalRegistry()
...     def testSetUp(self):
...         zca.pushGlobalRegistry()
...     def testTearDown(self):
...         zca.popGlobalRegistry()
>>> COMPONENT_SANDBOX = ComponentSandbox()Let’s now simulate a test using this layer.To begin with, we have the default registry.:>>> from zope.component import getGlobalSiteManager, getSiteManager
>>> getSiteManager() is getGlobalSiteManager()
True

>>> defaultGlobalSiteManager = getGlobalSiteManager()

>>> from zope.component import queryUtility
>>> queryUtility(IDummyUtility, name="layer") is None
TrueWe’ll now simulate layer setup. This will push a new registry onto the stack::>>> COMPONENT_SANDBOX.setUp()

>>> getSiteManager() is getGlobalSiteManager()
True
>>> getGlobalSiteManager() is defaultGlobalSiteManager
False
>>> layerGlobalSiteManager = getGlobalSiteManager()

>>> queryUtility(IDummyUtility, name="layer")
<DummyUtility layer>We’ll then simulate a test that registers a global component::>>> COMPONENT_SANDBOX.testSetUp()

>>> getSiteManager() is getGlobalSiteManager()
True
>>> getGlobalSiteManager() is defaultGlobalSiteManager
False
>>> getGlobalSiteManager() is layerGlobalSiteManager
FalseOur previously registered component is still here.:>>> queryUtility(IDummyUtility, name="layer")
<DummyUtility layer>We can also register a new one.:>>> provideUtility(DummyUtility("test"), name="test")
>>> queryUtility(IDummyUtility, name="layer")
<DummyUtility layer>
>>> queryUtility(IDummyUtility, name="test")
<DummyUtility test>On test tear-down, only the second utility disappears::>>> COMPONENT_SANDBOX.testTearDown()

>>> getSiteManager() is getGlobalSiteManager()
True
>>> getGlobalSiteManager() is defaultGlobalSiteManager
False
>>> getGlobalSiteManager() is layerGlobalSiteManager
True

>>> queryUtility(IDummyUtility, name="layer")
<DummyUtility layer>
>>> queryUtility(IDummyUtility, name="test") is None
TrueIf we tear down the layer too, we’re back where we started::>>> COMPONENT_SANDBOX.tearDown()

>>> getSiteManager() is getGlobalSiteManager()
True
>>> getGlobalSiteManager() is defaultGlobalSiteManager
True

>>> queryUtility(IDummyUtility, name="layer") is None
True
>>> queryUtility(IDummyUtility, name="test") is None
TrueZCML files helper classOne of the frequent use cases is a layer that loads a ZCML file and sandbox the resulting registry.TheZCMLSandboxcan be instantiated with afilename`andpackagearguments.:>>> import plone.testing
>>> ZCML_SANDBOX = zca.ZCMLSandbox(filename="testing_zca.zcml",
...     package=plone.testing)Before layer setup, the utility is not registered.:>>> queryUtility(Interface, name="layer") is None
TrueWe’ll now simulate layer setup.
This pushes a new registry onto the stack::>>> ZCML_SANDBOX.setUp()

>>> getSiteManager() is getGlobalSiteManager()
True
>>> getGlobalSiteManager() is defaultGlobalSiteManager
False
>>> queryUtility(Interface, name="layer")
<Dummy utility>TheZCMLSandboxclass can also be used as ancestor for your own classes when you need to load more than a single ZCML file.Your class then needs to override thesetUpZCMLFiles()method.
It is in charge of callingloadZCMLFile(), once for each ZCML file that the class needs to load.:>>> class OtherZCML(zca.ZCMLSandbox):
...     def setUpZCMLFiles(self):
...         self.loadZCMLFile("testing_zca.zcml", package=plone.testing)
...         self.loadZCMLFile("testing_zca_more_specific.zcml",
...             package=plone.testing)
>>> OTHER_ZCML_SANDBOX = OtherZCML()Before layer setup, a second utility is not registered.:>>> queryUtility(Interface, name="more_specific_layer") is None
TrueWe’ll now simulate the setup of the more specific layer.:>>> OTHER_ZCML_SANDBOX.setUp()After setUp, the second utility is registered::>>> queryUtility(Interface, name="more_specific_layer")
<Dummy utility>After layer teardown, the second utility is not registered anymore.:>>> OTHER_ZCML_SANDBOX.tearDown()
>>> queryUtility(Interface, name="more_specific_layer") is None
TrueAfter teardown of the first layer, the first utility is not registered anymore.:>>> ZCML_SANDBOX.tearDown()
>>> queryUtility(Interface, name="layer") is None
TrueSecurityThe Zope Security layers are found in the moduleplone.testing.security::>>> from plone.testing import securityFor testing, we need a testrunner::>>> from zope.testrunner import runnerLayersThesecurity.CHECKERSlayer makes sure thatzope.securitycheckers are correctly set up and torn down.:>>> "%s.%s" % (security.CHECKERS.__module__, security.CHECKERS.__name__,)
'plone.testing.security.Checkers'

>>> security.CHECKERS.__bases__
()Before the test, our custom checker is not in the registry.:>>> class DummyObject(object):
...     pass

>>> from zope.security.interfaces import IChecker
>>> from zope.interface import implementer
>>> @implementer(IChecker)
... class FauxChecker(object):
...     # we should really implement the interface here, but oh well
...     pass

>>> from zope.security.checker import getCheckerForInstancesOf
>>> getCheckerForInstancesOf(DummyObject) is None
TrueLayer setup stacks the current checkers.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, security.CHECKERS, setupLayers)
Set up plone.testing.security.Checkers in ... seconds.We can now set up a checker.
In real life, this may happen during ZCML configuration, but here will just call the API directlyMost likely, we’d do this in a child layer::>>> from zope.security.checker import defineChecker
>>> fauxChecker = FauxChecker()
>>> defineChecker(DummyObject, fauxChecker)

>>> getCheckerForInstancesOf(DummyObject) is fauxChecker
TrueLet’s now simulate a test that may use the checker.:>>> security.CHECKERS.testSetUp()
>>> getCheckerForInstancesOf(DummyObject) is fauxChecker
True
>>> security.CHECKERS.testTearDown()We still have the checker after test tear-down::>>> getCheckerForInstancesOf(DummyObject) is fauxChecker
TrueHowever, when we tear down the layer, the checker is gone::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.security.Checkers in ... seconds.

>>> getCheckerForInstancesOf(DummyObject) is None
TrueZope Publisher layersThe Zope Publisher layers are found in the moduleplone.testing.publisher:>>> from plone.testing import publisherFor testing, we need a testrunner::>>> from zope.testrunner import runnerZCML directivesThepublisher.PUBLISHER_DIRECTIVESlayer extends thezca.ZCML_DIRECTIVESlayer to extend its ZCML configuration context with thezope.app.publisherandzope.securitydirectives available.
It also extendssecurity.CHECKERS.:>>> from plone.testing import zca, security

>>> "%s.%s" % (publisher.PUBLISHER_DIRECTIVES.__module__, publisher.PUBLISHER_DIRECTIVES.__name__,)
'plone.testing.publisher.PublisherDirectives'

>>> publisher.PUBLISHER_DIRECTIVES.__bases__
(<Layer 'plone.testing.zca.ZCMLDirectives'>, <Layer 'plone.testing.security.Checkers'>)Before the test, we cannot use e.g.
the<permission />or<browser:view />directives without loading the necessarymeta.zcmlfiles.:>>> from zope.configuration import xmlconfig
>>> from zope.configuration.exceptions import ConfigurationError
>>> try:
...     xmlconfig.string("""\
...     <configure package="plone.testing"
...         xmlns="http://namespaces.zope.org/zope"
...         xmlns:browser="http://namespaces.zope.org/browser"
...         i18n_domain="plone.testing.tests">
...         <permission id="plone.testing.Test" title="plone.testing: Test" />
...         <browser:view
...             for="*"
...             name="plone.testing-test"
...             class="plone.testing.tests.DummyView"
...             permission="zope.Public"
...             />
...     </configure>""")
... except ConfigurationError as e:
...     True
TrueLayer setup creates a configuration context we can use to load further configuration.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, publisher.PUBLISHER_DIRECTIVES, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zca.ZCMLDirectives in ... seconds.
Set up plone.testing.security.Checkers in ... seconds.
Set up plone.testing.publisher.PublisherDirectives in ... seconds.Let’s now simulate a test that uses this configuration context to load the same ZCML string.:>>> zca.ZCML_DIRECTIVES.testSetUp()
>>> security.CHECKERS.testSetUp()
>>> publisher.PUBLISHER_DIRECTIVES.testSetUp()

>>> context = zca.ZCML_DIRECTIVES['configurationContext'] # would normally be self.layer['configurationContext']
>>> xmlconfig.string("""\
... <configure package="plone.testing"
...     xmlns="http://namespaces.zope.org/zope"
...     xmlns:browser="http://namespaces.zope.org/browser"
...     i18n_domain="plone.testing.tests">
...     <permission id="plone.testing.Test" title="plone.testing: Test" />
...     <browser:view
...         for="*"
...         name="plone.testing-test"
...         class="plone.testing.tests.DummyView"
...         permission="zope.Public"
...         />
... </configure>""", context=context) is context
TrueThe permission and view are now registered::>>> from zope.component import queryUtility
>>> from zope.security.interfaces import IPermission

>>> queryUtility(IPermission, name=u"plone.testing.Test")
<zope.security.permission.Permission object at ...>

>>> from zope.interface import Interface
>>> from zope.publisher.interfaces.browser import IDefaultBrowserLayer
>>> from zope.component import getSiteManager
>>> siteManager = getSiteManager()

>>> [x.factory for x in siteManager.registeredAdapters()
...  if x.provided==Interface and x.required==(Interface, IDefaultBrowserLayer)
...   and x.name==u"plone.testing-test"]
[<class '....plone.testing-test'>]We can then simulate test tear-down::>>> publisher.PUBLISHER_DIRECTIVES.testTearDown()
>>> security.CHECKERS.testTearDown()
>>> zca.ZCML_DIRECTIVES.testTearDown()Note that you’d normally combine this layer with thezca.UNIT_TESTINGor a similar layer to automatically tear down the component architecture between each test.
Here, we need to do it manually.:>>> from zope.component.testing import tearDown
>>> tearDown()Layer tear-down does nothing.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.publisher.PublisherDirectives in ... seconds.
Tear down plone.testing.zca.ZCMLDirectives in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.
Tear down plone.testing.security.Checkers in ... seconds.

>>> zca.ZCML_DIRECTIVES.get('configurationContext', None) is None
TrueZope Object Database layersThe ZODB layers are found in the moduleplone.testing.zodb::>>> from plone.testing import zodbFor testing, we need a testrunner::>>> from zope.testrunner import runnerEmpty ZODB layerTheEMPTY_ZODBlayer is used to set up an empty ZODB usingDemoStorage.The storage and database are set up as layer fixtures.
The database is exposed as the resourcezodbDB.A connection is opened for each test and exposed aszodbConnection.
The ZODB root is also exposed, aszodbRoot.
A new transaction is begun for each test.
On test tear-down, the transaction is aborted, the connection is closed, and the two test-specific resources are deleted.The layer has no bases.:>>> "%s.%s" % (zodb.EMPTY_ZODB.__module__, zodb.EMPTY_ZODB.__name__,)
'plone.testing.zodb.EmptyZODB'

>>> zodb.EMPTY_ZODB.__bases__
()Layer setup creates the database, but not a connection.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zodb.EMPTY_ZODB, setupLayers)
Set up plone.testing.zodb.EmptyZODB in ... seconds.

>>> db = zodb.EMPTY_ZODB['zodbDB']
>>> db.storage
EmptyZODB

>>> zodb.EMPTY_ZODB.get('zodbConnection', None) is None
True
>>> zodb.EMPTY_ZODB.get('zodbRoot', None) is None
TrueLet’s now simulate a test.:>>> zodb.EMPTY_ZODB.testSetUp()The test would then execute. It may use the ZODB root.:>>> zodb.EMPTY_ZODB['zodbConnection']
<...Connection...at ...>

>>> zodb.EMPTY_ZODB['zodbRoot']
{}

>>> zodb.EMPTY_ZODB['zodbRoot']['foo'] = 'bar'On test tear-down, the transaction is aborted and the connection is closed.:>>> zodb.EMPTY_ZODB.testTearDown()

>>> zodb.EMPTY_ZODB.get('zodbConnection', None) is None
True

>>> zodb.EMPTY_ZODB.get('zodbRoot', None) is None
TrueThe transaction has been rolled back.:>>> conn = zodb.EMPTY_ZODB['zodbDB'].open()
>>> conn.root()
{}
>>> conn.close()Layer tear-down closes and deletes the database.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zodb.EmptyZODB in ... seconds.

>>> zodb.EMPTY_ZODB.get('zodbDB', None) is None
TrueExtending the ZODB layerWhen creating a test fixture, it is often desirable to add some initial data to the database.
If you want to do that once on layer setup, you can create your own layer class based onEmptyZODBand override itscreateStorage()and/orcreateDatabase()methods to return a pre-populated database.:>>> import transaction
>>> from ZODB.DemoStorage import DemoStorage
>>> from ZODB.DB import DB

>>> class PopulatedZODB(zodb.EmptyZODB):
...
...     def createStorage(self):
...         return DemoStorage("My storage")
...
...     def createDatabase(self, storage):
...         db = DB(storage)
...         conn = db.open()
...
...         conn.root()['someData'] = 'a string'
...
...         transaction.commit()
...         conn.close()
...
...         return db

>>> POPULATED_ZODB = PopulatedZODB()We’ll use this new layer in a similar manner to the test above, showing that the data is there for each test, but that other changes are rolled back.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, POPULATED_ZODB, setupLayers)
Set up ...PopulatedZODB in ... seconds.

>>> db = POPULATED_ZODB['zodbDB']
>>> db.storage
My storage

>>> POPULATED_ZODB.get('zodbConnection', None) is None
True
>>> POPULATED_ZODB.get('zodbRoot', None) is None
TrueLet’s now simulate a test.:>>> POPULATED_ZODB.testSetUp()The test would then execute. It may use the ZODB root.:>>> POPULATED_ZODB['zodbConnection']
<...Connection...at ...>

>>> POPULATED_ZODB['zodbRoot']
{'someData': 'a string'}

>>> POPULATED_ZODB['zodbRoot']['foo'] = 'bar'On test tear-down, the transaction is aborted and the connection is closed.:>>> POPULATED_ZODB.testTearDown()

>>> POPULATED_ZODB.get('zodbConnection', None) is None
True

>>> POPULATED_ZODB.get('zodbRoot', None) is None
TrueThe transaction has been rolled back.:>>> conn = POPULATED_ZODB['zodbDB'].open()
>>> conn.root()
{'someData': 'a string'}
>>> conn.close()Layer tear-down closes and deletes the database.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down ...PopulatedZODB in ... seconds.

>>> POPULATED_ZODB.get('zodbDB', None) is None
TrueStackingDemoStoragestoragesThe example above shows how to create a simple test fixture with a custom database.
It is sometimes useful to be able to stack these fixtures, so that a base layer sets up some data for one set of tests, and a child layer extends this, temporarily, with more data.This can be achieved using layer bases and resource shadowing, combined with ZODB’s stackable DemoStorage.
There is even a helper function available::>>> from plone.testing import Layer
>>> from plone.testing import zodb
>>> import transaction

>>> class ExpandedZODB(Layer):
...     defaultBases = (POPULATED_ZODB,)
...
...     def setUp(self):
...         # Get the database from the base layer
...
...         self['zodbDB'] = db = zodb.stackDemoStorage(self.get('zodbDB'), name='ExpandedZODB')
...
...         conn = db.open()
...         conn.root()['additionalData'] = "Some new data"
...         transaction.commit()
...         conn.close()
...
...     def tearDown(self):
...         # Close the database and delete the shadowed copy
...
...         self['zodbDB'].close()
...         del self['zodbDB']

>>> EXPANDED_ZODB = ExpandedZODB()Notice that we are using plainLayeras a base class here.
We obtain the underlying database from our bases using the resource manager, and then create a shadow copy using a stacked storage.
Stacked storages contain the data of the original storage, but save changes in a separate (and, in this case, temporary) storage.Let’s simulate a test run again to show how this would work.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, EXPANDED_ZODB, setupLayers)
Set up ...PopulatedZODB in ... seconds.
Set up ...ExpandedZODB in ... seconds.

>>> db = EXPANDED_ZODB['zodbDB']
>>> db.storage
ExpandedZODB

>>> EXPANDED_ZODB.get('zodbConnection', None) is None
True
>>> EXPANDED_ZODB.get('zodbRoot', None) is None
TrueLet’s now simulate a test.:>>> POPULATED_ZODB.testSetUp()
>>> EXPANDED_ZODB.testSetUp()The test would then execute. It may use the ZODB root.:>>> EXPANDED_ZODB['zodbConnection']
<...Connection...at ...>

>>> EXPANDED_ZODB['zodbRoot'] == dict(someData='a string', additionalData='Some new data')
True

>>> POPULATED_ZODB['zodbRoot']['foo'] = 'bar'On test tear-down, the transaction is aborted and the connection is closed.:>>> EXPANDED_ZODB.testTearDown()
>>> POPULATED_ZODB.testTearDown()

>>> EXPANDED_ZODB.get('zodbConnection', None) is None
True

>>> EXPANDED_ZODB.get('zodbRoot', None) is None
TrueThe transaction has been rolled back.:>>> conn = EXPANDED_ZODB['zodbDB'].open()
>>> conn.root() == dict(someData='a string', additionalData='Some new data')
True
>>> conn.close()We’ll now tear down the expanded layer and inspect the database again.:>>> runner.tear_down_unneeded(options, [POPULATED_ZODB], setupLayers, [])
Tear down ...ExpandedZODB in ... seconds.

>>> conn = EXPANDED_ZODB['zodbDB'].open()
>>> conn.root()
{'someData': 'a string'}

>>> conn.close()Finally, we’ll tear down the rest of the layers.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down ...PopulatedZODB in ... seconds.

>>> EXPANDED_ZODB.get('zodbDB', None) is None
True
>>> POPULATED_ZODB.get('zodbDB', None) is None
TrueZope WSGI layersThe Zope WSGI layers are found in the moduleplone.testing.zope::>>> from plone.testing import zopeFor testing, we need a testrunner::>>> from zope.testrunner import runnerStartupSTARTUPis the base layer for all Zope WSGI testing.
It sets up a Zope WSGI sandbox environment that is suitable for testing.
It extends thezca.LAYER_CLEANUPlayer to maximise the chances of having and leaving a pristine environment.Note: You should probably use at leastINTEGRATION_TESTINGfor any real test, althoughSTARTUPis a useful base layer if you are setting up your own fixture.
See the description ofINTEGRATION_TESTINGbelow.:>>> "%s.%s" % (zope.STARTUP.__module__, zope.STARTUP.__name__,)
'plone.testing.zope.Startup'

>>> zope.STARTUP.__bases__
(<Layer 'plone.testing.zca.LayerCleanup'>,)On layer setup, Zope is initialised in a lightweight manner.
This involves certain patches to global modules that Zope manages, to reduce setup time, a database based onDemoStorage, and a minimal set of products that must be installed for Zope 2 to work.
A minimal set of ZCML is loaded, but packages in theProductsnamespace are not automatically configured.Let’s just verify that we have an empty component registry before the test::>>> from zope.component import getSiteManager
>>> list(getSiteManager().registeredAdapters())
[]Five sets a special vocabulary registry upon the layer setup, but there’s a default one set before::>>> from zope.schema.vocabulary import getVocabularyRegistry
>>> getVocabularyRegistry()
<zope.schema.vocabulary.VocabularyRegistry object ...>

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zope.STARTUP, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zope.Startup in ... seconds.After layer setup, thezodbDBresource is available, pointing to the default ZODB.:>>> zope.STARTUP['zodbDB']
<ZODB.DB.DB object at ...>

>>> zope.STARTUP['zodbDB'].storage
StartupIn addition, the resourceshostandportare set to the default hostname and port that are used for URLs generated from Zope.
These are hardcoded, but shadowed by layers that provide actual running Zope instances.:>>> zope.STARTUP['host']
'nohost'
>>> zope.STARTUP['port']
80At this point, it is also possible to get hold of a Zope application root.
If you are setting up a layer fixture, you can obtain an application root with the correct database that is properly closed by using thezopeApp()context manager.:>>> with zope.zopeApp() as app:
...     'acl_users' in app.objectIds()
TrueIf you want to use a specific database, you can pass that tozopeApp()as thedbparameter.
A new connection will be opened and closed.:>>> with zope.zopeApp(db=zope.STARTUP['zodbDB']) as app:
...     'acl_users' in app.objectIds()
TrueIf you want to reuse an existing connection, you can pass one tozopeApp()as theconnectionargument.
In this case, you will need to close the connection yourself.:>>> conn = zope.STARTUP['zodbDB'].open()
>>> with zope.zopeApp(connection=conn) as app:
...     'acl_users' in app.objectIds()
True

>>> conn.opened is not None
True

>>> conn.close()If an exception is raised within thewithblock, the transaction is aborted, but the connection is still closed (if it was opened by the context manager)::>>> with zope.zopeApp() as app:
...     raise Exception("Test error")
Traceback (most recent call last):
...
Exception: Test errorIt is common to combine thezopeApp()context manager with a stackedDemoStorageto set up a layer-specific fixture.
As a sketch::from plone.testing import Layer, zope, zodb

class MyLayer(Layer):
    defaultBases = (zope.STARTUP,)

    def setUp(self):
        self['zodbDB'] = zodb.stackDemoStorage(self.get('zodbDB'), name='MyLayer')
        with zope.zopeApp() as app:

            # Set up a fixture, e.g.:
            app.manage_addFolder('folder1')
            folder = app['folder1']
            folder._addRole('role1')
            folder.manage_addUserFolder()

            userFolder = folder['acl_users']
            ignore = userFolder.userFolderAddUser('user1', 'secret', ['role1'], [])
            folder.manage_role('role1', ('Access contents information',))

    def tearDown(self):
        self['zodbDB'].close()
        del self['zodbDB']Note that you would normallynotuse thezope.zopeApp()in a test or in atestSetUp()ortestTearDown()method.
TheIntegrationTestingandFunctionalTestinglayer classes manage the application object for you, exposing them as the resourceapp(see below).After layer setup, the global component registry contains a number of components needed by Zope.:>>> len(list(getSiteManager().registeredAdapters())) > 1 # in fact, > a lot
TrueAnd Five has set aZope2VocabularyRegistryvocabulary registry::>>> getVocabularyRegistry()
<....Zope2VocabularyRegistry object at ...>To load additional ZCML, you can use theconfigurationContextresource::>>> zope.STARTUP['configurationContext']
<zope.configuration.config.ConfigurationMachine object ...>Seezca.rstfor details about how to usezope.configurationfor this purpose.TheSTARTUPlayer does not perform any specific test setup or tear-down.
That is left up to theINTEGRATION_TESTINGandFUNCTIONAL_TESTINGlayers, or other layers using their layer classes -IntegrationTestingandFunctionalTesting.:>>> zope.STARTUP.testSetUp()
>>> zope.STARTUP.testTearDown()Layer tear-down resets the environment.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zope.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.

>>> import Zope2
>>> Zope2._began_startup
0
>>> Zope2.DB is None
True
>>> Zope2.bobo_application is None
True

>>> list(getSiteManager().registeredAdapters())
[]

>>> getVocabularyRegistry()
<zope.schema.vocabulary.VocabularyRegistry object at ...>Integration testINTEGRATION_TESTINGis intended for simple Zope WSGI integration testing.
It extendsSTARTUPto ensure that a transaction is begun before and rolled back after each test.
Two resources,appandrequest, are available during testing as well.
It does not manage any layer state - it implements the test lifecycle methods only.Note:You would normallynotuseINTEGRATION_TESTINGas a base layer.
Instead, you’d use theIntegrationTestingclass to create your own layer with the testing lifecycle semantics ofINTEGRATION_TESTING.
See theplone.testingREADMEfile for an example.appis the application root.
In a test, you should use this instead of thezopeAppcontext manager (which remains the weapon of choice for setting up persistent fixtures), because theappresource is part of the transaction managed by the layer.requestis a test request. It is the same asapp.REQUEST.:>>> "%s.%s" % (zope.INTEGRATION_TESTING.__module__, zope.INTEGRATION_TESTING.__name__,)
'plone.testing.zope.IntegrationTesting'

>>> zope.INTEGRATION_TESTING.__bases__
(<Layer 'plone.testing.zope.Startup'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zope.INTEGRATION_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zope.Startup in ... seconds.
Set up plone.testing.zope.IntegrationTesting in ... seconds.Let’s now simulate a test.
On test setup, theappresource is made available.
In a test, you should always use this to access the application root.:>>> zope.STARTUP.testSetUp()
>>> zope.INTEGRATION_TESTING.testSetUp()The test may now inspect and modify the environment.:>>> app = zope.INTEGRATION_TESTING['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')
>>> 'acl_users' in app.objectIds() and 'folder1' in app.objectIds()
TrueThe request is also available::>>> zope.INTEGRATION_TESTING['request'] # would normally be self.layer['request']
<HTTPRequest, URL=http://nohost>We can create a user and simulate logging in as that user, using thezope.login()helper::>>> app._addRole('role1')
>>> ignore = app['acl_users'].userFolderAddUser('user1', 'secret', ['role1'], [])
>>> zope.login(app['acl_users'], 'user1')The first argument tozope.login()is the user folder that contains the relevant user.
The second argument is the user’s name.
There is no need to give the password.:>>> from AccessControl import getSecurityManager
>>> getSecurityManager().getUser()
<User 'user1'>You can change the roles of a user using thezope.setRoles()helper::>>> sorted(getSecurityManager().getUser().getRolesInContext(app))
['Authenticated', 'role1']

>>> zope.setRoles(app['acl_users'], 'user1', [])
>>> getSecurityManager().getUser().getRolesInContext(app)
['Authenticated']To become the anonymous user again, usezope.logout()::>>> zope.logout()
>>> getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>On tear-down, the transaction is rolled back::>>> zope.INTEGRATION_TESTING.testTearDown()
>>> zope.STARTUP.testTearDown()

>>> 'app' in zope.INTEGRATION_TESTING
False

>>> 'request' in zope.INTEGRATION_TESTING
False

>>> with zope.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueLet’s tear down the layers::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zope.IntegrationTesting in ... seconds.
Tear down plone.testing.zope.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.Functional testingTheFUNCTIONAL_TESTINGlayer is very similar toINTEGRATION_TESTING, and exposes the same fixture and resources.
However, it has different transaction semantics.INTEGRATION_TESTINGcreates a single database storage, and rolls back the transaction after each test.FUNCTIONAL_TESTINGcreates a whole new database storage (stacked on top of the basic fixture) for each test.
This allows testing of code that performs an explicit commit, which is usually required for end-to-end testing.
The downside is that the set-up and tear-down of each test takes longer.Note:Again, you would normallynotuseFUNCTIONAL_TESTINGas a base layer.
Instead, you’d use theFunctionalTestingclass to create your own layer with the testing lifecycle semantics ofFUNCTIONAL_TESTING.
See theplone.testingREADMEfile for an example.LikeINTEGRATION_TESTING,FUNCTIONAL_TESTINGis based onSTARTUP.:>>> "%s.%s" % (zope.FUNCTIONAL_TESTING.__module__, zope.FUNCTIONAL_TESTING.__name__,)
'plone.testing.zope.FunctionalTesting'

>>> zope.FUNCTIONAL_TESTING.__bases__
(<Layer 'plone.testing.zope.Startup'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zope.FUNCTIONAL_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zope.Startup in ... seconds.
Set up plone.testing.zope.FunctionalTesting in ... seconds.Let’s now simulate a test.
On test setup, theappresource is made available.
In a test, you should always use this to access the application root.
Therequestresource can be used to access the test request.:>>> zope.STARTUP.testSetUp()
>>> zope.FUNCTIONAL_TESTING.testSetUp()The test may now inspect and modify the environment.
It may also commit things.:>>> app = zope.FUNCTIONAL_TESTING['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')
>>> 'acl_users' in app.objectIds() and 'folder1' in app.objectIds()
True

>>> import transaction
>>> transaction.commit()On tear-down, the database is torn down.:>>> zope.FUNCTIONAL_TESTING.testTearDown()
>>> zope.STARTUP.testTearDown()

>>> 'app' in zope.FUNCTIONAL_TESTING
False

>>> 'request' in zope.FUNCTIONAL_TESTING
False

>>> with zope.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueLet’s tear down the layer::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zope.FunctionalTesting in ... seconds.
Tear down plone.testing.zope.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.The test browserTheFUNCTIONAL_TESTINGlayer andFunctionalTestinglayer class are the basis for functional testing usingzope.testbrowser.
This simulates a web browser, allowing an application to be tested “end-to-end” via its user-facing interface.To use the test browser with aFunctionalTestinglayer (such as the defaultFUNCTIONAL_TESTINGlayer instance), we need to use a custom browser client, which ensures that the test browser uses the correct ZODB and is appropriately isolated from the test code.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zope.FUNCTIONAL_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zope.Startup in ... seconds.
Set up plone.testing.zope.FunctionalTesting in ... seconds.Let’s simulate a test::>>> zope.STARTUP.testSetUp()
>>> zope.FUNCTIONAL_TESTING.testSetUp()In the test, we can create a test browser client like so::>>> app = zope.FUNCTIONAL_TESTING['app'] # would normally be self.layer['app']
>>> browser = zope.Browser(app)It is usually best to let Zope errors be shown with full tracebacks::>>> browser.handleErrors = FalseWe can add to the test fixture in the test.
For those changes to be visible to the test browser, however, we need to commit the transaction.:>>> _ = app.manage_addDTMLDocument('dtml-doc-1')
>>> import transaction; transaction.commit()We can now view this via the test browser::>>> browser.open(app.absolute_url() + '/dtml-doc-1')
>>> 'This is the dtml-doc-1 Document.' in browser.contents
TrueThe test browser integration converts the URL into a request and passes control to Zope’s publisher.
Let’s check that query strings are available for input processing::>>> from urllib.parse import urlencode
>>> _ = app.manage_addDTMLDocument('dtml-doc-2', file='<dtml-var foo>')
>>> import transaction; transaction.commit()
>>> qs = urlencode({'foo': 'boo, bar & baz'})  # sic: the ampersand.
>>> browser.open(app.absolute_url() + '/dtml-doc-2?' + qs)
>>> browser.contents
'boo, bar & baz'The test browser also works with iterators.
Let’s test that with a simple file implementation that uses an iterator.:>>> from plone.testing.tests import DummyFile
>>> app._setObject('file1', DummyFile('file1'))
'file1'

>>> import transaction; transaction.commit()

>>> browser.open(app.absolute_url() + '/file1')
>>> 'The test browser also works with iterators' in browser.contents
TrueSee thezope.testbrowserdocumentation for more information about how to use the browser client.On tear-down, the database is torn down.:>>> zope.FUNCTIONAL_TESTING.testTearDown()
>>> zope.STARTUP.testTearDown()

>>> 'app' in zope.FUNCTIONAL_TESTING
False

>>> 'request' in zope.FUNCTIONAL_TESTING
False

>>> with zope.zopeApp() as app:
...     'acl_users' in app.objectIds()\
...         and 'folder1' not in app.objectIds()\
...         and 'file1' not in app.objectIds()
TrueLet’s tear down the layer::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zope.FunctionalTesting in ... seconds.
Tear down plone.testing.zope.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.HTTP serverTheWSGI_SERVER_FIXTURElayer extendsSTARTUPto start a single-threaded Zope server in a separate thread.
This makes it possible to connect to the test instance using a web browser or a testing tool like Selenium or Windmill.TheWSGI_SERVERlayer provides aFunctionalTestinglayer that hasWSGI_SERVER_FIXTUREas its base.:>>> "%s.%s" % (zope.WSGI_SERVER_FIXTURE.__module__, zope.WSGI_SERVER_FIXTURE.__name__,)
'plone.testing.zope.WSGIServer'

>>> zope.WSGI_SERVER_FIXTURE.__bases__
(<Layer 'plone.testing.zope.Startup'>,)


>>> "%s.%s" % (zope.WSGI_SERVER.__module__, zope.WSGI_SERVER.__name__,)
'plone.testing.zope.WSGIServer:Functional'

>>> zope.WSGI_SERVER.__bases__
(<Layer 'plone.testing.zope.WSGIServer'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zope.WSGI_SERVER, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zope.Startup in ... seconds.
Set up plone.testing.zope.WSGIServer in ... seconds.
Set up plone.testing.zope.WSGIServer:Functional in ... seconds.After layer setup, the resourceshostandportare available, and indicate where Zope is running.:>>> host = zope.WSGI_SERVER['host']
>>> host
'localhost'

>>> port = zope.WSGI_SERVER['port']Let’s now simulate a test.
Test setup does nothing beyond what the base layers do.:>>> zope.STARTUP.testSetUp()
>>> zope.FUNCTIONAL_TESTING.testSetUp()
>>> zope.WSGI_SERVER.testSetUp()It is common in a test to use the Python API to change the state of the server (e.g.
create some content or change a setting) and then use the HTTP protocol to look at the results.
Bear in mind that the server is running in a separate thread, with a separate security manager, so calls tozope.login()andzope.logout(), for instance, do not affect the server thread.:>>> app = zope.WSGI_SERVER['app'] # would normally be self.layer['app']
>>> _ = app.manage_addDTMLDocument('dtml-doc-3')Note that we need to commit the transaction before it will show up in the other thread.:>>> import transaction; transaction.commit()We can now look for this new object through the server.:>>> app_url = app.absolute_url()
>>> app_url.split(':')[:-1]
['http', '//localhost']

>>> from urllib.request import urlopen
>>> conn = urlopen(app_url + '/dtml-doc-3', timeout=5)
>>> b'This is the dtml-doc-3 Document.' in conn.read()
True
>>> conn.close()Test tear-down does nothing beyond what the base layers do.:>>> zope.WSGI_SERVER.testTearDown()
>>> zope.FUNCTIONAL_TESTING.testTearDown()
>>> zope.STARTUP.testTearDown()

>>> 'app' in zope.WSGI_SERVER
False

>>> 'request' in zope.WSGI_SERVER
False

>>> with zope.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueWhen the server is torn down, the WSGIServer thread is stopped.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zope.WSGIServer:Functional in ... seconds.
Tear down plone.testing.zope.WSGIServer in ... seconds.
Tear down plone.testing.zope.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.We can expect one of these exceptions:
- URLError: <urlopen error [Errno …] Connection refused>
- error: [Errno 104] Connection reset by peer>>> try:
...     conn = urlopen(app_url + '/folder1', timeout=5)
... except Exception as exc:
...     if 'Connection refused' not in str(exc) and 'Connection reset' not in str(exc):
...         raise exc
... else:
...     print('urlopen should have raised exception')Zope 2 layersThe Zope 2 layers are found in the moduleplone.testing.zserver::>>> from plone.testing import zserverFor testing, we need a testrunner::>>> from zope.testrunner import runnerStartupSTARTUPis the base layer for all Zope 2 testing.
It sets up a Zope 2 sandbox environment that is suitable for testing.
It extends thezca.LAYER_CLEANUPlayer to maximise the chances of having and leaving a pristine environment.Note: You should probably use at leastINTEGRATION_TESTINGfor any real test, althoughSTARTUPis a useful base layer if you are setting up your own fixture.
See the description ofINTEGRATION_TESTINGbelow.:>>> "%s.%s" % (zserver.STARTUP.__module__, zserver.STARTUP.__name__,)
'plone.testing.zserver.Startup'

>>> zserver.STARTUP.__bases__
(<Layer 'plone.testing.zca.LayerCleanup'>,)On layer setup, Zope is initialised in a lightweight manner.
This involves certain patches to global modules that Zope manages, to reduce setup time, a database based onDemoStorage, and a minimal set of products that must be installed for Zope 2 to work.
A minimal set of ZCML is loaded, but packages in theProductsnamespace are not automatically configured.Let’s just verify that we have an empty component registry before the test::>>> from zope.component import getSiteManager
>>> list(getSiteManager().registeredAdapters())
[]Five sets a special vocabulary registry upon the layer setup, but there’s a default one set before::>>> from zope.schema.vocabulary import getVocabularyRegistry
>>> getVocabularyRegistry()
<zope.schema.vocabulary.VocabularyRegistry object ...>

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.STARTUP, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.After layer setup, thezodbDBresource is available, pointing to the default ZODB.:>>> zserver.STARTUP['zodbDB']
<ZODB.DB.DB object at ...>

>>> zserver.STARTUP['zodbDB'].storage
StartupIn addition, the resourceshostandportare set to the default hostname and port that are used for URLs generated from Zope.
These are hardcoded, but shadowed by layers that provide actual running Zope instances.:>>> zserver.STARTUP['host']
'nohost'
>>> zserver.STARTUP['port']
80At this point, it is also possible to get hold of a Zope application root.
If you are setting up a layer fixture, you can obtain an application root with the correct database that is properly closed by using thezopeApp()context manager.:>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds()
TrueIf you want to use a specific database, you can pass that tozopeApp()as thedbparameter.
A new connection will be opened and closed.:>>> with zserver.zopeApp(db=zserver.STARTUP['zodbDB']) as app:
...     'acl_users' in app.objectIds()
TrueIf you want to reuse an existing connection, you can pass one tozopeApp()as theconnectionargument.
In this case, you will need to close the connection yourself.:>>> conn = zserver.STARTUP['zodbDB'].open()
>>> with zserver.zopeApp(connection=conn) as app:
...     'acl_users' in app.objectIds()
True

>>> conn.opened is not None
True

>>> conn.close()If an exception is raised within thewithblock, the transaction is aborted, but the connection is still closed (if it was opened by the context manager)::>>> with zserver.zopeApp() as app:
...     raise Exception("Test error")
Traceback (most recent call last):
...
Exception: Test errorIt is common to combine thezopeApp()context manager with a stackedDemoStorageto set up a layer-specific fixture.
As a sketch::from plone.testing import Layer, zserver, zodb

class MyLayer(Layer):
    defaultBases = (zserver.STARTUP,)

    def setUp(self):
        self['zodbDB'] = zodb.stackDemoStorage(self.get('zodbDB'), name='MyLayer')
        with zserver.zopeApp() as app:

            # Set up a fixture, e.g.:
            app.manage_addFolder('folder1')
            folder = app['folder1']
            folder._addRole('role1')
            folder.manage_addUserFolder()

            userFolder = folder['acl_users']
            ignore = userFolder.userFolderAddUser('user1', 'secret', ['role1'], [])
            folder.manage_role('role1', ('Access contents information',))

    def tearDown(self):
        self['zodbDB'].close()
        del self['zodbDB']Note that you would normallynotuse thezserver.zopeApp()in a test or in atestSetUp()ortestTearDown()method.
TheIntegrationTestingandFunctionalTestinglayer classes manage the application object for you, exposing them as the resourceapp(see below).After layer setup, the global component registry contains a number of components needed by Zope.:>>> len(list(getSiteManager().registeredAdapters())) > 1 # in fact, > a lot
TrueAnd Five has set aZope2VocabularyRegistryvocabulary registry::>>> getVocabularyRegistry()
<....Zope2VocabularyRegistry object at ...>To load additional ZCML, you can use theconfigurationContextresource::>>> zserver.STARTUP['configurationContext']
<zope.configuration.config.ConfigurationMachine object ...>Seezca.rstfor details about how to usezope.configurationfor this purpose.TheSTARTUPlayer does not perform any specific test setup or tear-down.
That is left up to theINTEGRATION_TESTINGandFUNCTIONAL_TESTINGlayers, or other layers using their layer classes -IntegrationTestingandFunctionalTesting.:>>> zserver.STARTUP.testSetUp()
>>> zserver.STARTUP.testTearDown()Layer tear-down resets the environment.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.

>>> import ZServer.Zope2
>>> ZServer.Zope2._began_startup
0
>>> import Zope2
>>> Zope2.DB is None
True
>>> Zope2.bobo_application is None
True

>>> list(getSiteManager().registeredAdapters())
[]

>>> getVocabularyRegistry()
<zope.schema.vocabulary.VocabularyRegistry object at ...>Integration testINTEGRATION_TESTINGis intended for simple Zope 2 integration testing.
It extendsSTARTUPto ensure that a transaction is begun before and rolled back after each test.
Two resources,appandrequest, are available during testing as well.
It does not manage any layer state - it implements the test lifecycle methods only.Note:You would normallynotuseINTEGRATION_TESTINGas a base layer.
Instead, you’d use theIntegrationTestingclass to create your own layer with the testing lifecycle semantics ofINTEGRATION_TESTING.
See theplone.testingREADMEfile for an example.appis the application root.
In a test, you should use this instead of thezopeAppcontext manager (which remains the weapon of choice for setting up persistent fixtures), because theappresource is part of the transaction managed by the layer.requestis a test request. It is the same asapp.REQUEST.:>>> "%s.%s" % (zserver.INTEGRATION_TESTING.__module__, zserver.INTEGRATION_TESTING.__name__,)
'plone.testing.zserver.IntegrationTesting'

>>> zserver.INTEGRATION_TESTING.__bases__
(<Layer 'plone.testing.zserver.Startup'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.INTEGRATION_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.
Set up plone.testing.zserver.IntegrationTesting in ... seconds.Let’s now simulate a test.
On test setup, theappresource is made available.
In a test, you should always use this to access the application root.:>>> zserver.STARTUP.testSetUp()
>>> zserver.INTEGRATION_TESTING.testSetUp()The test may now inspect and modify the environment.:>>> app = zserver.INTEGRATION_TESTING['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')
>>> 'acl_users' in app.objectIds() and 'folder1' in app.objectIds()
TrueThe request is also available::>>> zserver.INTEGRATION_TESTING['request'] # would normally be self.layer['request']
<HTTPRequest, URL=http://nohost>We can create a user and simulate logging in as that user, using thezserver.login()helper::>>> app._addRole('role1')
>>> ignore = app['acl_users'].userFolderAddUser('user1', 'secret', ['role1'], [])
>>> zserver.login(app['acl_users'], 'user1')The first argument tozserver.login()is the user folder that contains the relevant user.
The second argument is the user’s name.
There is no need to give the password.:>>> from AccessControl import getSecurityManager
>>> getSecurityManager().getUser()
<User 'user1'>You can change the roles of a user using thezserver.setRoles()helper::>>> sorted(getSecurityManager().getUser().getRolesInContext(app))
['Authenticated', 'role1']

>>> zserver.setRoles(app['acl_users'], 'user1', [])
>>> getSecurityManager().getUser().getRolesInContext(app)
['Authenticated']To become the anonymous user again, usezserver.logout()::>>> zserver.logout()
>>> getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>On tear-down, the transaction is rolled back::>>> zserver.INTEGRATION_TESTING.testTearDown()
>>> zserver.STARTUP.testTearDown()

>>> 'app' in zserver.INTEGRATION_TESTING
False

>>> 'request' in zserver.INTEGRATION_TESTING
False

>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueLet’s tear down the layers::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.IntegrationTesting in ... seconds.
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.Functional testingTheFUNCTIONAL_TESTINGlayer is very similar toINTEGRATION_TESTING, and exposes the same fixture and resources.
However, it has different transaction semantics.INTEGRATION_TESTINGcreates a single database storage, and rolls back the transaction after each test.FUNCTIONAL_TESTINGcreates a whole new database storage (stacked on top of the basic fixture) for each test.
This allows testing of code that performs an explicit commit, which is usually required for end-to-end testing.
The downside is that the set-up and tear-down of each test takes longer.Note:Again, you would normallynotuseFUNCTIONAL_TESTINGas a base layer.
Instead, you’d use theFunctionalTestingclass to create your own layer with the testing lifecycle semantics ofFUNCTIONAL_TESTING.
See theplone.testingREADMEfile for an example.LikeINTEGRATION_TESTING,FUNCTIONAL_TESTINGis based onSTARTUP.:>>> "%s.%s" % (zserver.FUNCTIONAL_TESTING.__module__, zserver.FUNCTIONAL_TESTING.__name__,)
'plone.testing.zserver.FunctionalTesting'

>>> zserver.FUNCTIONAL_TESTING.__bases__
(<Layer 'plone.testing.zserver.Startup'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.FUNCTIONAL_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.
Set up plone.testing.zserver.FunctionalTesting in ... seconds.Let’s now simulate a test.
On test setup, theappresource is made available.
In a test, you should always use this to access the application root.
Therequestresource can be used to access the test request.:>>> zserver.STARTUP.testSetUp()
>>> zserver.FUNCTIONAL_TESTING.testSetUp()The test may now inspect and modify the environment.
It may also commit things.:>>> app = zserver.FUNCTIONAL_TESTING['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')
>>> 'acl_users' in app.objectIds() and 'folder1' in app.objectIds()
True

>>> import transaction
>>> transaction.commit()On tear-down, the database is torn down.:>>> zserver.FUNCTIONAL_TESTING.testTearDown()
>>> zserver.STARTUP.testTearDown()

>>> 'app' in zserver.FUNCTIONAL_TESTING
False

>>> 'request' in zserver.FUNCTIONAL_TESTING
False

>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueLet’s tear down the layer::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.FunctionalTesting in ... seconds.
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.The test browserTheFUNCTIONAL_TESTINGlayer andFunctionalTestinglayer class are the basis for functional testing usingzope.testbrowser.
This simulates a web browser, allowing an application to be tested “end-to-end” via its user-facing interface.To use the test browser with aFunctionalTestinglayer (such as the defaultFUNCTIONAL_TESTINGlayer instance), we need to use a custom browser client, which ensures that the test browser uses the correct ZODB and is appropriately isolated from the test code.:>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.FUNCTIONAL_TESTING, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.
Set up plone.testing.zserver.FunctionalTesting in ... seconds.Let’s simulate a test::>>> zserver.STARTUP.testSetUp()
>>> zserver.FUNCTIONAL_TESTING.testSetUp()In the test, we can create a test browser client like so::>>> app = zserver.FUNCTIONAL_TESTING['app'] # would normally be self.layer['app']
>>> browser = zserver.Browser(app)It is usually best to let Zope errors be shown with full tracebacks::>>> browser.handleErrors = FalseWe can add to the test fixture in the test.
For those changes to be visible to the test browser, however, we need to commit the transaction.:>>> app.manage_addFolder('folder1')
>>> import transaction; transaction.commit()We can now view this via the test browser::>>> browser.open(app.absolute_url() + '/folder1')

>>> browser.contents.replace('"', '').replace("'", "")
'<Folder ...'The __repr__ of Zope objects is not stable anymore.The test browser integration converts the URL into a request and passes control to Zope’s publisher.
Let’s check that query strings are available for input processing::>>> import urllib
>>> qs = urllib.urlencode({'foo': 'boo, bar & baz'})  # sic: the ampersand.
>>> _ = app['folder1'].addDTMLMethod('index_html', file='<dtml-var foo>')
>>> import transaction; transaction.commit()
>>> browser.open(app.absolute_url() + '/folder1?' + qs)
>>> browser.contents
'boo, bar & baz'The test browser also works with iterators.
Let’s test that with a simple file implementation that uses an iterator.:>>> from plone.testing.tests import DummyFile
>>> app._setObject('file1', DummyFile('file1'))
'file1'

>>> import transaction; transaction.commit()

>>> browser.open(app.absolute_url() + '/file1')
>>> 'The test browser also works with iterators' in browser.contents
TrueSee thezope.testbrowserdocumentation for more information about how to use the browser client.On tear-down, the database is torn down.:>>> zserver.FUNCTIONAL_TESTING.testTearDown()
>>> zserver.STARTUP.testTearDown()

>>> 'app' in zserver.FUNCTIONAL_TESTING
False

>>> 'request' in zserver.FUNCTIONAL_TESTING
False

>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds()\
...         and 'folder1' not in app.objectIds()\
...         and 'file1' not in app.objectIds()
TrueLet’s tear down the layer::>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.FunctionalTesting in ... seconds.
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.HTTP serverTheZSERVER_FIXTURElayer extendsSTARTUPto start a single-threaded Zope server in a separate thread.
This makes it possible to connect to the test instance using a web browser or a testing tool like Selenium or Windmill.TheZSERVERlayer provides aFunctionalTestinglayer that hasZSERVER_FIXTUREas its base.:>>> "%s.%s" % (zserver.ZSERVER_FIXTURE.__module__, zserver.ZSERVER_FIXTURE.__name__,)
'plone.testing.zserver.ZServer'

>>> zserver.ZSERVER_FIXTURE.__bases__
(<Layer 'plone.testing.zserver.Startup'>,)


>>> "%s.%s" % (zserver.ZSERVER.__module__, zserver.ZSERVER.__name__,)
'plone.testing.zserver.ZServer:Functional'

>>> zserver.ZSERVER.__bases__
(<Layer 'plone.testing.zserver.ZServer'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.ZSERVER, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.
Set up plone.testing.zserver.ZServer in ... seconds.
Set up plone.testing.zserver.ZServer:Functional in ... seconds.After layer setup, the resourceshostandportare available, and indicate where Zope is running.:>>> host = zserver.ZSERVER['host']
>>> port = zserver.ZSERVER['port']Let’s now simulate a test.
Test setup does nothing beyond what the base layers do.:>>> zserver.STARTUP.testSetUp()
>>> zserver.FUNCTIONAL_TESTING.testSetUp()
>>> zserver.ZSERVER.testSetUp()It is common in a test to use the Python API to change the state of the server (e.g.
create some content or change a setting) and then use the HTTP protocol to look at the results.
Bear in mind that the server is running in a separate thread, with a separate security manager, so calls tozserver.login()andzserver.logout(), for instance, do not affect the server thread.:>>> app = zserver.ZSERVER['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')Note that we need to commit the transaction before it will show up in the other thread.:>>> import transaction; transaction.commit()We can now look for this new object through the server.:>>> app_url = app.absolute_url()
>>> app_url.split(':')[:-1]
['http', '//localhost']

>>> import urllib2
>>> conn = urllib2.urlopen(app_url + '/folder1', timeout=5)
>>> conn.read().replace('"', '').replace("'", "")
'<Folder ...'
>>> conn.close()The __repr__ of Zope objects is not stable anymore.Test tear-down does nothing beyond what the base layers do.:>>> zserver.ZSERVER.testTearDown()
>>> zserver.FUNCTIONAL_TESTING.testTearDown()
>>> zserver.STARTUP.testTearDown()

>>> 'app' in zserver.ZSERVER
False

>>> 'request' in zserver.ZSERVER
False

>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueWhen the server is torn down, the ZServer thread is stopped.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.ZServer:Functional in ... seconds.
Tear down plone.testing.zserver.ZServer in ... seconds.
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.We can expect one of these exceptions:
- URLError: <urlopen error [Errno …] Connection refused>
- error: [Errno 104] Connection reset by peer>>> try:
...     conn = urllib2.urlopen(app_url + '/folder1', timeout=5)
... except Exception as exc:
...     if 'Connection refused' not in str(exc) and 'Connection reset' not in str(exc):
...         raise exc
... else:
...     print('urllib2.urlopen should have raised exception')FTP serverTheFTP_SERVERlayer is identical similar toZSERVER, except that it starts an FTP server instead of an HTTP server.
The fixture is contained in theFTP_SERVER_FIXTURElayer.Warning:It is generally not safe to run theZSERVERandFTP_SERVERlayers concurrently, because they both start up the sameasyncoreloop.
If you need concurrent HTTP and FTP servers in a test, you can create your own layer by subclassing theZServerlayer class, and overriding thesetUpServer()andtearDownServer()hooks to set up and close both servers.
See the code for an example.TheFTP_SERVER_FIXTURElayer is based on theSTARTUPlayer.:>>> "%s.%s" % (zserver.FTP_SERVER_FIXTURE.__module__, zserver.FTP_SERVER_FIXTURE.__name__,)
'plone.testing.zserver.FTPServer'

>>> zserver.FTP_SERVER_FIXTURE.__bases__
(<Layer 'plone.testing.zserver.Startup'>,)TheFTP_SERVERlayer is based onFTP_SERVER_FIXTURE, using theFunctionalTestinglayer class.:>>> "%s.%s" % (zserver.FTP_SERVER.__module__, zserver.FTP_SERVER.__name__,)
'plone.testing.zserver.FTPServer:Functional'

>>> zserver.FTP_SERVER.__bases__
(<Layer 'plone.testing.zserver.FTPServer'>,)

>>> options = runner.get_options([], [])
>>> setupLayers = {}
>>> runner.setup_layer(options, zserver.FTP_SERVER, setupLayers)
Set up plone.testing.zca.LayerCleanup in ... seconds.
Set up plone.testing.zserver.Startup in ... seconds.
Set up plone.testing.zserver.FTPServer in ... seconds.
Set up plone.testing.zserver.FTPServer:Functional in ... seconds.After layer setup, the resourceshostandportare available, and indicate where Zope is running.:>>> host = zserver.FTP_SERVER['host']
>>> port = zserver.FTP_SERVER['port']Let’s now simulate a test.
Test setup does nothing beyond what the base layers do.:>>> zserver.STARTUP.testSetUp()
>>> zserver.FUNCTIONAL_TESTING.testSetUp()
>>> zserver.FTP_SERVER.testSetUp()As withZSERVER, we will set up some content for the test and then access it over the FTP port.:>>> app = zserver.FTP_SERVER['app'] # would normally be self.layer['app']
>>> app.manage_addFolder('folder1')We’ll also create a user in the root user folder to make FTP access easier.:>>> ignore = app['acl_users'].userFolderAddUser('admin', 'secret', ['Manager'], ())Note that we need to commit the transaction before it will show up in the other thread.:>>> import transaction; transaction.commit()We can now look for this new object through the server.:>>> app_path = app.absolute_url_path()

>>> import ftplib
>>> ftpClient = ftplib.FTP()
>>> ftpClient.connect(host, port, timeout=5)
'220 ... FTP server (...) ready.'

>>> ftpClient.login('admin', 'secret')
'230 Login successful.'

>>> ftpClient.cwd(app_path)
'250 CWD command successful.'

>>> ftpClient.retrlines('LIST')
drwxrwx---   1 Zope     Zope            0 ... .
...--w--w----   1 Zope     Zope            0 ... acl_users
drwxrwx---   1 Zope     Zope            0 ... folder1
'226 Transfer complete'

>>> ftpClient.quit()
'221 Goodbye.'Test tear-down does nothing beyond what the base layers do.:>>> zserver.FTP_SERVER.testTearDown()
>>> zserver.FUNCTIONAL_TESTING.testTearDown()
>>> zserver.STARTUP.testTearDown()

>>> 'app' in zserver.ZSERVER
False

>>> 'request' in zserver.ZSERVER
False

>>> with zserver.zopeApp() as app:
...     'acl_users' in app.objectIds() and 'folder1' not in app.objectIds()
TrueWhen the server is torn down, the FTP thread is stopped.:>>> runner.tear_down_unneeded(options, [], setupLayers, [])
Tear down plone.testing.zserver.FTPServer:Functional in ... seconds.
Tear down plone.testing.zserver.FTPServer in ... seconds.
Tear down plone.testing.zserver.Startup in ... seconds.
Tear down plone.testing.zca.LayerCleanup in ... seconds.

>>> ftpClient.connect(host, port, timeout=5)
Traceback (most recent call last):
...
error: [Errno ...] Connection refused