~launchpad-pqm/launchpad/devel

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
#! /usr/bin/python -S
#
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""Check that all the launchpad.conf files can be loaded.

Usage hint:

% utilities/check-configs.py -v
"""

import _pythonpath

import os
import sys
import ZConfig
import optparse
import traceback

from lazr.config import ConfigSchema
from lazr.config.interfaces import ConfigErrors

# Calculate some landmark paths.
import lp.services.config
here = os.path.dirname(lp.services.config.__file__)
lazr_schema_file = os.path.join(here, 'schema-lazr.conf')
lazr_schema = ConfigSchema(lazr_schema_file)
zconfig_schema_file = os.path.join(
    here, os.pardir, os.pardir, 'zope/app/server/schema.xml')
zconfig_schema = ZConfig.loadSchema(zconfig_schema_file)


def main():
    parser = optparse.OptionParser(usage="""\
%prog [options] [zconfig_overrides]

Parse all launchpad.conf and *-lazr.conf files found under the 'config'
directory rooted at the current working directory.  Warn about any
problems loading the config file.

With a specified directory, search there instead of the current working
directory for launchpad.conf files.  The search is always recursive.

The environment variable LPCONFIG can be used to limit the search to only
subdirectories of config that match $LPCONFIG, otherwise all are searched.

zconfig_overrides are passed directly to ZConfig.loadConfig().
""")
    parser.add_option('-v', '--verbose',
                      action='count', dest='verbosity',
                      help='Increase verbosity')
    options, arguments = parser.parse_args()

    # Are we searching for one config or for all configs?
    directory = os.path.join(here, os.pardir, os.pardir, os.pardir, 'configs')
    configs = []
    lpconfig = os.environ.get('LPCONFIG')
    if lpconfig is None:
        for dirpath, dirnames, filenames in os.walk(directory):
            for filename in filenames:
                if (filename == 'launchpad.conf'
                    or filename.endswith('-lazr.conf')):
                    configs.append(os.path.join(dirpath, filename))
    else:
        configs.append(os.path.join(directory, lpconfig, 'launchpad.conf'))
        configs.append(os.path.join(
            directory, lpconfig, 'launchpad-lazr.conf'))

    # Load each config and report any errors.
    summary = []
    for config in sorted(configs):
        if config.endswith('launchpad.conf'):
            # This is a ZConfig conf file.
            try:
                root, handlers = ZConfig.loadConfig(
                    zconfig_schema, config, arguments)
            except ZConfig.ConfigurationSyntaxError, error:
                if options.verbosity > 2:
                    traceback.print_exc()
                elif options.verbosity > 1:
                    print error
                summary.append((config, False))
            else:
                summary.append((config, True))
        else:
            # This is a lazr.config conf file.
            lazr_config = lazr_schema.load(config)
            try:
                lazr_config.validate()
            except ConfigErrors, error:
                if options.verbosity > 2:
                    messages = '\n'.join([str(er) for er in error.errors])
                    print messages
                elif options.verbosity > 1:
                    print error
                summary.append((config, False))
            else:
                summary.append((config, True))

    prefix_length = len(directory)
    for config, status in summary:
        path = config[prefix_length + 1:]
        if status:
            if options.verbosity > 0:
                print 'SUCCESS:', path
        else:
            print 'FAILURE:', path

    # Return a useful exit code.  0 == all success.
    return len([config for config, status in summary if not status])


if __name__ == '__main__':
    sys.exit(main())