collective.testcaselayer 0.1

Layers

The PloneTestCase test fixture can be set up and torn down as a layer.

>>> from collective.testcaselayer import ptc
>>> ptc.ptc_layer
<collective.testcaselayer.ptc.PTCLayer testMethod=layerOnly>

To test the effects of just this layer, set up the base layer separately. Because of the way PloneTestCase uses layers, we must first call the setupPloneSite() function.

>>> from zope.testing import testrunner
>>> from Products.PloneTestCase import ptc as plone_ptc
>>> plone_ptc.setupPloneSite()
>>> cmfsite_layer, = ptc.ptc_layer.__bases__
>>> options = testrunner.get_options([], [])
>>> setup_layers = {}
>>> testrunner.setup_layer(options, cmfsite_layer, setup_layers)
Set up Products.PloneTestCase.layer.ZCML in ... seconds.
Set up Products.PloneTestCase.layer.PloneSite in ... seconds.

The PloneTestCase test fixture has not been set up.

>>> from Testing import ZopeTestCase
>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)
>>> portal.acl_users.getUserById(plone_ptc.default_user)
>>> ZopeTestCase.close(app)

Set up the PloneTestCase layer.

>>> testrunner.setup_layer(options, ptc.ptc_layer, setup_layers)
Set up collective.testcaselayer.ptc.PTCLayer in ... seconds.

The PloneTestCase test fixture has been set up.

>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)
>>> portal.acl_users.getUserById(plone_ptc.default_user)
<PloneUser 'test_user_1_'>
>>> ZopeTestCase.close(app)

Tear down the PloneTestCase layer.

>>> testrunner.tear_down_unneeded(
...     options,
...     [layer for layer in setup_layers
...      if layer is not ptc.ptc_layer],
...     setup_layers)
Tear down collective.testcaselayer.ptc.PTCLayer in ... seconds.

The PloneTestCase test fixture is no longer set up.

>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)
>>> portal.acl_users.getUserById(plone_ptc.default_user)
>>> ZopeTestCase.close(app)

Layer Base Classes

The PloneTestCase class facilities can also be used in layers that use the PloneTestCase layer base class.

>>> class FooLayer(ptc.BasePTCLayer):
...     def afterSetUp(self):
...         self.addProfile(
...             'Products.CMFDefault:sample_content')
...         self.addProduct('CollectiveTestCaseLayerTesting')
...         self.loginAsPortalOwner()

This layer depends on the profile and product added which are set up in a testing only layer.

>>> from collective.testcaselayer.testing import layer
>>> foo_layer = FooLayer([layer.product_layer, cmfsite_layer])

The FooLayer test fixture has not been set up.

>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)

>>> hasattr(portal, 'subfolder')
False
>>> hasattr(portal, 'foo')
False

>>> from AccessControl import SecurityManagement
>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> ZopeTestCase.close(app)

Set up the FooLayer.

>>> testrunner.setup_layer(options, foo_layer, setup_layers)
Set up collective.testcaselayer.testing.layer.ProductLayer
in ... seconds.
Set up FooLayer in ... seconds.

The FooLayer test fixture has been set up.

>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)

>>> portal.subfolder
<ATFolder at /plone/subfolder>
>>> portal.foo
'foo'

>>> from AccessControl import SecurityManagement
>>> SecurityManagement.getSecurityManager().getUser()
<PropertiedUser 'portal_owner'>

>>> ZopeTestCase.close(app)

Tear down the FooLayer.

>>> testrunner.tear_down_unneeded(
...     options,
...     [layer for layer in setup_layers
...      if layer is not foo_layer],
...     setup_layers)
Tear down FooLayer in ... seconds.

The FooLayer test fixture is no longer set up.

>>> app = ZopeTestCase.app()
>>> portal = getattr(app, plone_ptc.portal_name)

>>> hasattr(portal, 'subfolder')
False
>>> hasattr(portal, 'foo')
False

>>> from AccessControl import SecurityManagement
>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> ZopeTestCase.close(app)

Finish tearing down the rest of the layers.

>>> testrunner.tear_down_unneeded(options, [], setup_layers)
Tear down collective.testcaselayer.testing.layer.ProductLayer
in ... seconds.
Tear down Products.PloneTestCase.layer.PloneSite in ... seconds.
Tear down Products.PloneTestCase.layer.ZCML in ... seconds.

Layers

The collective.testcaselayer.ztc module provides sandboxed layers that set up the test fixtures for ZopeTestCase. Note that test case based layers still act like test cases with a special no-op layerOnly() test method to that they have functional str() and repr() values.

>>> from collective.testcaselayer import ztc
>>> ztc.ztc_layer
<collective.testcaselayer.ztc.ZTCLayer testMethod=layerOnly>

Before we set up ZopeTestCase as a layer, nothing has been set up.

>>> from AccessControl import SecurityManagement
>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> hasattr(ztc.ztc_layer, 'app')
False

>>> from Testing import ZopeTestCase
>>> app = ZopeTestCase.app()
>>> app.objectValues()
[<UserFolder at /acl_users>,
 <ApplicationManager at /Control_Panel>]
>>> ZopeTestCase.close(app)

>>> from Testing.ZopeTestCase import connections
>>> connections.count()
0

Set up ZopeTestCase as a layer.

>>> from zope.testing import testrunner
>>> options = testrunner.get_options([], [])
>>> setup_layers = {}
>>> testrunner.setup_layer(options, ztc.ztc_layer, setup_layers)
Set up collective.testcaselayer.ztc.ZTCLayer in ... seconds.

The ZopeTestCase test fixture has been set up, but there is no logged in user.

>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> ztc.ztc_layer.app.objectValues()
[<UserFolder at /acl_users>,
 <ApplicationManager at /Control_Panel>,
 <Folder at /test_folder_1_>]

Also note that the app attribute of the layer represents an open connection to the ZODB.

>>> connections.count()
1

Tear down the ZopeTestCase layer.

>>> testrunner.tear_down_unneeded(options, [], setup_layers)
Tear down collective.testcaselayer.ztc.ZTCLayer in ... seconds.

Now everything is back to its previous state.

>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> hasattr(ztc.ztc_layer, 'app')
False

>>> from Testing import ZopeTestCase
>>> app = ZopeTestCase.app()
>>> app.objectValues()
[<UserFolder at /acl_users>,
 <ApplicationManager at /Control_Panel>]
>>> ZopeTestCase.close(app)

>>> connections.count()
0

Layer Base Classes

The collective.testcaselayer.ztc module also provides base classes for sandboxed layers that don’t actually set up the test case fixtures but allow using the facilities provided by the test cases in the layer set up and tear down code.

Since layers can be nested, these layer base classes don’t do the actual ZopeTestCase test fixture set up unless a subclass explicitly sets _setup_fixture (or _configure_portal for PortalTestCase) to True. Best practice should be to instantiate any layers depending on the ZTC test fixture with the ZTCLayer as a base layer as above.

Create a layer class that subclasses the appropriate base layer class. This layer class overrides the afterSetUp() method just as with ZopeTestCase based test cases. The afterSetUp method here excercises the factilities provided by ZopeTestCase.

>>> class FooLayer(ztc.BaseZTCLayer):
...     def afterSetUp(self):
...         self.login()
...         self.setRoles(['Manager'])
>>> foo_layer = FooLayer([ztc.ztc_layer])

To test the effects of just this layer, set up the base layer separately.

>>> testrunner.setup_layer(options, ztc.ztc_layer, setup_layers)
Set up collective.testcaselayer.ztc.ZTCLayer in ... seconds.

Before setting up the new layer, only the ZopeTestCase fixture is set up.

>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> app = ZopeTestCase.app()
>>> user = getattr(app, ZopeTestCase.folder_name
...                ).acl_users.getUserById(ZopeTestCase.user_name)
>>> user.getRoles()
('test_role_1_', 'Authenticated')
>>> ZopeTestCase.close(app)

Set up the new layer.

>>> testrunner.setup_layer(options, foo_layer, setup_layers)
Set up FooLayer in ... seconds.

Now the changed made by afterSetUp() are reflected.

>>> authenticated = SecurityManagement.getSecurityManager(
...     ).getUser()
>>> authenticated
<User 'test_user_1_'>
>>> authenticated.getRoles()
('Manager', 'Authenticated')

Tear down just the new layer.

>>> testrunner.tear_down_unneeded(
...     options, [ztc.ztc_layer], setup_layers)
Tear down FooLayer in ... seconds.

Everything is restored to its previous state.

>>> SecurityManagement.getSecurityManager().getUser()
<SpecialUser 'Anonymous User'>

>>> app = ZopeTestCase.app()
>>> user = getattr(app, ZopeTestCase.folder_name
...                ).acl_users.getUserById(ZopeTestCase.user_name)
>>> user.getRoles()
('test_role_1_', 'Authenticated')
>>> ZopeTestCase.close(app)

Finish tearing down the rest of the layers.

>>> testrunner.tear_down_unneeded(options, [], setup_layers)
Tear down collective.testcaselayer.ztc.ZTCLayer in ... seconds.

Layer Classes

Use the collective.testcaselayer.layer.Layer class to create your own layer classes.

>>> class FooLayer(layer.Layer):
...     def setUp(self): print 'running FooLayer.setUp'

The instances of the class will be your actual zope.testing layer.

>>> foo_layer = FooLayer()

>>> from zope.testing import testrunner
>>> options = testrunner.get_options([], [])
>>> testrunner.setup_layer(options, foo_layer, {})
Set up FooLayer running FooLayer.setUp
in ... seconds.

Beware that the Layer class itself or subclasses can be used themselves as layers without error but that is not how they’re intended to be used. For example, using the FooLayer class as a layer will treat the Layer base class as a layer itself and will set it up which is meaningless. Further, it will try to call the setUp method as a class method which will raise an error.

>>> testrunner.setup_layer(options, FooLayer, {})
Traceback (most recent call last):
TypeError: unbound method setUp() must be called with FooLayer instance as first argument (got nothing instead)

Base Layers

Base layers are designated by passing them into the layer class on instantiation.

Create another layer class.

>>> class BarLayer(layer.Layer):
...     def setUp(self): print 'running BarLayer.setUp'

Create the new layer that uses foo_layer as a base layer.

>>> bar_layer = BarLayer([foo_layer])

Set up the layers.

>>> testrunner.setup_layer(options, bar_layer, {})
Set up FooLayer running FooLayer.setUp
in ... seconds.
Set up BarLayer running BarLayer.setUp
in ... seconds.

Grouping Layers

If all that’s required from a layer is that it groups other layers as base layers, then the collective.testcaselayer.layer.Layer class can be used directly.

Create another layer.

>>> class BazLayer(layer.Layer):
...     def setUp(self): print 'running BazLayer.setUp'
>>> baz_layer = BazLayer()

Instantiate the Layer class with the base layers, a module, and a name.

>>> qux_layer = layer.Layer(
...     [bar_layer, baz_layer],
...     module='QuxModule', name='QuxLayer')

Set up the layers.

>>> testrunner.setup_layer(options, qux_layer, {})
Set up FooLayer running FooLayer.setUp
in ... seconds.
Set up BarLayer running BarLayer.setUp
in ... seconds.
Set up BazLayer running BazLayer.setUp
in ... seconds.
Set up QuxModule.QuxLayer in ... seconds.

By default, layers have the same module and name as their class. If you want the layer to have a different module or name than the class, then the both can be passed in as arguments. This is useful in this case and any time multiple instances of the same layer class will be used as layers.

Instantiating the Layer class directly without passing a name raises an error.

>>> layer.Layer([], module='QuxModule')
Traceback (most recent call last):
ValueError: The "name" argument is requied when instantiating
"Layer" directly

If the Layer class is instantiated directly without passing a module, the module name from the calling frame is used.

>>> __name__ = 'BahModule'
>>> quux_layer = layer.Layer([], name='QuuxLayer')
>>> testrunner.setup_layer(options, quux_layer, {})
Set up BahModule.QuuxLayer in ... seconds.

Changelog

0.1 - 2008-05-23

• Initial release

TODO

• Factor out collective.testclasslayer.layer

The collective.testclasslayer.layer module doesn’t actually have anything to do with test cases, but I didn’t want to create a separate package just for this one bit. If someone wants to put this in zope.testing or some other common testing dependency, that would be great.

• Factor unittest.TestCase out of Testing.ZopeTestCase.base.TestCase

It might be appropriate to refactor out the ZTC specific pieces of the test cases in the Testing.ZopeTestCase package such that there is a common base class that doesn’t subclass unittest.TestCase. With this in place we could do away with collective.testcaselayer.testcase and have common base classes that could be used either as layers or as test cases.