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
47 def os_cls(distro, osfamily):
48 """Given the distro name and the osfamily, return the appropriate class"""
52 module = __import__("image_creator.os_type.%s" % distro,
53 fromlist=['image_creator.os_type'])
54 classname = distro.capitalize()
56 module = __import__("image_creator.os_type.%s" % osfamily,
57 fromlist=['image_creator.os_type'])
58 classname = osfamily.capitalize()
60 return getattr(module, classname)
63 def add_prefix(target):
64 def wrapper(self, *args):
66 return map(lambda x: prefix + x, target(self, *args))
70 def sysprep(enabled=True):
71 """Decorator for system preparation tasks"""
74 func.enabled = enabled
81 """Basic operating system class"""
83 SysprepParam = namedtuple('SysprepParam',
84 'name description length validator')
86 def __init__(self, image, **kargs):
89 self.root = image.root
93 self.sysprep_params = \
94 kargs['sysprep_params'] if 'sysprep_params' in kargs else {}
98 def collect_metadata(self):
99 """Collect metadata about the OS"""
101 if not self.mount(readonly=True):
102 raise FatalError("Unable to mount the media read-only")
104 self.out.output('Collecting image metadata ...', False)
105 self._do_collect_metadata()
106 self.out.success('done')
112 def needed_sysprep_params(self):
113 """Returns a list of needed sysprep parameters. Each element in the
114 list is a SysprepParam object.
118 def list_syspreps(self):
119 """Returns a list of sysprep objects"""
120 objs = [getattr(self, name) for name in dir(self)
121 if not name.startswith('_')]
123 return [x for x in objs if self._is_sysprep(x) and x.executed is False]
125 def sysprep_info(self, obj):
126 """Returns information about a sysprep object"""
127 assert self._is_sysprep(obj), "Object is not a sysprep"
129 return (obj.__name__.replace('_', '-'), textwrap.dedent(obj.__doc__))
131 def get_sysprep_by_name(self, name):
132 """Returns the sysprep object with the given name"""
133 error_msg = "Syprep operation %s does not exist for %s" % \
134 (name, self.__class__.__name__)
136 method_name = name.replace('-', '_')
139 method = getattr(self, method_name)
140 except AttributeError:
141 raise FatalError(error_msg)
143 if not self._is_sysprep(method):
144 raise FatalError(error_msg)
148 def enable_sysprep(self, obj):
149 """Enable a system preparation operation"""
150 setattr(obj.im_func, 'enabled', True)
152 def disable_sysprep(self, obj):
153 """Disable a system preparation operation"""
154 setattr(obj.im_func, 'enabled', False)
156 def print_syspreps(self):
157 """Print enabled and disabled system preparation operations."""
159 syspreps = self.list_syspreps()
160 enabled = filter(lambda x: x.enabled, syspreps)
161 disabled = filter(lambda x: not x.enabled, syspreps)
163 wrapper = textwrap.TextWrapper()
164 wrapper.subsequent_indent = '\t'
165 wrapper.initial_indent = '\t'
168 self.out.output("Enabled system preparation operations:")
169 if len(enabled) == 0:
170 self.out.output("(none)")
172 for sysprep in enabled:
173 name = sysprep.__name__.replace('_', '-')
174 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
175 self.out.output(' %s:\n%s\n' % (name, descr))
177 self.out.output("Disabled system preparation operations:")
178 if len(disabled) == 0:
179 self.out.output("(none)")
181 for sysprep in disabled:
182 name = sysprep.__name__.replace('_', '-')
183 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
184 self.out.output(' %s:\n%s\n' % (name, descr))
186 def print_sysprep_params(self):
187 """Print the system preparation parameter the user may use"""
189 self.out.output("Needed system preparation parameters:")
191 params = self.needed_sysprep_params()
194 self.out.output("(none)")
198 self.out.output("\t%s (%s): %s" %
199 (param.description, param.name,
200 self.sysprep_params[param.name] if param.name in
201 self.sysprep_params else "(none)"))
203 def do_sysprep(self):
204 """Prepare system for image creation."""
207 if not self.mount(readonly=False):
208 raise FatalError("Unable to mount the media read-write")
210 self.out.output('Preparing system for image creation:')
212 tasks = self.list_syspreps()
213 enabled = filter(lambda x: x.enabled, tasks)
219 self.out.output(('(%d/%d)' % (cnt, size)).ljust(7), False)
221 setattr(task.im_func, 'executed', True)
227 def mount(self, readonly=False):
230 if getattr(self, "mounted", False):
233 mount_type = 'read-only' if readonly else 'read-write'
234 self.out.output("Mounting the media %s ..." % mount_type, False)
236 if not self._do_mount(readonly):
240 self.out.success('done')
244 """Umount all mounted filesystems."""
246 self.out.output("Umounting the media ...", False)
249 self.out.success('done')
251 def _is_sysprep(self, obj):
252 """Checks if an object is a sysprep"""
253 return getattr(obj, 'sysprep', False) and callable(obj)
256 def _ls(self, directory):
257 """List the name of all files under a directory"""
258 return self.g.ls(directory)
261 def _find(self, directory):
262 """List the name of all files recursively under a directory"""
263 return self.g.find(directory)
265 def _foreach_file(self, directory, action, **kargs):
266 """Perform an action recursively on all files under a directory.
268 The following options are allowed:
270 * maxdepth: If defined the action will not be performed on
271 files that are below this level of directories under the
274 * ftype: The action will only be performed on files of this
275 type. For a list of all allowed filetypes, see here:
276 http://libguestfs.org/guestfs.3.html#guestfs_readdir
278 * exclude: Exclude all files that follow this pattern.
280 maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
285 maxdepth = None if maxdepth is None else maxdepth - 1
286 kargs['maxdepth'] = maxdepth
288 exclude = None if 'exclude' not in kargs else kargs['exclude']
289 ftype = None if 'ftype' not in kargs else kargs['ftype']
290 has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
292 for f in self.g.readdir(directory):
293 if f['name'] in ('.', '..'):
296 full_path = "%s/%s" % (directory, f['name'])
298 if exclude and re.match(exclude, full_path):
301 if has_ftype(f, 'd'):
302 self._foreach_file(full_path, action, **kargs)
304 if has_ftype(f, ftype):
307 def _do_collect_metadata(self):
308 """helper method for collect_metadata"""
309 self.meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
310 self.meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
311 self.meta['OS'] = self.g.inspect_get_distro(self.root)
312 if self.meta['OS'] == "unknown":
313 self.meta['OS'] = self.meta['OSFAMILY']
314 self.meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
316 def _do_mount(self, readonly):
317 """helper method for mount"""
319 self.g.mount_options('ro' if readonly else 'rw', self.root, '/')
320 except RuntimeError as msg:
321 self.out.warn("unable to mount the root partition: %s" % msg)
326 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :