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
|
""" Base classes for Lint plugins and error handling """
import os
import sys
import logging
from copy import copy
import textwrap
import lxml.etree
import fcntl
import termios
import struct
from Bcfg2.Server import XI_NAMESPACE
from Bcfg2.Compat import walk_packages
__all__ = [m[1] for m in walk_packages(path=__path__)]
def _ioctl_GWINSZ(fd): # pylint: disable=C0103
""" get a tuple of (height, width) giving the size of the window
from the given file descriptor """
try:
return struct.unpack('hh', fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
except: # pylint: disable=W0702
return None
def get_termsize():
""" get a tuple of (width, height) giving the size of the terminal """
if not sys.stdout.isatty():
return None
dims = _ioctl_GWINSZ(0) or _ioctl_GWINSZ(1) or _ioctl_GWINSZ(2)
if not dims:
try:
fd = os.open(os.ctermid(), os.O_RDONLY)
dims = _ioctl_GWINSZ(fd)
os.close(fd)
except: # pylint: disable=W0702
pass
if not dims:
try:
dims = (os.environ['LINES'], os.environ['COLUMNS'])
except KeyError:
return None
return int(dims[1]), int(dims[0])
class Plugin(object):
""" base class for ServerlessPlugin and ServerPlugin """
def __init__(self, config, errorhandler=None, files=None):
self.files = files
self.config = config
self.logger = logging.getLogger('bcfg2-lint')
if errorhandler is None:
self.errorhandler = ErrorHandler()
else:
self.errorhandler = errorhandler
self.errorhandler.RegisterErrors(self.Errors())
def Run(self):
""" run the plugin. must be overloaded by child classes """
pass
@classmethod
def Errors(cls):
""" returns a dict of errors the plugin supplies. must be
overloaded by child classes """
def HandlesFile(self, fname):
""" returns true if the given file should be handled by the
plugin according to the files list, false otherwise """
return (self.files is None or
fname in self.files or
os.path.join(self.config['repo'], fname) in self.files or
os.path.abspath(fname) in self.files or
os.path.abspath(os.path.join(self.config['repo'],
fname)) in self.files)
def LintError(self, err, msg):
""" record an error in the lint process """
self.errorhandler.dispatch(err, msg)
def RenderXML(self, element, keep_text=False):
"""render an XML element for error output -- line number
prefixed, no children"""
xml = None
if len(element) or element.text:
el = copy(element)
if el.text and not keep_text:
el.text = '...'
for child in el.iterchildren():
el.remove(child)
xml = lxml.etree.tostring(
el,
xml_declaration=False).decode("UTF-8").strip()
else:
xml = lxml.etree.tostring(
element,
xml_declaration=False).decode("UTF-8").strip()
return " line %s: %s" % (element.sourceline, xml)
class ErrorHandler (object):
""" a class to handle errors for bcfg2-lint plugins """
def __init__(self, config=None):
self.errors = 0
self.warnings = 0
self.logger = logging.getLogger('bcfg2-lint')
termsize = get_termsize()
if termsize is not None and termsize[0] > 0:
twrap = textwrap.TextWrapper(initial_indent=" ",
subsequent_indent=" ",
width=termsize[0])
self._wrapper = twrap.wrap
else:
self._wrapper = lambda s: [s]
self.errortypes = dict()
if config is not None:
self.RegisterErrors(dict(config.items()))
def RegisterErrors(self, errors):
""" Register a dict of errors (name: default level) that a
plugin may raise """
for err, action in errors.items():
if err not in self.errortypes:
if "warn" in action:
self.errortypes[err] = self.warn
elif "err" in action:
self.errortypes[err] = self.error
else:
self.errortypes[err] = self.debug
def dispatch(self, err, msg):
""" Dispatch an error to the correct handler """
if err in self.errortypes:
self.errortypes[err](msg)
self.logger.debug(" (%s)" % err)
else:
# assume that it's an error, but complain
self.error(msg)
self.logger.warning("Unknown error %s" % err)
def error(self, msg):
""" log an error condition """
self.errors += 1
self._log(msg, self.logger.error, prefix="ERROR: ")
def warn(self, msg):
""" log a warning condition """
self.warnings += 1
self._log(msg, self.logger.warning, prefix="WARNING: ")
def debug(self, msg):
""" log a silent/debug condition """
self._log(msg, self.logger.debug)
def _log(self, msg, logfunc, prefix=""):
""" Generic log function that logs a message with the given
function after wrapping it for the terminal width """
# a message may itself consist of multiple lines. wrap() will
# elide them all into a single paragraph, which we don't want.
# so we split the message into its paragraphs and wrap each
# paragraph individually. this means, unfortunately, that we
# lose textwrap's built-in initial indent functionality,
# because we want to only treat the very first line of the
# first paragraph specially. so we do some silliness.
rawlines = msg.splitlines()
firstline = True
for rawline in rawlines:
lines = self._wrapper(rawline)
for line in lines:
if firstline:
logfunc(prefix + line.lstrip())
firstline = False
else:
logfunc(line)
class ServerlessPlugin (Plugin):
""" base class for plugins that are run before the server starts
up (i.e., plugins that check things that may prevent the server
from starting up) """
pass
class ServerPlugin (Plugin):
""" base class for plugins that check things that require the
running Bcfg2 server """
def __init__(self, core, config, **kwargs):
Plugin.__init__(self, config, **kwargs)
self.core = core
self.logger = self.core.logger
self.metadata = self.core.metadata
self.errorhandler.RegisterErrors({"broken-xinclude-chain": "warning"})
def has_all_xincludes(self, mfile):
""" return true if self.files includes all XIncludes listed in
the specified metadata type, false otherwise"""
if self.files is None:
return True
else:
path = os.path.join(self.metadata.data, mfile)
if path in self.files:
xdata = lxml.etree.parse(path)
for el in xdata.findall('./%sinclude' % XI_NAMESPACE):
if not self.has_all_xincludes(el.get('href')):
self.LintError("broken-xinclude-chain",
"Broken XInclude chain: could not "
"include %s" % path)
return False
return True
|
