Provides some testing helpers and an advanced MockTestCase.
This package provides helpers for writing tests.
Table of Contents
- Mocking vs. stubbing
- Component registry layer
- Mailing test helper
- Freezing datetime.now()
- Static UUIDS
- Generic Setup uninstall test
- Disabling quickinstaller snapshots
- Transaction interceptor
- Testing Layers
- 1.19.2 (2018-11-05)
- 1.19.1 (2018-10-23)
- 1.19.0 (2018-10-15)
- 1.18.0 (2018-07-12)
- 1.17.0 (2017-10-02)
- 1.16.0 (2017-08-08)
- 1.15.2 (2017-07-18)
- 1.15.1 (2017-07-04)
- 1.15.0 (2017-07-03)
- 1.14.0 (2017-06-23)
- 1.13.0 (2017-06-20)
- 1.12.0 (2017-06-19)
- 1.11.0 (2016-03-31)
- 1.10.3 (2015-10-11)
- 1.10.2 (2015-07-30)
- 1.10.1 (2015-07-27)
- 1.10.0 (2015-05-18)
- 1.9.1 (2015-05-15)
- 1.9.0 (2015-05-15)
- 1.8.1 (2015-01-05)
- 1.8.0 (2014-12-31)
- 1.7.0 (2014-09-30)
- 1.6.4 (2014-05-01)
- 1.6.3 (2014-04-30)
- 1.6.2 (2014-04-30)
- 1.6.1 (2014-04-29)
- 1.6.0 (2014-04-29)
- 1.5.2 (2014-02-09)
- 1.5.1 (2014-02-08)
- 1.5.0 (2013-09-24)
- 1.4 (2013-08-26)
- 1.3.1 (2013-05-24)
- 1.3 (2013-05-03)
- 1.2 (2012-05-22)
- 1.1 (2011-11-16)
- 1.0 (2011-10-12)
The FTWIntegrationTesting is an opinionated extension of Plone’s default integration testing layer.
The primary goal is to be able to run ftw.testbrowsers traversal driver with integration testing.
Database isolation and transactions
The Plone default integration testing layer does support transactions: when changes are committed in tests, no isolation is provided and the committed changes will apear in the next layer.
- We isolate between tests by making a savepoint in the test setup and rolling back to the savepoint in test tear down.
- With a transaction interceptor we make sure that no code in the test can commit or abort a transaction. Transactional behavior is simulated by using savepoints.
from ftw.testing import FTWIntegrationTesting from plone.app.testing import PLONE_FIXTURE from plone.app.testing import PloneSandboxLayer class TestingLayer(PloneSandboxLayer): defaultBases = (PLONE_FIXTURE,) TESTING_FIXTURE = TestingLayer() INTEGRATION_TESTING = FTWIntegrationTesting( bases=(TESTING_FIXTURE,), name='my.package:integration')
The integration test case is an test case base class providing sane defaults and practical helpers for testing Plone addons with an FTWIntegrationTesting testing layer.
You may make your own base class in your package, setting the default testing layer and extending the behavior and helpers for your needs.
# my/package/tests/test_case.py from ftw.testing import FTWIntegrationTestCase from my.package.testing import INTEGRATION_TESTING class IntegrationTestCase(FTWIntegrationTestCase): layer = INTEGRATION_TESTING
ftw.testing provides an advanced MockTestCase which provides bases on the plone.mocktestcase MockTestCase.
from ftw.testing import MockTestCase
The following additional methods are available:
- self.providing_mock(interfaces, *args, **kwargs)
- Creates a mock which provides interfaces.
- self.mock_interface(interface, provides=None, *args, **kwargs)
- Creates a mock object implementing interface. The mock does not only provide interface, but also use it as specification and asserts that the mocked methods do exist on the interface.
- self.stub(*args, **kwargs)
- Creates a stub. It acts like a mock but has no assertions.
- self.providing_stub(interfaces, *args, **kwargs)
- Creates a stub which provides interfaces.
- self.stub_interface(interface, provides=None, *args, **kwargs)
- Does the same as mock_interface, but disables counting of expected method calls and attribute access. See “Mocking vs. stubbing” below.
- self.set_parent(context, parent_context)
- Stubs the context so that its acquisition parent is parent_context. Expects at least context to be a mock or a stub. Returns the context.
- self.stub_request(interfaces=, stub_response=True, content_type='text/html', status=200)
- Returns a request stub which can be used for rendering templates. With the stub_response option, you can define if the request should stub a response by itself. The other optional arguments: content_type: Defines the expected output content type of the response. status: Defines the expected status code of the response.
- self.stub_response(request=None, content_type='text/html', status=200))
- Returns a stub response with some headers and options. When a request is given the response is also added to the given request. The other optional arguments: content_type: Defines the expected output content type of the response. status: Defines the expected status code of the response.
- self.assertRaises(*args, **kwargs)
- Uses unittest2 implementation of assertRaises instead of unittest implementation.
It also fixes a problem in mock_tool, where the getToolByName mock had assertions which is not very useful in some cases.
A mock is used for testing the communication between two objects. It asserts method calls. This is used when a test should not test if a object has a specific state after doing something (e.g. it has it’s attribute xy set to something), but if the object does something with another object. If for example an object Foo sends an email when method bar is called, we could mock the sendmail object and assert on the send-email method call.
On the other hand we often have to test the state of an object (attribute values) after doing something. This can be done without mocks by just calling the method and asserting the attribute values. But then we have to set up an integration test and install plone, which takes very long. For testing an object with dependencies to other parts of plone in a unit test, we can use stubs for faking other (separately tested) parts of plone. Stubs work like mocks: you can “expect” a method call and define a result. The difference between stubs and mocks is that stubs do not assert the expectations, so there will be no errors if something expected does not happen. So when using stubs we can assert the state without asserting the communcation between objects.
The MockTestCase is able to mock components (adapters, utilities). It cleans up the component registry after every test.
But when we use a ZCML layer, loading the ZCML of the package it should use the same component registry for all tests on the same layer. The ComponentRegistryLayer is a layer superclass for sharing the component registry and speeding up tests.
from ftw.testing.layer import ComponentRegistryLayer class ZCMLLayer(ComponentRegistryLayer): def setUp(self): super(ZCMLLayer, self).setUp() import my.package self.load_zcml_file('configure.zcml', my.package) ZCML_LAYER = ZCMLLayer()
Be aware that ComponentRegistryLayer is a base class for creating your own layer (by subclassing ComponentRegistryLayer) and is not usable with defaultBases directly. This allows us to use the functions load_zcml_file and load_zcml_string.
The Mailing helper object mocks the mailhost and captures sent emails. The emails can then be easily used for assertions.
from ftw.testing.mailing import Mailing import transaction class MyTest(TestCase): layer = MY_FUNCTIONAL_TESTING def setUp(self): Mailing(self.layer['portal']).set_up() transaction.commit() def tearDown(self): Mailing(self.layer['portal']).tear_down() def test_mail_stuff(self): portal = self.layer['portal'] do_send_email() mail = Mailing(portal).pop() self.assertEquals('Subject: ...', mail)
When testing code which depends on the current time, it is necessary to set the current time to a specific time. The freeze context manager makes that really easy:
from ftw.testing import freeze from datetime import datetime with freeze(datetime(2014, 5, 7, 12, 30)): # test code
The freeze context manager patches the datetime module, the time module and supports the Zope DateTime module. It removes the patches when exiting the context manager.
Updating the freezed time
from ftw.testing import freeze from datetime import datetime with freeze(datetime(2014, 5, 7, 12, 30)) as clock: # its 2014, 5, 7, 12, 30 clock.forward(days=2) # its 2014, 5, 9, 12, 30 clock.backward(minutes=15) # its 2014, 5, 9, 12, 15
You can use the timedelta arguments`(https://docs.python.org/2/library/datetime.html#datetime.timedelta)_ for ``forward` and backward.
When asserting UUIDs it can be annoying that they change at each test run. The staticuid decorator helps to fix that by using static uuids which are prefixed and counted within a scope, usually a test case:
from ftw.testing import staticuid from plone.app.testing import PLONE_INTEGRATION_TESTING from unittest2 import TestCase class MyTest(TestCase): layer = PLONE_INTEGRATION_TESTING @staticuid() def test_all_the_things(self): doc = self.portal.get(self.portal.invokeFactory('Document', 'the-document')) self.assertEquals('testallthethings0000000000000001', IUUID(doc)) @staticuid('MyUIDS') def test_a_prefix_can_be_set(self): doc = self.portal.get(self.portal.invokeFactory('Document', 'the-document')) self.assertEquals('MyUIDS00000000000000000000000001', IUUID(doc))
ftw.testing provides a test superclass for testing uninstall profiles. The test makes a Generic Setup snapshot before installing the package, then installs and uninstalls the package, creates another snapshot and diffs it. The package is installed without installing its dependencies, because it should not include uninstalling dependencies in the uninstall profile.
Appropriate testing layer setup is included and the test runs on a seperate layer which should not interfere with other tests.
from ftw.testing.genericsetup import GenericSetupUninstallMixin from ftw.testing.genericsetup import apply_generic_setup_layer from unittest2 import TestCase @apply_generic_setup_layer class TestGenericSetupUninstall(TestCase, GenericSetupUninstallMixin): package = 'my.package'
The my.package is expected to have a Generic Setup profile profile-my.package:default for installing the package and a profile-my.package:uninstall for uninstalling the package. It is expected to use z3c.autoinclude entry points for loading its ZCML.
The options are configured as class variables:
- The dotted name of the package as string, which is used for things such as guessing the Generic Setup profile names. This is mandatory.
- autoinclude (True)
- This makes the testing fixture load ZCML using the z3c.autoinclude entry points registered for the target plone.
- additional_zcml_packages (())
- Use this if needed ZCML is not loaded using the autoinclude option, e.g. when you need to load testing zcml. Pass in an iterable of dottednames of packages, which contain a configure.zcml.
- additional_products (())
- A list of additional Zope products to install.
- install_profile_name (default)
- The Generic Setup install profile name postfix.
- skip_files (())
- An iterable of Generic Setup files (e.g. ("viewlets.xml",)) to be ignored in the diff. This is sometimes necessary, because not all components can and should be uninstalled properly. For example viewlet orders cannot be removed using Generic Setup - but this is not a problem they do no longer take effect when the viewlets / viewlet managers are no longer registered.
from ftw.testing.genericsetup import GenericSetupUninstallMixin from ftw.testing.genericsetup import apply_generic_setup_layer from unittest2 import TestCase @apply_generic_setup_layer class TestGenericSetupUninstall(TestCase, GenericSetupUninstallMixin): package = 'my.package' autoinclude = False additional_zcml_packages = ('my.package', 'my.package.tests') additional_products = ('another.package', ) install_profile_name = 'default' skip_files = ('viewlets.xml', 'rolemap.xml')
Quickinstaller normally makes a complete Generic Setup (GS) snapshot before and after installing each GS profile, in order to be able to uninstall the profile afterwards.
In tests we usually don’t need this feature and want to disable it to speed up tests.
The ftw.testing.quickinstaller module provides a patcher for replacing the quickinstaller event handlers to skip creating snapshots. Usually we want to do this early (when loading testing.py), so that all the tests are speeding up. However, some tests which involve quickinstaller rely on having the snapshots made (see previous section about uninstall tests). Therefore the snapshot patcher object provides context managers for temporarily enabling / disabling the snapshot feature.
Disable snapshots early, so that everything is fast. Usually this is done in the testing.py in module scope, so that it happens already when the testrunner imports the tests:
from ftw.testing.quickinstaller import snapshots from plone.app.testing import PloneSandboxLayer snapshots.disable() class MyPackageLayer(PloneSandboxLayer): ...
When testing quickinstaller snapshot related things, such as uninstalling, the snapshots can be re-enabled for a context manager or in general:
from ftw.testing.quickinstaller import snapshots snapshots.disable() # snapshotting is now disabled with snapshots.enabled(): # snapshotting is enabled only within this block snapshots.enable() # snapshotting is now enabled with snapshots.disabled(): # snapshotting is disabled only within this block
The TransactionInterceptor patches Zope’s transaction manager in order to prevent code from interacting with the transaction.
This can be used for example for making sure that no tests commit transactions when they are running on an integration testing layer.
The interceptor needs to be installed manually with install() and removed at the end with uninstall(). It is the users responsibility to ensure proper uninstallation.
When the interceptor is installed, it is not yet active and passes through all calls. The intercepting begins with intercept() and ends when clear() is called.
from ftw.testing import TransactionInterceptor interceptor = TransactionInterceptor().install() try: interceptor.intercept(interceptor.BEGIN | interceptor.COMMIT | interceptor.ABORT) # ... interceptor.clear() transaction.abort() finally: interceptor.uninstall()
plone.app.testing’s default testing layers (such as PLONE_FIXTURE) do not isolate the component registry for each test.
ftw.testing’s COMPONENT_REGISTRY_ISOLATION testing layer isolates the component registry for each test, provides a stacked ZCML configuration context and provides the methods load_zcml_string and load_zcml_file for loading ZCML.
# testing.py from ftw.testing.layer import COMPONENT_REGISTRY_ISOLATION from plone.app.testing import IntegrationTesting from plone.app.testing import PloneSandboxLayer from zope.configuration import xmlconfig class MyPackageLayer(PloneSandboxLayer): defaultBases = (COMPONENT_REGISTRY_ISOLATION,) def setUpZope(self, app, configurationContext): import my.package xmlconfig.file('configure.zcml', ftw.package, context=configurationContext) MY_PACKAGE_FIXTURE = MyPackageLayer() MY_PACKAGE_INTEGRATION = IntegrationTesting( bases=(MY_PACKAGE_FIXTURE, COMPONENT_REGISTRY_ISOLATION), name='my.package:integration') # ---------------------------- # test_*.py from unittest2 import TestCase class TestSomething(TestCase): layer = MY_PACKAGE_INTEGRATION def test(self): self.layer['load_zcml_string']('<configure>...</configure>')
The TEMP_DIRECTORY testing layer creates an empty temp directory for each test and removes it recursively on tear down.
The path to the directory can be accessed with the temp_directory key.
from unittest2 import TestCase from ftw.testing.layer import TEMP_DIRECTORY class TestSomething(TestCase): layer = TEMP_DIRECTORY def test(self): path = self.layer['temp_directory']
The console script layer helps testing console scripts. On layer setup it creates and executes an isolated buildout with the package under development, which creates all console scripts of this package. This makes it easy to test console scripts by really executing them.
# testing.py from ftw.testing.layer import ConsoleScriptLayer CONSOLE_SCRIPT_TESTING = ConsoleScriptLayer('my.package') # test_*.py from my.package.testing import CONSOLE_SCRIPT_TESTING from unittest2 import TestCase class TestConsoleScripts(TestCase): layer = CONSOLE_SCRIPT_TESTING def test_executing_command(self): exitcode, output = self.layer['execute_script']('my-command args') self.assertEqual('something\n', output)
Be aware that the dependency zc.recipe.egg is required for building the console scripts. You may put the dependency into your tests extras require.
- Fix in timezone aware freezing for Zope DateTime. [njohner]
- Fix invalid reST in README.rst [Nachtalb]
- Drop support for plone 4.2. [jone]
- Fix bug with getting a timezone aware “now”. [njohner]
- Extend staticuid to also be a context manager. [jone]
- Also freeze datetime.utcnow(). [Rotonen]
- Add FTWIntegrationTesting and FTWIntegrationTestCase. [jone]
- Support Plone 5.1 for ConsoleScriptLayer. [jone]
- Freezer: keep timezone info when moving clock forward / backward. [jone]
- Freezer: Fix DST-bug in today() and time(). [jone]
- Fix savepoint simulation to cleanup savepoints. [jone]
- Add savepoint simulation to transaction interceptor. [jone]
- Do not require “Plone” egg. [jone]
- Add transaction interceptor. [jone]
- Support Plone 5.1 [mathias.leimgruber, jone]
- Remove splinter browser. Use ftw.testbrowser instead. [mathias.leimgruber, jone]
- Drop Plone 4.1 support. [jone]
- Freezer: reimplement “now” patching with forbiddenfruit. This fixes problems with pickling and comparison of frozen datetime objects. [jone]
- Freezer: disable freezing while committing to database for preventing pickling errors. [jone]
- Freezer bugfix: replace datetime instances when leaving freeze context manager. [jone]
- Added timezone(tz) support for “freeze”. [phgross]
- Use “now” as default of “freeze”. [jone]
- Update the freezed time with forward and backward. [jone]
- Fix site hook within staticuid decorated methods. [jone]
- Add staticuid decorator for having static uids. [jone]
- Declare missing dependency to p.a.testing required by the COMPONENT_REGISTRY_ISOLATION layer. [jone]
- Implement console script testing layer. [jone]
- Implement TEMP_DIRECTORY testing layer. [jone]
- Implement COMPONENT_REGISTRY_ISOLATION layer. [jone]
- Add patcher for disabling quickinstaller snappshotting in tests. [jone]
- Generic Setup uninstall test: Add a second test that uses Portal Setup for uninstallation. This makes sure that Portal Setup uninstallation behaves the same as quickinstaller uninstallation. [deif]
- Generic Setup uninstall test: Remove is_product option, since we require an uninstall external method which requires the package to be a product anyway. [jone]
- Generic Setup uninstall test: test that there is an uninstall external method. Uninstall external methods are still necessary today for properly uninstalling a package. [jone]
- Generic Setup test: use quickinstaller for uninstalling. [jone]
- Also install profile dependencies before creating a snapshot. [deif]
- Implement Generic Setup uninstall base test. [jone]
- Fix isinstance calls of freezed time in freeze context manager. [jone]
- Implement freeze context manager for freezing the time. [jone]
- AT form page object: add schemata helper methods for testing visible schematas and fields. [jone]
- Add custom mailhost class, remembering the sender and recipient of each email separately. [deif]
- Page objects: add a Plone.visit(obj) function. [jone]
- Fix a rare bug where the MockMailHost message list has been replaced by another instance. [jone, deif]
- Move Mailing helper class to its own module mailing. [deif]
- Drop official Plone 4.0 support. [jone]
- Component registry layer: use isolated ZCML layers. When using the same layer instances it may conflict with integration or functional testing layers. [jone]
- Add splinter integration and Plone page objects. [jone]
- onegov.ch approved: add badge to readme. [jone]
- MockTestCase: Support Products.PloneHotfix20121106 patch when mocking getToolByName. [jone]
- MockTestCase: add checks that setUp is called correctly. [jone]
- Add stub_reponse method to MockTestCase and adjust the stub_request method accordant. [phgross]
- Made providing interfaces configurable for the stub_request method. [phgross]
- Let the stub_request method also stub the getStatus of the response. [phgross]
- Add stub_request method to MockTestCase. [jone]
- No longer tear down the component registry in mock test case. Use the ComponentRegistryLayer. [jone]
- Add ComponentRegistryLayer base class. [jone]
- Add mock_interface and stub_interface methods to MockTestCase, creating a mock and using the interface as spec. [jone]
- Accept also interfaces directly rather than lists of interfaces when creating mocks or stubs which provides the interfaces. [jone]
- Patch mock_tool: do not count, so that it can be used multiple times. [jone]
- Initial release