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
|
#!/usr/bin/env python
#
# Copyright (c) 2001 - 2019 The SCons Foundation
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
from __future__ import print_function
__revision__ = "src/test_interrupts.py bee7caf9defd6e108fc2998a2520ddb36a967691 2019-12-17 02:07:09 bdeegan"
"""
Verify that the SCons source code contains only correct handling of
keyboard interrupts (e.g. Ctrl-C).
"""
import os
import os.path
import re
import time
import TestSCons
test = TestSCons.TestSCons()
# We do not want statements of the form:
# try:
# # do something, e.g.
# return a['x']
# except:
# # do the exception handling
# a['x'] = getx()
# return a['x']
#
# The code above may catch a KeyboardInterrupt exception, which was not
# intended by the programmer. We check for these situations in all python
# source files.
try:
cwd = os.environ['SCONS_CWD']
except KeyError:
scons_lib_dir = os.environ['SCONS_LIB_DIR']
MANIFEST = os.path.join(scons_lib_dir, 'MANIFEST.in')
else:
#cwd = os.getcwd()
scons_lib_dir = os.path.join(cwd, 'build', 'scons')
MANIFEST = os.path.join(scons_lib_dir, 'MANIFEST')
# We expect precisely this many uncaught KeyboardInterrupt exceptions
# from the files in the following dictionary.
expected_uncaught = {
'engine/SCons/Job.py' : 5,
'engine/SCons/Script/Main.py' : 1,
'engine/SCons/Taskmaster.py' : 3,
}
try:
fp = open(MANIFEST)
except IOError:
test.skip_test('%s does not exist; skipping test.\n' % MANIFEST)
else:
files = fp.read().split()
files = [f for f in files if f[-3:] == '.py']
# some regexps to parse the python files
tryexc_pat = re.compile(
r'^(?P<try_or_except>(?P<indent> *)(try|except)( [^\n]*)?:.*)',re.MULTILINE)
keyboardint_pat = re.compile(r' *except +([^,],)*KeyboardInterrupt([ ,][^\n]*)?:[^\n]*')
exceptall_pat = re.compile(r' *except(?: *| +Exception *, *[^: ]+):[^\n]*')
uncaughtKeyboardInterrupt = 0
for f in files:
with open(os.path.join(scons_lib_dir, f)) as ifp:
contents = ifp.read()
try_except_lines = {}
lastend = 0
while True:
match = tryexc_pat.search( contents, lastend )
if match is None:
break
#print match.groups()
lastend = match.end()
try:
indent_list = try_except_lines[match.group('indent')]
except:
indent_list = []
line_num = 1 + contents[:match.start()].count('\n')
indent_list.append( (line_num, match.group('try_or_except') ) )
try_except_lines[match.group('indent')] = indent_list
uncaught_this_file = []
for indent in list(try_except_lines.keys()):
exc_keyboardint_seen = 0
exc_all_seen = 0
for (l,statement) in try_except_lines[indent] + [(-1,indent + 'try')]:
#print "%4d %s" % (l,statement),
m1 = keyboardint_pat.match(statement)
m2 = exceptall_pat.match(statement)
if statement.find(indent + 'try') == 0:
if exc_all_seen and not exc_keyboardint_seen:
uncaught_this_file.append(line)
exc_keyboardint_seen = 0
exc_all_seen = 0
line = l
#print " -> reset"
elif m1 is not None:
exc_keyboardint_seen = 1
#print " -> keyboard -> ", m1.groups()
elif m2 is not None:
exc_all_seen = 1
#print " -> all -> ", m2.groups()
else:
pass
#print "Warning: unknown statement %s" % statement
expected_num = expected_uncaught.get(f, 0)
if expected_num != len(uncaught_this_file):
uncaughtKeyboardInterrupt = 1
msg = "%s: expected %d uncaught interrupts, got %d:"
print(msg % (f, expected_num, len(uncaught_this_file)))
for line in uncaught_this_file:
print(" File %s:%d: Uncaught KeyboardInterrupt!" % (f,line))
test.fail_test(uncaughtKeyboardInterrupt)
test.pass_test()
# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4:
|
