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

   1 #!/usr/bin/env python
   2
   3 # Copyright 2011 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 from image_creator import __version__ as version
  37 from image_creator import util
  38 from image_creator.disk import Disk
  39 from image_creator.util import get_command, error, success, output, \
  40                                                     FatalError, progress, md5
  41 from image_creator.os_type import get_os_class
  42 from image_creator.kamaki_wrapper import Kamaki
  43 import sys
  44 import os
  45 import optparse
  46 import StringIO
  47
  48
  49 def check_writable_dir(option, opt_str, value, parser):
  50     dirname = os.path.dirname(value)
  51     name = os.path.basename(value)
  52     if dirname and not os.path.isdir(dirname):
  53         raise FatalError("`%s' is not an existing directory" % dirname)
  54
  55     if not name:
  56         raise FatalError("`%s' is not a valid file name" % dirname)
  57
  58     setattr(parser.values, option.dest, value)
  59
  60
  61 def parse_options(input_args):
  62     usage = "Usage: %prog [options] <input_media>"
  63     parser = optparse.OptionParser(version=version, usage=usage)
  64
  65     account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \
  66         else None
  67     token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \
  68         else None
  69
  70     parser.add_option("-o", "--outfile", type="string", dest="outfile",
  71         default=None, action="callback", callback=check_writable_dir,
  72         help="dump image to FILE", metavar="FILE")
  73
  74     parser.add_option("-f", "--force", dest="force", default=False,
  75         action="store_true", help="overwrite output files if they exist")
  76
  77     parser.add_option("-s", "--silent", dest="silent", default=False,
  78         help="silent mode, only output errors", action="store_true")
  79
  80     parser.add_option("-u", "--upload", dest="upload", type="string",
  81         default=False, help="upload the image to pithos with name FILENAME",
  82         metavar="FILENAME")
  83
  84     parser.add_option("-r", "--register", dest="register", type="string",
  85         default=False, help="register the image to ~okeanos as IMAGENAME",
  86         metavar="IMAGENAME")
  87
  88     parser.add_option("-a", "--account", dest="account", type="string",
  89         default=account,
  90         help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
  91         % account)
  92
  93     parser.add_option("-t", "--token", dest="token", type="string",
  94         default=token,
  95         help="Use this token when uploading/registring images [Default: %s]"\
  96         % token)
  97
  98     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
  99         help="print the enabled and disabled system preparation operations "
 100         "for this input media", action="store_true")
 101
 102     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 103         help="run SYSPREP operation on the input media",
 104         action="append", metavar="SYSPREP")
 105
 106     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 107         help="prevent SYSPREP operation from running on the input media",
 108         default=[], action="append", metavar="SYSPREP")
 109
 110     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 111         help="don't perform system preperation", action="store_false")
 112
 113     parser.add_option("--no-shrink", dest="shrink", default=True,
 114         help="don't shrink any partition", action="store_false")
 115
 116     options, args = parser.parse_args(input_args)
 117
 118     if len(args) != 1:
 119         parser.error('Wrong number of arguments')
 120     options.source = args[0]
 121     if not os.path.exists(options.source):
 122         raise FatalError("Input media `%s' is not accessible" % options.source)
 123
 124     if options.register and options.upload == False:
 125         raise FatalError("You also need to set -u when -r option is set")
 126
 127     if options.upload and options.account is None:
 128         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 129         "account name is specified. Use -a to set an account name.")
 130
 131     if options.upload and options.token is None:
 132         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 133         "token is specified. User -t to set a token.")
 134
 135     return options
 136
 137
 138 def image_creator():
 139     options = parse_options(sys.argv[1:])
 140
 141     if options.silent:
 142         util.silent = True
 143
 144     if options.outfile is None and not options.upload \
 145                                             and not options.print_sysprep:
 146         raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " \
 147                                                                 "must be set")
 148
 149     title = 'snf-image-creator %s' % version
 150     output(title)
 151     output('=' * len(title))
 152
 153     if os.geteuid() != 0:
 154         raise FatalError("You must run %s as root" \
 155                         % os.path.basename(sys.argv[0]))
 156
 157     if not options.force and options.outfile is not None:
 158         for extension in ('', '.meta', '.md5sum'):
 159             filename = "%s%s" % (options.outfile, extension)
 160             if os.path.exists(filename):
 161                 raise FatalError("Output file %s exists "
 162                     "(use --force to overwrite it)." % filename)
 163
 164     disk = Disk(options.source)
 165     try:
 166         snapshot = disk.snapshot()
 167
 168         dev = disk.get_device(snapshot)
 169         dev.mount()
 170
 171         osclass = get_os_class(dev.distro, dev.ostype)
 172         image_os = osclass(dev.root, dev.g)
 173         metadata = image_os.get_metadata()
 174         output()
 175
 176         for sysprep in options.disabled_syspreps:
 177             image_os.disable_sysprep(sysprep)
 178
 179         for sysprep in options.enabled_syspreps:
 180             image_os.enable_sysprep(sysprep)
 181
 182         if options.print_sysprep:
 183             image_os.print_syspreps()
 184             output()
 185
 186         if options.outfile is None and not options.upload:
 187             return 0
 188
 189         if options.sysprep:
 190             image_os.do_sysprep()
 191
 192         dev.umount()
 193
 194         size = options.shrink and dev.shrink() or dev.size
 195         metadata.update(dev.meta)
 196
 197         checksum = md5(snapshot, size)
 198
 199         metastring = '\n'.join(
 200                 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 201         metastring += '\n'
 202
 203         if options.outfile is not None:
 204             dev.dump(options.outfile)
 205
 206             output('Dumping metadata file...', False)
 207             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 208                 f.write(metastring)
 209             success('done')
 210
 211             output('Dumping md5sum file...', False)
 212             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 213                 f.write('%s %s\n' % (checksum, \
 214                                             os.path.basename(options.outfile)))
 215             success('done')
 216
 217         # Destroy the device. We only need the snapshot from now on
 218         disk.destroy_device(dev)
 219
 220         output()
 221
 222         uploaded_obj = ""
 223         if options.upload:
 224             output("Uploading image to pithos:")
 225             kamaki = Kamaki(options.account, options.token)
 226             with open(snapshot) as f:
 227                 uploaded_obj = kamaki.upload(f, size, options.upload,
 228                                 "(1/4)  Calculating block hashes",
 229                                 "(2/4)  Uploading missing blocks")
 230
 231             output("(3/4)  Uploading metadata file...", False)
 232             kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
 233                                 remote_path="%s.%s" % (options.upload, 'meta'))
 234             success('done')
 235             output("(4/4)  Uploading md5sum file...", False)
 236             md5sumstr = '%s %s\n' % (
 237                 checksum, os.path.basename(options.upload))
 238             kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
 239                             remote_path="%s.%s" % (options.upload, 'md5sum'))
 240             success('done')
 241             output()
 242
 243         if options.register:
 244             output('Registring image to ~okeanos...', False)
 245             kamaki.register(options.register, uploaded_obj, metadata)
 246             success('done')
 247             output()
 248
 249     finally:
 250         output('cleaning up...')
 251         disk.cleanup()
 252
 253     success("snf-image-creator exited without errors")
 254
 255     return 0
 256
 257
 258 def main():
 259     try:
 260         ret = image_creator()
 261         sys.exit(ret)
 262     except FatalError as e:
 263         error(e)
 264         sys.exit(1)
 265
 266
 267 if __name__ == '__main__':
 268     main()
 269
 270 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :