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
|
# SPDX-License-Identifier: GPL-2.0-or-later
#
# Test helpers for FRR
#
# Copyright (C) 2017 by David Lamparter & Christian Franke,
# Open Source Routing / NetDEF Inc.
#
# This file is part of FRRouting (FRR)
#
import subprocess
import sys
import re
import inspect
import os
import difflib
import frrsix
#
# These are the gritty internals of the TestMultiOut implementation.
# See below for the definition of actual TestMultiOut tests.
#
srcbase = os.path.abspath(inspect.getsourcefile(frrsix))
for i in range(0, 3):
srcbase = os.path.dirname(srcbase)
def binpath(srcpath):
return os.path.relpath(os.path.abspath(srcpath), srcbase)
class MultiTestFailure(Exception):
pass
class MetaTestMultiOut(type):
def __getattr__(cls, name):
if name.startswith("_"):
raise AttributeError
internal_name = "_{}".format(name)
if internal_name not in dir(cls):
raise AttributeError
def registrar(*args, **kwargs):
cls._add_test(getattr(cls, internal_name), *args, **kwargs)
return registrar
@frrsix.add_metaclass(MetaTestMultiOut)
class _TestMultiOut(object):
def _run_tests(self):
if "tests_run" in dir(self.__class__) and self.tests_run:
return
self.__class__.tests_run = True
basedir = os.path.dirname(inspect.getsourcefile(type(self)))
program = os.path.join(basedir, self.program)
proc = subprocess.Popen([binpath(program)], stdout=subprocess.PIPE)
self.output, _ = proc.communicate("")
self.exitcode = proc.wait()
self.__class__.testresults = {}
for test in self.tests:
try:
test(self)
except MultiTestFailure:
self.testresults[test] = sys.exc_info()
else:
self.testresults[test] = None
def _exit_cleanly(self):
if self.exitcode != 0:
raise MultiTestFailure("Program did not terminate with exit code 0")
@classmethod
def _add_test(cls, method, *args, **kwargs):
if "tests" not in dir(cls):
setattr(cls, "tests", [])
if method is not cls._exit_cleanly:
cls._add_test(cls._exit_cleanly)
def matchfunction(self):
method(self, *args, **kwargs)
cls.tests.append(matchfunction)
def testfunction(self):
self._run_tests()
result = self.testresults[matchfunction]
if result is not None:
frrsix.reraise(*result)
testname = re.sub(r"[^A-Za-z0-9]", "_", "%r%r" % (args, kwargs))
testname = re.sub(r"__*", "_", testname)
testname = testname.strip("_")
if not testname:
testname = method.__name__.strip("_")
if "test_%s" % testname in dir(cls):
index = 2
while "test_%s_%d" % (testname, index) in dir(cls):
index += 1
testname = "%s_%d" % (testname, index)
setattr(cls, "test_%s" % testname, testfunction)
#
# This class houses the actual TestMultiOut tests types.
# If you want to add a new test type, you probably do it here.
#
# Say you want to add a test type called foobarlicious. Then define
# a function _foobarlicious here that takes self and the test arguments
# when called. That function should check the output in self.output
# to see whether it matches the expectation of foobarlicious with the
# given arguments and should then adjust self.output according to how
# much output it consumed.
# If the output doesn't meet the expectations, MultiTestFailure can be
# raised, however that should only be done after self.output has been
# modified according to consumed content.
#
re_okfail = re.compile(r"(?:[3[12]m|^)?(?P<ret>OK|failed)".encode("utf8"), re.MULTILINE)
class TestMultiOut(_TestMultiOut):
def _onesimple(self, line):
if type(line) is str:
line = line.encode("utf8")
idx = self.output.find(line)
if idx != -1:
self.output = self.output[idx + len(line) :]
else:
raise MultiTestFailure("%r could not be found" % line)
def _okfail(self, line, okfail=re_okfail):
self._onesimple(line)
m = okfail.search(self.output)
if m is None:
raise MultiTestFailure("OK/fail not found")
self.output = self.output[m.end() :]
if m.group("ret") != "OK".encode("utf8"):
raise MultiTestFailure("Test output indicates failure")
#
# This class implements a test comparing the output of a program against
# an existing reference output
#
class TestRefMismatch(Exception):
def __init__(self, _test, outtext, reftext):
self.outtext = outtext
self.reftext = reftext
def __str__(self):
rv = "Expected output and actual output differ:\n"
rv += "\n".join(
difflib.unified_diff(
self.reftext.splitlines(),
self.outtext.splitlines(),
"reftext",
"outtext",
lineterm="",
)
)
return rv
class TestExitNonzero(Exception):
pass
class TestRefOut(object):
def test_refout(self):
basedir = os.path.dirname(inspect.getsourcefile(type(self)))
program = os.path.join(basedir, self.program)
if getattr(self, "built_refin", False):
refin = binpath(program) + ".in"
else:
refin = program + ".in"
if getattr(self, "built_refout", False):
refout = binpath(program) + ".refout"
else:
refout = program + ".refout"
intext = ""
if os.path.exists(refin):
with open(refin, "rb") as f:
intext = f.read()
with open(refout, "rb") as f:
reftext = f.read()
proc = subprocess.Popen(
[binpath(program)], stdin=subprocess.PIPE, stdout=subprocess.PIPE
)
outtext, _ = proc.communicate(intext)
# Get rid of newline problems (Windows vs Unix Style)
outtext_str = outtext.decode("utf8").replace("\r\n", "\n").replace("\r", "\n")
reftext_str = reftext.decode("utf8").replace("\r\n", "\n").replace("\r", "\n")
if outtext_str != reftext_str:
raise TestRefMismatch(self, outtext_str, reftext_str)
if proc.wait() != 0:
raise TestExitNonzero(self)
|
