Add options for enabling/disabling sysprep tasks
[snf-image-creator] / image_creator / util.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 import sys
35 import pbs
36 from clint.textui import colored, progress as uiprogress
37
38
39 class FatalError(Exception):
40     pass
41
42
43 silent = False
44
45
46 def get_command(command):
47     def find_sbin_command(command, exception):
48         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
49         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
50             if os.path.exists(fullpath) and os.access(fullpath, os.X_OK):
51                 return pbs.Command(fullpath)
52         raise exception
53
54     try:
55         return pbs.__getattr__(command)
56     except pbs.CommadNotFount as e:
57         return find_sbin_command(command, e)
58
59
60 def error(msg, new_line=True):
61     nl = "\n" if new_line else ''
62     sys.stderr.write(colored.red('Error: %s' % msg) + nl)
63
64
65 def warn(msg, new_line=True):
66     if not silent:
67         nl = "\n" if new_line else ''
68         sys.stderr.write(colored.yellow("Warning: %s" % msg) + nl)
69
70
71 def success(msg, new_line=True):
72     if not silent:
73         nl = "\n" if new_line else ''
74         sys.stdout.write(colored.green(msg) + nl)
75         if not nl:
76             sys.stdout.flush()
77
78
79 def output(msg="", new_line=True):
80     if not silent:
81         nl = "\n" if new_line else ''
82         sys.stdout.write(msg + nl)
83         if not nl:
84             sys.stdout.flush()
85
86
87 def progress(label='', n=100):
88
89     PROGRESS_LENGTH = 32
90     MESSAGE_LENGTH = 32
91
92     def progress_generator(label, n):
93         position = 0
94         for i in uiprogress.bar(range(n), label.ljust(MESSAGE_LENGTH), \
95                                                     PROGRESS_LENGTH, silent):
96             if i < position:
97                 continue
98             position = yield
99         yield  # suppress the StopIteration exception
100     return progress_generator(label, n)
101
102 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :