plugins: Move plugins to dedicated submodule
This change groups the plugin modules together under kas.plugins and moves the @kasplugin decorator to this submodule. This will ensure the codebase stays organised as more plugins are added. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Paul Barker
Jan Kiszka
35
kas/plugins/__init__.py
Normal file
35
kas/plugins/__init__.py
Normal file
@@ -0,0 +1,35 @@
|
||||
# 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 contains and manages kas plugins
|
||||
"""
|
||||
|
||||
|
||||
def kasplugin(plugin_class):
|
||||
"""
|
||||
A decorator that registers kas plugins
|
||||
"""
|
||||
if not hasattr(kasplugin, 'plugins'):
|
||||
setattr(kasplugin, 'plugins', {})
|
||||
getattr(kasplugin, 'plugins').update({
|
||||
plugin_class.name: plugin_class
|
||||
})
|
||||
137
kas/plugins/build.py
Normal file
137
kas/plugins/build.py
Normal file
@@ -0,0 +1,137 @@
|
||||
# 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.
|
||||
"""
|
||||
The build plugin for kas.
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from kas.context import create_global_context
|
||||
from kas.config import Config
|
||||
from kas.libkas import find_program, run_cmd
|
||||
from kas.libcmds import (Macro, Command, SetupDir, CleanupSSHAgent,
|
||||
SetupSSHAgent, SetupEnviron,
|
||||
WriteBBConfig, SetupHome, ReposApplyPatches,
|
||||
Loop, InitSetupRepos, FinishSetupRepos,
|
||||
SetupReposStep)
|
||||
from kas.plugins import kasplugin
|
||||
|
||||
__license__ = 'MIT'
|
||||
__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
|
||||
|
||||
|
||||
@kasplugin
|
||||
class Build:
|
||||
"""
|
||||
This class implements the build plugin for kas.
|
||||
"""
|
||||
|
||||
name = 'build'
|
||||
helpmsg = (
|
||||
'Checks out all necessary repositories and builds using bitbake as '
|
||||
'specificed in the configuration file.'
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def setup_parser(cls, parser):
|
||||
"""
|
||||
Setup the argument parser for the build plugin
|
||||
"""
|
||||
|
||||
parser.add_argument('extra_bitbake_args',
|
||||
nargs='*',
|
||||
help='Extra arguments to pass to bitbake')
|
||||
parser.add_argument('--target',
|
||||
action='append',
|
||||
help='Select target to build')
|
||||
parser.add_argument('-c', '--cmd', '--task', dest='task',
|
||||
help='Select which task should be executed')
|
||||
|
||||
def run(self, args):
|
||||
"""
|
||||
Executes the build command of the kas plugin.
|
||||
"""
|
||||
|
||||
ctx = create_global_context(args)
|
||||
ctx.config = Config(args.config, args.target, args.task)
|
||||
|
||||
macro = Macro()
|
||||
|
||||
# Prepare
|
||||
macro.add(SetupDir())
|
||||
|
||||
if 'SSH_PRIVATE_KEY' in os.environ:
|
||||
macro.add(SetupSSHAgent())
|
||||
|
||||
macro.add(InitSetupRepos())
|
||||
|
||||
repo_loop = Loop('repo_setup_loop')
|
||||
repo_loop.add(SetupReposStep())
|
||||
|
||||
macro.add(repo_loop)
|
||||
macro.add(FinishSetupRepos())
|
||||
|
||||
macro.add(SetupEnviron())
|
||||
macro.add(SetupHome())
|
||||
macro.add(ReposApplyPatches())
|
||||
|
||||
macro.add(WriteBBConfig())
|
||||
|
||||
# Build
|
||||
macro.add(BuildCommand(args.extra_bitbake_args))
|
||||
|
||||
if 'SSH_PRIVATE_KEY' in os.environ:
|
||||
macro.add(CleanupSSHAgent())
|
||||
|
||||
macro.run(ctx, args.skip)
|
||||
|
||||
|
||||
class BuildCommand(Command):
|
||||
"""
|
||||
Implements the bitbake build step.
|
||||
"""
|
||||
|
||||
def __init__(self, extra_bitbake_args):
|
||||
super().__init__()
|
||||
self.extra_bitbake_args = extra_bitbake_args
|
||||
|
||||
def __str__(self):
|
||||
return 'build'
|
||||
|
||||
def execute(self, ctx):
|
||||
"""
|
||||
Executes the bitbake build command.
|
||||
"""
|
||||
# Start bitbake build of image
|
||||
bitbake = find_program(ctx.environ['PATH'], 'bitbake')
|
||||
cmd = [bitbake, '-k', '-c', ctx.config.get_bitbake_task()] \
|
||||
+ self.extra_bitbake_args + ctx.config.get_bitbake_targets()
|
||||
if sys.stdout.isatty():
|
||||
logging.info('%s$ %s', ctx.build_dir, ' '.join(cmd))
|
||||
ret = subprocess.call(cmd, env=ctx.environ, cwd=ctx.build_dir)
|
||||
if ret != 0:
|
||||
logging.error('Command returned non-zero exit status %d', ret)
|
||||
sys.exit(ret)
|
||||
else:
|
||||
run_cmd(cmd, cwd=ctx.build_dir)
|
||||
131
kas/plugins/shell.py
Normal file
131
kas/plugins/shell.py
Normal file
@@ -0,0 +1,131 @@
|
||||
# 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 contains a kas plugin that opens a shell within the kas
|
||||
environment
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from kas.context import create_global_context
|
||||
from kas.config import Config
|
||||
from kas.libcmds import (Macro, Command, SetupDir, SetupEnviron,
|
||||
WriteBBConfig, SetupHome, ReposApplyPatches,
|
||||
CleanupSSHAgent, SetupSSHAgent,
|
||||
Loop, InitSetupRepos, FinishSetupRepos,
|
||||
SetupReposStep)
|
||||
from kas.plugins import kasplugin
|
||||
|
||||
__license__ = 'MIT'
|
||||
__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
|
||||
|
||||
|
||||
@kasplugin
|
||||
class Shell:
|
||||
"""
|
||||
Implements a kas plugin that opens a shell within the kas environment.
|
||||
"""
|
||||
|
||||
name = 'shell'
|
||||
helpmsg = 'Run a shell in the build environment.'
|
||||
|
||||
@classmethod
|
||||
def setup_parser(cls, parser):
|
||||
"""
|
||||
Setup the argument parser for the shell plugin
|
||||
"""
|
||||
|
||||
parser.add_argument('-k', '--keep-config-unchanged',
|
||||
help='Skip steps that change the configuration',
|
||||
action='store_true')
|
||||
parser.add_argument('-c', '--command',
|
||||
help='Run command',
|
||||
default='')
|
||||
|
||||
def run(self, args):
|
||||
"""
|
||||
Runs this kas plugin
|
||||
"""
|
||||
|
||||
ctx = create_global_context(args)
|
||||
ctx.config = Config(args.config, None, None)
|
||||
|
||||
macro = Macro()
|
||||
|
||||
# Prepare
|
||||
if not args.keep_config_unchanged:
|
||||
macro.add(SetupDir())
|
||||
|
||||
if 'SSH_PRIVATE_KEY' in os.environ:
|
||||
macro.add(SetupSSHAgent())
|
||||
|
||||
ctx.keep_config = args.keep_config_unchanged
|
||||
|
||||
macro.add(InitSetupRepos())
|
||||
|
||||
repo_loop = Loop('repo_setup_loop')
|
||||
repo_loop.add(SetupReposStep())
|
||||
|
||||
macro.add(repo_loop)
|
||||
macro.add(FinishSetupRepos())
|
||||
|
||||
macro.add(SetupEnviron())
|
||||
macro.add(SetupHome())
|
||||
|
||||
if not args.keep_config_unchanged:
|
||||
macro.add(ReposApplyPatches())
|
||||
macro.add(WriteBBConfig())
|
||||
|
||||
# Shell
|
||||
macro.add(ShellCommand(args.command))
|
||||
|
||||
if 'SSH_PRIVATE_KEY' in os.environ:
|
||||
macro.add(CleanupSSHAgent())
|
||||
|
||||
macro.run(ctx, args.skip)
|
||||
|
||||
|
||||
class ShellCommand(Command):
|
||||
"""
|
||||
This class implements the command that starts a shell.
|
||||
"""
|
||||
|
||||
def __init__(self, cmd):
|
||||
super().__init__()
|
||||
self.cmd = []
|
||||
if cmd:
|
||||
self.cmd = cmd
|
||||
|
||||
def __str__(self):
|
||||
return 'shell'
|
||||
|
||||
def execute(self, ctx):
|
||||
cmd = [ctx.environ.get('SHELL', '/bin/sh')]
|
||||
if self.cmd:
|
||||
cmd.append('-c')
|
||||
cmd.append(self.cmd)
|
||||
ret = subprocess.call(cmd, env=ctx.environ, cwd=ctx.build_dir)
|
||||
if ret != 0:
|
||||
logging.error('Shell returned non-zero exit status %d', ret)
|
||||
sys.exit(ret)
|
||||
Reference in New Issue
Block a user