Add decorators defining sysprep params

[snf-image-creator] / image_creator / os_type / __init__.py

diff --git a/image_creator/os_type/__init__.py b/image_creator/os_type/__init__.py
index ec4f20d..7e6c452 100644 (file)
--- a/image_creator/os_type/__init__.py
+++ b/image_creator/os_type/__init__.py
@@ -41,6 +41,8 @@ from image_creator.util import FatalError
 
 import textwrap
 import re
+from collections import namedtuple
+from functools import wraps
 
 
 def os_cls(distro, osfamily):
@@ -66,23 +68,79 @@ def add_prefix(target):
     return wrapper
 
 
-def sysprep(enabled=True):
+def sysprep(message, enabled=True, **kwargs):
     """Decorator for system preparation tasks"""
     def wrapper(func):
         func.sysprep = True
         func.enabled = enabled
         func.executed = False
-        return func
+
+        for key, val in kwargs.items():
+            setattr(func, key, val)
+
+        @wraps(func)
+        def inner(self, print_message=True):
+            if print_message:
+                self.out.output(message)
+            return func(self)
+
+        return inner
+
+    return wrapper
+
+
+def add_sysprep_param(name, descr, maxlen, default=None,
+                      validator=lambda x: True):
+    """Decorator for init that adds the definition for a system preparation
+    parameter
+    """
+    def wrapper(func):
+
+        @wraps(func)
+        def inner(self, *args, **kwargs):
+
+            func(self, *args, **kwargs)
+
+            if not hasattr(self, 'needed_sysprep_params'):
+                self.needed_sysprep_params = {}
+            getattr(self, 'needed_sysprep_params')[name] = \
+                self.SysprepParam(descr, maxlen, validator)
+        return inner
+
+    return wrapper
+
+
+def del_sysprep_param(name):
+    """Decorator for init that deletes a previously added sysprep parameter
+    definition .
+    """
+    def wrapper(func):
+
+        @wraps(func)
+        def inner(self, *args, **kwargs):
+            del self.needed_sysprep_params[nam]
+            func(self, *args, **kwargs)
+
+        return inner
+
     return wrapper
 
 
 class OSBase(object):
     """Basic operating system class"""
 
-    def __init__(self, rootdev, ghandler, output):
-        self.root = rootdev
-        self.g = ghandler
-        self.out = output
+    SysprepParam = namedtuple('SysprepParam', 'description maxlen validator')
+
+    def __init__(self, image, **kargs):
+        self.image = image
+
+        self.root = image.root
+        self.g = image.g
+        self.out = image.out
+
+        self.sysprep_params = \
+            kargs['sysprep_params'] if 'sysprep_params' in kargs else {}
+
         self.meta = {}
 
     def collect_metadata(self):
@@ -110,7 +168,10 @@ class OSBase(object):
         """Returns information about a sysprep object"""
         assert self._is_sysprep(obj), "Object is not a sysprep"
 
-        return (obj.__name__.replace('_', '-'), textwrap.dedent(obj.__doc__))
+        SysprepInfo = namedtuple("SysprepInfo", "name description")
+
+        return SysprepInfo(obj.__name__.replace('_', '-'),
+                           textwrap.dedent(obj.__doc__))
 
     def get_sysprep_by_name(self, name):
         """Returns the sysprep object with the given name"""
@@ -167,6 +228,23 @@ class OSBase(object):
                 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
                 self.out.output('    %s:\n%s\n' % (name, descr))
 
+    def print_sysprep_params(self):
+        """Print the system preparation parameter the user may use"""
+
+        self.out.output("Needed system preparation parameters:")
+
+        params = self.needed_sysprep_params()
+
+        if len(params) == 0:
+            self.out.output("(none)")
+            return
+
+        for param in params:
+            self.out.output("\t%s (%s): %s" %
+                            (param.description, param.name,
+                             self.sysprep_params[param.name] if param.name in
+                             self.sysprep_params else "(none)"))
+
     def do_sysprep(self):
         """Prepare system for image creation."""