This change moves all plugin handling code into the kas.plugins module. New accessor functions `plugins.get(name)` and `plugins.all()` are provided to wrap the plugins dictionary so that the kas main function doesn't need to worry about how this is accessed. Plugins are loaded at runtime rather than at parse time by calling `plugins.load()` which gives us an improved ability to handle errors. The `@kasplugin` decorator is removed as it modified and attribute on the kasplugin function itself when a plugin module was loaded. Importing a module should not result in changes to a variable in a different module as it leads to an initialization code flow which is difficult to reason about. Instead, plugin modules should now list the plugins which they introduce in a `__KAS_PLUGINS__` list which will be walked at runtime by `plugins.load()`. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
178 lines
5.4 KiB
Python
178 lines
5.4 KiB
Python
#!/usr/bin/env python3
|
|
#
|
|
# kas - setup tool for bitbake based projects
|
|
#
|
|
# Copyright (c) Siemens AG, 2017-2018
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
"""
|
|
This module is the main entry point for kas, setup tool for bitbake based
|
|
projects
|
|
"""
|
|
|
|
import argparse
|
|
import atexit
|
|
import asyncio
|
|
import traceback
|
|
import logging
|
|
import signal
|
|
import sys
|
|
import os
|
|
|
|
try:
|
|
import colorlog
|
|
HAVE_COLORLOG = True
|
|
except ImportError:
|
|
HAVE_COLORLOG = False
|
|
|
|
from . import __version__, __file_version__, __compatible_file_version__
|
|
from . import plugins
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
|
|
|
|
|
|
def create_logger():
|
|
"""
|
|
Setup the logging environment
|
|
"""
|
|
log = logging.getLogger() # root logger
|
|
log.setLevel(logging.INFO)
|
|
format_str = '%(asctime)s - %(levelname)-8s - %(message)s'
|
|
date_format = '%Y-%m-%d %H:%M:%S'
|
|
if HAVE_COLORLOG and os.isatty(2):
|
|
cformat = '%(log_color)s' + format_str
|
|
colors = {'DEBUG': 'reset',
|
|
'INFO': 'reset',
|
|
'WARNING': 'bold_yellow',
|
|
'ERROR': 'bold_red',
|
|
'CRITICAL': 'bold_red'}
|
|
formatter = colorlog.ColoredFormatter(cformat, date_format,
|
|
log_colors=colors)
|
|
else:
|
|
formatter = logging.Formatter(format_str, date_format)
|
|
stream_handler = logging.StreamHandler()
|
|
stream_handler.setFormatter(formatter)
|
|
log.addHandler(stream_handler)
|
|
return logging.getLogger(__name__)
|
|
|
|
|
|
def interruption():
|
|
"""
|
|
Ignore SIGINT/SIGTERM in kas, let them be handled by our sub-processes
|
|
"""
|
|
pass
|
|
|
|
|
|
def _atexit_handler():
|
|
"""
|
|
Waits for completion of the event loop
|
|
"""
|
|
loop = asyncio.get_event_loop()
|
|
pending = asyncio.Task.all_tasks()
|
|
if not loop.is_closed():
|
|
loop.run_until_complete(asyncio.gather(*pending))
|
|
loop.close()
|
|
|
|
|
|
def setup_parser_common_args(parser):
|
|
parser.add_argument('config',
|
|
help='Config file')
|
|
parser.add_argument('--skip',
|
|
help='Skip build steps',
|
|
default=[])
|
|
parser.add_argument('--force-checkout', action='store_true',
|
|
help='Always checkout the desired refspec of each '
|
|
'repository, discarding any local changes')
|
|
parser.add_argument('--update', action='store_true',
|
|
help='Pull new upstream changes to the desired '
|
|
'refspec even if it is already checked out locally')
|
|
|
|
|
|
def kas_get_argparser():
|
|
"""
|
|
Creates an argparser for kas with all plugins.
|
|
"""
|
|
parser = argparse.ArgumentParser(description='kas - setup tool for '
|
|
'bitbake based project')
|
|
|
|
verstr = '%(prog)s {} (configuration format version {}, ' \
|
|
'earliest compatible version {})'.format(__version__, __file_version__,
|
|
__compatible_file_version__)
|
|
parser.add_argument('--version', action='version', version=verstr)
|
|
|
|
parser.add_argument('-d', '--debug',
|
|
action='store_true',
|
|
help='Enable debug logging')
|
|
|
|
subparser = parser.add_subparsers(help='sub command help', dest='cmd')
|
|
|
|
for plugin in plugins.all():
|
|
plugin_parser = subparser.add_parser(plugin.name, help=plugin.helpmsg)
|
|
setup_parser_common_args(plugin_parser)
|
|
plugin.setup_parser(plugin_parser)
|
|
|
|
return parser
|
|
|
|
|
|
def kas(argv):
|
|
"""
|
|
The actual main entry point of kas.
|
|
"""
|
|
create_logger()
|
|
plugins.load()
|
|
|
|
parser = kas_get_argparser()
|
|
args = parser.parse_args(argv)
|
|
|
|
if args.debug:
|
|
logging.getLogger().setLevel(logging.DEBUG)
|
|
|
|
logging.info('%s %s started', os.path.basename(sys.argv[0]), __version__)
|
|
|
|
loop = asyncio.get_event_loop()
|
|
|
|
for sig in (signal.SIGINT, signal.SIGTERM):
|
|
loop.add_signal_handler(sig, interruption)
|
|
atexit.register(_atexit_handler)
|
|
|
|
plugin_class = plugins.get(args.cmd)
|
|
if plugin_class:
|
|
plugin = plugin_class()
|
|
plugin.run(args)
|
|
else:
|
|
parser.print_help()
|
|
|
|
|
|
def main():
|
|
"""
|
|
The main function that operates as a wrapper around kas.
|
|
"""
|
|
|
|
try:
|
|
sys.exit(kas(sys.argv[1:]))
|
|
except Exception as err:
|
|
logging.error('%s', err)
|
|
traceback.print_exc()
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|