-
Notifications
You must be signed in to change notification settings - Fork 4
/
run_tests.py
300 lines (263 loc) · 10.3 KB
/
run_tests.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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2020-2022 F4PGA Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
"""
run_tests.py
====================================
The core of the test infrastructure for prjxray-bram-patch.
Runs a series of tests on test designs to ensure patching is operational.
Test designs to be operated on are generated using the "generate_test.py" script and are located in
testing/tests/master.
"""
import os
import os.path
import subprocess
import sys
import patch_mem as patch_mem
import glob
def doTest(fasmToPatch, init, mdd, patchedFasm, origFasm, selectedMemToPatch):
"""
Test a specific design and report if it was successful.
Parameters
---------
fasmToPatch
Path to fasm file to be patched
init
Path to new memory init file
mdd
Path to MDD file
patchedFasm
Where to put the patched file (typically in /tmp)
origFasm
What to compare the patchedFasm to
"""
print(
"====================\nRunning test: \n fasmToPatch={}\n init={}\n mdd={}\n patchedFasm={}\n origFasm={}\n selectedMemtoPatch={}\n"
.format(
fasmToPatch, init, mdd, patchedFasm, origFasm, selectedMemToPatch
),
flush=True
)
for fil in [fasmToPatch, init, mdd, origFasm]:
assert os.path.isfile(fil), print("No such file: {}".format(fil))
patch_mem.patch_mem(
fasm=fasmToPatch,
init=init,
mdd=mdd,
outfile=patchedFasm,
selectedMemToPatch=selectedMemToPatch
)
print('Checking results...')
print(" {}\n {}".format(origFasm, patchedFasm))
diff = subprocess.run(
['diff', origFasm, patchedFasm],
stdout=subprocess.PIPE,
universal_newlines=True
) # , shell=True)
if (diff.stdout == ''):
print('RESULT: Files match, success!\n')
return "SUCCESS"
else:
print('RESULT: ERROR - Files do not match\n')
return "FAILURE"
return "SUCCESS"
####################################################################################################
def main():
"""
The main test driver routine.
Parameters
---------
"""
# Terminate early without running all tests?
LAST_TEST = None
#LAST_TEST = (1, '16k', 2048 * 8)
MAKE_REPORT = True # Do you want status updated into passed.txt, failed.txt, incomplete.txt?
CLEAR_REPORTS = False # Do you want status files cleared?
GENERATE_ALT = True # This needs to be set to true to force the creation of the alt.fasm file (only needed once)
EXIT_ON_FAILURE = False # Should you exit on a failure?
EXIT_ON_INCOMPLETE = False # Should you exit on an incomplete test?
ONE_TEST = None
#ONE_TEST = (8, '128k', 1 * 128 * 1024)
SKIP_PASSED = True # Should you skip over tests that are in the passed.txt file?
widths_to_test = [
1, 2, 4, 8, 9, 16, 18, 32, 36, 64, 72, 128, 144, 256, 288
]
depths_to_test = [
('128', 128), ('256', 256), ('512', 512), ('1k', 1024), ('2k', 2048),
('4k', 2048 * 2), ('8k', 2048 * 4), ('16k', 2048 * 8),
('32k', 2048 * 16), ('64k', 2048 * 32), ('128k', 2048 * 64)
]
weird_widths_to_test = [
3, 6, 11, 17, 19, 25, 34, 37, 69, 100, 127, 130, 200
]
weird_depths_to_test = [
('1027', 1027),
('5k', 5000),
('7k', 7000),
('1050', 1050),
('36k', 1024 * 36),
('36k+20', 1024 * 36 + 20),
('72k', 1024 * 72),
# do more later
]
rootdir = os.environ.get("MEM_PATCH_DIR")
assert rootdir is not None, "Must set 'MEM_PATCH_DIR' environment variable to run tests."
testsdir = os.path.join(rootdir, 'testing', 'tests')
stopfile = os.path.join(testsdir, 'stop')
passed = os.path.join(testsdir, 'passed.txt')
failed = os.path.join(testsdir, 'failed.txt')
incomplete = os.path.join(testsdir, 'incomplete.txt')
# Create report files if they don't exist
for reportFile in [passed, failed, incomplete]:
if not os.path.isfile(reportFile):
with open(reportFile, mode='w') as r:
pass
widths = widths_to_test + weird_widths_to_test
depths = depths_to_test + weird_depths_to_test
already_passed = []
if CLEAR_REPORTS:
print("Clearing 'passed.txt', 'failed,txt', 'incomplete.txt'")
for reportFile in [passed, failed, incomplete]:
if os.path.isfile(reportFile):
try:
os.remove(reportFile)
with open(reportFile, mode='w') as r:
pass
except:
print('Unable to clear report file: {}'.format(reportFile))
else:
with open(reportFile, mode='w') as r:
pass
# Do we want to skip tests that have already passed or not?
# If so, build the already_passed list from the passed.txt file
if SKIP_PASSED:
with open(passed) as p:
for line in p:
if line.strip() is not '':
already_passed.append(line.strip())
if ONE_TEST is not None:
wid, depthname, depth = ONE_TEST
design = '{}b{}'.format(depthname, wid)
designdir = os.path.join(testsdir, 'master', design)
status = doTest(
fasmToPatch=os.path.join(designdir, 'alt.fasm'),
init=os.path.join(designdir, 'init', 'init.mem'),
mdd=os.path.join(designdir, 'mapping.mdd'),
patchedFasm=os.path.join(designdir, 'patched.fasm'),
origFasm=os.path.join(designdir, 'real.fasm'),
selectedMemToPatch='mem/ram'
)
else: # Perform a whole collection of tests
for wid in widths_to_test:
for depth_tup in depths_to_test:
depthname = depth_tup[0]
depth = depth_tup[1]
design = '{}b{}'.format(depthname, wid)
designdir = os.path.join(testsdir, 'master', design)
if not os.path.isdir(designdir):
print(
"Skipping {} because it doesn't exist".
format(designdir)
)
continue
if design in already_passed:
print(
'Skipping {} because it already passed'.format(design)
)
continue
if os.path.isfile(stopfile):
print('Stop file detected, stopping batch')
sys.exit()
status = doTest(
fasmToPatch=os.path.join(designdir, 'alt.fasm'),
init=os.path.join(designdir, 'init', 'init.mem'),
mdd=os.path.join(designdir, 'mapping.mdd'),
patchedFasm=os.path.join(designdir, 'patched.fasm'),
origFasm=os.path.join(designdir, 'real.fasm'),
selectedMemToPatch='mem/ram'
)
if status == "SUCCESS":
if MAKE_REPORT:
if design not in already_passed:
already_passed.append(design)
with open(passed, mode='a') as f:
f.write('{}\n'.format(design))
if status == "FAILURE":
if MAKE_REPORT:
with open(failed) as f:
already_failed = f.read()
if design not in already_failed:
with open(failed, mode='a') as f:
f.write('{}\n'.format(design))
if EXIT_ON_FAILURE:
print('Failure detected, exiting')
sys.exit()
if status == "INCOMPLETE":
with open(incomplete) as f:
already_incomplete = f.read()
if design not in already_incomplete:
with open(incomplete, mode='a') as f:
f.write('{}\n'.format(design))
if EXIT_ON_INCOMPLETE:
print('Incomplete test detected, exiting')
sys.exit()
if (wid, depthname, depth) == LAST_TEST:
print('Last test executed, stopping batch')
sys.exit()
if __name__ == "__main__":
# Run a series of tests
if (len(sys.argv) == 1):
main()
# Run a test for a specific directory created by generate_tests.py program
elif (len(sys.argv) == 2):
d = sys.argv[1]
assert os.path.isdir(d)
status = doTest(
fasmToPatch="{}/alt.fasm".format(d),
init="{}/init/init.mem".format(d),
mdd=glob.glob("{}/*.mdd".format(d))[0],
patchedFasm="{}/patched.fasm".format(d),
origFasm="{}/real.fasm".format(d),
selectedMemToPatch="mem/ram"
)
print("Test status = {}".format(status))
if (status == "SUCCESS"):
exit(0)
else:
exit(1)
# Run a single directed test
elif len(sys.argv) == 7:
assert os.path.isfile(sys.argv[1])
status = doTest(
fasmToPatch=sys.argv[1],
init=sys.argv[2],
mdd=sys.argv[3],
patchedFasm=sys.argv[4],
origFasm=sys.argv[5],
selectedMemToPatch=sys.argv[6]
)
print("Test status = {}".format(status))
if (status == "SUCCESS"):
exit(0)
else:
exit(1)
else:
print(
"Usage:\n python run_tests.py #To run series of tests\nOR\n python run_tests.py fasmToPatch, init, mdd, patchedFasm, origFasm hdlMemToPatch # To run a directed test",
file=sys.stderr
)
exit(1)