Bump version to 0.2.2
[snf-image-creator] / 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     module = None
42     classname = None
43     try:
44         module = __import__("image_creator.os_type.%s" % distro,
45                             fromlist=['image_creator.os_type'])
46         classname = distro.capitalize()
47     except ImportError:
48         module = __import__("image_creator.os_type.%s" % osfamily,
49                             fromlist=['image_creator.os_type'])
50         classname = osfamily.capitalize()
51
52     return getattr(module, classname)
53
54
55 def add_prefix(target):
56     def wrapper(self, *args):
57         prefix = args[0]
58         return map(lambda x: prefix + x, target(self, *args))
59     return wrapper
60
61
62 def sysprep(enabled=True):
63     def wrapper(func):
64         func.sysprep = True
65         func.enabled = enabled
66         return func
67     return wrapper
68
69
70 class OSBase(object):
71     """Basic operating system class"""
72
73     def __init__(self, rootdev, ghandler, output):
74         self.root = rootdev
75         self.g = ghandler
76         self.out = output
77
78         # Collect metadata about the OS
79         self.meta = {}
80         self.meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
81         self.meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
82         self.meta['OS'] = self.g.inspect_get_distro(self.root)
83         self.meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
84
85     def _is_sysprep(self, obj):
86         return getattr(obj, 'sysprep', False) and callable(obj)
87
88     def list_syspreps(self):
89
90         objs = [getattr(self, name) for name in dir(self)
91                 if not name.startswith('_')]
92
93         return [x for x in objs if self._is_sysprep(x)]
94
95     def sysprep_info(self, obj):
96         assert self._is_sysprep(obj), "Object is not a sysprep"
97
98         return (obj.__name__.replace('_', '-'), textwrap.dedent(obj.__doc__))
99
100     def get_sysprep_by_name(self, name):
101         """Returns the sysprep object with the given name"""
102         error_msg = "Syprep operation %s does not exist for %s" % \
103                     (name, self.__class__.__name__)
104
105         method_name = name.replace('-', '_')
106         method = None
107         try:
108             method = getattr(self, method_name)
109         except AttributeError:
110             raise FatalError(error_msg)
111
112         if not self._is_sysprep(method):
113             raise FatalError(error_msg)
114
115         return method
116
117     def enable_sysprep(self, obj):
118         """Enable a system preparation operation"""
119         setattr(obj.im_func, 'enabled', True)
120
121     def disable_sysprep(self, obj):
122         """Disable a system preparation operation"""
123         setattr(obj.im_func, 'enabled', False)
124
125     def print_syspreps(self):
126         """Print enabled and disabled system preparation operations."""
127
128         syspreps = self.list_syspreps()
129         enabled = filter(lambda x: x.enabled, syspreps)
130         disabled = filter(lambda x: not x.enabled, syspreps)
131
132         wrapper = textwrap.TextWrapper()
133         wrapper.subsequent_indent = '\t'
134         wrapper.initial_indent = '\t'
135         wrapper.width = 72
136
137         self.out.output("Enabled system preparation operations:")
138         if len(enabled) == 0:
139             self.out.output("(none)")
140         else:
141             for sysprep in enabled:
142                 name = sysprep.__name__.replace('_', '-')
143                 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
144                 self.out.output('    %s:\n%s\n' % (name, descr))
145
146         self.out.output("Disabled system preparation operations:")
147         if len(disabled) == 0:
148             self.out.output("(none)")
149         else:
150             for sysprep in disabled:
151                 name = sysprep.__name__.replace('_', '-')
152                 descr = wrapper.fill(textwrap.dedent(sysprep.__doc__))
153                 self.out.output('    %s:\n%s\n' % (name, descr))
154
155     @add_prefix
156     def ls(self, directory):
157         """List the name of all files under a directory"""
158         return self.g.ls(directory)
159
160     @add_prefix
161     def find(self, directory):
162         """List the name of all files recursively under a directory"""
163         return self.g.find(directory)
164
165     def foreach_file(self, directory, action, **kargs):
166         """Perform an action recursively on all files under a directory.
167
168         The following options are allowed:
169
170         * maxdepth: If defined the action will not be performed on
171           files that are below this level of directories under the
172           directory parameter.
173
174         * ftype: The action will only be performed on files of this
175           type. For a list of all allowed filetypes, see here:
176           http://libguestfs.org/guestfs.3.html#guestfs_readdir
177
178         * exclude: Exclude all files that follow this pattern.
179         """
180         maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
181         if maxdepth == 0:
182             return
183
184         # maxdepth -= 1
185         maxdepth = None if maxdepth is None else maxdepth - 1
186         kargs['maxdepth'] = maxdepth
187
188         exclude = None if 'exclude' not in kargs else kargs['exclude']
189         ftype = None if 'ftype' not in kargs else kargs['ftype']
190         has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
191
192         for f in self.g.readdir(directory):
193             if f['name'] in ('.', '..'):
194                 continue
195
196             full_path = "%s/%s" % (directory, f['name'])
197
198             if exclude and re.match(exclude, full_path):
199                 continue
200
201             if has_ftype(f, 'd'):
202                 self.foreach_file(full_path, action, **kargs)
203
204             if has_ftype(f, ftype):
205                 action(full_path)
206
207     def do_sysprep(self):
208         """Prepere system for image creation."""
209
210         self.out.output('Preparing system for image creation:')
211
212         tasks = self.list_syspreps()
213         enabled = filter(lambda x: x.enabled, tasks)
214
215         size = len(enabled)
216         cnt = 0
217         for task in enabled:
218             cnt += 1
219             self.out.output(('(%d/%d)' % (cnt, size)).ljust(7), False)
220             task()
221         self.out.output()
222
223 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :