1 # Copyright 2012 GRNET S.A. All rights reserved.
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
7 # 1. Redistributions of source code must retain the above
8 # copyright notice, this list of conditions and the following
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.
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.
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.
34 from image_creator.util import FatalError
40 def os_cls(distro, osfamily):
41 """Given the distro name and the osfamily, return the appropriate class"""
45 module = __import__("image_creator.os_type.%s" % distro,
46 fromlist=['image_creator.os_type'])
47 classname = distro.capitalize()
49 module = __import__("image_creator.os_type.%s" % osfamily,
50 fromlist=['image_creator.os_type'])
51 classname = osfamily.capitalize()
53 return getattr(module, classname)
56 def add_prefix(target):
57 def wrapper(self, *args):
59 return map(lambda x: prefix + x, target(self, *args))
63 def sysprep(enabled=True):
64 """Decorator for system preparation tasks"""
67 func.enabled = enabled
74 """Basic operating system class"""
76 def __init__(self, rootdev, ghandler, output):
81 # Collect metadata about the OS
83 self.meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
84 self.meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
85 self.meta['OS'] = self.g.inspect_get_distro(self.root)
86 if self.meta['OS'] == "unknown":
87 self.meta['OS'] = self.meta['OSFAMILY']
88 self.meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
90 def _is_sysprep(self, obj):
91 return getattr(obj, 'sysprep', False) and callable(obj)
93 def list_syspreps(self):
95 objs = [getattr(self, name) for name in dir(self)
96 if not name.startswith('_')]
98 return [x for x in objs if self._is_sysprep(x) and x.executed is False]
100 def sysprep_info(self, obj):
101 assert self._is_sysprep(obj), "Object is not a sysprep"
103 return (obj.__name__.replace('_', '-'), textwrap.dedent(obj.__doc__))
105 def get_sysprep_by_name(self, name):
106 """Returns the sysprep object with the given name"""
107 error_msg = "Syprep operation %s does not exist for %s" % \
108 (name, self.__class__.__name__)
110 method_name = name.replace('-', '_')
113 method = getattr(self, method_name)
114 except AttributeError:
115 raise FatalError(error_msg)
117 if not self._is_sysprep(method):
118 raise FatalError(error_msg)
122 def enable_sysprep(self, obj):
123 """Enable a system preparation operation"""
124 setattr(obj.im_func, 'enabled', True)
126 def disable_sysprep(self, obj):
127 """Disable a system preparation operation"""
128 setattr(obj.im_func, 'enabled', False)
130 def print_syspreps(self):
131 """Print enabled and disabled system preparation operations."""
133 syspreps = self.list_syspreps()
134 enabled = filter(lambda x: x.enabled, syspreps)
135 disabled = filter(lambda x: not x.enabled, syspreps)
137 wrapper = textwrap.TextWrapper()
138 wrapper.subsequent_indent = '\t'
139 wrapper.initial_indent = '\t'
142 self.out.output("Enabled system preparation operations:")
143 if len(enabled) == 0:
144 self.out.output("(none)")
146 for sysprep in enabled:
147 name = sysprep.__name__.replace('_', '-')
148 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
149 self.out.output(' %s:\n%s\n' % (name, descr))
151 self.out.output("Disabled system preparation operations:")
152 if len(disabled) == 0:
153 self.out.output("(none)")
155 for sysprep in disabled:
156 name = sysprep.__name__.replace('_', '-')
157 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
158 self.out.output(' %s:\n%s\n' % (name, descr))
161 def ls(self, directory):
162 """List the name of all files under a directory"""
163 return self.g.ls(directory)
166 def find(self, directory):
167 """List the name of all files recursively under a directory"""
168 return self.g.find(directory)
170 def foreach_file(self, directory, action, **kargs):
171 """Perform an action recursively on all files under a directory.
173 The following options are allowed:
175 * maxdepth: If defined the action will not be performed on
176 files that are below this level of directories under the
179 * ftype: The action will only be performed on files of this
180 type. For a list of all allowed filetypes, see here:
181 http://libguestfs.org/guestfs.3.html#guestfs_readdir
183 * exclude: Exclude all files that follow this pattern.
185 maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
190 maxdepth = None if maxdepth is None else maxdepth - 1
191 kargs['maxdepth'] = maxdepth
193 exclude = None if 'exclude' not in kargs else kargs['exclude']
194 ftype = None if 'ftype' not in kargs else kargs['ftype']
195 has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
197 for f in self.g.readdir(directory):
198 if f['name'] in ('.', '..'):
201 full_path = "%s/%s" % (directory, f['name'])
203 if exclude and re.match(exclude, full_path):
206 if has_ftype(f, 'd'):
207 self.foreach_file(full_path, action, **kargs)
209 if has_ftype(f, ftype):
212 def do_sysprep(self):
213 """Prepere system for image creation."""
215 self.out.output('Preparing system for image creation:')
217 tasks = self.list_syspreps()
218 enabled = filter(lambda x: x.enabled, tasks)
224 self.out.output(('(%d/%d)' % (cnt, size)).ljust(7), False)
226 setattr(task.im_func, 'executed', True)
229 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :