-
-
Notifications
You must be signed in to change notification settings - Fork 222
Expand file tree
/
Copy pathrunChecks.py
More file actions
executable file
·297 lines (275 loc) · 11.2 KB
/
Copy pathrunChecks.py
File metadata and controls
executable file
·297 lines (275 loc) · 11.2 KB
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
#!/usr/bin/env python3
"""
Replacement for test-math-dependencies target in Makefile.
"""
from __future__ import print_function
import os
import sys
import re
import glob
from collections import defaultdict
winsfx = ".exe"
testsfx = "_test.cpp"
testsfx_no_ext = "_test"
def files_in_folder(folder):
"""Returns a list of files in the folder and all
its subfolders recursively. The folder can be
written with wildcards as with the Unix find command.
"""
files = []
for f in glob.glob(folder):
if os.path.isdir(f):
files.extend(files_in_folder(f + os.sep + "**"))
else:
files.append(f)
return files
def check_non_unique_test_names():
test_files = files_in_folder("test/unit/")
tests = {}
duplicates = defaultdict(list)
for filepath in test_files:
if os.path.isfile(filepath) and filepath.endswith(testsfx):
with open(filepath) as file:
test_file_content = file.read()
# look for TEST() and TEST_F()
matches = re.findall(r"TEST(?:_F)?\((.*?)\)", test_file_content, re.DOTALL)
for x in matches:
if not ("#" in x):
# strips for test names written in two lines
x_stripped = x.replace("\n", "").replace(" ", "").replace(",",", ")
if x_stripped in tests:
duplicates[x_stripped].append(filepath)
else:
tests[x_stripped] = filepath
errors = []
if len(duplicates)>0:
duplicates_error_msg = ""
for x in duplicates:
duplicates_error_msg += "(" + x + ") in files:\n"
# add the first found file first
duplicates_error_msg += "\t" + tests[x] + "\n"
for y in duplicates[x]:
duplicates_error_msg += "\t" + y + "\n"
errors.append(
"Tests or test fixtures with non-unique names found in test/unit:\n\n" +
duplicates_error_msg
)
return errors
def grep_patterns(type, folder, patterns_and_messages, exclude_filters=[]):
"""Checks the files in the provided folder for matches
with any of the patterns. It returns an array of
messages and the provided type with
the line number. This check ignores comments.
@param type: type or group of the check, listed with the error
@param folder: folder in which to check for the pattern
@param patterns_and_messages: a list of patterns and messages that
are printed if the pattern is matched
@param exclude_filter a list of files or folder that are excluded from
the check
"""
errors = []
folder.replace("/", os.sep)
exclude_files = []
for excl in exclude_filters:
exclude_files.extend(files_in_folder(excl))
files = files_in_folder(folder + os.sep + "**")
files = [x for x in files if x not in exclude_files]
for filepath in files:
if os.path.isfile(filepath):
line_num = 0
multi_line_comment = False
old_state_multi_line_comment = False
with open(filepath, "r") as f:
for line in f:
line_num += 1
# exclude multi line comments
if multi_line_comment:
if re.search("\*/", line):
multi_line_comment = False
else:
if re.search("/\*", line):
multi_line_comment = True
# parse the first line in a multi line comment for rare and weird case of
# "pattern /*""
if not multi_line_comment or (
multi_line_comment and not old_state_multi_line_comment
):
for p in patterns_and_messages:
# cover the edge cases where matched patterns
# are behind "//", "/*" or before "*/"
if (
not re.search(".*" + p["pattern"] + ".*\*/.*", line)
and not re.search(".*/\*.*" + p["pattern"], line)
and not re.search(".*//.*" + p["pattern"], line)
and re.search(p["pattern"], line)
):
errors.append(
filepath
+ " at line "
+ str(line_num)
+ ":\n\t"
+ "["
+ type
+ "] "
+ p["message"]
)
old_state_multi_line_comment = multi_line_comment
return errors
def check_non_test_files_in_test():
all_cpp = files_in_folder("test/unit/math/")
# if the file is a .cpp file that doesnt end with _test.cpp
errors = []
errors.extend(
x + ":\n\t A .cpp file without the " + testsfx + " suffix found in test/unit/math/"
for x in all_cpp
if os.path.splitext(x)[1] == ".cpp" and x[-len(testsfx) :] != testsfx
)
errors.extend(
x + ":\n\t A *_test.hpp file found. Must be *_test.cpp to run."
for x in all_cpp
if os.path.splitext(x)[1] == ".hpp" and x[-len(testsfx): -len(testsfx) + len(testsfx_no_ext)] == testsfx_no_ext
)
return errors
def check_rev_test_fixtures():
test_files = [
x for x in files_in_folder("test/unit/math/rev")
if os.path.isfile(x) and x.endswith(testsfx)
]
errors = []
for filepath in test_files:
line_num = 0
multi_line_comment = False
old_state_multi_line_comment = False
with open(filepath, "r") as f:
for line in f:
line_num += 1
if multi_line_comment:
if re.search("\*/", line):
multi_line_comment = False
else:
if re.search("/\*", line):
multi_line_comment = True
if not multi_line_comment or (
multi_line_comment and not old_state_multi_line_comment
):
if (
not re.search(r".*\bTEST\(.*\*/.*", line)
and not re.search(r".*/\*.*\bTEST\(", line)
and not re.search(r".*//.*\bTEST\(", line)
and re.search(r"\bTEST\(", line)
):
errors.append(
filepath
+ " at line "
+ str(line_num)
+ ":\n\t[rev-tests] Reverse-mode tests in "
+ "test/unit/math/rev must use a cleanup fixture. "
+ "Replace raw TEST(...) with TEST_F(AgradRev, ...) "
+ "or another approved fixture-based form."
)
old_state_multi_line_comment = multi_line_comment
return errors
def main():
errors = []
# Check for files inside stan/math/prim that contain stan/math/rev or stan/math/fwd
prim_checks = [
{
"pattern": "<stan/math/rev/",
"message": "File includes a stan/math/rev header file.",
},
{"pattern": "stan::math::var", "message": "File uses stan::math::var."},
{
"pattern": "<stan/math/fwd/",
"message": "File includes a stan/math/fwd header file.",
},
{"pattern": "stan::math::fvar", "message": "File uses stan::math::fvar."},
{
"pattern": "<stan/math/mix/",
"message": "File includes a stan/math/mix header file.",
},
]
errors.extend(grep_patterns("prim", "stan/math/prim", prim_checks))
# Check for files inside stan/math/rev that contain stan/math/fwd or stan/math/mix
rev_checks = [
{
"pattern": "<stan/math/fwd/",
"message": "File includes a stan/math/fwd header file.",
},
{"pattern": "stan::math::fvar", "message": "File uses stan::math::fvar."},
{
"pattern": "<stan/math/mix/",
"message": "File includes a stan/math/mix header file.",
},
]
errors.extend(grep_patterns("rev", "stan/math/rev", rev_checks))
# Check to make sure we use C++14 constructs in stan/math
cpp14_checks = [
{
"pattern": "boost::is_unsigned<",
"message": "File uses boost::is_unsigned instead of std::is_unsigned.",
},
{
"pattern": "<boost/type_traits/is_unsigned>",
"message": "File includes <boost/type_traits/is_unsigned.hpp> instead of <type_traits>.",
},
{
"pattern": "boost::is_arithmetic<",
"message": "File uses boost::is_arithmetic instead of std::is_arithmetic.",
},
{
"pattern": "<boost/type_traits/is_arithmetic.hpp>",
"message": "File includes <boost/type_traits/is_unsigned.hpp> instead of <type_traits>.",
},
{
"pattern": "boost::is_convertible<",
"message": "File uses boost::is_convertible instead of std::is_convertible.",
},
{
"pattern": "<boost/type_traits/is_convertible.hpp>",
"message": "File includes <boost/type_traits/is_convertible.hpp> instead of <type_traits>.",
},
{
"pattern": "boost::is_same<",
"message": "File uses boost::is_same instead of std::is_same.",
},
{
"pattern": "<boost/type_traits/is_same.hpp>",
"message": "File includes <boost/type_traits/is_same.hpp> instead of <type_traits>.",
},
{
"pattern": "boost::enable_if_c<",
"message": "File uses boost::enable_if_c instead of std::enable_if.",
},
{
"pattern": "boost::enable_if<",
"message": "File uses boost::enable_if instead of std::enable_if.",
},
{
"pattern": "boost::disable_if<",
"message": "File uses boost::disable_if instead of std::enable_if.",
},
{
"pattern": "<boost/utility/enable_if.hpp>",
"message": "Replace \<boost/utility/enable_if.hpp\> with \<type_traits\>.",
},
]
errors.extend(grep_patterns("C++14", "stan/math", cpp14_checks))
# Check that we do not use non-reentrant safe functions from std
thread_safe_checks = [
{
"pattern": "std::lgamma",
"message": "Replace std::lgamma with reentrant safe version boost::math::lgamma or lgamma_r on supporting platforms.",
}
]
errors.extend(
grep_patterns("thread-reentrant-safe", "stan/math", thread_safe_checks)
)
errors.extend(check_non_test_files_in_test())
errors.extend(check_rev_test_fixtures())
errors.extend(check_non_unique_test_names())
if errors:
for e in errors:
print(e, file=sys.stderr)
sys.exit(1)
if __name__ == "__main__":
main()