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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# This is a wrapper script to run tests using the unittest
# framework. It setups the environment properly and defines some
# commandline options for running tests.
#
# Copyright 2008 Jaap Karssenberg <jaap.karssenberg@gmail.com>
import os
import sys
import shutil
import getopt
import logging
import tests
from tests import unittest
def main(argv=None):
'''Run either all tests, or those specified in argv'''
if argv is None:
argv = sys.argv
# parse options
coverage = None
failfast = False
loglevel = logging.WARNING
opts, args = getopt.gnu_getopt(argv[1:],
'hVD', ['help', 'coverage', 'fast', 'failfast', 'debug', 'verbose'])
for o, a in opts:
if o in ('-h', '--help'):
print '''\
usage: %s [OPTIONS] [MODULES]
Where MODULE should a module name from ./tests/
If no module is given the whole test suite is run.
Options:
-h, --help print this text
--fast skip a number of slower tests (assumes --failfast)
--failfast stop after the first test that fails
--coverage report test coverage statistics
-V, --verbose run with verbose output from logging
-D, --debug run with debug output from logging
''' % argv[0]
return
elif o == '--coverage':
try:
import coverage as coverage_module
except ImportError:
print >>sys.stderr, '''\
Can not run test coverage without module 'coverage'.
On Ubuntu or Debian install package 'python-coverage'.
'''
sys.exit(1)
#~ coverage = coverage_module.coverage(data_suffix=True, auto_data=True)
coverage = coverage_module.coverage(data_suffix=True)
coverage.erase() # clean up old date set
coverage.exclude('assert ')
coverage.exclude('raise NotImplementedError')
coverage.start()
elif o == '--fast':
failfast = True
tests.FAST_TEST = True
# set before any test classes are loaded !
elif o == '--failfast':
failfast = True
elif o in ('-V', '--verbose'):
loglevel = logging.INFO
elif o in ('-D', '--debug'):
loglevel = logging.DEBUG
else:
assert False
# Set logging handler
logging.basicConfig(level=loglevel, format='%(levelname)s: %(message)s')
# Build the test suite
loader = unittest.TestLoader()
if args:
suite = unittest.TestSuite()
for module in [ 'tests.'+name for name in args ]:
test = loader.loadTestsFromName(module)
suite.addTest(test)
else:
suite = tests.load_tests(loader, None, None)
# And run it
unittest.installHandler() # Fancy handling for ^C during test
unittest.TextTestRunner(verbosity=2, failfast=failfast).run(suite)
# Check the modules were loaded from the right location
# (so no testing based on modules from a previous installed version...)
mylib = os.path.abspath('./zim')
for module in [m for m in sys.modules.keys()
if m == 'zim' or m.startswith('zim.')]:
if sys.modules[module] is None:
continue
file = sys.modules[module].__file__
assert file.startswith(mylib), \
'Module %s was loaded from %s' % (module, file)
# Create coverage output if asked to do so
if coverage:
coverage.stop()
#~ coverage.combine()
print '\nWriting coverage reports...'
pyfiles = list(tests.zim_pyfiles())
#~ coverage.report(pyfiles, show_missing=False)
#~ coverage.html_report(pyfiles, directory='./coverage')
html_coverage_report(coverage, pyfiles, './coverage')
print 'Done - Coverage reports can be found in ./coverage/'
def html_coverage_report(coverage, pyfiles, directory):
'''Our own wrapper to get coverage data in html - standard wrapper
from coverage.html_report fails for our code :(
'''
# Detailed report in html
if os.path.exists(directory):
shutil.rmtree(directory) # cleanup
os.mkdir(directory)
index = []
for path in pyfiles:
if any(n in path for n in ('inc', '_version', '__main__')):
continue
htmlfile = path[:-3].replace('/', '.')+'.html'
html = open(directory + '/' + htmlfile, 'w')
html.write('''\
<html>
<head>
<title>Coverage report for %s</title>
<style>
.code { white-space: pre; font-family: monospace }
.executed { background-color: #9f9 }
.excluded { background-color: #ccc }
.missing { background-color: #f99 }
.comment { }
</style>
</head>
<body>
<h1>Coverage report for %s</h1>
<table width="100%%">
<tr><td class="executed"> </td><td>Executed statement</td></tr>
<tr><td class="missing"> </td><td>Untested statement</td></tr>
<tr><td class="excluded"> </td><td>Ignored statement</td></tr>
<tr><td> </td><td> </td></tr>
''' % (path, path))
p, statements, excluded, missing, l = coverage.analysis2(path)
nstat = len(statements)
nexec = nstat - len(missing)
index.append((path, htmlfile, nstat, nexec))
file = open(path)
i = 0
for line in file:
i += 1
line = line.replace('<', '<')
line = line.replace('>', '>')
if i in missing: type = 'missing'
elif i in excluded: type = 'excluded'
elif i in statements: type = 'executed'
else: type = 'comment'
html.write('<tr><td class="%s">%i</td><td class="code">%s</td></tr>\n'
% (type, i, line.rstrip()) )
html.write('''\
</table>
</body>
</html>
''')
html.close()
# Index for detailed reports
html = open(directory + '/index.html', 'w')
html.write('''\
<html>
<head>
<title>Test Coverage Index</title>
<style>
.good { background-color: #9f9; text-align: right }
.close { background-color: #cf9; text-align: right }
.ontrack { background-color: #ff9; text-align: right }
.lacking { background-color: #fc9; text-align: right }
.bad { background-color: #f99; text-align: right }
.int { text-align: right }
</style>
</head>
<body>
<h1>Test Coverage Index</h1>
<table>
<tr><td><b>File</b></td><td><b>Stmts</b></td><td><b>Exec</b></td><td><b>Cover</b></td></tr>
''')
total_stat = reduce(int.__add__, [r[2] for r in index])
total_exec = reduce(int.__add__, [r[3] for r in index])
total_perc = int( float(total_exec) / total_stat * 100 )
if total_perc >= 90: type = 'good'
elif total_perc >= 80: type = 'close'
elif total_perc >= 60: type = 'ontrack'
elif total_perc >= 40: type = 'lacking'
else: type = 'bad'
html.write('<tr><td><b>Total</b></td>'
'<td class="int">%i</td><td class="int">%i</td>'
'<td class="%s">%.0f%%</td></tr>\n'
% (total_stat, total_exec, type, total_perc) )
for report in index:
pyfile, htmlfile, statements, executed = report
if statements: percentage = int( float(executed) / statements * 100 )
else: percentage = 100
if percentage >= 90: type = 'good'
elif percentage >= 80: type = 'close'
elif percentage >= 60: type = 'ontrack'
elif percentage >= 40: type = 'lacking'
else: type = 'bad'
html.write('<tr><td><a href="%s">%s</a></td>'
'<td class="int">%i</td><td class="int">%i</td>'
'<td class="%s">%.0f%%</td></tr>\n'
% (htmlfile, pyfile, statements, executed, type, percentage) )
html.write('''\
</table>
</body>
</html>
''')
html.close()
if __name__ == '__main__':
main()
|