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
|
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2018 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.
#
##############################################################################
"""
Tests for the documentation.
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import doctest
import os.path
import re
import unittest
import manuel.capture
import manuel.codeblock
import manuel.doctest
import manuel.ignore
import manuel.testing
from zope.testing import renormalizing
checker = renormalizing.RENormalizing([
# Python 3 unicode removed the "u".
(re.compile("u('.*?')"), r"\1"),
(re.compile('u(".*?")'), r"\1"),
# Python 3 bytes added the "b".
(re.compile("b('.*?')"), r"\1"),
(re.compile('b(".*?")'), r"\1"),
])
optionflags = (
doctest.NORMALIZE_WHITESPACE
| doctest.ELLIPSIS
| doctest.IGNORE_EXCEPTION_DETAIL
)
def test_suite():
# zope.testrunner
suite = unittest.TestSuite()
here = os.path.dirname(os.path.abspath(__file__))
while not os.path.exists(os.path.join(here, 'setup.py')):
prev, here = here, os.path.dirname(here)
if here == prev:
# Let's avoid infinite loops at root
class SkippedDocTests(unittest.TestCase): # pragma: no cover
@unittest.skip('Could not find setup.py')
def test_docs(self):
pass
suite.addTest(
unittest.makeSuite(SkippedDocTests)) # pragma: no cover
return suite # pragma: no cover
docs = os.path.join(here, 'docs')
api_docs = os.path.join(docs, 'api')
doc_files_to_test = (
'narr.rst',
)
api_files_to_test = (
'config.rst',
'docutils.rst',
'fields.rst',
'xmlconfig.rst',
)
# Plain doctest suites
api_to_test = (
'config',
'docutils',
'fields',
'interfaces',
'name',
'xmlconfig',
'zopeconfigure',
)
paths = [os.path.join(docs, f) for f in doc_files_to_test]
paths += [os.path.join(api_docs, f) for f in api_files_to_test]
m = manuel.ignore.Manuel()
m += manuel.doctest.Manuel(checker=checker, optionflags=optionflags)
m += manuel.codeblock.Manuel()
m += manuel.capture.Manuel()
suite.addTest(
manuel.testing.TestSuite(
m,
*paths
)
)
for mod_name in api_to_test:
mod_name = 'zope.configuration.' + mod_name
suite.addTest(
doctest.DocTestSuite(
mod_name,
checker=checker,
optionflags=optionflags
)
)
return suite
def load_tests(loader, standard_tests, pattern):
# Pure unittest protocol.
return test_suite()
|
