collective.testcaselayer 1.6.1

层

PloneTestCase 测试固定装置可以作为层设置和拆解。

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

为了测试仅此层的效应，单独设置基础层。由于 PloneTestCase 使用层的方式，我们首先必须调用 setupPloneSite() 函数。

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

PloneTestCase 测试固定装置尚未设置。

>>> 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)

设置 PloneTestCase 层。

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

PloneTestCase 测试固定装置已设置。

>>> 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)

拆解 PloneTestCase 层。

>>> runner.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.

PloneTestCase 测试固定装置不再设置。

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

层基类

PloneTestCase 类设施也可以在使用 PloneTestCase 层基类的层中使用。

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

此层依赖于在仅用于测试的层中设置的配置文件和产品。

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

FooLayer 测试固定装置尚未设置。

>>> 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)

设置 FooLayer。

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

FooLayer 测试固定装置已设置。

>>> 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)

拆解 FooLayer。

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

FooLayer 测试固定装置不再设置。

>>> 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)

完成拆解其余层的操作。

>>> runner.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.

层

collective.testcaselayer.ztc 模块提供沙盒层，用于设置 ZopeTestCase 的测试固定装置。请注意，基于测试用例的层仍然像测试用例一样操作，具有特殊的 no-op layerOnly() 测试方法，以便它们具有功能的 str() 和 repr() 值。

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

在我们将 ZopeTestCase 设置为层之前，没有设置任何内容。

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

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

>>> from Testing import ZopeTestCase
>>> app = ZopeTestCase.app()
>>> 'test_folder_1_' in app.objectIds()
False
>>> ZopeTestCase.close(app)

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

将 ZopeTestCase 设置为层。

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

ZopeTestCase 测试固定装置已设置，但没有登录用户。

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

>>> 'test_folder_1_' in  ztc.ztc_layer.app.objectIds()
True

还请注意，层的 app 属性代表对 ZODB 的开放连接。

>>> connections.count()
1

拆解 ZopeTestCase 层。

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

现在一切又回到了原来的状态。

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

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

>>> from Testing import ZopeTestCase
>>> app = ZopeTestCase.app()
>>> 'test_folder_1_' in app.objectIds()
False
>>> ZopeTestCase.close(app)

>>> connections.count()
0

层基类

collective.testcaselayer.ztc 模块还提供沙盒层的基类，这些层实际上不设置测试用例固定装置，但允许在层设置和拆解代码中使用测试用例提供的功能。

由于层可以嵌套，这些层基类不执行实际的ZopeTestCase测试环境设置，除非子类显式地将 _setup_fixture（或 PortalTestCase的_configure_portal）设置为True。最佳实践是使用ZTC测试环境设置实例化任何依赖的层，将ZTCLayer作为基层，如上所述。

创建一个继承适当基层的层类。这个层类覆盖了afterSetUp()方法，就像ZopeTestCase基于测试用例一样。这里的afterSetUp方法使用了ZopeTestCase提供的功能以及一个额外的loadZCML()方法，用于在ZCML调试模式下加载ZCML文件。

>>> from collective.testcaselayer import testing
>>> class FooLayer(ztc.BaseZTCLayer):
...     def afterSetUp(self):
...         self.login()
...         self.setRoles(['Manager'])
...         self.loadZCML('loadzcml.zcml', package=testing)
>>> foo_layer = FooLayer([ztc.ztc_layer])

为了仅测试这个层的效果，请单独设置基层。

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

在设置新层之前，仅设置ZopeTestCase测试环境。

>>> 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)

设置新层。

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

现在afterSetUp()所做的更改得到了反映。

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

仅拆除新层。

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

一切恢复到之前的状态。

>>> 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)

完成拆解其余层的操作。

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

层类

使用collective.testcaselayer.layer.Layer类创建自己的层类。

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

该类的实例将是实际的zope.testing层。

>>> foo_layer = FooLayer()

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

请注意，Layer类本身或其子类可以自身作为层使用而不会出错，但这不是它们被设计的方式。例如，将FooLayer类作为层使用将把Layer基类本身视为层，并设置它，这是没有意义的。此外，它将尝试以类方法调用setUp方法，这会引发错误。

>>> runner.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)

基本层

