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 import util
  38 from image_creator.disk import Disk
  39 from image_creator.util import FatalError, MD5
  40 from image_creator.output.cli import SilentOutput, SimpleOutput, \
  41     OutputWthProgress
  42 from image_creator.os_type import os_cls
  43 from image_creator.kamaki_wrapper import Kamaki, ClientError
  44 import sys
  45 import os
  46 import optparse
  47 import StringIO
  48 import signal
  49
  50
  51 def check_writable_dir(option, opt_str, value, parser):
  52     dirname = os.path.dirname(value)
  53     name = os.path.basename(value)
  54     if dirname and not os.path.isdir(dirname):
  55         raise FatalError("`%s' is not an existing directory" % dirname)
  56
  57     if not name:
  58         raise FatalError("`%s' is not a valid file name" % dirname)
  59
  60     setattr(parser.values, option.dest, value)
  61
  62
  63 def parse_options(input_args):
  64     usage = "Usage: %prog [options] <input_media>"
  65     parser = optparse.OptionParser(version=version, usage=usage)
  66
  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",
  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=token, help="use this authentication token when "
  99                       "uploading/registering images [Default: %s]" % token)
 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("--tmpdir", dest="tmp", type="string", default=None,
 122                       help="create large temporary image files under DIR",
 123                       metavar="DIR")
 124
 125     options, args = parser.parse_args(input_args)
 126
 127     if len(args) != 1:
 128         parser.error('Wrong number of arguments')
 129
 130     options.source = args[0]
 131     if not os.path.exists(options.source):
 132         raise FatalError("Input media `%s' is not accessible" % options.source)
 133
 134     if options.register and not options.upload:
 135         raise FatalError("You also need to set -u when -r option is set")
 136
 137     if options.upload and options.token is None:
 138         raise FatalError("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     try:
 189         account = Kamaki.get_account(options.token)
 190         if account is None:
 191             raise FatalError("The authentication token you provided is not "
 192                              "valid!")
 193     except ClientError as e:
 194         raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 195
 196     disk = Disk(options.source, out, options.tmp)
 197
 198     def signal_handler(signum, frame):
 199         disk.cleanup()
 200
 201     signal.signal(signal.SIGINT, signal_handler)
 202     signal.signal(signal.SIGTERM, signal_handler)
 203     try:
 204         snapshot = disk.snapshot()
 205
 206         dev = disk.get_device(snapshot)
 207
 208         # If no customization is to be applied, the image should be mounted ro
 209         readonly = (not (options.sysprep or options.shrink) or
 210                     options.print_sysprep)
 211         dev.mount(readonly)
 212
 213         cls = os_cls(dev.distro, dev.ostype)
 214         image_os = cls(dev.root, dev.g, out)
 215         out.output()
 216
 217         for sysprep in options.disabled_syspreps:
 218             image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
 219
 220         for sysprep in options.enabled_syspreps:
 221             image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
 222
 223         if options.print_sysprep:
 224             image_os.print_syspreps()
 225             out.output()
 226
 227         if options.outfile is None and not options.upload:
 228             return 0
 229
 230         if options.sysprep:
 231             image_os.do_sysprep()
 232
 233         metadata = image_os.meta
 234         dev.umount()
 235
 236         size = options.shrink and dev.shrink() or dev.size
 237         metadata.update(dev.meta)
 238
 239         # Add command line metadata to the collected ones...
 240         metadata.update(options.metadata)
 241
 242         md5 = MD5(out)
 243         checksum = md5.compute(snapshot, size)
 244
 245         metastring = '\n'.join(
 246             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 247         metastring += '\n'
 248
 249         if options.outfile is not None:
 250             dev.dump(options.outfile)
 251
 252             out.output('Dumping metadata file ...', False)
 253             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 254                 f.write(metastring)
 255             out.success('done')
 256
 257             out.output('Dumping md5sum file ...', False)
 258             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 259                 f.write('%s %s\n' % (checksum,
 260                                      os.path.basename(options.outfile)))
 261             out.success('done')
 262
 263         # Destroy the device. We only need the snapshot from now on
 264         disk.destroy_device(dev)
 265
 266         out.output()
 267         try:
 268             uploaded_obj = ""
 269             if options.upload:
 270                 out.output("Uploading image to pithos:")
 271                 kamaki = Kamaki(account, out)
 272                 with open(snapshot, 'rb') as f:
 273                     uploaded_obj = kamaki.upload(f, size, options.upload,
 274                         "(1/4)  Calculating block hashes",
 275                         "(2/4)  Uploading missing blocks")
 276
 277                 out.output("(3/4)  Uploading metadata file ...", False)
 278                 kamaki.upload(StringIO.StringIO(metastring),
 279                               size=len(metastring),
 280                               remote_path="%s.%s" % (options.upload, 'meta'))
 281                 out.success('done')
 282                 out.output("(4/4)  Uploading md5sum file ...", False)
 283                 md5sumstr = '%s %s\n' % (checksum,
 284                                          os.path.basename(options.upload))
 285                 kamaki.upload(StringIO.StringIO(md5sumstr),
 286                               size=len(md5sumstr),
 287                               remote_path="%s.%s" % (options.upload, 'md5sum'))
 288                 out.success('done')
 289                 out.output()
 290
 291             if options.register:
 292                 out.output('Registering image with ~okeanos ...', False)
 293                 kamaki.register(options.register, uploaded_obj, metadata)
 294                 out.success('done')
 295                 out.output()
 296         except ClientError as e:
 297             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
 298
 299     finally:
 300         out.output('cleaning up ...')
 301         disk.cleanup()
 302
 303     out.success("snf-image-creator exited without errors")
 304
 305     return 0
 306
 307
 308 def main():
 309     try:
 310         ret = image_creator()
 311         sys.exit(ret)
 312     except FatalError as e:
 313         colored = sys.stderr.isatty()
 314         SimpleOutput(colored).error(e)
 315         sys.exit(1)
 316
 317 if __name__ == '__main__':
 318     main()
 319
 320 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :