PTU5KAS/kas/build.py
Andreas Reichel 7b18e5ec3b Refactor repo checkout
If a kas-file inside a repo includes another kas-file form a repo
which is not checked-out, and this 2nd repo can only be checked-out
with an SSH-key, kas fails. This is, because the constructor of
the Config class used to fetch missing repos already before the
SSH-Agent was setup.

This patch refactors the way in which kas checks-out repositories. This
also required the Config class to be split into Context and Config,
where the new Context is the build-Context, i.e. containing the
environment of commands executed by kas and the new Config is the Config
of kas itself, i.e. containing the repo dictionary.

This way it is possible to initialize the context needed for SSH setup
independently of the kas configuration.

The commands ReposFetch and ReposCheckout are refactored into a
SetupRepos command. This command parses the include files and
successively checks-out needed repos and updates the config as long
as repos are missing. The logic is taken directly from the constructor
of the former Config class (with minor adaptations).

Further refactoring will be needed to clean up the conceptual
programming patterns (i.e. to keep the Macro-Style consistent),
and to re-add the macro pattern regarding the above ReposFetch.

Signed-off-by: Andreas Reichel <andreas.reichel.ext@siemens.com>
2018-08-23 16:29:56 +02:00

123 lines
3.9 KiB
Python

# kas - setup tool for bitbake based projects
#
# Copyright (c) Siemens AG, 2017
#
# 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 os
from .context import Context
from .libkas import find_program, run_cmd, kasplugin
from .libcmds import (Macro, Command, SetupDir, CleanupSSHAgent,
SetupSSHAgent, SetupEnviron, SetupRepos,
WriteBBConfig, SetupHome, ReposApplyPatches)
__license__ = 'MIT'
__copyright__ = 'Copyright (c) Siemens AG, 2017'
@kasplugin
class Build:
"""
This class implements the build plugin for kas.
"""
@classmethod
def get_argparser(cls, parser):
"""
Returns an a parser for the build plugin
"""
bld_psr = parser.add_parser('build',
help='Checks out all necessary '
'repositories and builds using '
'bitbake as specificed in the '
'configuration file.')
bld_psr.add_argument('config',
help='Config file')
bld_psr.add_argument('--target',
action='append',
help='Select target to build')
bld_psr.add_argument('--task',
help='Select which task should be executed')
bld_psr.add_argument('--skip',
help='Skip build steps',
default=[])
def run(self, args):
"""
Executes the build command of the kas plugin.
"""
# pylint: disable=no-self-use
if args.cmd != 'build':
return False
ctx = Context(args.config, args.target, args.task)
macro = Macro()
# Prepare
macro.add(SetupDir())
if 'SSH_PRIVATE_KEY' in os.environ:
macro.add(SetupSSHAgent())
macro.add(SetupRepos())
macro.add(SetupEnviron())
macro.add(SetupHome())
macro.add(ReposApplyPatches())
macro.add(WriteBBConfig())
# Build
macro.add(BuildCommand(args.task))
if 'SSH_PRIVATE_KEY' in os.environ:
macro.add(CleanupSSHAgent())
macro.run(ctx, args.skip)
return True
class BuildCommand(Command):
"""
Implement the bitbake build step.
"""
def __init__(self, task):
super().__init__()
self.task = task
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')
run_cmd(([bitbake, '-k', '-c', ctx.config.get_bitbake_task()]
+ ctx.config.get_bitbake_targets()),
env=ctx.environ, cwd=ctx.build_dir)