generic-poky/scripts/lib/mic/creator.py

352 lines
14 KiB
Python
Raw Normal View History

wic: Add mic w/pykickstart This is the starting point for the implemention described in [YOCTO 3847] which came to the conclusion that it would make sense to use kickstart syntax to implement image creation in OpenEmbedded. I subsequently realized that there was an existing tool that already implemented image creation using kickstart syntax, the Tizen/Meego mic tool. As such, it made sense to use that as a starting point - this commit essentially just copies the relevant Python code from the MIC tool to the scripts/lib dir, where it can be accessed by the previously created wic tool. Most of this will be removed or renamed by later commits, since we're initially focusing on partitioning only. Care should be taken so that we can easily add back any additional functionality should we decide later to expand the tool, though (we may also want to contribute our local changes to the mic tool to the Tizen project if it makes sense, and therefore should avoid gratuitous changes to the original code if possible). Added the /mic subdir from Tizen mic repo as a starting point: git clone git://review.tizen.org/tools/mic.git For reference, the top commit: commit 20164175ddc234a17b8a12c33d04b012347b1530 Author: Gui Chen <gui.chen@intel.com> Date: Sun Jun 30 22:32:16 2013 -0400 bump up to 0.19.2 Also added the /plugins subdir, moved to under the /mic subdir (to match the default plugin_dir location in mic.conf.in, which was renamed to yocto-image.conf (moved and renamed by later patches) and put into /scripts. (From OE-Core rev: 31f0360f1fd4ebc9dfcaed42d1c50d2448b4632e) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-24 15:31:34 +00:00
#!/usr/bin/python -tt
#
# Copyright (c) 2011 Intel, Inc.
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation; version 2 of the License
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc., 59
# Temple Place - Suite 330, Boston, MA 02111-1307, USA.
import os, sys, re
from optparse import SUPPRESS_HELP
from mic import msger, rt_util
from mic.utils import cmdln, errors, rpmmisc
from mic.conf import configmgr
from mic.plugin import pluginmgr
class Creator(cmdln.Cmdln):
"""${name}: create an image
Usage:
${name} SUBCOMMAND <ksfile> [OPTS]
${command_list}
${option_list}
"""
name = 'mic create(cr)'
def __init__(self, *args, **kwargs):
cmdln.Cmdln.__init__(self, *args, **kwargs)
self._subcmds = []
# get cmds from pluginmgr
# mix-in do_subcmd interface
for subcmd, klass in pluginmgr.get_plugins('imager').iteritems():
if not hasattr(klass, 'do_create'):
msger.warning("Unsurpport subcmd: %s" % subcmd)
continue
func = getattr(klass, 'do_create')
setattr(self.__class__, "do_"+subcmd, func)
self._subcmds.append(subcmd)
def get_optparser(self):
optparser = cmdln.CmdlnOptionParser(self)
optparser.add_option('-d', '--debug', action='store_true',
dest='debug',
help=SUPPRESS_HELP)
optparser.add_option('-v', '--verbose', action='store_true',
dest='verbose',
help=SUPPRESS_HELP)
optparser.add_option('', '--logfile', type='string', dest='logfile',
default=None,
help='Path of logfile')
optparser.add_option('-c', '--config', type='string', dest='config',
default=None,
help='Specify config file for mic')
optparser.add_option('-k', '--cachedir', type='string', action='store',
dest='cachedir', default=None,
help='Cache directory to store the downloaded')
optparser.add_option('-o', '--outdir', type='string', action='store',
dest='outdir', default=None,
help='Output directory')
optparser.add_option('-A', '--arch', type='string', dest='arch',
default=None,
help='Specify repo architecture')
optparser.add_option('', '--release', type='string', dest='release',
default=None, metavar='RID',
help='Generate a release of RID with all necessary'
' files, when @BUILD_ID@ is contained in '
'kickstart file, it will be replaced by RID')
optparser.add_option("", "--record-pkgs", type="string",
dest="record_pkgs", default=None,
help='Record the info of installed packages, '
'multiple values can be specified which '
'joined by ",", valid values: "name", '
'"content", "license", "vcs"')
optparser.add_option('', '--pkgmgr', type='string', dest='pkgmgr',
default=None,
help='Specify backend package manager')
optparser.add_option('', '--local-pkgs-path', type='string',
dest='local_pkgs_path', default=None,
help='Path for local pkgs(rpms) to be installed')
optparser.add_option('', '--runtime', type='string',
dest='runtime', default=None,
help='Specify runtime mode, avaiable: bootstrap, native')
# --taring-to is alias to --pack-to
optparser.add_option('', '--taring-to', type='string',
dest='pack_to', default=None,
help=SUPPRESS_HELP)
optparser.add_option('', '--pack-to', type='string',
dest='pack_to', default=None,
help='Pack the images together into the specified'
' achive, extension supported: .zip, .tar, '
'.tar.gz, .tar.bz2, etc. by default, .tar '
'will be used')
optparser.add_option('', '--copy-kernel', action='store_true',
dest='copy_kernel',
help='Copy kernel files from image /boot directory'
' to the image output directory.')
optparser.add_option('', '--install-pkgs', type='string', action='store',
dest='install_pkgs', default=None,
help='Specify what type of packages to be installed,'
' valid: source, debuginfo, debugsource')
optparser.add_option('', '--tmpfs', action='store_true', dest='enabletmpfs',
help='Setup tmpdir as tmpfs to accelerate, experimental'
' feature, use it if you have more than 4G memory')
optparser.add_option('', '--repourl', action='append',
dest='repourl', default=[],
help=SUPPRESS_HELP)
return optparser
def preoptparse(self, argv):
optparser = self.get_optparser()
largs = []
rargs = []
while argv:
arg = argv.pop(0)
if arg in ('-h', '--help'):
rargs.append(arg)
elif optparser.has_option(arg):
largs.append(arg)
if optparser.get_option(arg).takes_value():
try:
largs.append(argv.pop(0))
except IndexError:
raise errors.Usage("option %s requires arguments" % arg)
else:
if arg.startswith("--"):
if "=" in arg:
opt = arg.split("=")[0]
else:
opt = None
elif arg.startswith("-") and len(arg) > 2:
opt = arg[0:2]
else:
opt = None
if opt and optparser.has_option(opt):
largs.append(arg)
else:
rargs.append(arg)
return largs + rargs
def postoptparse(self):
abspath = lambda pth: os.path.abspath(os.path.expanduser(pth))
if self.options.verbose:
msger.set_loglevel('verbose')
if self.options.debug:
msger.set_loglevel('debug')
if self.options.logfile:
logfile_abs_path = abspath(self.options.logfile)
if os.path.isdir(logfile_abs_path):
raise errors.Usage("logfile's path %s should be file"
% self.options.logfile)
if not os.path.exists(os.path.dirname(logfile_abs_path)):
os.makedirs(os.path.dirname(logfile_abs_path))
msger.set_interactive(False)
msger.set_logfile(logfile_abs_path)
configmgr.create['logfile'] = self.options.logfile
if self.options.config:
configmgr.reset()
configmgr._siteconf = self.options.config
if self.options.outdir is not None:
configmgr.create['outdir'] = abspath(self.options.outdir)
if self.options.cachedir is not None:
configmgr.create['cachedir'] = abspath(self.options.cachedir)
os.environ['ZYPP_LOCKFILE_ROOT'] = configmgr.create['cachedir']
for cdir in ('outdir', 'cachedir'):
if os.path.exists(configmgr.create[cdir]) \
and not os.path.isdir(configmgr.create[cdir]):
msger.error('Invalid directory specified: %s' \
% configmgr.create[cdir])
if self.options.local_pkgs_path is not None:
if not os.path.exists(self.options.local_pkgs_path):
msger.error('Local pkgs directory: \'%s\' not exist' \
% self.options.local_pkgs_path)
configmgr.create['local_pkgs_path'] = self.options.local_pkgs_path
if self.options.release:
configmgr.create['release'] = self.options.release.rstrip('/')
if self.options.record_pkgs:
configmgr.create['record_pkgs'] = []
for infotype in self.options.record_pkgs.split(','):
if infotype not in ('name', 'content', 'license', 'vcs'):
raise errors.Usage('Invalid pkg recording: %s, valid ones:'
' "name", "content", "license", "vcs"' \
% infotype)
configmgr.create['record_pkgs'].append(infotype)
if self.options.arch is not None:
supported_arch = sorted(rpmmisc.archPolicies.keys(), reverse=True)
if self.options.arch in supported_arch:
configmgr.create['arch'] = self.options.arch
else:
raise errors.Usage('Invalid architecture: "%s".\n'
' Supported architectures are: \n'
' %s' % (self.options.arch,
', '.join(supported_arch)))
if self.options.pkgmgr is not None:
configmgr.create['pkgmgr'] = self.options.pkgmgr
if self.options.runtime:
configmgr.set_runtime(self.options.runtime)
if self.options.pack_to is not None:
configmgr.create['pack_to'] = self.options.pack_to
if self.options.copy_kernel:
configmgr.create['copy_kernel'] = self.options.copy_kernel
if self.options.install_pkgs:
configmgr.create['install_pkgs'] = []
for pkgtype in self.options.install_pkgs.split(','):
if pkgtype not in ('source', 'debuginfo', 'debugsource'):
raise errors.Usage('Invalid parameter specified: "%s", '
'valid values: source, debuginfo, '
'debusource' % pkgtype)
configmgr.create['install_pkgs'].append(pkgtype)
if self.options.enabletmpfs:
configmgr.create['enabletmpfs'] = self.options.enabletmpfs
if self.options.repourl:
for item in self.options.repourl:
try:
key, val = item.split('=')
except:
continue
configmgr.create['repourl'][key] = val
def main(self, argv=None):
if argv is None:
argv = sys.argv
else:
argv = argv[:] # don't modify caller's list
self.optparser = self.get_optparser()
if self.optparser:
try:
argv = self.preoptparse(argv)
self.options, args = self.optparser.parse_args(argv)
except cmdln.CmdlnUserError, ex:
msg = "%s: %s\nTry '%s help' for info.\n"\
% (self.name, ex, self.name)
msger.error(msg)
except cmdln.StopOptionProcessing, ex:
return 0
else:
# optparser=None means no process for opts
self.options, args = None, argv[1:]
if not args:
return self.emptyline()
self.postoptparse()
return self.cmd(args)
def precmd(self, argv): # check help before cmd
if '-h' in argv or '?' in argv or '--help' in argv or 'help' in argv:
return argv
if len(argv) == 1:
return ['help', argv[0]]
return argv
def do_auto(self, subcmd, opts, *args):
"""${cmd_name}: auto detect image type from magic header
Usage:
${name} ${cmd_name} <ksfile>
${cmd_option_list}
"""
def parse_magic_line(re_str, pstr, ptype='mic'):
ptn = re.compile(re_str)
m = ptn.match(pstr)
if not m or not m.groups():
return None
inline_argv = m.group(1).strip()
if ptype == 'mic':
m2 = re.search('(?P<format>\w+)', inline_argv)
elif ptype == 'mic2':
m2 = re.search('(-f|--format(=)?)\s*(?P<format>\w+)',
inline_argv)
else:
return None
if m2:
cmdname = m2.group('format')
inline_argv = inline_argv.replace(m2.group(0), '')
return (cmdname, inline_argv)
return None
if len(args) != 1:
raise errors.Usage("Extra arguments given")
if not os.path.exists(args[0]):
raise errors.CreatorError("Can't find the file: %s" % args[0])
with open(args[0], 'r') as rf:
first_line = rf.readline()
mic_re = '^#\s*-\*-mic-options-\*-\s+(.*)\s+-\*-mic-options-\*-'
mic2_re = '^#\s*-\*-mic2-options-\*-\s+(.*)\s+-\*-mic2-options-\*-'
result = parse_magic_line(mic_re, first_line, 'mic') \
or parse_magic_line(mic2_re, first_line, 'mic2')
if not result:
raise errors.KsError("Invalid magic line in file: %s" % args[0])
if result[0] not in self._subcmds:
raise errors.KsError("Unsupport format '%s' in %s"
% (result[0], args[0]))
argv = ' '.join(result + args).split()
self.main(argv)