通过在实例化时传递它们，指定基层。

创建另一个层类。

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

创建使用foo_layer作为基层的新的层。

>>> bar_layer = BarLayer([foo_layer])

设置层。

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

分组层

如果层所需的一切仅仅是将其作为基层组合其他层，则可以直接使用collective.testcaselayer.layer.Layer类。

创建另一个层。

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

使用基层、一个模块和一个名称实例化Layer类。

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

设置层。

>>> runner.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.

默认情况下，层具有与它们的类相同的模块和名称。如果您希望层具有与类不同的模块或名称，则可以将它们都作为参数传递。这在当前情况下很有用，并且在需要使用同一层类的多个实例作为层时也很有用。

直接实例化Layer类而不传递名称会引发错误。

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

如果直接实例化Layer类而不传递模块，则使用调用帧的模块名称。

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

流式传输到响应的数据

由于 Testing.ZopeTestCase.zopedoctest.functional 中的一些行为，当数据直接流式传输到响应中（而不是从可调用的已发布内容返回数据）时，testbrowser.contents 为空。这使得对需要将数据流式传输到响应以进行性能测试的代码进行功能测试变得困难，例如当响应数据非常大，会消耗太多内存时。

流迭代器

还包括一个从 plone.app.blob 夺取的补丁，以便在测试环境中支持 HTTP 响应的流迭代器。这允许对使用流迭代器的代码进行功能测试。

HTTP_REFERRER

由于 问题 #98437，“TestBrowser Referer: header set to ‘localhost’”，一些 testbrowser 请求会引发 NotFound。两个例子是直接访问 Plone login_form 而不是通过链接访问，或者使用 Plone content_status_history 表单。

测试补丁

添加一个渲染 referer 的文档。

>>> folder.addDTMLDocument(
...     'index_html', file='''\
... <html><body>
... <dtml-var "REQUEST['HTTP_REFERER']">
... <form action="." method="post" id="post"></form>
... <form action="." method="get" id="get"></form>
... <a href=".">link</a>
... </html></body>
... ''')
''

打开一个浏览器。

>>> from Products.Five.testbrowser import Browser
>>> browser = Browser()
>>> browser.handleErrors = False

在修补之前，新鲜请求有一个无效的 referer。

>>> browser.open(folder.index_html.absolute_url())
>>> print browser.contents
<html><body>
localhost
<form action="." method="post" id="post"></form>
<form action="." method="get" id="get"></form>
<a href=".">link</a>
</html></body>

添加一个将内容流式传输到响应的脚本。

>>> from Products.PythonScripts import PythonScript
>>> PythonScript.manage_addPythonScript(folder, 'foo.txt')
''
>>> folder['foo.txt'].ZPythonScript_edit(params='', body='''\
... context.REQUEST.response.setHeader('Content-Type', 'text/plain')
... context.REQUEST.response.setHeader(
...     'Content-Disposition',
...     'attachment;filename=foo.txt')
... context.REQUEST.response.write('foo')''')

在修补之前，流式传输到响应的数据不在浏览器内容中。

>>> browser.open(folder['foo.txt'].absolute_url())
>>> browser.isHtml
False
>>> print browser.contents

添加一个返回流迭代器的脚本。

>>> from Products.PythonScripts import PythonScript
>>> PythonScript.manage_addPythonScript(folder, 'bar.txt')
''
>>> folder['bar.txt'].ZPythonScript_edit(params='', body='''\
... from collective.testcaselayer.testing.iterator import (
...     StreamIterator)
... context.REQUEST.response.setHeader('Content-Type', 'text/plain')
... context.REQUEST.response.setHeader(
...     'Content-Disposition',
...     'attachment;filename=bar.txt')
... return StreamIterator(['bar', 'qux'])''')

>>> from AccessControl import allow_module
>>> allow_module('collective.testcaselayer.testing.iterator')

流迭代器不受支持。

>>> browser.open(folder['bar.txt'].absolute_url())
>>> browser.isHtml
False
>>> print browser.contents
['bar', 'qux']

应用补丁。

>>> from Products.Five import zcml
>>> from Products.Five import fiveconfigure
>>> from collective import testcaselayer
>>> fiveconfigure.debug_mode = True
>>> zcml.load_config('testing.zcml', package=testcaselayer)
>>> fiveconfigure.debug_mode = False

新鲜请求应没有 referer。

>>> browser.open(folder.index_html.absolute_url())
>>> print browser.contents
<html><body>
<form action="." method="post" id="post"></form>
<form action="." method="get" id="get"></form>
<a href=".">link</a>
</html></body>

通过 post 提交表单应没有 referer。

>>> browser.getForm('post').submit()
>>> print browser.contents
<html><body>
<form action="." method="post" id="post"></form>
<form action="." method="get" id="get"></form>
<a href=".">link</a>
</html></body>

通过 get 提交表单应没有 referer。

>>> browser.getForm('get').submit()
>>> print browser.contents
<html><body>
<form action="." method="post" id="post"></form>
<form action="." method="get" id="get"></form>
<a href=".">link</a>
</html></body>

点击链接应设置 referer。

>>> browser.getLink('link').click()
>>> print browser.contents
<html><body>
http://nohost/test_folder_1_/...
<form action="." method="post" id="post"></form>
<form action="." method="get" id="get"></form>
<a href=".">link</a>
</html></body>

流式传输到响应的数据现在在浏览器内容中。

>>> browser.open(folder['foo.txt'].absolute_url())
>>> browser.isHtml
False
>>> print browser.contents
Status: 200 OK
X-Powered-By: Zope (www.zope.org), Python (www.python.org)
Content-Length: 0
Content-Type: text/plain
Content-Disposition: attachment;filename=foo.txt
foo

流迭代器现在在浏览器内容中。

>>> browser.open(folder['bar.txt'].absolute_url())
>>> browser.isHtml
False
>>> print browser.contents
barqux

1.6.1 (2015-08-14)

• 小清理：空格、git 忽略、setup.py。[gforcada, rnix, maurits]

1.6 (2012-10-17)

• 如果门户没有 portal_kss 工具，不要中断。[davisagli]

1.5 - 2012-05-18

• Plone 4.1 兼容性。[rossp]

• 让层拆除进行清理。允许在关闭数据库连接或其他清理操作之前进行 post_mortem 调试以查看 TB 中的状态。[rossp]

1.4 - 2011-07-15

• 将模拟邮件主机移动到实际的 GS 配置文件中，这样它就不会在依赖层运行自己的配置文件时被替换。这也使得模拟邮件主机在测试之外可用。[rossp]

• 添加一些设置测试浏览器 AT 日历小部件的实用方法，以避免 end/beginning-of-month 间歇性失败。[rossp]

• 避免 PloneTestCase 和 zope.testing/testrunner 之间的版本冲突。[rossp]

1.3 - 2010-02-09

• 添加一个 loadZCML 便捷方法 [rossp]

• 添加一个包含一些有用测试设置的通用层 [rossp]

• 添加一个模拟邮件主机层 [rossp]

1.2.2 - 2009-11-14

• 为流迭代器响应添加功能测试支持。借鉴自witsch的plone.app.blob测试补丁。[rossp]

• 与Zope 2.10-2.12兼容。[rossp, witsch]

• 修复了Zope 2.12/Plone 4的沙箱替换。[witsch]

1.2.1 - 2009-10-11

• 将ZTC功能doctest猴子补丁移至testing.zcml，以免在自动包含时被选中。optilude报告说这会破坏调试模式。

1.2 - 2009-08-21

• 添加补丁，以便将数据流式传输到响应中，在testbrowser.contents中可用。[rossp]

• 添加修复HTTP_REFERER测试浏览器错误的补丁。[rossp] https://bugs.launchpad.net/bugs/98437

1.1 - 2009-07-29

• 修复发布。由于setuptools与SVN 1.6的交互，文件丢失。

1.0 - 2009-07-29

• 针对Plone 3.3rc4进行测试

• 添加基本Plone测试用例层的示例代码

• 弃用zope.testing<3.6支持

• collective.testcaselayer.ptc模块需要调用ptc.setupPloneSite()以确保Plone站点存在

0.2 - 2008-01-08

• 在PortalTestCase子层中使self.folder属性可用

• 使测试与zope.testing.testrunner重构兼容

0.1 - 2008-05-23

• 初始发布