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