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
|
import os.path
import lxml.etree
import Bcfg2.Server.Lint
from Bcfg2.Server.Plugins.Packages import Apt, Yum
class RequiredAttrs(Bcfg2.Server.Lint.ServerPlugin):
""" verify attributes for configuration entries (as defined in
doc/server/configurationentries) """
def __init__(self, *args, **kwargs):
Bcfg2.Server.Lint.ServerPlugin.__init__(self, *args, **kwargs)
self.required_attrs = {
'Path': {
'device': ['name', 'owner', 'group', 'dev_type'],
'directory': ['name', 'owner', 'group', 'perms'],
'file': ['name', 'owner', 'group', 'perms', '__text__'],
'hardlink': ['name', 'to'],
'symlink': ['name', 'to'],
'ignore': ['name'],
'nonexistent': ['name'],
'permissions': ['name', 'owner', 'group', 'perms'],
'vcs': ['vcstype', 'revision', 'sourceurl']},
'Service': {
'chkconfig': ['name'],
'deb': ['name'],
'rc-update': ['name'],
'smf': ['name', 'FMRI'],
'upstart': ['name']},
'Action': ['name', 'timing', 'when', 'status', 'command'],
'Package': ['name']}
def Run(self):
self.check_packages()
if "Defaults" in self.core.plugins:
self.logger.info("Defaults plugin enabled; skipping required "
"attribute checks")
else:
self.check_rules()
self.check_bundles()
@classmethod
def Errors(cls):
return {"unknown-entry-type":"error",
"unknown-entry-tag":"error",
"required-attrs-missing":"error",
"extra-attrs":"warning"}
def check_packages(self):
""" check package sources for Source entries with missing attrs """
if 'Packages' in self.core.plugins:
for source in self.core.plugins['Packages'].sources:
if isinstance(source, Yum.YumSource):
if (not source.pulp_id and not source.url and
not source.rawurl):
self.LintError("required-attrs-missing",
"A %s source must have either a url, "
"rawurl, or pulp_id attribute: %s" %
(source.ptype,
self.RenderXML(source.xsource)))
elif not source.url and not source.rawurl:
self.LintError("required-attrs-missing",
"A %s source must have either a url or "
"rawurl attribute: %s" %
(source.ptype,
self.RenderXML(source.xsource)))
if (not isinstance(source, Apt.AptSource) and
source.recommended):
self.LintError("extra-attrs",
"The recommended attribute is not "
"supported on %s sources: %s" %
(source.ptype,
self.RenderXML(source.xsource)))
def check_rules(self):
""" check Rules for Path entries with missing attrs """
if 'Rules' in self.core.plugins:
for rules in self.core.plugins['Rules'].entries.values():
xdata = rules.pnode.data
for path in xdata.xpath("//Path"):
self.check_entry(path, os.path.join(self.config['repo'],
rules.name))
def check_bundles(self):
""" check bundles for BoundPath entries with missing attrs """
if 'Bundler' in self.core.plugins:
for bundle in self.core.plugins['Bundler'].entries.values():
try:
xdata = lxml.etree.XML(bundle.data)
except (lxml.etree.XMLSyntaxError, AttributeError):
xdata = lxml.etree.parse(bundle.template.filepath).getroot()
for path in xdata.xpath("//*[substring(name(), 1, 5) = 'Bound']"):
self.check_entry(path, bundle.name)
def check_entry(self, entry, filename):
""" generic entry check """
if self.HandlesFile(filename):
name = entry.get('name')
tag = entry.tag
if tag.startswith("Bound"):
tag = tag[5:]
if tag not in self.required_attrs:
self.LintError("unknown-entry-tag",
"Unknown entry tag '%s': %s" %
(entry.tag, self.RenderXML(entry)))
if isinstance(self.required_attrs[tag], dict):
etype = entry.get('type')
if etype in self.required_attrs[tag]:
required_attrs = set(self.required_attrs[tag][etype] +
['type'])
else:
self.LintError("unknown-entry-type",
"Unknown %s type %s: %s" %
(tag, etype, self.RenderXML(entry)))
return
else:
required_attrs = set(self.required_attrs[tag])
attrs = set(entry.attrib.keys())
if 'dev_type' in required_attrs:
dev_type = entry.get('dev_type')
if dev_type in ['block', 'char']:
# check if major/minor are specified
required_attrs |= set(['major', 'minor'])
if '__text__' in required_attrs:
required_attrs.remove('__text__')
if (not entry.text and
not entry.get('empty', 'false').lower() == 'true'):
self.LintError("required-attrs-missing",
"Text missing for %s %s in %s: %s" %
(entry.tag, name, filename,
self.RenderXML(entry)))
if not attrs.issuperset(required_attrs):
self.LintError("required-attrs-missing",
"The following required attribute(s) are "
"missing for %s %s in %s: %s\n%s" %
(entry.tag, name, filename,
", ".join([attr
for attr in
required_attrs.difference(attrs)]),
self.RenderXML(entry)))
|
