1 # -*- coding: utf-8 -*-
3 # Copyright 2012 GRNET S.A. All rights reserved.
5 # Redistribution and use in source and binary forms, with or
6 # without modification, are permitted provided that the following
9 # 1. Redistributions of source code must retain the above
10 # copyright notice, this list of conditions and the following
13 # 2. Redistributions in binary form must reproduce the above
14 # copyright notice, this list of conditions and the following
15 # disclaimer in the documentation and/or other materials
16 # provided with the distribution.
18 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
31 # The views and conclusions contained in the software and
32 # documentation are those of the authors and should not be
33 # interpreted as representing official policies, either expressed
34 # or implied, of GRNET S.A.
36 """This package provides various classes for preparing different Operating
37 Systems for image creation.
40 from image_creator.util import FatalError
44 from collections import namedtuple
45 from functools import wraps
48 def os_cls(distro, osfamily):
49 """Given the distro name and the osfamily, return the appropriate class"""
53 module = __import__("image_creator.os_type.%s" % distro,
54 fromlist=['image_creator.os_type'])
55 classname = distro.capitalize()
57 module = __import__("image_creator.os_type.%s" % osfamily,
58 fromlist=['image_creator.os_type'])
59 classname = osfamily.capitalize()
61 return getattr(module, classname)
64 def add_prefix(target):
65 """Decorator that adds a prefix to the result of a function"""
66 def wrapper(self, *args):
68 return [prefix + path for path in target(self, *args)]
72 def sysprep(message, enabled=True, **kwargs):
73 """Decorator for system preparation tasks"""
76 method.enabled = enabled
77 method.executed = False
79 for key, val in kwargs.items():
80 setattr(method, key, val)
83 def inner(self, print_message=True):
85 self.out.output(message)
92 def add_sysprep_param(name, type, default, descr, validate=lambda x: True):
93 """Decorator for __init__ that adds the definition for a system preparation
94 parameter in an instance of a os_type class
98 def inner(self, *args, **kwargs):
99 init(self, *args, **kwargs)
100 self.needed_sysprep_params[name] = \
101 self.SysprepParam(type, default, descr, validate)
102 if default is not None:
103 self.sysprep_params[name] = default
108 def del_sysprep_param(name):
109 """Decorator for __init__ that deletes a previously added sysprep parameter
110 definition from an instance of a os_type class.
114 def inner(self, *args, **kwargs):
115 del self.needed_sysprep_params[name]
116 func(self, *args, **kwargs)
121 class OSBase(object):
122 """Basic operating system class"""
124 SysprepParam = namedtuple('SysprepParam',
125 ['type', 'default', 'description', 'validate'])
127 def __init__(self, image, **kargs):
130 self.root = image.root
134 self.needed_sysprep_params = {}
135 self.sysprep_params = \
136 kargs['sysprep_params'] if 'sysprep_params' in kargs else {}
141 def collect_metadata(self):
142 """Collect metadata about the OS"""
144 if not self.mount(readonly=True):
145 raise FatalError("Unable to mount the media read-only")
147 self.out.output('Collecting image metadata ...', False)
148 self._do_collect_metadata()
149 self.out.success('done')
155 def list_syspreps(self):
156 """Returns a list of sysprep objects"""
157 objs = [getattr(self, name) for name in dir(self)
158 if not name.startswith('_')]
160 return [x for x in objs if self._is_sysprep(x) and x.executed is False]
162 def sysprep_info(self, obj):
163 """Returns information about a sysprep object"""
164 assert self._is_sysprep(obj), "Object is not a sysprep"
166 SysprepInfo = namedtuple("SysprepInfo", "name description")
168 return SysprepInfo(obj.__name__.replace('_', '-'),
169 textwrap.dedent(obj.__doc__))
171 def get_sysprep_by_name(self, name):
172 """Returns the sysprep object with the given name"""
173 error_msg = "Syprep operation %s does not exist for %s" % \
174 (name, self.__class__.__name__)
176 method_name = name.replace('-', '_')
179 method = getattr(self, method_name)
180 except AttributeError:
181 raise FatalError(error_msg)
183 if not self._is_sysprep(method):
184 raise FatalError(error_msg)
188 def enable_sysprep(self, obj):
189 """Enable a system preparation operation"""
190 setattr(obj.im_func, 'enabled', True)
192 def disable_sysprep(self, obj):
193 """Disable a system preparation operation"""
194 setattr(obj.im_func, 'enabled', False)
196 def print_syspreps(self):
197 """Print enabled and disabled system preparation operations."""
199 syspreps = self.list_syspreps()
200 enabled = [sysprep for sysprep in syspreps if sysprep.enabled]
201 disabled = [sysprep for sysprep in syspreps if not sysprep.enabled]
203 wrapper = textwrap.TextWrapper()
204 wrapper.subsequent_indent = '\t'
205 wrapper.initial_indent = '\t'
208 self.out.output("Enabled system preparation operations:")
209 if len(enabled) == 0:
210 self.out.output("(none)")
212 for sysprep in enabled:
213 name = sysprep.__name__.replace('_', '-')
214 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
215 self.out.output(' %s:\n%s\n' % (name, descr))
217 self.out.output("Disabled system preparation operations:")
218 if len(disabled) == 0:
219 self.out.output("(none)")
221 for sysprep in disabled:
222 name = sysprep.__name__.replace('_', '-')
223 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
224 self.out.output(' %s:\n%s\n' % (name, descr))
226 def print_sysprep_params(self):
227 """Print the system preparation parameter the user may use"""
229 self.out.output("Needed system preparation parameters:")
231 if len(self.needed_sysprep_params) == 0:
232 self.out.output("(none)")
235 for name, param in self.needed_sysprep_params.items():
236 self.out.output("\t%s (%s): %s" %
237 (param.description, name,
238 self.sysprep_params[name] if name in
239 self.sysprep_params else "(none)"))
241 def do_sysprep(self):
242 """Prepare system for image creation."""
245 if not self.mount(readonly=False):
246 raise FatalError("Unable to mount the media read-write")
248 self.out.output('Preparing system for image creation:')
250 enabled = [task for task in self.list_syspreps() if task.enabled]
256 self.out.output(('(%d/%d)' % (cnt, size)).ljust(7), False)
258 setattr(task.im_func, 'executed', True)
264 def mount(self, readonly=False):
267 if getattr(self, "mounted", False):
270 mount_type = 'read-only' if readonly else 'read-write'
271 self.out.output("Mounting the media %s ..." % mount_type, False)
273 if not self._do_mount(readonly):
277 self.out.success('done')
281 """Umount all mounted filesystems."""
283 self.out.output("Umounting the media ...", False)
286 self.out.success('done')
288 def _is_sysprep(self, obj):
289 """Checks if an object is a sysprep"""
290 return getattr(obj, 'sysprep', False) and callable(obj)
293 def _ls(self, directory):
294 """List the name of all files under a directory"""
295 return self.g.ls(directory)
298 def _find(self, directory):
299 """List the name of all files recursively under a directory"""
300 return self.g.find(directory)
302 def _foreach_file(self, directory, action, **kargs):
303 """Perform an action recursively on all files under a directory.
305 The following options are allowed:
307 * maxdepth: If defined the action will not be performed on
308 files that are below this level of directories under the
311 * ftype: The action will only be performed on files of this
312 type. For a list of all allowed filetypes, see here:
313 http://libguestfs.org/guestfs.3.html#guestfs_readdir
315 * exclude: Exclude all files that follow this pattern.
317 maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
322 maxdepth = None if maxdepth is None else maxdepth - 1
323 kargs['maxdepth'] = maxdepth
325 exclude = None if 'exclude' not in kargs else kargs['exclude']
326 ftype = None if 'ftype' not in kargs else kargs['ftype']
327 has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
329 for f in self.g.readdir(directory):
330 if f['name'] in ('.', '..'):
333 full_path = "%s/%s" % (directory, f['name'])
335 if exclude and re.match(exclude, full_path):
338 if has_ftype(f, 'd'):
339 self._foreach_file(full_path, action, **kargs)
341 if has_ftype(f, ftype):
344 def _do_collect_metadata(self):
345 """helper method for collect_metadata"""
346 self.meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
347 self.meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
348 self.meta['OS'] = self.g.inspect_get_distro(self.root)
349 if self.meta['OS'] == "unknown":
350 self.meta['OS'] = self.meta['OSFAMILY']
351 self.meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
353 def _do_mount(self, readonly):
354 """helper method for mount"""
356 self.g.mount_options('ro' if readonly else 'rw', self.root, '/')
357 except RuntimeError as msg:
358 self.out.warn("unable to mount the root partition: %s" % msg)
363 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :