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

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # Copyright 2012 GRNET S.A. All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or
   7 # without modification, are permitted provided that the following
   8 # conditions are met:
   9 #
  10 #   1. Redistributions of source code must retain the above
  11 #      copyright notice, this list of conditions and the following
  12 #      disclaimer.
  13 #
  14 #   2. Redistributions in binary form must reproduce the above
  15 #      copyright notice, this list of conditions and the following
  16 #      disclaimer in the documentation and/or other materials
  17 #      provided with the distribution.
  18 #
  19 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  20 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  23 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  29 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 # POSSIBILITY OF SUCH DAMAGE.
  31 #
  32 # The views and conclusions contained in the software and
  33 # documentation are those of the authors and should not be
  34 # interpreted as representing official policies, either expressed
  35 # or implied, of GRNET S.A.
  36
  37 """This module is the entrance point for the non-interactive version of the
  38 snf-image-creator program.
  39 """
  40
  41 from image_creator import __version__ as version
  42 from image_creator.disk import Disk
  43 from image_creator.util import FatalError, MD5
  44 from image_creator.output.cli import SilentOutput, SimpleOutput, \
  45     OutputWthProgress
  46 from image_creator.kamaki_wrapper import Kamaki, ClientError
  47 import sys
  48 import os
  49 import optparse
  50 import StringIO
  51 import signal
  52
  53
  54 def check_writable_dir(option, opt_str, value, parser):
  55     dirname = os.path.dirname(value)
  56     name = os.path.basename(value)
  57     if dirname and not os.path.isdir(dirname):
  58         raise FatalError("`%s' is not an existing directory" % dirname)
  59
  60     if not name:
  61         raise FatalError("`%s' is not a valid file name" % dirname)
  62
  63     setattr(parser.values, option.dest, value)
  64
  65
  66 def parse_options(input_args):
  67     usage = "Usage: %prog [options] <input_media>"
  68     parser = optparse.OptionParser(version=version, usage=usage)
  69
  70     parser.add_option("-o", "--outfile", type="string", dest="outfile",
  71                       default=None, action="callback",
  72                       callback=check_writable_dir, help="dump image to FILE",
  73                       metavar="FILE")
  74
  75     parser.add_option("-f", "--force", dest="force", default=False,
  76                       action="store_true",
  77                       help="overwrite output files if they exist")
  78
  79     parser.add_option("-s", "--silent", dest="silent", default=False,
  80                       help="output only errors",
  81                       action="store_true")
  82
  83     parser.add_option("-u", "--upload", dest="upload", type="string",
  84                       default=False,
  85                       help="upload the image to pithos with name FILENAME",
  86                       metavar="FILENAME")
  87
  88     parser.add_option("-r", "--register", dest="register", type="string",
  89                       default=False,
  90                       help="register the image with ~okeanos as IMAGENAME",
  91                       metavar="IMAGENAME")
  92
  93     parser.add_option("-m", "--metadata", dest="metadata", default=[],
  94                       help="add custom KEY=VALUE metadata to the image",
  95                       action="append", metavar="KEY=VALUE")
  96
  97     parser.add_option("-t", "--token", dest="token", type="string",
  98                       default=None, help="use this authentication token when "
  99                       "uploading/registering images")
 100
 101     parser.add_option("-a", "--authentication-url", dest="url", type="string",
 102                       default=None, help="use this authentication URL when "
 103                       "uploading/registering images")
 104
 105     parser.add_option("-c", "--cloud", dest="cloud", type="string",
 106                       default=None, help="use this saved cloud account to "
 107                       "authenticate against a cloud when "
 108                       "uploading/registering images")
 109
 110     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
 111                       help="print the enabled and disabled system preparation "
 112                       "operations for this input media", action="store_true")
 113
 114     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 115                       help="run SYSPREP operation on the input media",
 116                       action="append", metavar="SYSPREP")
 117
 118     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 119                       help="prevent SYSPREP operation from running on the "
 120                       "input media", default=[], action="append",
 121                       metavar="SYSPREP")
 122
 123     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 124                       help="don't perform any system preparation operation",
 125                       action="store_false")
 126
 127     parser.add_option("--no-shrink", dest="shrink", default=True,
 128                       help="don't shrink any partition", action="store_false")
 129
 130     parser.add_option("--public", dest="public", default=False,
 131                       help="register image with cyclades as public",
 132                       action="store_true")
 133
 134     parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
 135                       help="create large temporary image files under DIR",
 136                       metavar="DIR")
 137
 138     options, args = parser.parse_args(input_args)
 139
 140     if len(args) != 1:
 141         parser.error('Wrong number of arguments')
 142
 143     options.source = args[0]
 144     if not os.path.exists(options.source):
 145         raise FatalError("Input media `%s' is not accessible" % options.source)
 146
 147     if options.register and not options.upload:
 148         raise FatalError("You also need to set -u when -r option is set")
 149
 150     if options.upload and (options.token is None or options.url is None) and \
 151             options.cloud is None:
 152
 153         err = "You need to either specify an authentication URL and token " \
 154               "pair or an available cloud name."
 155
 156         raise FatalError("Image uploading cannot be performed. %s" % err)
 157
 158     if options.tmp is not None and not os.path.isdir(options.tmp):
 159         raise FatalError("The directory `%s' specified with --tmpdir is not "
 160                          "valid" % options.tmp)
 161
 162     meta = {}
 163     for m in options.metadata:
 164         try:
 165             key, value = m.split('=', 1)
 166         except ValueError:
 167             raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
 168                              "format." % m)
 169         meta[key] = value
 170     options.metadata = meta
 171
 172     return options
 173
 174
 175 def image_creator():
 176     options = parse_options(sys.argv[1:])
 177
 178     if options.outfile is None and not options.upload and not \
 179             options.print_sysprep:
 180         raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
 181                          "must be set")
 182
 183     if options.silent:
 184         out = SilentOutput()
 185     else:
 186         out = OutputWthProgress(True) if sys.stderr.isatty() else \
 187             SimpleOutput(False)
 188
 189     title = 'snf-image-creator %s' % version
 190     out.output(title)
 191     out.output('=' * len(title))
 192
 193     if os.geteuid() != 0:
 194         raise FatalError("You must run %s as root"
 195                          % os.path.basename(sys.argv[0]))
 196
 197     if not options.force and options.outfile is not None:
 198         for extension in ('', '.meta', '.md5sum'):
 199             filename = "%s%s" % (options.outfile, extension)
 200             if os.path.exists(filename):
 201                 raise FatalError("Output file `%s' exists "
 202                                  "(use --force to overwrite it)." % filename)
 203
 204     # Check if the authentication info is valid. The earlier the better
 205     if options.token is not None and options.url is not None:
 206         try:
 207             account = Kamaki.create_account(options.url, options.token)
 208             if account is None:
 209                 raise FatalError("The authentication token and/or URL you "
 210                                  "provided is not valid!")
 211             else:
 212                 kamaki = Kamaki(account, out)
 213         except ClientError as e:
 214             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 215     elif options.cloud:
 216         avail_clouds = Kamaki.get_clouds()
 217         if options.cloud not in avail_clouds.keys():
 218             raise FatalError(
 219                 "Cloud: `%s' does not exist.\n\nAvailable clouds:\n\n\t%s\n"
 220                 % (options.cloud, "\n\t".join(avail_clouds.keys())))
 221         try:
 222             account = Kamaki.get_account(options.cloud)
 223             if account is None:
 224                 raise FatalError(
 225                     "Cloud: `$s' exists but is not valid!" % options.cloud)
 226             else:
 227                 kamaki = Kamaki(account, out)
 228         except ClientError as e:
 229             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 230
 231     if options.upload and not options.force:
 232         if kamaki.object_exists(options.upload):
 233             raise FatalError("Remote pithos object `%s' exists "
 234                              "(use --force to overwrite it)." % options.upload)
 235         if kamaki.object_exists("%s.md5sum" % options.upload):
 236             raise FatalError("Remote pithos object `%s.md5sum' exists "
 237                              "(use --force to overwrite it)." % options.upload)
 238
 239     if options.register and not options.force:
 240         if kamaki.object_exists("%s.meta" % options.upload):
 241             raise FatalError("Remote pithos object `%s.meta' exists "
 242                              "(use --force to overwrite it)." % options.upload)
 243
 244     disk = Disk(options.source, out, options.tmp)
 245
 246     def signal_handler(signum, frame):
 247         disk.cleanup()
 248
 249     signal.signal(signal.SIGINT, signal_handler)
 250     signal.signal(signal.SIGTERM, signal_handler)
 251     try:
 252         snapshot = disk.snapshot()
 253
 254         image = disk.get_image(snapshot)
 255
 256         for sysprep in options.disabled_syspreps:
 257             image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
 258
 259         for sysprep in options.enabled_syspreps:
 260             image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
 261
 262         if options.print_sysprep:
 263             image.os.print_syspreps()
 264             out.output()
 265
 266         if options.outfile is None and not options.upload:
 267             return 0
 268
 269         if options.sysprep:
 270             image.os.do_sysprep()
 271
 272         metadata = image.os.meta
 273
 274         size = options.shrink and image.shrink() or image.size
 275         metadata.update(image.meta)
 276
 277         # Add command line metadata to the collected ones...
 278         metadata.update(options.metadata)
 279
 280         md5 = MD5(out)
 281         checksum = md5.compute(image.device, size)
 282
 283         metastring = '\n'.join(
 284             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 285         metastring += '\n'
 286
 287         if options.outfile is not None:
 288             image.dump(options.outfile)
 289
 290             out.output('Dumping metadata file ...', False)
 291             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 292                 f.write(metastring)
 293             out.success('done')
 294
 295             out.output('Dumping md5sum file ...', False)
 296             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 297                 f.write('%s %s\n' % (checksum,
 298                                      os.path.basename(options.outfile)))
 299             out.success('done')
 300
 301         # Destroy the image instance. We only need the snapshot from now on
 302         disk.destroy_image(image)
 303
 304         out.output()
 305         try:
 306             uploaded_obj = ""
 307             if options.upload:
 308                 out.output("Uploading image to pithos:")
 309                 with open(snapshot, 'rb') as f:
 310                     uploaded_obj = kamaki.upload(
 311                         f, size, options.upload,
 312                         "(1/3)  Calculating block hashes",
 313                         "(2/3)  Uploading missing blocks")
 314                 out.output("(3/3)  Uploading md5sum file ...", False)
 315                 md5sumstr = '%s %s\n' % (checksum,
 316                                          os.path.basename(options.upload))
 317                 kamaki.upload(StringIO.StringIO(md5sumstr),
 318                               size=len(md5sumstr),
 319                               remote_path="%s.%s" % (options.upload, 'md5sum'))
 320                 out.success('done')
 321                 out.output()
 322
 323             if options.register:
 324                 img_type = 'public' if options.public else 'private'
 325                 out.output('Registering %s image with ~okeanos ...' % img_type,
 326                            False)
 327                 kamaki.register(options.register, uploaded_obj, metadata,
 328                                 options.public)
 329                 out.success('done')
 330                 out.output("Uploading metadata file ...", False)
 331                 kamaki.upload(StringIO.StringIO(metastring),
 332                               size=len(metastring),
 333                               remote_path="%s.%s" % (options.upload, 'meta'))
 334                 out.success('done')
 335                 if options.public:
 336                     out.output("Sharing md5sum file ...", False)
 337                     kamaki.share("%s.md5sum" % options.upload)
 338                     out.success('done')
 339                     out.output("Sharing metadata file ...", False)
 340                     kamaki.share("%s.meta" % options.upload)
 341                     out.success('done')
 342
 343                 out.output()
 344         except ClientError as e:
 345             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
 346
 347     finally:
 348         out.output('cleaning up ...')
 349         disk.cleanup()
 350
 351     out.success("snf-image-creator exited without errors")
 352
 353     return 0
 354
 355
 356 def main():
 357     try:
 358         ret = image_creator()
 359         sys.exit(ret)
 360     except FatalError as e:
 361         colored = sys.stderr.isatty()
 362         SimpleOutput(colored).error(e)
 363         sys.exit(1)
 364
 365 if __name__ == '__main__':
 366     main()
 367
 368 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :