source: trunk/packages/invirt-base/python/invirt/common.py @ 3029

Last change on this file since 3029 was 3029, checked in by gdb, 14 years ago

Improvements to captureOutput

File size: 4.3 KB
Line 
1from __future__ import with_statement
2
3import unittest
4from fcntl import flock, LOCK_EX, LOCK_SH, LOCK_UN
5import contextlib as clib
6import subprocess
7
8class InvirtConfigError(AttributeError):
9    pass
10
11class struct(dict):
12    'A simple namespace object.'
13    def __init__(self, d = {}, __prefix = None, __default=None, **kwargs):
14        super(struct, self).__init__(d)
15        self.__prefix = __prefix
16        self.__default = __default
17        self.update(kwargs)
18    def __getattr__(self, key):
19        try:
20            return self[key]
21        except KeyError:
22            if self.__default is None:
23                # XX ideally these would point a frame higher on the stack.
24                prefix = self.__prefix
25                if prefix is not None:
26                    raise InvirtConfigError('missing configuration variable '
27                                            '%s%s' % (prefix, key))
28                else:
29                    raise AttributeError("anonymous struct has no member '%s'"
30                                         % (key,))
31            else:
32                return struct({}, '', self.__default)
33
34def dicts2struct(x, prefix = None, default = None):
35    """
36    Given a tree of lists/dicts, perform a deep traversal to transform all the
37    dicts to structs.
38    """
39    if prefix is not None:
40        def newprefix(k): return prefix + str(k) + '.'
41    else:
42        def newprefix(k): return prefix
43    if type(x) == dict:
44        return struct(((k, dicts2struct(v, newprefix(k), default))
45                       for k,v in x.iteritems()),
46                      prefix,
47                      default)
48    elif type(x) == list:
49        return [dicts2struct(v, newprefix(i), default)
50                for i, v in enumerate(x)]
51    elif x is None:
52        return struct({}, prefix, default)
53    else:
54        return x
55
56@clib.contextmanager
57def lock_file(path, exclusive = True):
58    with clib.closing(file(path, 'w')) as f:
59        if exclusive:
60            locktype = LOCK_EX
61        else:
62            locktype = LOCK_SH
63        flock(f, locktype)
64        try:
65            yield
66        finally:
67            flock(f, LOCK_UN)
68
69def captureOutput(popen_args, stdin_str=None, *args, **kwargs):
70    """Capture stdout from a command.
71
72    This method will proxy the arguments to subprocess.Popen. It
73    returns the output from the command if the call succeeded and
74    raises an exception if the process returns a non-0 value.
75
76    This is intended to be a variant on the subprocess.check_call
77    function that also allows you access to the output from the
78    command.
79    """
80    if 'stdin' not in kwargs:
81        kwargs['stdin'] = subprocess.PIPE
82    if 'stdout' not in kwargs:
83        kwargs['stdout'] = subprocess.PIPE
84    if 'stderr' not in kwargs:
85        kwargs['stderr'] = subprocess.PIPE
86    p = subprocess.Popen(popen_args, *args, **kwargs)
87    out, err = p.communicate(stdin_str)
88    if p.returncode:
89        raise subprocess.CalledProcessError(p.returncode, '%s, stdout: %s, stderr: %s' %
90                                            (popen_args, out, err))
91    return out
92
93#
94# Exceptions.
95#
96
97class InvalidInput(Exception):
98    """Exception for user-provided input is invalid but maybe in good faith.
99
100    This would include setting memory to negative (which might be a
101    typo) but not setting an invalid boot CD (which requires bypassing
102    the select box).
103    """
104    def __init__(self, err_field, err_value, expl=None):
105        Exception.__init__(self, expl)
106        self.err_field = err_field
107        self.err_value = err_value
108
109class CodeError(Exception):
110    """Exception for internal errors or bad faith input."""
111    pass
112
113#
114# Tests.
115#
116
117class common_tests(unittest.TestCase):
118    def test_dicts2structs(self):
119        dicts = {
120                'atom': 0,
121                'dict': { 'atom': 'atom', 'list': [1,2,3] },
122                'list': [ 'atom', {'key': 'value'} ]
123                }
124        structs = dicts2struct(dicts, '')
125        self.assertEqual(structs.atom,        dicts['atom'])
126        self.assertEqual(structs.dict.atom,   dicts['dict']['atom'])
127        self.assertEqual(structs.dict.list,   dicts['dict']['list'])
128        self.assertEqual(structs.list[0],     dicts['list'][0])
129        self.assertEqual(structs.list[1].key, dicts['list'][1]['key'])
130        self.assertEqual(set(structs), set(['atom', 'dict', 'list']))
131
132if __name__ == '__main__':
133    unittest.main()
Note: See TracBrowser for help on using the repository browser.