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("-m", "--metadata", dest="metadata", default=[],
  94         help="Add custom KEY=VALUE metadata to the image", action="append",
  95         metavar="KEY=VALUE")
  96
  97     parser.add_option("-t", "--token", dest="token", type="string",
  98         default=token,
  99         help="Use this token when uploading/registring images [Default: %s]"\
 100         % token)
 101
 102     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
 103         help="print the enabled and disabled system preparation operations "
 104         "for this input media", action="store_true")
 105
 106     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 107         help="run SYSPREP operation on the input media",
 108         action="append", metavar="SYSPREP")
 109
 110     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 111         help="prevent SYSPREP operation from running on the input media",
 112         default=[], action="append", metavar="SYSPREP")
 113
 114     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 115         help="don't perform system preperation", action="store_false")
 116
 117     parser.add_option("--no-shrink", dest="shrink", default=True,
 118         help="don't shrink any partition", action="store_false")
 119
 120     options, args = parser.parse_args(input_args)
 121
 122     if len(args) != 1:
 123         parser.error('Wrong number of arguments')
 124
 125     options.source = args[0]
 126     if not os.path.exists(options.source):
 127         raise FatalError("Input media `%s' is not accessible" % options.source)
 128
 129     if options.register and options.upload == False:
 130         raise FatalError("You also need to set -u when -r option is set")
 131
 132     if options.upload and options.account is None:
 133         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 134         "account name is specified. Use -a to set an account name.")
 135
 136     if options.upload and options.token is None:
 137         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 138         "token is specified. User -t to set a token.")
 139
 140     meta = {}
 141     for m in options.metadata:
 142         try:
 143             key, value = m.split('=', 1)
 144         except ValueError:
 145             raise FatalError("Metadata option: `%s' is not in "\
 146                                                     "KEY=VALUE format." % m)
 147         meta[key] = value
 148     options.metadata = meta
 149
 150     return options
 151
 152
 153 def image_creator():
 154     options = parse_options(sys.argv[1:])
 155
 156     if options.silent:
 157         util.silent = True
 158
 159     if options.outfile is None and not options.upload \
 160                                             and not options.print_sysprep:
 161         raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " \
 162                                                                 "must be set")
 163
 164     title = 'snf-image-creator %s' % version
 165     output(title)
 166     output('=' * len(title))
 167
 168     if os.geteuid() != 0:
 169         raise FatalError("You must run %s as root" \
 170                         % os.path.basename(sys.argv[0]))
 171
 172     if not options.force and options.outfile is not None:
 173         for extension in ('', '.meta', '.md5sum'):
 174             filename = "%s%s" % (options.outfile, extension)
 175             if os.path.exists(filename):
 176                 raise FatalError("Output file %s exists "
 177                     "(use --force to overwrite it)." % filename)
 178
 179     disk = Disk(options.source)
 180     try:
 181         snapshot = disk.snapshot()
 182
 183         dev = disk.get_device(snapshot)
 184         dev.mount()
 185
 186         osclass = get_os_class(dev.distro, dev.ostype)
 187         image_os = osclass(dev.root, dev.g)
 188         output()
 189
 190         for sysprep in options.disabled_syspreps:
 191             image_os.disable_sysprep(sysprep)
 192
 193         for sysprep in options.enabled_syspreps:
 194             image_os.enable_sysprep(sysprep)
 195
 196         if options.print_sysprep:
 197             image_os.print_syspreps()
 198             output()
 199
 200         if options.outfile is None and not options.upload:
 201             return 0
 202
 203         if options.sysprep:
 204             image_os.do_sysprep()
 205
 206         metadata = image_os.meta
 207         dev.umount()
 208
 209         size = options.shrink and dev.shrink() or dev.size
 210         metadata.update(dev.meta)
 211
 212         # Add command line metadata to the collected ones...
 213         metadata.update(options.metadata)
 214
 215         checksum = md5(snapshot, size)
 216
 217         metastring = '\n'.join(
 218                 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 219         metastring += '\n'
 220
 221         if options.outfile is not None:
 222             dev.dump(options.outfile)
 223
 224             output('Dumping metadata file...', False)
 225             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 226                 f.write(metastring)
 227             success('done')
 228
 229             output('Dumping md5sum file...', False)
 230             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 231                 f.write('%s %s\n' % (checksum, \
 232                                             os.path.basename(options.outfile)))
 233             success('done')
 234
 235         # Destroy the device. We only need the snapshot from now on
 236         disk.destroy_device(dev)
 237
 238         output()
 239
 240         uploaded_obj = ""
 241         if options.upload:
 242             output("Uploading image to pithos:")
 243             kamaki = Kamaki(options.account, options.token)
 244             with open(snapshot) as f:
 245                 uploaded_obj = kamaki.upload(f, size, options.upload,
 246                                 "(1/4)  Calculating block hashes",
 247                                 "(2/4)  Uploading missing blocks")
 248
 249             output("(3/4)  Uploading metadata file...", False)
 250             kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
 251                                 remote_path="%s.%s" % (options.upload, 'meta'))
 252             success('done')
 253             output("(4/4)  Uploading md5sum file...", False)
 254             md5sumstr = '%s %s\n' % (
 255                 checksum, os.path.basename(options.upload))
 256             kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
 257                             remote_path="%s.%s" % (options.upload, 'md5sum'))
 258             success('done')
 259             output()
 260
 261         if options.register:
 262             output('Registring image to ~okeanos...', False)
 263             kamaki.register(options.register, uploaded_obj, metadata)
 264             success('done')
 265             output()
 266
 267     finally:
 268         output('cleaning up...')
 269         disk.cleanup()
 270
 271     success("snf-image-creator exited without errors")
 272
 273     return 0
 274
 275
 276 def main():
 277     try:
 278         ret = image_creator()
 279         sys.exit(ret)
 280     except FatalError as e:
 281         error(e)
 282         sys.exit(1)
 283
 284
 285 if __name__ == '__main__':
 286     main()
 287
 288 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :