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
|
import os
import re
import sys
import glob
from subprocess import Popen, PIPE, STDOUT
# add all parent testsuite directories to sys.path to allow (most)
# relative imports in python 2.4
_path = os.path.dirname(__file__)
while _path != '/':
if os.path.basename(_path).lower().startswith("test"):
sys.path.append(_path)
if os.path.basename(_path) == "testsuite":
break
_path = os.path.dirname(_path)
from common import can_skip, skip, skipIf, skipUnless, Bcfg2TestCase
# path to Bcfg2 src directory
srcpath = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..",
"src"))
# path to pylint rc file
rcfile = os.path.abspath(os.path.join(os.path.dirname(__file__), "..",
"pylintrc.conf"))
# test for pylint existence
try:
Popen(['pylint'], stdout=PIPE, stderr=STDOUT).wait()
HAS_PYLINT = True
except OSError:
HAS_PYLINT = False
# perform checks on the listed files only if the module listed in the
# keys can be imported
contingent_checks = {
("django",): {"lib/Bcfg2/Server": ["Reports",
"SchemaUpdater",
"models.py"],
"lib/Bcfg2/Server/Admin": ["Reports.py", "Syncdb.py"],
"sbin": ["bcfg2-reports"]},
("pyinotify",): {"lib/Bcfg2/Server/FileMonitor": ["Inotify.py"]},
("yum",): {"lib/Bcfg2/Client/Tools": ["YUM*"]},
("genshi",): {"lib/Bcfg2/Server/Plugins/Cfg": ["CfgGenshiGenerator.py"]},
("Cheetah",): {"lib/Bcfg2/Server/Plugins/Cfg": ["CfgCheetahGenerator.py"]},
("M2Crypto",): {"lib/Bcfg2": ["Encryption.py"],
"lib/Bcfg2/Server/Plugins/Cfg":
["CfgEncryptedGenerator.py"]},
("M2Crypto", "genshi"): {"lib/Bcfg2/Server/Plugins/Cfg":
["CfgEncryptedGenshiGenerator.py"]},
("M2Crypto", "Cheetah"): {"lib/Bcfg2/Server/Plugins/Cfg":
["CfgEncryptedCheetahGenerator.py"]},
}
# perform only error checking on the listed files
error_checks = {
"sbin": ["bcfg2-build-reports", "bcfg2-admin", "bcfg2-reports"],
"lib/Bcfg2": ["Proxy.py", "SSLServer.py"],
"lib/Bcfg2/Server": ["Reports", "SchemaUpdater"],
"lib/Bcfg2/Server/Admin": ["Backup.py",
"Bundle.py",
"Client.py",
"Compare.py",
"Minestruct.py",
"Perf.py",
"Pull.py",
"Query.py",
"Reports.py",
"Snapshots.py",
"Syncdb.py",
"Tidy.py",
"Viz.py",
"Xcmd.py"],
"lib/Bcfg2/Client/Tools": ["launchd.py",
"OpenCSW.py",
"Blast.py",
"SYSV.py",
"FreeBSDInit.py",
"DebInit.py",
"RcUpdate.py",
"VCS.py",
"YUM24.py"],
"lib/Bcfg2/Server/Plugins": ["Decisions.py",
"Deps.py",
"Ldap.py",
"Pkgmgr.py"]
}
# perform no checks at all on the listed files
no_checks = {
"lib/Bcfg2/Client/Tools": ["APT.py", "RPM.py", "rpmtools.py"],
"lib/Bcfg2/Server": ["Snapshots", "Hostbase"],
"lib/Bcfg2": ["manage.py"],
"lib/Bcfg2/Server/Reports": ["manage.py"],
"lib/Bcfg2/Server/Plugins": ["Account.py",
"Base.py",
"Editor.py",
"Hostbase.py",
"Snapshots.py",
"Statistics.py",
"TCheetah.py",
"TGenshi.py"],
}
try:
any
except NameError:
def any(iterable):
""" implementation of builtin any() for python 2.4 """
for element in iterable:
if element:
return True
return False
def expand_path_dict(pathdict):
""" given a path dict as above, return a list of all the paths """
rv = []
for parent, modules in pathdict.items():
for mod in modules:
rv.extend(glob.glob(os.path.join(srcpath, parent, mod)))
return rv
def whitelist_filter(filelist, whitelist):
rv = []
for fpath in filelist:
if fpath in whitelist:
rv.append(fpath)
continue
# check if the path is in any directories that are in the
# whitelist
if any(fpath.startswith(wpath + "/") for wpath in whitelist):
rv.append(fpath)
continue
return rv
def blacklist_filter(filelist, blacklist):
rv = []
for fpath in filelist:
if fpath in blacklist:
continue
# check that the path isn't in any directories that are in
# the blacklist
if any(fpath.startswith(bpath + "/") for bpath in blacklist):
continue
rv.append(fpath)
return rv
class TestPylint(Bcfg2TestCase):
pylint_cmd = ["pylint", "--rcfile", rcfile, "--init-hook",
"import sys;sys.path.append('%s')" %
os.path.join(srcpath, "lib")]
# regex to find errors and fatal errors
error_re = re.compile(r':\d+:\s+\[[EF]\d{4}')
# build the blacklists
blacklist = expand_path_dict(no_checks)
contingent_blacklist = []
for filedict in contingent_checks.values():
contingent_blacklist += expand_path_dict(filedict)
full_blacklist = expand_path_dict(error_checks) + contingent_blacklist + \
blacklist
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_lib_full(self):
full_list = []
for root, _, files in os.walk(os.path.join(srcpath, "lib")):
full_list.extend(blacklist_filter([os.path.join(root, f)
for f in files
if f.endswith(".py")],
self.full_blacklist))
self._pylint_full(full_list)
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_contingent_full(self):
blacklist = set(expand_path_dict(error_checks) + self.blacklist)
for (mods, filedict) in contingent_checks.items():
if "django" in mods:
# there's some issue with running pylint on modules
# that use django in Travis CI (but not elsewhere), so
# skip these for now
continue
try:
for mod in mods:
__import__(mod)
except ImportError:
continue
self._pylint_full(blacklist_filter(expand_path_dict(filedict),
blacklist))
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_sbin_full(self):
all_sbin = [os.path.join(srcpath, "sbin", f)
for f in glob.glob(os.path.join(srcpath, "sbin", "*"))]
sbin_list = blacklist_filter([f for f in all_sbin
if not os.path.islink(f)],
self.full_blacklist)
self._pylint_full(sbin_list,
extra_args=["--module-rgx",
"[a-z_-][a-z0-9_-]*$"])
def _pylint_full(self, paths, extra_args=None):
""" test select files for all pylint errors """
if extra_args is None:
extra_args = []
args = self.pylint_cmd + extra_args + \
[os.path.join(srcpath, p) for p in paths]
pylint = Popen(args, stdout=PIPE, stderr=STDOUT)
print(pylint.communicate()[0])
self.assertEqual(pylint.wait(), 0)
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_sbin_errors(self):
all_sbin = [os.path.join(srcpath, "sbin", f)
for f in glob.glob(os.path.join(srcpath, "sbin", "*"))]
sbin_list = blacklist_filter([f for f in all_sbin
if not os.path.islink(f)],
self.contingent_blacklist)
self._pylint_errors(sbin_list,
extra_args=["--module-rgx",
"[a-z_-][a-z0-9_-]*$"])
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_contingent_errors(self):
whitelist = expand_path_dict(error_checks)
for (mods, filedict) in contingent_checks.items():
if "django" in mods:
# there's some issue with running pylint on modules
# that use django in Travis CI (but not elsewhere), so
# skip these for now
continue
try:
for mod in mods:
__import__(mod)
except ImportError:
continue
flist = \
blacklist_filter(whitelist_filter(expand_path_dict(filedict),
whitelist),
self.blacklist)
self._pylint_errors(flist)
@skipIf(not os.path.exists(srcpath), "%s does not exist" % srcpath)
@skipIf(not os.path.exists(rcfile), "%s does not exist" % rcfile)
@skipUnless(HAS_PYLINT, "pylint not found, skipping")
def test_lib_errors(self):
filelist = blacklist_filter(expand_path_dict(error_checks),
self.contingent_blacklist)
return self._pylint_errors(filelist)
def _pylint_errors(self, paths, extra_args=None):
""" test all files for fatals and errors """
if extra_args is None:
extra_args = []
args = self.pylint_cmd + extra_args + \
["-f", "parseable", "-d", "R0801,E1103"] + \
[os.path.join(srcpath, p) for p in paths]
pylint = Popen(args, stdout=PIPE, stderr=STDOUT)
output = pylint.communicate()[0]
rv = pylint.wait()
for line in output.splitlines():
if self.error_re.search(str(line)):
print(line)
# pylint returns a bitmask, where 1 means fatal errors
# were encountered and 2 means errors were encountered.
self.assertEqual(rv & 3, 0)
|
