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("--print-sysprep", dest="print_sysprep", default=False,
 102                       help="print the enabled and disabled system preparation "
 103                       "operations for this input media", action="store_true")
 104
 105     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 106                       help="run SYSPREP operation on the input media",
 107                       action="append", metavar="SYSPREP")
 108
 109     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 110                       help="prevent SYSPREP operation from running on the "
 111                       "input media", default=[], action="append",
 112                       metavar="SYSPREP")
 113
 114     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 115                       help="don't perform any system preparation operation",
 116                       action="store_false")
 117
 118     parser.add_option("--no-shrink", dest="shrink", default=True,
 119                       help="don't shrink any partition", action="store_false")
 120
 121     parser.add_option("--public", dest="public", default=False,
 122                       help="register image with cyclades as public",
 123                       action="store_true")
 124
 125     parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
 126                       help="create large temporary image files under DIR",
 127                       metavar="DIR")
 128
 129     options, args = parser.parse_args(input_args)
 130
 131     if len(args) != 1:
 132         parser.error('Wrong number of arguments')
 133
 134     options.source = args[0]
 135     if not os.path.exists(options.source):
 136         raise FatalError("Input media `%s' is not accessible" % options.source)
 137
 138     if options.register and not options.upload:
 139         raise FatalError("You also need to set -u when -r option is set")
 140
 141     if options.upload and options.token is None:
 142         raise FatalError(
 143             "Image uploading cannot be performed. "
 144             "No authentication token is specified. Use -t to set a token")
 145
 146     if options.tmp is not None and not os.path.isdir(options.tmp):
 147         raise FatalError("The directory `%s' specified with --tmpdir is not "
 148                          "valid" % options.tmp)
 149
 150     meta = {}
 151     for m in options.metadata:
 152         try:
 153             key, value = m.split('=', 1)
 154         except ValueError:
 155             raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
 156                              "format." % m)
 157         meta[key] = value
 158     options.metadata = meta
 159
 160     return options
 161
 162
 163 def image_creator():
 164     options = parse_options(sys.argv[1:])
 165
 166     if options.outfile is None and not options.upload and not \
 167             options.print_sysprep:
 168         raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
 169                          "must be set")
 170
 171     if options.silent:
 172         out = SilentOutput()
 173     else:
 174         out = OutputWthProgress(True) if sys.stderr.isatty() else \
 175             SimpleOutput(False)
 176
 177     title = 'snf-image-creator %s' % version
 178     out.output(title)
 179     out.output('=' * len(title))
 180
 181     if os.geteuid() != 0:
 182         raise FatalError("You must run %s as root"
 183                          % os.path.basename(sys.argv[0]))
 184
 185     if not options.force and options.outfile is not None:
 186         for extension in ('', '.meta', '.md5sum'):
 187             filename = "%s%s" % (options.outfile, extension)
 188             if os.path.exists(filename):
 189                 raise FatalError("Output file `%s' exists "
 190                                  "(use --force to overwrite it)." % filename)
 191
 192     # Check if the authentication token is valid. The earlier the better
 193     if options.token is not None:
 194         try:
 195             account = Kamaki.get_account(options.token)
 196             if account is None:
 197                 raise FatalError("The authentication token you provided is not"
 198                                  " valid!")
 199             else:
 200                 kamaki = Kamaki(account, out)
 201         except ClientError as e:
 202             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 203
 204     if options.upload and not options.force:
 205         if kamaki.object_exists(options.upload):
 206             raise FatalError("Remote pithos object `%s' exists "
 207                              "(use --force to overwrite it)." % options.upload)
 208         if kamaki.object_exists("%s.md5sum" % options.upload):
 209             raise FatalError("Remote pithos object `%s.md5sum' exists "
 210                              "(use --force to overwrite it)." % options.upload)
 211
 212     if options.register and not options.force:
 213         if kamaki.object_exists("%s.meta" % options.upload):
 214             raise FatalError("Remote pithos object `%s.meta' exists "
 215                              "(use --force to overwrite it)." % options.upload)
 216
 217     disk = Disk(options.source, out, options.tmp)
 218
 219     def signal_handler(signum, frame):
 220         disk.cleanup()
 221
 222     signal.signal(signal.SIGINT, signal_handler)
 223     signal.signal(signal.SIGTERM, signal_handler)
 224     try:
 225         snapshot = disk.snapshot()
 226
 227         image = disk.get_image(snapshot)
 228
 229         for sysprep in options.disabled_syspreps:
 230             image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
 231
 232         for sysprep in options.enabled_syspreps:
 233             image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
 234
 235         if options.print_sysprep:
 236             image.os.print_syspreps()
 237             out.output()
 238
 239         if options.outfile is None and not options.upload:
 240             return 0
 241
 242         if options.sysprep:
 243             image.os.do_sysprep()
 244
 245         metadata = image.os.meta
 246
 247         size = options.shrink and image.shrink() or image.size
 248         metadata.update(image.meta)
 249
 250         # Add command line metadata to the collected ones...
 251         metadata.update(options.metadata)
 252
 253         md5 = MD5(out)
 254         checksum = md5.compute(image.device, size)
 255
 256         metastring = '\n'.join(
 257             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 258         metastring += '\n'
 259
 260         if options.outfile is not None:
 261             image.dump(options.outfile)
 262
 263             out.output('Dumping metadata file ...', False)
 264             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 265                 f.write(metastring)
 266             out.success('done')
 267
 268             out.output('Dumping md5sum file ...', False)
 269             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 270                 f.write('%s %s\n' % (checksum,
 271                                      os.path.basename(options.outfile)))
 272             out.success('done')
 273
 274         # Destroy the image instance. We only need the snapshot from now on
 275         disk.destroy_image(image)
 276
 277         out.output()
 278         try:
 279             uploaded_obj = ""
 280             if options.upload:
 281                 out.output("Uploading image to pithos:")
 282                 with open(snapshot, 'rb') as f:
 283                     uploaded_obj = kamaki.upload(
 284                         f, size, options.upload,
 285                         "(1/3)  Calculating block hashes",
 286                         "(2/3)  Uploading missing blocks")
 287                 out.output("(3/3)  Uploading md5sum file ...", False)
 288                 md5sumstr = '%s %s\n' % (checksum,
 289                                          os.path.basename(options.upload))
 290                 kamaki.upload(StringIO.StringIO(md5sumstr),
 291                               size=len(md5sumstr),
 292                               remote_path="%s.%s" % (options.upload, 'md5sum'))
 293                 out.success('done')
 294                 out.output()
 295
 296             if options.register:
 297                 img_type = 'public' if options.public else 'private'
 298                 out.output('Registering %s image with ~okeanos ...' % img_type,
 299                            False)
 300                 kamaki.register(options.register, uploaded_obj, metadata,
 301                                 options.public)
 302                 out.success('done')
 303                 out.output("Uploading metadata file ...", False)
 304                 kamaki.upload(StringIO.StringIO(metastring),
 305                               size=len(metastring),
 306                               remote_path="%s.%s" % (options.upload, 'meta'))
 307                 out.success('done')
 308                 if options.public:
 309                     out.output("Sharing md5sum file ...", False)
 310                     kamaki.share("%s.md5sum" % options.upload)
 311                     out.success('done')
 312                     out.output("Sharing metadata file ...", False)
 313                     kamaki.share("%s.meta" % options.upload)
 314                     out.success('done')
 315
 316                 out.output()
 317         except ClientError as e:
 318             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
 319
 320     finally:
 321         out.output('cleaning up ...')
 322         disk.cleanup()
 323
 324     out.success("snf-image-creator exited without errors")
 325
 326     return 0
 327
 328
 329 def main():
 330     try:
 331         ret = image_creator()
 332         sys.exit(ret)
 333     except FatalError as e:
 334         colored = sys.stderr.isatty()
 335         SimpleOutput(colored).error(e)
 336         sys.exit(1)
 337
 338 if __name__ == '__main__':
 339     main()
 340
 341 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :