-
Notifications
You must be signed in to change notification settings - Fork 4
/
functional.py
863 lines (698 loc) · 30.7 KB
/
functional.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Functional testing framework for Zope 3.
There should be a file 'ftesting.zcml' in the current directory.
"""
from __future__ import print_function
import copy
import doctest
import logging
import os.path
import re
import io
import sys
import traceback
import unittest
from six.moves.http_cookies import SimpleCookie
from transaction import abort, commit
from ZODB.DB import DB
from ZODB.DemoStorage import DemoStorage
from ZODB.interfaces import IDatabase
from zope import component
from zope.publisher.interfaces import ISkinnable
from zope.publisher.browser import BrowserRequest
from zope.publisher.http import HTTPRequest
from zope.publisher.publish import publish
from zope.publisher.skinnable import setDefaultSkin
from zope.security.interfaces import Forbidden, Unauthorized
import zope.app.appsetup.product
import zope.app.testing.setup
from zope.app.testing._compat import NativeStringIO
from zope.app.testing._compat import headers_factory
from zope.app.appsetup.appsetup import multi_database
from zope.app.debug import Debugger
from zope.app.publication.http import HTTPPublication
from zope.app.publication.zopepublication import ZopePublication
from zope.app.publication.httpfactory import chooseClasses
from zope.component.hooks import setSite, getSite
class ResponseWrapper(object):
"""A wrapper that adds several introspective methods to a response."""
def __init__(self, response, path, request, omit=()):
self._response = response
self._path = path
self._request = request
self.omit = omit
self._body = None
def getOutput(self):
"""Returns the full HTTP output (headers + body)"""
body = self.getBody()
omit = self.omit
headers = [x
for x in self._response.getHeaders()
if x[0].lower() not in omit]
headers.sort()
headers = '\n'.join([("%s: %s" % (n, v)) for (n, v) in headers])
statusline = '%s %s' % (self._response._request['SERVER_PROTOCOL'],
self._response.getStatusString())
if body:
return '%s\n%s\n\n%s' % (statusline, headers, body)
else:
return '%s\n%s\n' % (statusline, headers)
def getBody(self):
"""Returns the response body"""
if self._body is None:
try:
b = self._response.consumeBody()
except TypeError:
from zope.publisher.http import DirectResult
from zope.publisher.xmlrpc import XMLRPCResponse
if (isinstance(self._response, XMLRPCResponse)
and isinstance(getattr(self._response, '_result', None), DirectResult)):
# Somewhere in the publisher we're getting a DirectResult
# whose '_result' body is a sequence of strings, but we're expecting
# bytes
b = ''.join(self._response._result.body)
else:
raise
if isinstance(b, bytes) and bytes is not str:
b = b.decode("utf-8")
self._body = ''.join(b)
return self._body
def getPath(self):
"""Returns the path of the request"""
return self._path
def __getattr__(self, attr):
return getattr(self._response, attr)
__str__ = getOutput
class IManagerSetup(zope.interface.Interface):
"""Utility for enabling up a functional testing manager with needed grants
TODO This is an interim solution. It tries to break the dependence
on a particular security policy, however, we need a much better
way of managing functional-testing configurations.
"""
def setUpManager():
"""Set up the manager, zope.mgr
"""
class BaseDatabaseFactory(object):
"""Factory object for passing to appsetup.multi_databases
This class is an internal implementation detail, subject to change
without notice!
It is currently used by FunctionalTestSetUp.__init__ to create the
basic storage(s) containing the data that is common to all tests
in a layer.
The constructor takes the name of the new database, and a
dictionary of storages. The 'open' method creates a new
DemoStorage, and adds it to the storage dictionary under the given
name. Then creates and returns a named DB object using the
storage.
"""
def __init__(self, name, base_storages):
self.name = name
self.base_storages = base_storages
def open(self):
name = self.name
if name in self.base_storages:
raise ValueError("Duplicate database name: %r" % name)
storage = DemoStorage("Memory storage %r" % name)
self.base_storages[name] = storage
return DB(storage, database_name=name)
class DerivedDatabaseFactory(object):
"""Factory object for passing to appsetup.multi_databases
This class is an internal implementation detail, subject to change
without notice!
It is currently used by FunctionalTestSetUp.setUp to create the
derived storage(s) used for each test in a layer.
The constructor takes the name of the new database, and a
dictionary of storages. The 'open' method creates a new
DemoStorage as a wrapper around the storage with the given
name. Then creates and returns a named DB object using the
storage.
"""
def __init__(self, name, base_storages):
self.name = name
self.storage = DemoStorage("Demo storage %r" % name,
base_storages[name])
def open(self):
return DB(self.storage, database_name=self.name)
class FunctionalTestSetup(object):
"""Keeps shared state across several functional test cases."""
__shared_state = {'_init': False}
def __init__(self, config_file=None, database_names=None,
product_config=None):
"""Initializes Zope 3 framework.
Creates a volatile memory storage. Parses Zope3 configuration files.
"""
self.__dict__ = self.__shared_state
if database_names is not None:
database_names = tuple(database_names)
if not self._init:
# Make sure unit tests are cleaned up
zope.app.testing.setup.placefulSetUp()
zope.app.testing.setup.placefulTearDown()
if not config_file:
config_file = 'ftesting.zcml'
if database_names is None:
database_names = ('unnamed',)
self.log = NativeStringIO()
# Make it silent but keep the log available for debugging
logging.root.addHandler(logging.StreamHandler(self.log))
self.old_product_config = copy.deepcopy(
zope.app.appsetup.product.saveConfiguration())
configs = []
if product_config:
configs = zope.app.appsetup.product.loadConfiguration(
NativeStringIO(product_config))
configs = [
zope.app.appsetup.product.FauxConfiguration(name, values)
for name, values in configs.items()]
self.local_product_config = configs
zope.app.appsetup.product.setProductConfigurations(configs)
self._base_storages = {}
self.db = multi_database(
BaseDatabaseFactory(name, self._base_storages)
for name in database_names)[0][0]
# This handles anything added by generations or other bootstrap
# subscribers.
commit()
self.dbstack = []
self.app = Debugger(self.db, config_file)
self.connection = None
self._config_file = config_file
self._product_config = product_config
self._database_names = database_names
self._init = True
# Make a local grant for the test user
setup = component.queryUtility(IManagerSetup)
if setup is not None:
setup.setUpManager()
FunctionalTestSetup().connection = None
elif config_file and config_file != self._config_file:
# Running different tests with different configurations is not
# supported at the moment
raise NotImplementedError('Already configured'
' with a different config file')
elif product_config and product_config != self._product_config:
raise NotImplementedError('Already configured'
' with different product configuration')
elif database_names and database_names != self._database_names:
# Running different tests with different configurations is not
# supported at the moment
raise NotImplementedError('Already configured'
' with different database names')
# BBB: Simulate the old base_storage attribute, but only when not using
# multiple databases. There *is* code in the wild that uses the attribute.
def _get_base_storage(self):
if len(self._database_names) != 1:
raise AttributeError('base_storage')
return self._base_storages[self._database_names[0]]
def _set_base_storage(self, value):
if len(self._database_names) != 1:
raise AttributeError('base_storage')
self._base_storages[self._database_names[0]] = value
base_storage = property(_get_base_storage, _set_base_storage)
def _close_databases(self):
# This is really careful to unregister the databases before attempting
# to close anything. Zope Corporation has a couple of large
# multi-database applications that get bitten if we're not careful
# like this, but we've not been able to write a concise test case yet.
base = component.getGlobalSiteManager()
dbs = []
for name, db in list(component.getUtilitiesFor(IDatabase)):
ok = base.unregisterUtility(db, IDatabase, name)
assert ok
dbs.append(db)
abort()
if self.connection:
self.connection.close()
self.connection = None
for db in dbs:
db.close()
def setUp(self):
"""Prepares for a functional test case."""
# Tear down the old demo storages (if any) and create fresh ones
abort()
self.dbstack.append((self.db, self.connection))
self.connection = None
zope.app.appsetup.product.setProductConfigurations(
self.local_product_config)
self.db = self.app.db = multi_database(
DerivedDatabaseFactory(name, self._base_storages)
for name in self._database_names)[0][0]
def tearDown(self):
"""Cleans up after a functional test case."""
self._close_databases()
self.db, self.connection = self.dbstack.pop()
setSite(None)
def tearDownCompletely(self):
"""Cleans up the setup done by the constructor."""
self._close_databases()
assert self.dbstack == []
zope.app.testing.setup.placefulTearDown()
zope.app.appsetup.product.restoreConfiguration(
self.old_product_config)
self._config_file = False
self._product_config = None
self._database_names = None
self._init = False
def getRootFolder(self):
"""Returns the Zope root folder."""
if not self.connection:
self.connection = self.db.open()
root = self.connection.root()
return root[ZopePublication.root_name]
def getApplication(self):
"""Returns the Zope application instance."""
return self.app
class ZCMLLayer:
"""ZCML-defined test layer
"""
__bases__ = ()
def __init__(self, config_file, module, name, allow_teardown=False,
product_config=None):
self.config_file = config_file
self.__module__ = module
self.__name__ = name
self.allow_teardown = allow_teardown
self.product_config = product_config
def setUp(self):
self.setup = FunctionalTestSetup(
self.config_file, product_config=self.product_config)
def tearDown(self):
self.setup.tearDownCompletely()
if not self.allow_teardown:
# Some ZCML directives change globals but are not accompanied
# with registered CleanUp handlers to undo the changes. Let
# packages which use such directives indicate that they do not
# support tearing down.
raise NotImplementedError
def defineLayer(name, zcml='test.zcml', allow_teardown=False):
"""Helper function for defining layers.
Usage: defineLayer('foo')
"""
globals = sys._getframe(1).f_globals
globals[name] = ZCMLLayer(
os.path.join(os.path.dirname(globals['__file__']), zcml),
globals['__name__'],
name,
allow_teardown=allow_teardown,
)
if os.path.exists(os.path.join('zopeskel', 'etc', 'ftesting.zcml')):
Functional = os.path.join('zopeskel', 'etc', 'ftesting.zcml')
FunctionalNoDevMode = os.path.join('zopeskel', 'etc', 'ftesting-base.zcml')
elif os.path.exists(os.path.join('etc', 'ftesting.zcml')):
Functional = os.path.join('etc', 'ftesting.zcml')
FunctionalNoDevMode = os.path.join('etc', 'ftesting-base.zcml')
else:
# let's hope that the file is in our CWD. If not, we'll get an
# error anyways, but we can't just throw an error if we don't find
# that file. This module might be imported for other things as
# well, not only starting up Zope from ftesting.zcml.
Functional = 'ftesting.zcml'
FunctionalNoDevMode = 'ftesting-base.zcml'
Functional = os.path.abspath(Functional)
FunctionalNoDevMode = os.path.abspath(FunctionalNoDevMode)
Functional = ZCMLLayer(Functional, __name__, 'Functional')
FunctionalNoDevMode = ZCMLLayer(FunctionalNoDevMode, __name__,
'FunctionalNoDevMode')
class FunctionalTestCase(unittest.TestCase):
"""Functional test case."""
layer = Functional
def setUp(self):
"""Prepares for a functional test case."""
super(FunctionalTestCase, self).setUp()
FunctionalTestSetup().setUp()
def tearDown(self):
"""Cleans up after a functional test case."""
FunctionalTestSetup().tearDown()
super(FunctionalTestCase, self).tearDown()
def getRootFolder(self):
"""Returns the Zope root folder."""
return FunctionalTestSetup().getRootFolder()
def commit(self):
commit()
def abort(self):
abort()
class CookieHandler(object):
def __init__(self, *args, **kw):
# Somewhere to store cookies between consecutive requests
self.cookies = SimpleCookie()
super(CookieHandler, self).__init__(*args, **kw)
def httpCookie(self, path):
"""Return self.cookies as an HTTP_COOKIE environment value."""
l = [m.OutputString().split(';')[0] for m in self.cookies.values()
if path.startswith(m['path'])]
return '; '.join(l)
def loadCookies(self, envstring):
self.cookies.load(envstring)
def saveCookies(self, response):
"""Save cookies from the response."""
# Urgh - need to play with the response's privates to extract
# cookies that have been set
# TODO: extend the IHTTPRequest interface to allow access to all
# cookies
# TODO: handle cookie expirations
for k, v in response._cookies.items():
k = k.encode('utf8') if bytes is str else k
val = v['value']
val = val.encode('utf8') if bytes is str else val
self.cookies[k] = val
if 'path' in v:
self.cookies[k]['path'] = v['path']
class BrowserTestCase(CookieHandler, FunctionalTestCase):
"""Functional test case for Browser requests."""
def setSite(self, site):
"""Set the site which will be used to look up local components"""
setSite(site)
def getSite(self):
"""Returns the site which is used to look up local components"""
return getSite()
def makeRequest(self, path='', basic=None, form=None, env={}):
"""Creates a new request object.
Arguments:
path -- the path to be traversed (e.g. "/folder1/index.html")
basic -- basic HTTP authentication credentials ("user:password")
form -- a dictionary emulating a form submission
(Note that field values should be Unicode strings)
env -- a dictionary of additional environment variables
(You can emulate HTTP request header
X-Header: foo
by adding 'HTTP_X_HEADER': 'foo' to env)
"""
environment = {"HTTP_HOST": 'localhost',
"HTTP_COOKIE": self.httpCookie(path)}
environment.update(env)
app = FunctionalTestSetup().getApplication()
request = app._request(path, '',
environment=environment,
basic=basic, form=form,
request=BrowserRequest)
setDefaultSkin(request)
return request
def publish(self, path, basic=None, form=None, env={},
handle_errors=False):
"""Renders an object at a given location.
Arguments are the same as in makeRequest with the following exception:
handle_errors -- if False (default), exceptions will not be caught
if True, exceptions will return a formatted error
page.
Returns the response object enhanced with the following methods:
getOutput() -- returns the full HTTP output as a string
getBody() -- returns the full response body as a string
getPath() -- returns the path used in the request
"""
old_site = self.getSite()
self.setSite(None)
# A cookie header has been sent - ensure that future requests
# in this test also send the cookie, as this is what browsers do.
# We pull it apart and reassemble the header to block cookies
# with invalid paths going through, which may or may not be correct
if 'HTTP_COOKIE' in env:
self.loadCookies(env['HTTP_COOKIE'])
del env['HTTP_COOKIE'] # Added again in makeRequest
request = self.makeRequest(path, basic=basic, form=form, env=env)
if 'HTTP_COOKIE' in env:
self.loadCookies(env['HTTP_COOKIE'])
request = publish(request, handle_errors=handle_errors)
response = ResponseWrapper(request.response, path, request)
self.saveCookies(response)
self.setSite(old_site)
return response
def checkForBrokenLinks(self, body, path, basic=None):
"""Looks for broken links in a page by trying to traverse relative
URIs.
"""
if not body:
return
old_site = self.getSite()
self.setSite(None)
try:
from html.parser import HTMLParser
NullFormatter = None
except ImportError:
from htmllib import HTMLParser
from formatter import NullFormatter
class SimpleHTMLParser(HTMLParser):
def __init__(self, base):
if NullFormatter:
HTMLParser.__init__(self, NullFormatter())
else:
super(SimpleHTMLParser, self).__init__()
self.base = base
self.anchorlist = []
def do_base(self, attrs):
self.base = dict(attrs).get('href', self.base)
if sys.version_info[0] >= 3:
# Version 3 stopped automatically building the anchorlist
def handle_starttag(self, tag, attrs):
if tag == 'a':
attrs = dict(attrs)
if 'href' in attrs:
self.anchorlist.append(attrs['href'])
parser = SimpleHTMLParser(path)
if bytes is not str and not isinstance(body, str):
body = body.decode("utf-8")
parser.feed(body)
parser.close()
base = parser.base
while not base.endswith('/'):
base = base[:-1]
if base.startswith('http://localhost/'):
base = base[len('http://localhost/') - 1:]
errors = []
for a in parser.anchorlist:
if a.startswith('http://localhost/'):
a = a[len('http://localhost/') - 1:]
elif a.find(':') != -1:
# Assume it is an external link
continue
elif not a.startswith('/'):
a = base + a
if a.find('#') != -1:
a = a[:a.index('#')]
# ??? what about queries (/path/to/foo?bar=baz&etc)?
request = None
try:
try:
request = self.makeRequest(a, basic=basic)
publication = request.publication
request.processInputs()
publication.beforeTraversal(request)
object = publication.getApplication(request)
object = request.traverse(object)
publication.afterTraversal(request, object)
except (KeyError, NameError, AttributeError, Unauthorized,
Forbidden):
e = traceback.format_exception_only(
*sys.exc_info()[:2])[-1]
errors.append((a, e.strip()))
finally:
publication.endRequest(request, object)
self.setSite(old_site)
# Make sure we don't have pending changes
abort()
# The request should always be closed to free resources
# held by the request
if request:
request.close()
if errors:
self.fail("%s contains broken links:\n" % path
+ "\n".join([" %s:\t%s" % (a, e) for a, e in errors]))
class HTTPTestCase(FunctionalTestCase):
"""Functional test case for HTTP requests."""
def makeRequest(self, path='', basic=None, form=None, env={},
instream=None):
"""Creates a new request object.
Arguments:
path -- the path to be traversed (e.g. "/folder1/index.html")
basic -- basic HTTP authentication credentials ("user:password")
form -- a dictionary emulating a form submission
(Note that field values should be Unicode strings)
env -- a dictionary of additional environment variables
(You can emulate HTTP request header
X-Header: foo
by adding 'HTTP_X_HEADER': 'foo' to env)
instream -- a stream from where the HTTP request will be read
"""
if instream is None:
instream = ''
environment = {"HTTP_HOST": 'localhost'}
environment.update(env)
app = FunctionalTestSetup().getApplication()
request = app._request(path, instream,
environment=environment,
basic=basic,
form=form,
request=HTTPRequest,
publication=HTTPPublication)
return request
def publish(self, path, basic=None, form=None, env={},
handle_errors=False, request_body=''):
"""Renders an object at a given location.
Arguments are the same as in makeRequest with the following exception:
handle_errors -- if False (default), exceptions will not be caught
if True, exceptions will return a formatted error
page.
Returns the response object enhanced with the following methods:
getOutput() -- returns the full HTTP output as a string
getBody() -- returns the full response body as a string
getPath() -- returns the path used in the request
"""
request = self.makeRequest(path, basic=basic, form=form, env=env,
instream=request_body)
response = ResponseWrapper(request.response, path, request)
publish(request, handle_errors=handle_errors)
return response
headerre = re.compile(r'(\S+): (.+)$')
basicre = re.compile('Basic (.+)?:(.+)?$')
def split_header(header):
return headerre.match(header).group(1, 2)
def auth_header(header):
match = basicre.match(header)
if match:
import base64
u, p = match.group(1, 2)
if u is None:
u = ''
if p is None:
p = ''
user_pass = '%s:%s' % (u, p)
encoder = getattr(base64, 'encodebytes', base64.encodestring)
auth = encoder(user_pass.encode("latin-1"))
auth = auth.decode('ascii')
return 'Basic %s' % auth[:-1]
return header
def getRootFolder():
return FunctionalTestSetup().getRootFolder()
def sync():
getRootFolder()._p_jar.sync()
# Sample functional test case
class SampleFunctionalTest(BrowserTestCase):
def testRootPage(self):
response = self.publish('/')
self.assertEqual(response.getStatus(), 200)
def testRootPage_preferred_languages(self):
response = self.publish('/', env={'HTTP_ACCEPT_LANGUAGE': 'en'})
self.assertEqual(response.getStatus(), 200)
def testNotExisting(self):
response = self.publish('/nosuchthing', handle_errors=True)
self.assertEqual(response.getStatus(), 404)
def testLinks(self):
response = self.publish('/')
self.assertEqual(response.getStatus(), 200)
self.checkForBrokenLinks(response.consumeBody(), response.getPath())
def sample_test_suite():
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(SampleFunctionalTest))
return suite
class HTTPCaller(CookieHandler):
"""Execute an HTTP request string via the publisher"""
def __call__(self, request_string, handle_errors=True, form=None):
# Commit work done by previous python code.
commit()
# Discard leading white space to make call layout simpler
request_string = request_string.lstrip()
# split off and parse the command line
l = request_string.find('\n')
command_line = request_string[:l].rstrip()
request_string = request_string[l + 1:]
method, path, protocol = command_line.split()
# If we don't feed bytes to Python 3, it gets stuck in a loop
# and ultimately raises HTTPException: got more than 100 headers.
instream = io.BytesIO(request_string.encode("latin-1")
if not isinstance(request_string, bytes)
else request_string)
environment = {
"HTTP_COOKIE": self.httpCookie(path),
"HTTP_HOST": 'localhost',
"REQUEST_METHOD": method,
"SERVER_PROTOCOL": protocol,
"REMOTE_ADDR": '127.0.0.1',
}
headers = [split_header(header)
for header in headers_factory(instream).headers]
for name, value in headers:
name = ('_'.join(name.upper().split('-')))
if name not in ('CONTENT_TYPE', 'CONTENT_LENGTH'):
name = 'HTTP_' + name
environment[name] = value.rstrip()
auth_key = 'HTTP_AUTHORIZATION'
if auth_key in environment:
environment[auth_key] = auth_header(environment[auth_key])
old_site = getSite()
setSite(None)
request_cls, publication_cls = self.chooseRequestClass(method, path,
environment)
app = FunctionalTestSetup().getApplication()
request = app._request(
path, instream,
environment=environment,
request=request_cls, publication=publication_cls)
if ISkinnable.providedBy(request):
# only ISkinnable requests have skins
setDefaultSkin(request)
if form is not None:
if request.form:
raise ValueError("only one set of form values can be provided")
request.form = form
request = publish(request, handle_errors=handle_errors)
response = ResponseWrapper(
request.response, path, request,
omit=('x-content-type-warning', 'x-powered-by'),
)
self.saveCookies(response)
setSite(old_site)
# sync Python connection:
getRootFolder()._p_jar.sync()
return response
def chooseRequestClass(self, method, path, environment):
"""Choose and return a request class and a publication class"""
# note that `path` is unused by the default implementation (BBB)
return chooseClasses(method, environment)
def FunctionalDocFileSuite(*paths, **kw):
"""Build a functional test suite from a text file."""
kw['package'] = doctest._normalize_module(kw.get('package'))
_prepare_doctest_keywords(kw)
suite = doctest.DocFileSuite(*paths, **kw)
suite.layer = Functional
return suite
def FunctionalDocTestSuite(*paths, **kw):
"""Build a functional test suite from docstrings in a module."""
_prepare_doctest_keywords(kw)
suite = doctest.DocTestSuite(*paths, **kw)
suite.layer = Functional
return suite
def _prepare_doctest_keywords(kw):
globs = kw.setdefault('globs', {})
globs['getRootFolder'] = getRootFolder
globs['sync'] = sync
kwsetUp = kw.get('setUp')
def setUp(test):
test.globs['http'] = HTTPCaller()
FunctionalTestSetup().setUp()
if kwsetUp is not None:
kwsetUp(test)
kw['setUp'] = setUp
kwtearDown = kw.get('tearDown')
def tearDown(test):
if kwtearDown is not None:
kwtearDown(test)
FunctionalTestSetup().tearDown()
kw['tearDown'] = tearDown
if 'optionflags' not in kw:
old = doctest.set_unittest_reportflags(0)
doctest.set_unittest_reportflags(old)
kw['optionflags'] = (old
| doctest.ELLIPSIS
| doctest.REPORT_NDIFF
| doctest.NORMALIZE_WHITESPACE)