code.grnet.gr Git - snf-image-creator/blob - image_creator/os_type/__init__.py

   1 # Copyright 2012 GRNET S.A. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or
   4 # without modification, are permitted provided that the following
   5 # conditions are met:
   6 #
   7 #   1. Redistributions of source code must retain the above
   8 #      copyright notice, this list of conditions and the following
   9 #      disclaimer.
  10 #
  11 #   2. Redistributions in binary form must reproduce the above
  12 #      copyright notice, this list of conditions and the following
  13 #      disclaimer in the documentation and/or other materials
  14 #      provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 # POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # The views and conclusions contained in the software and
  30 # documentation are those of the authors and should not be
  31 # interpreted as representing official policies, either expressed
  32 # or implied, of GRNET S.A.
  33
  34 from image_creator.util import FatalError
  35
  36 import textwrap
  37 import re
  38
  39
  40 def os_cls(distro, osfamily):
  41     """Given the distro name and the osfamily, return the appropriate class"""
  42     module = None
  43     classname = None
  44     try:
  45         module = __import__("image_creator.os_type.%s" % distro,
  46                             fromlist=['image_creator.os_type'])
  47         classname = distro.capitalize()
  48     except ImportError:
  49         module = __import__("image_creator.os_type.%s" % osfamily,
  50                             fromlist=['image_creator.os_type'])
  51         classname = osfamily.capitalize()
  52
  53     return getattr(module, classname)
  54
  55
  56 def add_prefix(target):
  57     def wrapper(self, *args):
  58         prefix = args[0]
  59         return map(lambda x: prefix + x, target(self, *args))
  60     return wrapper
  61
  62
  63 def sysprep(enabled=True):
  64     """Decorator for system preparation tasks"""
  65     def wrapper(func):
  66         func.sysprep = True
  67         func.enabled = enabled
  68         return func
  69     return wrapper
  70
  71
  72 class OSBase(object):
  73     """Basic operating system class"""
  74
  75     def __init__(self, rootdev, ghandler, output):
  76         self.root = rootdev
  77         self.g = ghandler
  78         self.out = output
  79
  80         # Collect metadata about the OS
  81         self.meta = {}
  82         self.meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
  83         self.meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
  84         self.meta['OS'] = self.g.inspect_get_distro(self.root)
  85         self.meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
  86
  87     def _is_sysprep(self, obj):
  88         return getattr(obj, 'sysprep', False) and callable(obj)
  89
  90     def list_syspreps(self):
  91
  92         objs = [getattr(self, name) for name in dir(self)
  93                 if not name.startswith('_')]
  94
  95         return [x for x in objs if self._is_sysprep(x)]
  96
  97     def sysprep_info(self, obj):
  98         assert self._is_sysprep(obj), "Object is not a sysprep"
  99
 100         return (obj.__name__.replace('_', '-'), textwrap.dedent(obj.__doc__))
 101
 102     def get_sysprep_by_name(self, name):
 103         """Returns the sysprep object with the given name"""
 104         error_msg = "Syprep operation %s does not exist for %s" % \
 105                     (name, self.__class__.__name__)
 106
 107         method_name = name.replace('-', '_')
 108         method = None
 109         try:
 110             method = getattr(self, method_name)
 111         except AttributeError:
 112             raise FatalError(error_msg)
 113
 114         if not self._is_sysprep(method):
 115             raise FatalError(error_msg)
 116
 117         return method
 118
 119     def enable_sysprep(self, obj):
 120         """Enable a system preparation operation"""
 121         setattr(obj.im_func, 'enabled', True)
 122
 123     def disable_sysprep(self, obj):
 124         """Disable a system preparation operation"""
 125         setattr(obj.im_func, 'enabled', False)
 126
 127     def print_syspreps(self):
 128         """Print enabled and disabled system preparation operations."""
 129
 130         syspreps = self.list_syspreps()
 131         enabled = filter(lambda x: x.enabled, syspreps)
 132         disabled = filter(lambda x: not x.enabled, syspreps)
 133
 134         wrapper = textwrap.TextWrapper()
 135         wrapper.subsequent_indent = '\t'
 136         wrapper.initial_indent = '\t'
 137         wrapper.width = 72
 138
 139         self.out.output("Enabled system preparation operations:")
 140         if len(enabled) == 0:
 141             self.out.output("(none)")
 142         else:
 143             for sysprep in enabled:
 144                 name = sysprep.__name__.replace('_', '-')
 145                 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
 146                 self.out.output('    %s:\n%s\n' % (name, descr))
 147
 148         self.out.output("Disabled system preparation operations:")
 149         if len(disabled) == 0:
 150             self.out.output("(none)")
 151         else:
 152             for sysprep in disabled:
 153                 name = sysprep.__name__.replace('_', '-')
 154                 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
 155                 self.out.output('    %s:\n%s\n' % (name, descr))
 156
 157     @add_prefix
 158     def ls(self, directory):
 159         """List the name of all files under a directory"""
 160         return self.g.ls(directory)
 161
 162     @add_prefix
 163     def find(self, directory):
 164         """List the name of all files recursively under a directory"""
 165         return self.g.find(directory)
 166
 167     def foreach_file(self, directory, action, **kargs):
 168         """Perform an action recursively on all files under a directory.
 169
 170         The following options are allowed:
 171
 172         * maxdepth: If defined the action will not be performed on
 173           files that are below this level of directories under the
 174           directory parameter.
 175
 176         * ftype: The action will only be performed on files of this
 177           type. For a list of all allowed filetypes, see here:
 178           http://libguestfs.org/guestfs.3.html#guestfs_readdir
 179
 180         * exclude: Exclude all files that follow this pattern.
 181         """
 182         maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
 183         if maxdepth == 0:
 184             return
 185
 186         # maxdepth -= 1
 187         maxdepth = None if maxdepth is None else maxdepth - 1
 188         kargs['maxdepth'] = maxdepth
 189
 190         exclude = None if 'exclude' not in kargs else kargs['exclude']
 191         ftype = None if 'ftype' not in kargs else kargs['ftype']
 192         has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
 193
 194         for f in self.g.readdir(directory):
 195             if f['name'] in ('.', '..'):
 196                 continue
 197
 198             full_path = "%s/%s" % (directory, f['name'])
 199
 200             if exclude and re.match(exclude, full_path):
 201                 continue
 202
 203             if has_ftype(f, 'd'):
 204                 self.foreach_file(full_path, action, **kargs)
 205
 206             if has_ftype(f, ftype):
 207                 action(full_path)
 208
 209     def do_sysprep(self):
 210         """Prepere system for image creation."""
 211
 212         self.out.output('Preparing system for image creation:')
 213
 214         tasks = self.list_syspreps()
 215         enabled = filter(lambda x: x.enabled, tasks)
 216
 217         size = len(enabled)
 218         cnt = 0
 219         for task in enabled:
 220             cnt += 1
 221             self.out.output(('(%d/%d)' % (cnt, size)).ljust(7), False)
 222             task()
 223         self.out.output()
 224
 225 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :