7b18e5ec3b
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>
131 lines
4.1 KiB
Python
131 lines
4.1 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.
|
|
"""
|
|
This module contains a kas plugin that opens a shell within the kas
|
|
environment
|
|
"""
|
|
|
|
import subprocess
|
|
import os
|
|
from kas.libkas import kasplugin
|
|
from kas.context import Context
|
|
from kas.libcmds import (Macro, Command, SetupDir, SetupEnviron,
|
|
WriteBBConfig, SetupHome, ReposApplyPatches,
|
|
CleanupSSHAgent, SetupSSHAgent, SetupRepos)
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2017'
|
|
|
|
|
|
@kasplugin
|
|
class Shell:
|
|
"""
|
|
Implements a kas plugin that opens a shell within the kas environment.
|
|
"""
|
|
|
|
@classmethod
|
|
def get_argparser(cls, parser):
|
|
"""
|
|
Returns a parser for the shell plugin
|
|
"""
|
|
sh_prs = parser.add_parser('shell',
|
|
help='Run a shell in the build '
|
|
'environment.')
|
|
|
|
sh_prs.add_argument('config',
|
|
help='Config file')
|
|
sh_prs.add_argument('--target',
|
|
action='append',
|
|
help='Select target to build')
|
|
sh_prs.add_argument('--skip',
|
|
help='Skip build steps',
|
|
default=[])
|
|
sh_prs.add_argument('-k', '--keep-config-unchanged',
|
|
help='Skip steps that change the configuration',
|
|
action='store_true')
|
|
sh_prs.add_argument('-c', '--command',
|
|
help='Run command',
|
|
default='')
|
|
|
|
def run(self, args):
|
|
"""
|
|
Runs this kas plugin
|
|
"""
|
|
# pylint: disable= no-self-use
|
|
|
|
if args.cmd != 'shell':
|
|
return False
|
|
|
|
ctx = Context(args.config, args.target, 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(SetupRepos())
|
|
|
|
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)
|
|
|
|
return True
|
|
|
|
|
|
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)
|
|
subprocess.call(cmd, env=ctx.environ,
|
|
cwd=ctx.build_dir)
|