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

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