* moved more generic code into `common` package
[invirt/packages/invirt-base.git] / files / usr / sbin / invirt-getconf
1 #!/usr/bin/env python
2
3 """
4 invirt-getconf loads an invirt configuration file (either the original YAML
5 source or the faster-to-load JSON cache) and prints the configuration option
6 with the given name (key).  Keys are dot-separated paths into the YAML
7 configuration tree.  List indexes (0-based) are also treated as path
8 components.
9
10 (Due to this path language, certain restrictions are placed on the keys used in
11 the YAML configuration; e.g., they cannot contain dots.)
12
13 Examples:
14
15   invirt-getconf db.uri
16   invirt-getconf authn.0.type
17 """
18
19 from invirt.config import load
20 from sys import argv, exit, stderr
21 from optparse import OptionParser
22
23 class invirt_exception(Exception): pass
24
25 def main(argv):
26     try:
27         parser = OptionParser(usage = '%prog [options] key',
28                 description = __doc__.strip().split('\n\n')[0])
29         parser.add_option('-s', '--src',
30                 default = '/etc/invirt/master.yaml',
31                 help = 'the source YAML configuration file to read from')
32         parser.add_option('-c', '--cache',
33                 default = '/var/lib/invirt/invirt.json',
34                 help = 'path to the JSON cache')
35         parser.add_option('-r', '--refresh',
36                 action = 'store_true',
37                 help = 'force the cache to be regenerated')
38         opts, args = parser.parse_args()
39
40         try: [key] = args
41         except: raise invirt_exception(__doc__.strip())
42
43         conf = load(opts.src, opts.cache, opts.refresh)
44         components = key.split('.')
45         for i, component in enumerate(components):
46             progress = '.'.join(components[:i])
47             if type(conf) not in [dict, list]:
48                 raise invirt_exception(
49                         '%s: node has no children (atomic datum)' % progress)
50             if type(conf) == list:
51                 try: component = int(component)
52                 except: raise invirt_exception(
53                         '%s: node a list; integer path component required, '
54                         'but got "%s"' % (progress, component))
55             try: conf = conf[component]
56             except KeyError: raise invirt_exception(
57                     '%s: key "%s" not found' % (progress, component))
58             except IndexError: raise invirt_exception(
59                     '%s: index %s out of range' % (progress, component))
60         print conf
61     except invirt_exception, ex:
62         print >> stderr, ex
63         return 1
64
65 if __name__ == '__main__':
66     exit(main(argv))
67
68 # vim:et:sw=4:ts=4