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
|
""" Ensure that all named groups are valid group names. """
import os
import re
import Bcfg2.Server.Lint
try:
from Bcfg2.Server.Plugins.Bundler import BundleTemplateFile
HAS_GENSHI = True
except ImportError:
HAS_GENSHI = False
class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
""" Ensure that all named groups are valid group names. """
#: A string regex that matches only valid group names. Currently,
#: a group name is considered valid if it contains only
#: non-whitespace characters.
pattern = r'\S+$'
#: A compiled regex for
#: :attr:`Bcfg2.Server.Lint.GroupNames.GroupNames.pattern`
valid = re.compile(r'^' + pattern)
def Run(self):
self.check_metadata()
if 'Rules' in self.core.plugins:
self.check_rules()
if 'Bundler' in self.core.plugins:
self.check_bundles()
if 'GroupPatterns' in self.core.plugins:
self.check_grouppatterns()
if 'Cfg' in self.core.plugins:
self.check_cfg()
@classmethod
def Errors(cls):
return {"invalid-group-name": "error"}
def check_rules(self):
""" Check groups used in the Rules plugin for validity. """
for rules in self.core.plugins['Rules'].entries.values():
if not self.HandlesFile(rules.name):
continue
xdata = rules.pnode.data
self.check_entries(xdata.xpath("//Group"),
os.path.join(self.config['repo'], rules.name))
def check_bundles(self):
""" Check groups used in the Bundler plugin for validity. """
for bundle in self.core.plugins['Bundler'].entries.values():
if (self.HandlesFile(bundle.name) and
(not HAS_GENSHI or
not isinstance(bundle, BundleTemplateFile))):
self.check_entries(bundle.xdata.xpath("//Group"),
bundle.name)
def check_metadata(self):
""" Check groups used or declared in the Metadata plugin for
validity. """
self.check_entries(self.metadata.groups_xml.xdata.xpath("//Group"),
os.path.join(self.config['repo'],
self.metadata.groups_xml.name))
def check_grouppatterns(self):
""" Check groups used in the GroupPatterns plugin for validity """
cfg = self.core.plugins['GroupPatterns'].config
if not self.HandlesFile(cfg.name):
return
for grp in cfg.xdata.xpath('//GroupPattern/Group'):
if not self.valid.search(grp.text):
self.LintError("invalid-group-name",
"Invalid group name in %s: %s" %
(cfg.name, self.RenderXML(grp, keep_text=True)))
def check_cfg(self):
""" Check groups used in group-specific files in the Cfg
plugin for validity. """
for root, _, files in os.walk(self.core.plugins['Cfg'].data):
for fname in files:
basename = os.path.basename(root)
if (re.search(r'^%s\.G\d\d_' % basename, fname) and
not re.search(r'^%s\.G\d\d_' % basename + self.pattern,
fname)):
self.LintError("invalid-group-name",
"Invalid group name referenced in %s" %
os.path.join(root, fname))
def check_entries(self, entries, fname):
""" Check a generic list of XML entries for <Group> tags with
invalid name attributes.
:param entries: A list of XML <Group> tags whose ``name``
attributes will be validated.
:type entries: list of lxml.etree._Element
:param fname: The filename the entry list came from
:type fname: string
"""
for grp in entries:
if not self.valid.search(grp.get("name")):
self.LintError("invalid-group-name",
"Invalid group name in %s: %s" %
(fname, self.RenderXML(grp)))
|
