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 output
  35
  36 import re
  37
  38
  39 def add_prefix(target):
  40     def wrapper(self, *args):
  41         prefix = args[0]
  42         return map(lambda x: prefix + x, target(self, *args))
  43     return wrapper
  44
  45
  46 class OSBase(object):
  47     """Basic operating system class"""
  48     def __init__(self, rootdev, ghandler):
  49         self.root = rootdev
  50         self.g = ghandler
  51
  52     @add_prefix
  53     def ls(self, directory):
  54         """List the name of all files under a directory"""
  55         return self.g.ls(directory)
  56
  57     @add_prefix
  58     def find(self, directory):
  59         """List the name of all files recursively under a directory"""
  60         return self.g.find(directory)
  61
  62     def foreach_file(self, directory, action, **kargs):
  63         """Perform an action recursively on all files under a directory.
  64
  65         The following options are allowed:
  66
  67         * maxdepth: If defined the action will not be performed on
  68           files that are below this level of directories under the
  69           directory parameter.
  70
  71         * ftype: The action will only be performed on files of this
  72           type. For a list of all allowed filetypes, see here:
  73           http://libguestfs.org/guestfs.3.html#guestfs_readdir
  74
  75         * exclude: Exclude all files that follow this pattern.
  76         """
  77         maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
  78         if maxdepth == 0:
  79             return
  80
  81         # maxdepth -= 1
  82         maxdepth = None if maxdepth is None else maxdepth - 1
  83         kargs['maxdepth'] = maxdepth
  84
  85         exclude = None if 'exclude' not in kargs else kargs['exclude']
  86         ftype = None if 'ftype' not in kargs else kargs['ftype']
  87         has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
  88
  89         for f in self.g.readdir(directory):
  90             if f['name'] in ('.', '..'):
  91                 continue
  92
  93             full_path = "%s/%s" % (directory, f['name'])
  94
  95             if exclude and re.match(exclude, full_path):
  96                 continue
  97
  98             if has_ftype(f, 'd'):
  99                 self.foreach_file(full_path, action, **kargs)
 100
 101             if has_ftype(f, ftype):
 102                 action(full_path)
 103
 104     def get_metadata(self):
 105         """Returns some descriptive metadata about the OS."""
 106         meta = {}
 107         meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
 108         meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
 109         meta['OS'] = self.g.inspect_get_distro(self.root)
 110         meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
 111
 112         return meta
 113
 114     def data_cleanup(self):
 115         """Cleanup sensitive data out of the OS image."""
 116
 117         output('Cleaning up sensitive data out of the OS image:')
 118
 119         is_cleanup = lambda x: x.startswith('data_cleanup_') and \
 120                                                     callable(getattr(self, x))
 121         tasks = [getattr(self, x) for x in dir(self) if is_cleanup(x)]
 122         size = len(tasks)
 123         cnt = 0
 124         for task in tasks:
 125             cnt += 1
 126             output(('(%d/%d)' % (cnt, size)).ljust(7), False)
 127             task()
 128         output()
 129
 130     def sysprep(self):
 131         """Prepere system for image creation."""
 132
 133         output('Preparing system for image creation:')
 134
 135         is_sysprep = lambda x: x.startswith('sysprep_') and \
 136                                                     callable(getattr(self, x))
 137         tasks = [getattr(self, x) for x in dir(self) if is_sysprep(x)]
 138         size = len(tasks)
 139         cnt = 0
 140         for task in tasks:
 141             cnt += 1
 142             output(('(%d/%d)' % (cnt, size)).ljust(7), False)
 143             task()
 144         output()
 145
 146 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :