#!/usr/bin/env python
# ex:ts=4:sw=4:sts=4:et
# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
#
# Copyright (c) 2013, Intel Corporation.
# All rights reserved.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# DESCRIPTION 'wic' is the OpenEmbedded Image Creator that users can
# use to generate bootable images. Invoking it without any arguments
# will display help screens for the 'wic' command and list the
# available 'wic' subcommands. Invoking a subcommand without any
# arguments will likewise display help screens for the specified
# subcommand. Please use that interface for detailed help.
#
# AUTHORS
# Tom Zanussi <tom.zanussi (at] linux.intel.com>
#
__version__ = "0.1.0"
# Python Standard Library modules
import os
import sys
import optparse
import logging
# External modules
scripts_path = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])))
lib_path = scripts_path + '/lib'
sys.path = sys.path + [lib_path]
from image.help import *
from image.engine import *
def wic_create_subcommand(args, usage_str):
"""
Command-line handling for image creation. The real work is done
by image.engine.wic_create()
"""
parser = optparse.OptionParser(usage = usage_str)
parser.add_option("-o", "--outdir", dest = "outdir",
action = "store", help = "name of directory to create image in")
parser.add_option("-i", "--infile", dest = "properties_file",
action = "store", help = "name of file containing the values for image properties as a JSON file")
parser.add_option("-e", "--image-name", dest = "image_name",
action = "store", help = "name of the image to use the artifacts from e.g. core-image-sato")
parser.add_option("-r", "--rootfs-dir", dest = "rootfs_dir",
action = "store", help = "path to the /rootfs dir to use as the .wks rootfs source")
parser.add_option("-b", "--bootimg-dir", dest = "bootimg_dir",
action = "store", help = "path to the dir containing the boot artifacts (e.g. /EFI or /syslinux dirs) to use as the .wks bootimg source")
parser.add_option("-k", "--kernel-dir", dest = "kernel_dir",
action = "store", help = "path to the dir containing the kernel to use in the .wks bootimg")
parser.add_option("-n", "--native-sysroot", dest = "native_sysroot",
action = "store", help = "path to the native sysroot containing the tools to use to build the image")
parser.add_option("-p", "--skip-build-check", dest = "build_check",
action = "store_false", default = True, help = "skip the build check")
(options, args) = parser.parse_args(args)
if len(args) != 1:
logging.error("Wrong number of arguments, exiting\n")
parser.print_help()
sys.exit(1)
if not options.image_name and not (options.rootfs_dir and
options.bootimg_dir and
options.kernel_dir and
options.native_sysroot):
print "Build artifacts not completely specified, exiting."
print " (Use 'wic -e' or 'wic -r -b -k -n' to specify artifacts)"
sys.exit(1)
if not options.image_name:
options.build_check = False
if options.build_check and not options.properties_file:
print "Checking basic build environment..."
if not verify_build_env():
print "Couldn't verify build environment, exiting\n"
sys.exit(1)
else:
print "Done.\n"
print "Creating image(s)...\n"
bootimg_dir = staging_data_dir = hdddir = ""
if options.image_name:
(rootfs_dir, kernel_dir, hdddir, staging_data_dir, native_sysroot) = \
find_artifacts(options.image_name)
wks_file = args[0]
if not wks_file.endswith(".wks"):
wks_file = find_canned_image(scripts_path, wks_file)
if not wks_file:
print "No image named %s found, exiting. (Use 'wic list images' to list available images, or specify a fully-qualified OE kickstart (.wks) filename)\n" % wks_file
sys.exit(1)
image_output_dir = ""
if options.outdir:
image_output_dir = options.outdir
if not options.image_name:
rootfs_dir = options.rootfs_dir
bootimg_dir = options.bootimg_dir
kernel_dir = options.kernel_dir
native_sysroot = options.native_sysroot
if not os.path.isdir(rootfs_dir):
print "--roofs-dir (-r) not found, exiting\n"
sys.exit(1)
if not os.path.isdir(bootimg_dir):
print "--bootimg-dir (-b) not found, exiting\n"
sys.exit(1)
if not os.path.isdir(kernel_dir):
print "--kernel-dir (-k) not found, exiting\n"
sys.exit(1)
if not os.path.isdir(native_sysroot):
print "--native-sysroot (-n) not found, exiting\n"
sys.exit(1)
else:
not_found = not_found_dir = ""
if not os.path.isdir(rootfs_dir):
(not_found, not_found_dir) = ("rootfs-dir", rootfs_dir)
elif not os.path.isdir(hdddir) and not os.path.isdir(staging_data_dir):
(not_found, not_found_dir) = ("bootimg-dir", bootimg_dir)
elif not os.path.isdir(kernel_dir):
(not_found, not_found_dir) = ("kernel-dir", kernel_dir)
elif not os.path.isdir(native_sysroot):
(not_found, not_found_dir) = ("native-sysroot", native_sysroot)
if not_found:
if not not_found_dir:
not_found_dir = "Completely missing artifact - wrong image (.wks) used?"
print "Build artifacts not found, exiting."
print " (Please check that the build artifacts for the machine"
print " selected in local.conf actually exist and that they"
print " are the correct artifacts for the image (.wks file)).\n"
print "The artifact that couldn't be found was %s:\n %s" % \
(not_found, not_found_dir)
sys.exit(1)
wic_create(args, wks_file, rootfs_dir, bootimg_dir, kernel_dir,
native_sysroot, hdddir, staging_data_dir, scripts_path,
image_output_dir, options.properties_file)
def wic_list_subcommand(args, usage_str):
"""
Command-line handling for listing available image properties and
values. The real work is done by image.engine.wic_list()
"""
parser = optparse.OptionParser(usage = usage_str)
parser.add_option("-o", "--outfile", action = "store",
dest = "properties_file",
help = "dump the possible values for image properties to a JSON file")
(options, args) = parser.parse_args(args)
if not wic_list(args, scripts_path, options.properties_file):
logging.error("Bad list arguments, exiting\n")
parser.print_help()
sys.exit(1)
subcommands = {
"create": [wic_create_subcommand,
wic_create_usage,
wic_create_help],
"list": [wic_list_subcommand,
wic_list_usage,
wic_list_help],
}
def start_logging(loglevel):
logging.basicConfig(filname = 'wic.log', filemode = 'w', level=loglevel)
def main():
parser = optparse.OptionParser(version = "wic version %s" % __version__,
usage = wic_usage)
parser.disable_interspersed_args()
parser.add_option("-D", "--debug", dest = "debug", action = "store_true",
default = False, help = "output debug information")
(options, args) = parser.parse_args()
loglevel = logging.INFO
if options.debug:
loglevel = logging.DEBUG
start_logging(loglevel)
if len(args):
if args[0] == "help":
if len(args) == 1:
parser.print_help()
sys.exit(1)
invoke_subcommand(args, parser, wic_help_usage, subcommands)
if __name__ == "__main__":
try:
ret = main()
except Exception:
ret = 1
import traceback
traceback.print_exc(5)
sys.exit(ret)