summaryrefslogtreecommitdiffstats
path: root/src/sbin/bcfg2-repo-validate
blob: fea8ee157b03b2026d9c3b175436520440df00f0 (plain)
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
#!/usr/bin/env python

"""
bcfg2-repo-validate checks all xml files in Bcfg2
repos against their respective XML schemas.
"""
__revision__ = '$Revision$'

import glob
import lxml.etree
import os
import sys
import fnmatch
import Bcfg2.Options

if __name__ == '__main__':
    opts = {'repo': Bcfg2.Options.SERVER_REPOSITORY,
            'prefix': Bcfg2.Options.INSTALL_PREFIX,
            'verbose': Bcfg2.Options.VERBOSE,
            'configfile': Bcfg2.Options.CFILE,
            'schema' : Bcfg2.Options.SCHEMA_PATH,
            'stdin': Bcfg2.Options.FILES_ON_STDIN}
    setup = Bcfg2.Options.OptionParser(opts)
    setup.parse(sys.argv[1:])
    verbose = setup['verbose']
    cpath = setup['configfile']
    schemadir = setup['schema']
    os.chdir(schemadir)
    repo = setup['repo']

    if setup['stdin']:
        file_list = map(lambda s: s.strip(), sys.stdin.readlines())
        info_list = [f for f in file_list if os.path.basename(f) == 'info.xml']
        metadata_list = fnmatch.filter(file_list, "*/Metadata/groups.xml")
        clients_list = fnmatch.filter(file_list, "*/Metadata/clients.xml")
        bundle_list = fnmatch.filter(file_list, "*/Bundler/*.xml")
        genshibundle_list = fnmatch.filter(file_list, "*/Bundler/*.genshi")
        pkg_list = fnmatch.filter(file_list, "*/Pkgmgr/*.xml")
        base_list = fnmatch.filter(file_list, "*/Base/*.xml")
        rules_list = fnmatch.filter(file_list, "*/Rules/*.xml")
        imageinfo_list = fnmatch.filter(file_list,
                                        "*/etc/report-configuration.xml")
        services_list = fnmatch.filter(file_list, "*/Svcmgr/*.xml")
        deps_list = fnmatch.filter(file_list, "*/Deps/*.xml")
        dec_list = fnmatch.filter(file_list, "*/Decisions/*")
        pkgcfg_list = fnmatch.filter(file_list, "*/Packages/config.xml")
        gp_list = fnmatch.filter(file_list, "*/GroupPatterns/config.xml")
    else:
        # not reading files from stdin
        
        # Get a list of all info.xml files in the bcfg2 repository
        info_list = []
        for infodir in ['Cfg', 'TGenshi', 'TCheetah']:
            for root, dirs, files in os.walk('%s/%s' % (repo, infodir)):
                info_list.extend([os.path.join(root, f) for f in files
                                  if f == 'info.xml'])

        # get metadata list
        metadata_list = glob.glob("%s/Metadata/groups.xml" % repo)

        # get other file lists
        clients_list = glob.glob("%s/Metadata/clients.xml" % repo)
        bundle_list = glob.glob("%s/Bundler/*.xml" % repo)
        genshibundle_list = glob.glob("%s/Bundler/*.genshi" % repo)
        pkg_list = glob.glob("%s/Pkgmgr/*.xml" % repo)
        base_list = glob.glob("%s/Base/*.xml" % repo)
        rules_list = glob.glob("%s/Rules/*.xml" % repo)
        imageinfo_list = glob.glob("%s/etc/report-configuration.xml" % repo)
        services_list = glob.glob("%s/Svcmgr/*.xml" % repo)
        deps_list = glob.glob("%s/Deps/*.xml" % repo)
        dec_list = glob.glob("%s/Decisions/*" % repo)
        pkgcfg_list = glob.glob("%s/Packages/config.xml" % repo)
        gp_list = glob.glob('%s/GroupPatterns/config.xml' % repo)

    # include files in metadata_list
    ref_bundles = set()
    xdata = lxml.etree.parse("%s/Metadata/groups.xml" % repo)
    included = set([ent.get('href') for ent in \
                   xdata.findall('./{http://www.w3.org/2001/XInclude}include')])
    while included:
        try:
            filename = included.pop()
        except KeyError:
            continue
        metadata_list.append("%s/Metadata/%s" % (repo, filename))
        groupdata = lxml.etree.parse("%s/Metadata/%s" % (repo, filename))
        group_ents = [ent.get('href') for ent in \
                      groupdata.
                      findall('./{http://www.w3.org/2001/XInclude}include')]
        for ent in group_ents:
            included.add(ent)
        included.discard(filename)

    # check for multiple default group definitions
    default_groups = []
    for grp in lxml.etree.parse("%s/Metadata/groups.xml" \
                                      % repo).findall('.//Group'):
        if grp.get('default') == 'true':
            default_groups.append(grp)
    if len(default_groups) > 1:
        print("*** Warning: Multiple default groups defined")
        for grp in default_groups:
            print("  %s" % grp.get('name'))

    # get all XIncluded bundles
    xdata.xinclude()
    for bundle in xdata.findall("//Bundle"):
        ref_bundles.add("%s/Bundler/%s" % (repo, bundle.get('name')))

    # verify attributes for configuration entries
    # (as defined in doc/server/configurationentries)
    # TODO: See if it is possible to do this in the schema instead
    required_configuration_attrs = {
        'device': ['name', 'owner', 'group', 'dev_type'],
        'directory': ['name', 'owner', 'group', 'perms'],
        'file': ['name', 'owner', 'group', 'perms'],
        'hardlink': ['name', 'to'],
        'symlink': ['name', 'to'],
        'ignore': ['name'],
        'nonexistent': ['name'],
        'permissions': ['name', 'owner', 'group', 'perms']}
    for rfile in rules_list:
        try:
            xdata = lxml.etree.parse(rfile)
        except lxml.etree.XMLSyntaxError, e:
            print("Failed to parse %s: %s" % (rfile, e))
        for posixpath in xdata.findall("//Path"):
            pathname = posixpath.get('name')
            pathtype = posixpath.get('type')
            pathset = set(posixpath.attrib.keys())
            try:
                required_attrs = set(required_configuration_attrs[pathtype] \
                                     + ['type'])
            except KeyError:
                continue
            if 'dev_type' in required_attrs:
                dev_type = posixpath.get('dev_type')
                if dev_type in ['block', 'char']:
                    # check if major/minor are specified
                    required_attrs |= set(['major', 'minor'])
            if pathset.issuperset(required_attrs):
                continue
            else:
                print("The following required attributes are missing for"
                      " Path %s in %s: %s" % (pathname, rfile,
                      [attr for attr in required_attrs.difference(pathset)]))

    # warn on duplicate Pkgmgr entries with the same priority
    pset = set()
    for plist in pkg_list:
        try:
            xdata = lxml.etree.parse(plist)
        except lxml.etree.XMLSyntaxError, e:
            print("Failed to parse %s: %s" % (plist, e))
        # get priority, type, group
        priority = xdata.getroot().get('priority')
        ptype = xdata.getroot().get('type')
        for pkg in xdata.findall("//Package"):
            if pkg.getparent().tag == 'Group':
                grp = pkg.getparent().get('name')
                if type(grp) is not str and grp.getparent().tag == 'Group':
                    pgrp = grp.getparent().get('name')
                else:
                    pgrp = 'none'
            else:
                grp = 'none'
                pgrp = 'none'
            ptuple = (pkg.get('name'), priority, ptype, grp, pgrp)
            # check if package is already listed with same priority,
            # type, grp
            if ptuple in pset:
                print("Duplicate Package %s, priority:%s, type:%s"\
                       % (pkg.get('name'), priority, ptype))
            else:
                pset.add(ptuple)

    filesets = {'metadata': (metadata_list, "%s/metadata.xsd"),
                'clients': (clients_list, "%s/clients.xsd"),
                'info': (info_list, "%s/info.xsd"),
                'bundle': (bundle_list, "%s/bundle.xsd"),
                'pkglist': (pkg_list, "%s/pkglist.xsd"),
                'base': (base_list, "%s/base.xsd"),
                'rules': (rules_list, "%s/rules.xsd"),
                'imageinfo': (imageinfo_list, "%s/report-configuration.xsd"),
                'services': (services_list, "%s/services.xsd"),
                'deps': (deps_list, "%s/deps.xsd"),
                'decisions': (dec_list, "%s/decisions.xsd"),
                'packages': (pkgcfg_list, "%s/packages.xsd"),
                'grouppatterns': (gp_list, "%s/grouppatterns.xsd"),
                }

    failures = 0
    for k, (filelist, schemaname) in list(filesets.items()):
        try:
            schema = lxml.etree.XMLSchema(lxml.etree.parse(open(schemaname %
                                                                schemadir)))
        except:
            print("Failed to process schema %s" % (schemaname % schemadir))
            failures = 1
            continue
        for filename in filelist:
            try:
                datafile = lxml.etree.parse(open(filename))
            except SyntaxError:
                print("%s ***FAILS*** to parse \t\t<----" % (filename))
                os.system("xmllint %s" % filename)
                failures = 1
                continue
            except IOError:
                print("Failed to open file %s \t\t<---" % (filename))
                failures = 1
                continue
            if schema.validate(datafile):
                if verbose:
                    print("%s checks out" % (filename))
            else:
                rc = os.system("xmllint --noout --xinclude --schema \
                                %s %s > /dev/null 2>/dev/null" % \
                               (schemaname % schemadir, filename))
                if rc:
                    failures = 1
                    print("%s ***FAILS*** to verify \t\t<----" % (filename))
                    os.system("xmllint --noout --xinclude --schema %s %s" % \
                              (schemaname % schemadir, filename))
                elif verbose:
                    print("%s checks out" % (filename))

    # print out missing bundle information
    if verbose:
        print("")
        if not setup['stdin']:
            # if we've taken a list of files on stdin, there's an
            # excellent chance that referenced bundles do not exist,
            # so skip this check
            for bundle in ref_bundles:
                # check for both regular and genshi bundles
                xmlbundle = "%s.xml" % bundle
                genshibundle = "%s.genshi" % bundle
                allbundles = bundle_list + genshibundle_list
                if (xmlbundle not in allbundles and
                    genshibundle not in allbundles):
                    print("*** Warning: Bundle %s referenced, but does not "
                          "exist." % bundle)
                    
        # verify bundle name attribute matches filename
        for bundle in (bundle_list + genshibundle_list):
            fname = bundle.split('Bundler/')[1].split('.')[0]
            xdata = lxml.etree.parse(bundle)
            bname = xdata.getroot().get('name')
            if fname != bname:
                print("The following names are inconsistent:")
                print("  Filename is %s" % fname)
                print("  Bundle name found in %s is %s" % (fname, bname))


    raise SystemExit, failures