X-Git-Url: http://xvm.mit.edu/gitweb/invirt/packages/invirt-base.git/blobdiff_plain/f2acfa0565a11ed251ad390461a5c428640681c2..59f4105b3f9c76abb0017ce6a4834408e32767a4:/python/invirt/common.py

diff --git a/python/invirt/common.py b/python/invirt/common.py
index 77770a6..603b7f3 100644
--- a/python/invirt/common.py
+++ b/python/invirt/common.py
@@ -3,23 +3,51 @@ from __future__ import with_statement
 import unittest
 from fcntl import flock, LOCK_EX, LOCK_SH, LOCK_UN
 import contextlib as clib
+import subprocess
+
+class InvirtConfigError(AttributeError):
+    pass
 
 class struct(object):
     'A simple namespace object.'
-    def __init__(self, d = {}, **kwargs):
-        'd is the dictionary to update my __dict__ with.'
-        self.__dict__.update(d)
-        self.__dict__.update(kwargs)
+    def __init__(self, d = {}, __prefix = None, **kwargs):
+        'd is the dictionary or the items-iterable to update my __dict__ with.'
+        dct = {}
+        dct.update(d)
+        dct.update(kwargs)
+        self.__dict__.update(dct)
+        self.__keys = set(dct)
+        self.__prefix = __prefix
+    def __getattr__(self, key):
+        # XX ideally these would point a frame higher on the stack.
+        prefix = self.__prefix
+        if prefix is not None:
+            raise InvirtConfigError('missing configuration variable %s%s'
+                                    % (prefix, key))
+        else:
+            raise AttributeError("anonymous struct has no member '%s'"
+                                 % (key,))
+    def __iter__(self):
+        for i in self.__keys:
+            yield i
 
-def dicts2struct(x):
+def dicts2struct(x, prefix = None):
     """
     Given a tree of lists/dicts, perform a deep traversal to transform all the
     dicts to structs.
     """
+    if prefix is not None:
+        def newprefix(k): return prefix + str(k) + '.'
+    else:
+        def newprefix(k): return prefix
     if type(x) == dict:
-        return struct((k, dicts2struct(v)) for k,v in x.iteritems())
+        return struct(((k, dicts2struct(v, newprefix(k)))
+                       for k,v in x.iteritems()),
+                      prefix)
     elif type(x) == list:
-        return [dicts2struct(v) for v in x]
+        return [dicts2struct(v, newprefix(i)) for i, v in enumerate(x)]
+    elif x is None:
+        return struct({}, prefix)
     else:
         return x
 
@@ -36,6 +64,49 @@ def lock_file(path, exclusive = True):
         finally:
             flock(f, LOCK_UN)
 
+def captureOutput(popen_args, stdin_str=None, *args, **kwargs):
+    """Capture stdout from a command.
+
+    This method will proxy the arguments to subprocess.Popen. It
+    returns the output from the command if the call succeeded and
+    raises an exception if the process returns a non-0 value.
+
+    This is intended to be a variant on the subprocess.check_call
+    function that also allows you access to the output from the
+    command.
+    """
+    if 'stdin' not in kwargs:
+        kwargs['stdin'] = subprocess.PIPE
+    if 'stdout' not in kwargs:
+        kwargs['stdout'] = subprocess.PIPE
+    if 'stderr' not in kwargs:
+        kwargs['stderr'] = subprocess.STDOUT
+    p = subprocess.Popen(popen_args, *args, **kwargs)
+    out, _ = p.communicate(stdin_str)
+    if p.returncode:
+        raise subprocess.CalledProcessError(p.returncode, popen_args, out)
+    return out
+
+#
+# Exceptions.
+#
+
+class InvalidInput(Exception):
+    """Exception for user-provided input is invalid but maybe in good faith.
+
+    This would include setting memory to negative (which might be a
+    typo) but not setting an invalid boot CD (which requires bypassing
+    the select box).
+    """
+    def __init__(self, err_field, err_value, expl=None):
+        Exception.__init__(self, expl)
+        self.err_field = err_field
+        self.err_value = err_value
+
+class CodeError(Exception):
+    """Exception for internal errors or bad faith input."""
+    pass
+
 #
 # Tests.
 #
@@ -47,12 +118,13 @@ class common_tests(unittest.TestCase):
                 'dict': { 'atom': 'atom', 'list': [1,2,3] },
                 'list': [ 'atom', {'key': 'value'} ]
                 }
-        structs = dicts2struct(dicts)
+        structs = dicts2struct(dicts, '')
         self.assertEqual(structs.atom,        dicts['atom'])
         self.assertEqual(structs.dict.atom,   dicts['dict']['atom'])
         self.assertEqual(structs.dict.list,   dicts['dict']['list'])
         self.assertEqual(structs.list[0],     dicts['list'][0])
         self.assertEqual(structs.list[1].key, dicts['list'][1]['key'])
+        self.assertEqual(set(structs), set(['atom', 'dict', 'list']))
 
 if __name__ == '__main__':
     unittest.main()