Source code for kiwi.cli

# Copyright (c) 2015 SUSE Linux GmbH.  All rights reserved.
#
# This file is part of kiwi.
#
# kiwi 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, either version 3 of the License, or
# (at your option) any later version.
#
# kiwi 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 kiwi.  If not, see <http://www.gnu.org/licenses/>
#
"""
usage: kiwi -h | --help
       kiwi [--profile=<name>...]
            [--type=<build_type>]
            [--logfile=<filename>]
            [--debug]
            [--color-output]
           image <command> [<args>...]
       kiwi [--debug]
            [--color-output]
           result <command> [<args>...]
       kiwi [--profile=<name>...]
            [--shared-cache-dir=<directory>]
            [--type=<build_type>]
            [--logfile=<filename>]
            [--debug]
            [--color-output]
           system <command> [<args>...]
       kiwi compat <legacy_args>...
       kiwi --compat <legacy_args>...
       kiwi -v | --version
       kiwi help

global options:
    --color-output
        use colors for warning and error messages
    --debug
        print debug information
    -v --version
        show program version
    help
        show manual page

global options for services: image, system
    --logfile=<filename>
        create a log file containing all log information including
        debug information even if this is was not requested by the
        debug switch
    --profile=<name>
        profile name, multiple profiles can be selected by passing
        this option multiple times
    --shared-cache-dir=<directory>
        specify an alternative shared cache directory. The directory
        is shared via bind mount between the build host and image
        root system and contains information about package repositories
        and their cache and meta data. [default: /var/cache/kiwi]
    --type=<build_type>
        image build type. If not set the default XML specified
        build type will be used
"""
from __future__ import print_function
import sys
import glob
import re
import os
import importlib
from docopt import docopt

# project
from .exceptions import (
    KiwiUnknownServiceName,
    KiwiCommandNotFound,
    KiwiCommandNotLoaded,
    KiwiLoadCommandUndefined,
    KiwiCompatError
)
from .path import Path
from .defaults import Defaults
from .version import __version__
from .help import Help


[docs]class Cli(object): """ **Implements the main command line interface** An instance of the Cli class builds the entry point for the application and implements methods to load further command plugins which itself provides their own command line interface """ def __init__(self): self.all_args = docopt( __doc__, version='KIWI (next generation) version ' + __version__, options_first=True ) self.command_args = self.all_args['<args>'] self.command_loaded = None
[docs] def show_and_exit_on_help_request(self): """ Execute man to show the selected manual page """ if self.all_args['help']: manual = Help() manual.show('kiwi') sys.exit(0)
[docs] def get_servicename(self): """ Extract service name from argument parse result :return: service name :rtype: str """ if self.all_args.get('image') is True: return 'image' elif self.all_args.get('system') is True: return 'system' elif self.all_args.get('result') is True: return 'result' elif self.all_args.get('--compat') is True: return 'compat' elif self.all_args.get('compat') is True: return 'compat' else: raise KiwiUnknownServiceName( 'Unknown/Invalid Servicename' )
[docs] def invoke_kiwicompat(self, compat_args): """ Execute kiwicompat with provided legacy KIWI command line arguments Example: .. code:: python invoke_kiwicompat( '--build', 'description', '--type', 'vmx', '-d', 'destination' ) :param list compat_args: legacy kiwi command arguments """ kiwicompat = self._lookup_kiwicompat() try: os.execvp(kiwicompat, ['kiwicompat'] + compat_args) except Exception as e: raise KiwiCompatError( '%s: %s' % (type(e).__name__, format(e)) )
[docs] def get_command(self): """ Extract selected command name :return: command name :rtype: str """ return self.all_args['<command>']
[docs] def get_command_args(self): """ Extract argument dict for selected command :return: Contains dictionary of command arguments .. code:: python { '--command-option': 'value' } :rtype: dict """ return self._load_command_args()
[docs] def get_global_args(self): """ Extract argument dict for global arguments :return: Contains dictionary of global arguments .. code:: python { '--global-option': 'value' } :rtype: dict """ result = {} for arg, value in list(self.all_args.items()): if not arg == '<command>' and not arg == '<args>': result[arg] = value return result
[docs] def load_command(self): """ Loads task class plugin according to service and command name :return: importlib loaded module :rtype: object """ command = self.get_command() service = self.get_servicename() if service == 'compat': compat_arguments = self.all_args['<legacy_args>'] if '--' in compat_arguments: compat_arguments.remove('--') return self.invoke_kiwicompat(compat_arguments) if not command: raise KiwiLoadCommandUndefined( 'No command specified for %s service' % service ) command_source_file = Defaults.project_file( 'tasks/' + service + '_' + command + '.py' ) if not os.path.exists(command_source_file): prefix = 'usage:' for service_command in self._get_command_implementations(service): print('%s kiwi %s' % (prefix, service_command)) prefix = ' ' raise SystemExit(1) self.command_loaded = importlib.import_module( 'kiwi.tasks.' + service + '_' + command ) return self.command_loaded
def _get_command_implementations(self, service): command_implementations = [] glob_match = Defaults.project_file('/') + 'tasks/*.py' for source_file in glob.iglob(glob_match): with open(source_file, 'r') as source: for line in source: if re.search('usage: (.*)', line): command_path = os.path.basename( source_file ).replace('.py', '').split('_') if command_path[0] == service: command_implementations.append( ' '.join(command_path) ) break return command_implementations def _load_command_args(self): try: argv = [ self.get_servicename(), self.get_command() ] + self.command_args return docopt(self.command_loaded.__doc__, argv=argv) except Exception: raise KiwiCommandNotLoaded( '%s command not loaded' % self.get_command() ) def _lookup_kiwicompat(self): for kiwicompat_name in ['kiwicompat-3', 'kiwicompat-2']: kiwicompat = Path.which(kiwicompat_name, access_mode=os.X_OK) if kiwicompat: return kiwicompat raise KiwiCommandNotFound('kiwicompat not found')