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
  45
  46 class FatalError(Exception):
  47     """Fatal Error exception of snf-image-creator"""
  48     pass
  49
  50
  51 def get_command(command):
  52     """Return a file system binary command"""
  53     def find_sbin_command(command, exception):
  54         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
  55         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
  56             if os.path.exists(fullpath) and os.access(fullpath, os.X_OK):
  57                 return sh.Command(fullpath)
  58         raise exception
  59
  60     try:
  61         return sh.__getattr__(command)
  62     except sh.CommandNotFound as e:
  63         return find_sbin_command(command, e)
  64
  65
  66 def try_fail_repeat(command, *args):
  67     """Execute a command multiple times until it succeeds"""
  68     times = (0.1, 0.5, 1, 2)
  69     i = iter(times)
  70     while True:
  71         try:
  72             command(*args)
  73             return
  74         except sh.ErrorReturnCode:
  75             try:
  76                 wait = i.next()
  77             except StopIteration:
  78                 break
  79             time.sleep(wait)
  80
  81     raise FatalError("Command: `%s %s' failed" % (command, " ".join(args)))
  82
  83
  84 def free_space(dirname):
  85     """Compute the free space in a directory"""
  86     stat = os.statvfs(dirname)
  87     return stat.f_bavail * stat.f_frsize
  88
  89
  90 def check_guestfs_version(ghandler, major, minor, release):
  91     """Checks if the version of the used libguestfs is smaller, equal or
  92     greater than the one specified by the major, minor and release triplet
  93
  94     Returns:
  95         < 0 if the installed version is smaller than the specified one
  96         = 0 if they are equal
  97         > 0 if the installed one is greater than the specified one
  98     """
  99
 100     ver = ghandler.version()
 101
 102     for (a, b) in (ver['major'], major), (ver['minor'], minor), \
 103             (ver['release'], release):
 104         if a != b:
 105             return a - b
 106
 107     return 0
 108
 109
 110 class MD5:
 111     """Represents MD5 computations"""
 112     def __init__(self, output):
 113         """Create an MD5 instance"""
 114         self.out = output
 115
 116     def compute(self, filename, size):
 117         """Compute the MD5 checksum of a file"""
 118         MB = 2 ** 20
 119         BLOCKSIZE = 4 * MB  # 4MB
 120
 121         prog_size = ((size + MB - 1) // MB)  # in MB
 122         progressbar = self.out.Progress(prog_size, "Calculating md5sum", 'mb')
 123         md5 = hashlib.md5()
 124         with open(filename, "r") as src:
 125             left = size
 126             while left > 0:
 127                 length = min(left, BLOCKSIZE)
 128                 data = src.read(length)
 129                 md5.update(data)
 130                 left -= length
 131                 progressbar.goto((size - left) // MB)
 132
 133         checksum = md5.hexdigest()
 134         progressbar.success(checksum)
 135
 136         return checksum
 137
 138 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :