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