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
|
import os
import sys
import re
import traceback
import mimetypes
import difflib
import shutil
from . import util
class TestFailureException(Exception):
def __init__(self, message, *args):
self.message = message
self.files = []
for a in args:
self.files.append(str(a))
def __str__(self):
return self.message
def __repr__(self):
return "<TestFailureException '{}' with files: {}>".format(self.message, repr(self.files))
class TestLogger:
def __init__(self):
self.indentation = 0
self.test_name = ''
self.outputs = [sys.stdout]
self.failed = False
def subprocess_print(self, line: str):
for o in self.outputs:
o.write(line)
o.flush()
def rawprint(self, line: str, with_stdout=True):
for o in self.outputs:
if o == sys.stdout and not with_stdout:
continue
for l in line.split('\n'):
if self.indentation > 0:
o.write(self.indentation*' ')
o.write(l)
o.write('\n')
o.flush()
def add_output(self, o, header='', footer=''):
os.makedirs(os.path.dirname(o), exist_ok=True)
self.outputs.append(open(o, "a"))
def print(self, line: str, with_stdout=True):
self.rawprint('.. ' + line, with_stdout)
def comment(self, line: str):
self.rawprint('// ' + line)
def header(self, text):
self.rawprint('\n## ' + text + ' ##\n')
def indent(self):
self.indentation += 4
def dedent(self):
self.indentation -= 4
def begin_test(self, test_name: str, print_header: bool=True):
self.test_name = test_name
if print_header:
self.rawprint(">> Test {}".format(test_name))
self.indent()
self.failed = False
def end_test(self, test_name: str, print_footer: bool=True):
if self.failed:
self.rawprint("$$ FAILED")
self.dedent()
if print_footer:
self.rawprint("<< Test {}".format(test_name))
self.test_name = ''
def begin_section(self, name: str):
self.rawprint(">> Section {}".format(name))
self.indent()
def end_section(self, name: str):
self.dedent()
self.rawprint("<< Section {}".format(name))
def inline_file(self, name: str, path: str, with_stdout: bool = False):
self.rawprint(">> Raw {}".format(name))
self.indent()
with open(path) as f:
lines = f.readlines()
for l in lines:
self.rawprint(l.strip(), with_stdout=with_stdout)
self.dedent()
self.rawprint("<< Raw {}".format(name))
def success(self, message):
self.rawprint("** " + message)
def error(self, message):
self.failed = True
self.rawprint("!! " + message)
def failure(self, ex):
self.failed = True
if ex is TestFailureException:
self.rawprint("!+ FAILURE in {}: {}".format(self.test_name, str(ex)))
else:
self.rawprint("!+ FAILURE in {}: {} {}".format(self.test_name, type(ex).__name__, str(ex)))
self.rawprint('>> Callstack')
tb = traceback.extract_tb(sys.exc_info()[2])
for frame in reversed(tb):
filename = util.sanitise_filename(frame.filename)
filename = re.sub('.*site-packages/', 'site-packages/', filename)
if filename[0] == '/':
filename = filename[1:]
self.rawprint(" File \"{}\", line {}, in {}".format(filename, frame.lineno, frame.name))
self.rawprint(" {}".format(frame.line))
self.rawprint('<< Callstack')
if isinstance(ex, TestFailureException):
file_list = []
for f in ex.files:
fname = '{}_{}'.format(self.test_name, os.path.basename(f))
if 'data' in f:
ext = fname.rfind('.')
if ext > 0:
fname = fname[0:ext] + '_ref' + fname[ext:]
if not os.path.exists(f):
continue
shutil.copyfile(f, util.get_artifact_path(fname))
file_list.append(fname)
diff_file = ''
diff = ''
# Special handling for the common case where we have two files to generate comparisons
if len(file_list) == 2:
mime = mimetypes.guess_type(ex.files[0])
if 'image' in mime[0]:
# If we have two files and they are images, a failed image comparison should have
# generated a diff.png. Grab it and include it
diff_tmp_file = util.get_tmp_path('diff.png')
if os.path.exists(diff_tmp_file):
diff_artifact = '{}_diff.png'.format(self.test_name)
shutil.move(diff_tmp_file, util.get_artifact_path(diff_artifact))
diff_file = ' ({})'.format(diff_artifact)
elif 'text' in mime[0] or 'xml' in mime[0]:
with open(ex.files[0]) as f:
fromlines = f.readlines()
with open(ex.files[1]) as f:
tolines = f.readlines()
diff = difflib.unified_diff(fromlines, tolines, fromfile=file_list[0], tofile=file_list[1])
if diff != '':
self.rawprint("=+ Compare: " + ','.join(file_list) + diff_file)
self.indent()
self.rawprint(''.join(diff).strip())
self.dedent()
self.rawprint("=- Compare")
elif len(file_list) > 0:
self.rawprint("== Compare: " + ','.join(file_list) + diff_file)
self.rawprint("!- FAILURE")
log = TestLogger()
|
