code.grnet.gr Git - snf-image-creator/blob - image_creator/util.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright 2012 GRNET S.A. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or
   6 # without modification, are permitted provided that the following
   7 # conditions are met:
   8 #
   9 #   1. Redistributions of source code must retain the above
  10 #      copyright notice, this list of conditions and the following
  11 #      disclaimer.
  12 #
  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.
  17 #
  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.
  30 #
  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.
  35
  36 """This module provides various helper functions to be used by other parts of
  37 the package.
  38 """
  39
  40 import sh
  41 import hashlib
  42 import time
  43 import os
  44 import re
  45
  46
  47 class FatalError(Exception):
  48     """Fatal Error exception of snf-image-creator"""
  49     pass
  50
  51
  52 def get_command(command):
  53     """Return a file system binary command"""
  54     def find_sbin_command(command, exception):
  55         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
  56         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
  57             if os.path.exists(fullpath) and os.access(fullpath, os.X_OK):
  58                 return sh.Command(fullpath)
  59         raise exception
  60
  61     try:
  62         return sh.__getattr__(command)
  63     except sh.CommandNotFound as e:
  64         return find_sbin_command(command, e)
  65
  66
  67 def get_kvm_binary():
  68     """Returns the path to the kvm binary"""
  69
  70     uname = get_command('uname')
  71     which = get_command('which')
  72
  73     machine = str(uname('-m'))
  74     if re.match('i[3-6]86', machine):
  75         machine = 'i386'
  76
  77     binary = which('qemu-system-%s' % machine)
  78
  79     if binary is None:
  80         return which('kvm')
  81
  82     return binary
  83
  84
  85 def try_fail_repeat(command, *args):
  86     """Execute a command multiple times until it succeeds"""
  87     times = (0.1, 0.5, 1, 2)
  88     i = iter(times)
  89     while True:
  90         try:
  91             command(*args)
  92             return
  93         except sh.ErrorReturnCode:
  94             try:
  95                 wait = i.next()
  96             except StopIteration:
  97                 break
  98             time.sleep(wait)
  99
 100     raise FatalError("Command: `%s %s' failed" % (command, " ".join(args)))
 101
 102
 103 def free_space(dirname):
 104     """Compute the free space in a directory"""
 105     stat = os.statvfs(dirname)
 106     return stat.f_bavail * stat.f_frsize
 107
 108
 109 def check_guestfs_version(ghandler, major, minor, release):
 110     """Checks if the version of the used libguestfs is smaller, equal or
 111     greater than the one specified by the major, minor and release triplet
 112
 113     Returns:
 114         < 0 if the installed version is smaller than the specified one
 115         = 0 if they are equal
 116         > 0 if the installed one is greater than the specified one
 117     """
 118
 119     ver = ghandler.version()
 120
 121     for (a, b) in (ver['major'], major), (ver['minor'], minor), \
 122             (ver['release'], release):
 123         if a != b:
 124             return a - b
 125
 126     return 0
 127
 128
 129 class MD5:
 130     """Represents MD5 computations"""
 131     def __init__(self, output):
 132         """Create an MD5 instance"""
 133         self.out = output
 134
 135     def compute(self, filename, size):
 136         """Compute the MD5 checksum of a file"""
 137         MB = 2 ** 20
 138         BLOCKSIZE = 4 * MB  # 4MB
 139
 140         prog_size = ((size + MB - 1) // MB)  # in MB
 141         progressbar = self.out.Progress(prog_size, "Calculating md5sum", 'mb')
 142         md5 = hashlib.md5()
 143         with open(filename, "r") as src:
 144             left = size
 145             while left > 0:
 146                 length = min(left, BLOCKSIZE)
 147                 data = src.read(length)
 148                 md5.update(data)
 149                 left -= length
 150                 progressbar.goto((size - left) // MB)
 151
 152         checksum = md5.hexdigest()
 153         progressbar.success(checksum)
 154
 155         return checksum
 156
 157 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :