Source code for Bcfg2.Server.Lint.GroupNames
""" Ensure that all named groups are valid group names. """
import os
import re
import Bcfg2.Server.Lint
[docs]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)
[docs] 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()
[docs] @classmethod
def Errors(cls):
return {"invalid-group-name": "error"}
[docs] 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(Bcfg2.Options.setup.repository,
rules.name))
[docs] 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 bundle.template is None:
self.check_entries(bundle.xdata.xpath("//Group"),
bundle.name)
[docs] 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)))
[docs] 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))
[docs] 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)))
