forked from curl/trurl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test.py
240 lines (202 loc) · 7.86 KB
/
test.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
#!/usr/bin/env python3
##########################################################################
# _ _ ____ _
# Project ___| | | | _ \| |
# / __| | | | |_) | |
# | (__| |_| | _ <| |___
# \___|\___/|_| \_\_____|
#
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at https://curl.se/docs/copyright.html.
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
# SPDX-License-Identifier: curl
#
##########################################################################
import sys
from os import getcwd, path
import json
import shlex
from subprocess import PIPE, run
from dataclasses import dataclass, asdict
from typing import Any, Optional, TextIO
PROGNAME = "trurl"
TESTFILE = "tests.json"
VALGRINDTEST = "valgrind"
VALGRINDARGS = ["--error-exitcode=1", "--leak-check=full", "-q"]
RED = "\033[91m" # used to mark unsuccessful tests
NOCOLOR = "\033[0m"
@dataclass
class CommandOutput:
stdout: Any
returncode: int
stderr: str
def testComponent(value, exp):
if isinstance(exp, bool):
result = value == 0 or value not in ("", [])
if exp:
return result
else:
return not result
return value == exp
class TestCase:
def __init__(self, testIndex, baseCmd, **testCase):
self.testIndex = testIndex
self.baseCmd = baseCmd
self.arguments = testCase["input"]["arguments"]
self.expected = testCase["expected"]
self.commandOutput: CommandOutput = None
self.testPassed: bool = False
def runCommand(self, cmdfilter: Optional[str], runWithValgrind: bool):
# Skip test if none of the arguments contain the keyword
if cmdfilter and all(cmdfilter not in arg for arg in self.arguments):
return False
cmd = [self.baseCmd]
args = self.arguments
if runWithValgrind:
cmd = [VALGRINDTEST]
args = VALGRINDARGS + [self.baseCmd] + self.arguments
output = run(
cmd + args,
stdout=PIPE, stderr=PIPE,
encoding="utf-8"
)
if isinstance(self.expected["stdout"], list):
# if we don't expect string, parse to json
try:
stdout = json.loads(output.stdout)
except json.decoder.JSONDecodeError:
stdout = None
else:
stdout = output.stdout
# assume stderr is always going to be string
stderr = output.stderr
self.commandOutput = CommandOutput(stdout, output.returncode, stderr)
return True
def test(self):
# return true only if stdout, stderr and errorcode
# are equal to the ones found in the testfile
self.testPassed = all(
testComponent(asdict(self.commandOutput)[k], exp)
for k, exp in self.expected.items())
return self.testPassed
def _printVerbose(self, output: TextIO):
self._printConcise(output)
for component, exp in self.expected.items():
value = asdict(self.commandOutput)[component]
itemFail = self.commandOutput.returncode == 1 or \
not testComponent(value, exp)
print(f"--- {component} --- ", file=output)
print("expected:", file=output)
print("nothing" if exp is False else
"something" if exp is True else
f"{exp!r}",file=output)
print("got:", file=output)
header = RED if itemFail else ""
footer = NOCOLOR if itemFail else ""
print(f"{header}{value!r}{footer}", file=output)
print()
def _printConcise(self, output: TextIO):
if self.testPassed:
header = ""
result = "passed"
footer = ""
else:
header = RED
result = "failed"
footer = NOCOLOR
text = f"{self.testIndex}: {result}\t{shlex.join(self.arguments)}"
print(f"{header}{text}{footer}", file=output)
def printDetail(self, verbose: bool = False, failed: bool = False):
output: TextIO = sys.stderr if failed else sys.stdout
if verbose:
self._printVerbose(output)
else:
self._printConcise(output)
def main(argc, argv):
ret = 0
baseDir = path.dirname(path.realpath(argv[0]))
# python on windows does not always seem to find the
# executable if it is in a different output directory than
# the python script, even if it is in the current working
# directory, using absolute paths to the executable and json
# file makes it reliably find the executable
baseCmd = path.join(getcwd(), PROGNAME)
# the .exe on the end is necessary when using absolute paths
if sys.platform == "win32" or sys.platform == "cygwin":
baseCmd += ".exe"
# check if the trurl executable exists
if path.isfile(baseCmd):
# get the version info for the feature list
output = run(
[baseCmd, "--version"],
stdout=PIPE, stderr=PIPE,
encoding="utf-8"
)
features = output.stdout.split('\n')[1].split()[1:]
with open(path.join(baseDir, TESTFILE), "r") as file:
allTests = json.load(file)
testIndexesToRun = []
# if argv[1] exists and starts with int
cmdfilter = ""
testIndexesToRun = list(range(len(allTests)))
runWithValgrind = False
verboseDetail = False
if argc > 1:
for arg in argv[1:]:
if arg[0].isnumeric():
# run only test cases separated by ","
testIndexesToRun = []
for caseIndex in arg.split(","):
testIndexesToRun.append(int(caseIndex))
elif arg == "--with-valgrind":
runWithValgrind = True
elif arg == "--verbose":
verboseDetail = True
else:
cmdfilter = argv[1]
numTestsFailed = 0
numTestsPassed = 0
numTestsSkipped = 0
for testIndex in testIndexesToRun:
# skip tests if required features are not met
if "required" in allTests[testIndex]:
required = allTests[testIndex]["required"]
if not set(required).issubset(set(features)):
print(f"Missing feature, skipping test {testIndex + 1}.")
numTestsSkipped += 1
continue
test = TestCase(testIndex + 1, baseCmd, **allTests[testIndex])
if test.runCommand(cmdfilter, runWithValgrind):
if test.test(): # passed
test.printDetail(verbose=verboseDetail)
numTestsPassed += 1
else:
test.printDetail(verbose=True, failed=True)
numTestsFailed += 1
# finally print the results to terminal
print("Finished:")
result = ", ".join([
f"Failed: {numTestsFailed}",
f"Passed: {numTestsPassed}",
f"Skipped: {numTestsSkipped}",
f"Total: {len(testIndexesToRun)}"
])
if (numTestsFailed == 0):
print("Passed! - ", result)
else:
ret = f"Failed! - {result}"
else:
ret = f" error: File \"{baseCmd}\" not found!"
return ret
if __name__ == "__main__":
sys.exit(main(len(sys.argv), sys.argv))