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

   1 #!/usr/bin/env python
   2
   3 # Copyright 2011 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 get_os_class
  37 from image_creator import __version__ as version
  38 from image_creator import util
  39 from image_creator.disk import Disk
  40 from image_creator.util import get_command, error, success, output, \
  41                                                     FatalError, progress, md5
  42 from image_creator.kamaki_wrapper import Kamaki
  43 import sys
  44 import os
  45 import optparse
  46 import StringIO
  47
  48 dd = get_command('dd')
  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", callback=check_writable_dir,
  74         help="dump image to FILE", metavar="FILE")
  75
  76     parser.add_option("-f", "--force", dest="force", default=False,
  77         action="store_true", help="overwrite output files if they exist")
  78
  79     parser.add_option("-s", "--silent", dest="silent", default=False,
  80         help="silent mode, only output errors", action="store_true")
  81
  82     parser.add_option("-u", "--upload", dest="upload", type="string",
  83         default=False, help="upload the image to pithos with name FILENAME",
  84         metavar="FILENAME")
  85
  86     parser.add_option("-r", "--register", dest="register", type="string",
  87         default=False, help="register the image to ~okeanos as IMAGENAME",
  88         metavar="IMAGENAME")
  89
  90     parser.add_option("-a", "--account", dest="account", type="string",
  91         default=account,
  92         help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
  93         % account)
  94
  95     parser.add_option("-t", "--token", dest="token", type="string",
  96         default=token,
  97         help="Use this token when uploading/registring images [Default: %s]"\
  98         % token)
  99
 100     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
 101         help="print the enabled and disabled system preparation operations "
 102         "for this input media", action="store_true")
 103
 104     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 105         help="run SYSPREP operation on the input media",
 106         action="append", metavar="SYSPREP")
 107
 108     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 109         help="prevent SYSPREP operation from running on the input media",
 110         default=[], action="append", metavar="SYSPREP")
 111
 112     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 113         help="don't perform system preperation", action="store_false")
 114
 115     parser.add_option("--no-shrink", dest="shrink", default=True,
 116         help="don't shrink any partition", action="store_false")
 117
 118     options, args = parser.parse_args(input_args)
 119
 120     if len(args) != 1:
 121         parser.error('Wrong number of arguments')
 122     options.source = args[0]
 123     if not os.path.exists(options.source):
 124         raise FatalError("Input media `%s' is not accessible" % options.source)
 125
 126     if options.register and options.upload == False:
 127         raise FatalError("You also need to set -u when -r option is set")
 128
 129     if options.upload and options.account is None:
 130         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 131         "account name is specified. Use -a to set an account name.")
 132
 133     if options.upload and options.token is None:
 134         raise FatalError("Image uploading cannot be performed. No ~okeanos "
 135         "token is specified. User -t to set a token.")
 136
 137     return options
 138
 139
 140 def image_creator():
 141     options = parse_options(sys.argv[1:])
 142
 143     if options.silent:
 144         util.silent = True
 145
 146     if options.outfile is None and not options.upload \
 147                                             and not options.print_sysprep:
 148         raise FatalError("At least one of `-o', `-u' or" \
 149                             "`--print-sysprep' must be set")
 150
 151     title = 'snf-image-creator %s' % version
 152     output(title)
 153     output('=' * len(title))
 154
 155     if os.geteuid() != 0:
 156         raise FatalError("You must run %s as root" \
 157                         % os.path.basename(sys.argv[0]))
 158
 159     if not options.force and options.outfile is not None:
 160         for extension in ('', '.meta', '.md5sum'):
 161             filename = "%s%s" % (options.outfile, extension)
 162             if os.path.exists(filename):
 163                 raise FatalError("Output file %s exists "
 164                     "(use --force to overwrite it)." % filename)
 165
 166     disk = Disk(options.source)
 167     try:
 168         snapshot = disk.snapshot()
 169
 170         dev = disk.get_device(snapshot)
 171         dev.mount()
 172
 173         osclass = get_os_class(dev.distro, dev.ostype)
 174         image_os = osclass(dev.root, dev.g)
 175         metadata = image_os.get_metadata()
 176         output()
 177
 178         for sysprep in options.disabled_syspreps:
 179             image_os.disable_sysprep(sysprep)
 180
 181         for sysprep in options.enabled_syspreps:
 182             image_os.enable_sysprep(sysprep)
 183
 184         if options.print_sysprep:
 185             image_os.print_syspreps()
 186             output()
 187
 188         if options.outfile is None and not options.upload:
 189             return 0
 190
 191         if options.sysprep:
 192             image_os.do_sysprep()
 193
 194         dev.umount()
 195
 196         size = options.shrink and dev.shrink() or dev.size
 197         metadata['SIZE'] = str(size // 2 ** 20)
 198
 199         checksum = md5(snapshot, size)
 200
 201         metastring = '\n'.join(
 202             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
 203         metastring += '\n'
 204
 205         if options.outfile is not None:
 206             dev.dump(options.outfile)
 207
 208             output('Dumping metadata file...', False)
 209             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 210                     f.write(metastring)
 211             success('done')
 212
 213             output('Dumping md5sum file...', False)
 214             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 215                 f.write('%s %s\n' % (
 216                                 checksum, os.path.basename(options.outfile)))
 217             success('done')
 218
 219         # Destroy the device. We only need the snapshot from now on
 220         disk.destroy_device(dev)
 221
 222         output()
 223
 224         uploaded_obj = ""
 225         if options.upload:
 226             output("Uploading image to pithos:")
 227             kamaki = Kamaki(options.account, options.token)
 228             with open(snapshot) as f:
 229                 uploaded_obj = kamaki.upload(f, size, options.upload,
 230                                 "(1/4)  Calculating block hashes",
 231                                 "(2/4)  Uploading missing blocks")
 232
 233             output("(3/4)  Uploading metadata file...", False)
 234             kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
 235                                 remote_path="%s.%s" % (options.upload, 'meta'))
 236             success('done')
 237             output("(4/4)  Uploading md5sum file...", False)
 238             md5sumstr = '%s %s\n' % (
 239                 checksum, os.path.basename(options.upload))
 240             kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
 241                             remote_path="%s.%s" % (options.upload, 'md5sum'))
 242             success('done')
 243             output()
 244
 245         if options.register:
 246             output('Registring image to ~okeanos...', False)
 247             kamaki.register(options.register, uploaded_obj, metadata)
 248             success('done')
 249             output()
 250
 251     finally:
 252         output('cleaning up...')
 253         disk.cleanup()
 254
 255     success("snf-image-creator exited without errors")
 256
 257     return 0
 258
 259
 260 def main():
 261     try:
 262         ret = image_creator()
 263         sys.exit(ret)
 264     except FatalError as e:
 265         error(e)
 266         sys.exit(1)
 267
 268
 269 if __name__ == '__main__':
 270     main()
 271
 272 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :