-
Notifications
You must be signed in to change notification settings - Fork 9
/
FRUIT.py
454 lines (389 loc) · 16.5 KB
/
FRUIT.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
#!/usr/bin/env python
"""Module for building and running Fortran unit tests using a Python
interface to the FRUIT library:
http://sourceforge.net/projects/fortranxunit/
as a simple alternative to some of the original Ruby tools provided
with FRUIT.
Copyright 2014 University of Auckland.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from __future__ import (absolute_import, division, print_function)
def subroutine_type(name):
"""Returns type of subroutine, 'setup' or 'teardown' if it has
either of those names, or module setup or teardown, otherwise None."""
lowername = name.lower()
if lowername == 'setup':
subtype = 'global setup'
elif lowername == 'teardown':
subtype = 'global teardown'
elif lowername.startswith('test_'):
subtype = 'test'
elif 'setup_' in lowername or '_setup' in lowername:
subtype = 'setup'
elif 'teardown_' in lowername or '_teardown' in lowername:
subtype = 'teardown'
else:
subtype = None
return subtype
class test_subroutine(object):
"""Stores test subroutine data."""
def __init__(self, name="", description="", subtype=None):
self.name = name
self.description = description
self.subtype = subtype
class test_module(object):
"""Stores test module data."""
def __init__(self, test_filename):
self.test_filename = test_filename
self.parse()
def __repr__(self):
return str([sub.name for sub in self.subroutines])
def parse(self):
"""Parse module name and test cases."""
with open(self.test_filename) as f:
self.parse_test_module_name(f)
self.parse_subroutines(f)
def parse_test_module_name(self, f):
"""Parses test module name from file f."""
self.test_module_name = None
while self.test_module_name is None:
line = f.readline()
imod = line.lower().find('module')
if imod >= 0 and '!' not in line[:imod]:
self.test_module_name = line[imod:].strip().split()[1]
def parse_subroutine_description(self, f, subname):
"""Parses subroutine to find its description."""
line = f.readline()
while not line.strip():
line = f.readline()
comment_pos = line.find('!')
if comment_pos >= 0:
description = line[comment_pos+1:].strip()
else:
description = subname
return description
def parse_subroutine(self, f, line):
"""Parses a single subroutine in a test module."""
isub = line.lower().find('subroutine')
pre = line[:isub]
if '!' not in pre and 'end' not in pre.lower():
subname = line[isub:].strip().split()[1]
bracpos = subname.find('(')
if bracpos >= 0:
subname = subname[:bracpos]
subtype = subroutine_type(subname)
if subtype == 'test':
description = self.parse_subroutine_description(f, subname)
sub = test_subroutine(subname, description, subtype)
self.subroutines.append(sub)
elif subtype == 'setup':
self.setup = subname
elif subtype == 'teardown':
self.teardown = subname
elif subtype == 'global setup':
self.global_setup = True
elif subtype == 'global teardown':
self.global_teardown = True
def parse_subroutines(self, f):
"""Parses subroutines in test module."""
self.setup, self.teardown = None, None
self.global_setup, self.global_teardown = False, False
self.subroutines = []
line = f.readline()
while line:
if 'subroutine' in line.lower():
self.parse_subroutine(f, line)
line = f.readline()
class test_result(object):
def __init__(self, success=0, total=0):
self.success = success
self.total = total
def __repr__(self):
return "%d / %d (%3.0f%%)" % (self.success, self.total, self.percent)
def get_percent(self):
"""Returns percentage of successful results."""
try:
return self.success / self.total * 100
except ZeroDivisionError:
return 0.0
percent = property(get_percent)
class test_suite(object):
"""Class for suite of FRUIT tests"""
def __init__(self, test_filenames):
if isinstance(test_filenames, str):
test_filenames = [test_filenames]
self.test_filenames = test_filenames
self.test_modules = []
self.driver = None
self.exe = None
self.asserts = test_result()
self.cases = test_result()
self.built = False
self.parse()
def __repr__(self):
return '\n'.join([mod.test_filename + ': ' + str(mod)
for mod in self.test_modules])
def get_num_test_modules(self):
return len(self.test_modules)
num_test_modules = property(get_num_test_modules)
def get_global_setup(self):
return any([mod.global_setup for mod in self.test_modules])
global_setup = property(get_global_setup)
def get_global_teardown(self):
return any([mod.global_teardown for mod in self.test_modules])
global_teardown = property(get_global_teardown)
def parse(self):
"""Parses test F90 files containing test cases."""
for test_filename in self.test_filenames:
mod = test_module(test_filename)
self.test_modules.append(mod)
def parse_test_module_name(self, f):
"""Parses test module name from file f."""
line = f.readline()
while 'module' not in line.lower():
line = f.readline()
imod = line.find('module')
self.test_module_name = line[imod:].strip().split()[1]
def driver_lines(self, mpi=False, mpi_comm='MPI_COMM_WORLD'):
"""Creates lines for driver program to write to file."""
lines = []
lines.append('program tests')
lines.append('')
lines.append(' ! Driver program for FRUIT unit tests in:')
for mod in self.test_modules:
if mod.subroutines:
lines.append(' ! ' + mod.test_filename.strip())
lines.append('')
lines.append(' ! Generated by FRUITPy.')
lines.append('')
lines.append(' use fruit')
if mpi:
lines.append(' use fruit_mpi')
for mod in self.test_modules:
lines.append(' use ' + mod.test_module_name)
lines.append('')
lines.append(' implicit none')
lines.append(' integer :: failed_count')
if mpi:
lines.append(' integer :: size, rank, ierr')
lines.append('')
lines.append(' call init_fruit')
if self.global_setup:
lines.append(' call setup')
lines.append('')
if mpi:
lines.append(' call MPI_COMM_SIZE(' + mpi_comm + ', size, ierr)')
lines.append(' call MPI_COMM_RANK(' + mpi_comm + ', rank, ierr)')
lines.append('')
for mod in self.test_modules:
if mod.subroutines:
if self.num_test_modules > 1:
lines.append(' ! ' + mod.test_filename.strip() + ':')
if mod.setup:
lines.append(' call ' + mod.setup)
for sub in mod.subroutines:
lines.append(' call run_test_case(' +
sub.name + ',"' + sub.description + '")')
if mod.teardown:
lines.append(' call ' + mod.teardown)
if mod.setup or mod.teardown or mod.subroutines:
lines.append('')
lines.append(' call get_failed_count(failed_count)')
if mpi:
lines.append(' call fruit_summary_mpi(size, rank)')
lines.append(' call fruit_finalize_mpi(size, rank)')
else:
lines.append(' call fruit_summary')
lines.append(' call fruit_finalize')
if self.global_teardown:
lines.append(' call teardown')
lines.append(' if (failed_count > 0) stop 1')
lines.append('')
lines.append('end program tests')
return lines
def write(self, driver, mpi=False, mpi_comm='MPI_COMM_WORLD'):
"""Writes driver program to file."""
from os.path import isfile
self.driver = driver
lines = '\n'.join(self.driver_lines(mpi, mpi_comm))
if isfile(self.driver):
with open(self.driver) as f:
oldlines = ''.join([line for line in f])
update = oldlines != lines
else:
update = True
if update:
with open(self.driver, 'w') as f:
f.write(lines)
return update
def build(self, build_command, output_dir='', update=True):
"""Compiles and links FRUIT driver program. Returns True if
the build was successful. The output_dir parameter specifies
the directory for the executable (same as source by default).
Setting the update parameter to True forces the executable to
be rebuilt."""
from subprocess import call
from os.path import isfile, splitext, split, join
from os import remove
import shlex
from sys import platform
self.exe, ext = splitext(self.driver)
source_path, self.exe = split(self.exe)
if platform == 'win32':
self.exe += ".exe"
pathexe = join(output_dir, self.exe)
if isfile(pathexe) and update:
remove(pathexe)
if not isinstance(build_command, list):
build_command = shlex.split(build_command)
ret = call(build_command)
self.built = ret == 0 and isfile(pathexe)
return self.built
def run(self, run_command=None, num_procs=1, output_dir='', mpi=False):
"""Runs test suite, and returns True if all tests passed. An
optional run command may be specified. If num_procs > 1, or
mpi is True, the suite will be run using in parallel using MPI."""
import os
import shlex
import subprocess
if num_procs > 1: mpi = True
if output_dir != '':
orig_dir = os.getcwd()
os.chdir(output_dir)
if run_command is None:
if mpi:
run = ['mpirun', '-np', str(num_procs), self.exe]
else:
prefix = './' if os.name == 'posix' else ''
run = [prefix + self.exe]
else:
if not isinstance(run_command, list):
run_command = shlex.split(run_command)
if mpi:
run_command = ['-np', str(num_procs)] + run_command
run = run_command
sp = subprocess.Popen(run, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
output = sp.communicate()[0]
self.parse_output(output)
if output_dir != '':
os.chdir(orig_dir)
return self.success
def parse_output(self, output):
"""Parses output."""
try:
self.output_lines = output.decode().splitlines()
except AttributeError:
self.output_lines = output.splitlines()
self.get_success()
self.get_messages()
self.get_statistics()
def get_output(self):
"""Gets output from output_lines, in a form suitable for display."""
return ''.join(self.output_lines)
output = property(get_output)
def get_success(self):
"""Determines whether all tests ran successfully, by parsing the
output."""
self.success = any(["SUCCESSFUL!" in line
for line in self.output_lines])
def get_messages(self):
"""Parses output failure messages."""
self.messages = []
if not self.success:
for i, line in enumerate(self.output_lines):
if "Failed assertion messages:" in line:
for j in range(i + 1, len(self.output_lines)):
msg = self.output_lines[j]
if "end of failed assertion messages." in msg:
break
else:
self.messages.append(msg.strip())
break
def parse_summary_line(self, line):
"""Parses a summary line containing statistics on successful and total
numbers of asserts or cases."""
items = line.split()
slashpos = -(items[::-1].index('/') + 1) # last occurrence of /
return int(items[slashpos - 1]), int(items[slashpos + 1])
def get_statistics(self):
"""Parses output success / failure statistics."""
for i, line in enumerate(self.output_lines):
if "Successful asserts / total asserts" in line:
self.asserts.success, self.asserts.total = \
self.parse_summary_line(line)
self.cases.success, self.cases.total = \
self.parse_summary_line(self.output_lines[i + 1])
def summary(self):
"""Prints a summary of the test results."""
if not self.built:
print('Test driver could not be built.')
return
if self.success:
print("All tests passed.")
else:
print("Some tests failed:\n")
print('\n'.join(self.messages))
print()
print("Hit rate:")
print(" asserts: ", self.asserts)
print(" cases : ", self.cases)
def build_run(self, driver, build_command=['make'], run_command=None,
num_procs=1, output_dir='', mpi_comm='MPI_COMM_WORLD',
mpi=False):
"""Writes, builds and runs test suite. Returns True if the
build and all tests were successful.
The parameters are:
- 'driver' (string): name of the driver program source file to be
created (include path if you want it created in a different directory)
- 'build_command' (list or str): command for building the test driver
program
- 'run_command' (list or str): command for running the driver program
(to override the default, based on the driver source name)
- 'num_procs' (integer): set > 1 to run the test suite in parallel
using MPI
- 'output_dir' (string): directory for driver executable (default is
the driver source directory)
- 'mpi_comm' (string): name of MPI communicator to use in driver
program (default is 'MPI_COMM_WORLD')
- 'mpi' (Boolean): set True to force using MPI. Only needed for
num_procs = 1. Can be used to avoid having to rebuild the test
executable between runs with 1 processor and multiple processors.
"""
if num_procs > 1: mpi = True
if self.num_test_modules > 0:
update = self.write(driver, mpi, mpi_comm)
if self.build(build_command, output_dir, update):
return self.run(run_command, num_procs, output_dir, mpi)
return False
if __name__ == '__main__':
from sys import argv
from argparse import ArgumentParser
parser = ArgumentParser()
parser.add_argument('command', choices=['build_run', 'write'], help=
"""
command to be executed,
build_run - write driver file, build and execute tests,
write - write driver file
""")
parser.add_argument('file', nargs='+',
help="Fortran module(s) defining test cases")
parser.add_argument('-d', '--driver', default="fruit_driver.f90",
help="driver file name, default: %(default)s")
parser.add_argument('-b', '--build', default="make",
help="build command, default: %(default)s")
args = parser.parse_args(argv[1:])
ts = test_suite(args.file)
if args.command == "build_run":
ts.build_run(args.driver, args.build)
ts.summary()
elif args.command == "write":
ts.write(args.driver)