Fix typo in sh.CommandNotFound exception
[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 sh
35 import hashlib
36 import time
37 import os
38
39
40 class FatalError(Exception):
41     """Fatal Error exception of snf-image-creator"""
42     pass
43
44
45 def get_command(command):
46     """Return a file system binary 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 sh.Command(fullpath)
52         raise exception
53
54     try:
55         return sh.__getattr__(command)
56     except sh.CommandNotFound as e:
57         return find_sbin_command(command, e)
58
59
60 def try_fail_repeat(command, *args):
61     """Execute a command multiple times until it succeeds"""
62     times = (0.1, 0.5, 1, 2)
63     i = iter(times)
64     while True:
65         try:
66             command(*args)
67             return
68         except sh.ErrorReturnCode:
69             try:
70                 wait = i.next()
71             except StopIteration:
72                 break
73             time.sleep(wait)
74
75     raise FatalError("Command: `%s %s' failed" % (command, " ".join(args)))
76
77
78 def free_space(dirname):
79     """Compute the free space in a directory"""
80     stat = os.statvfs(dirname)
81     return stat.f_bavail * stat.f_frsize
82
83
84 class MD5:
85     """Represents MD5 computations"""
86     def __init__(self, output):
87         """Create an MD5 instance"""
88         self.out = output
89
90     def compute(self, filename, size):
91         """Compute the MD5 checksum of a file"""
92         MB = 2 ** 20
93         BLOCKSIZE = 4 * MB  # 4MB
94
95         prog_size = ((size + MB - 1) // MB)  # in MB
96         progressbar = self.out.Progress(prog_size, "Calculating md5sum", 'mb')
97         md5 = hashlib.md5()
98         with open(filename, "r") as src:
99             left = size
100             while left > 0:
101                 length = min(left, BLOCKSIZE)
102                 data = src.read(length)
103                 md5.update(data)
104                 left -= length
105                 progressbar.goto((size - left) // MB)
106
107         checksum = md5.hexdigest()
108         progressbar.success(checksum)
109
110         return checksum
111
112 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :