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