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>
282 lines
8.0 KiB
Python
282 lines
8.0 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 contain common commands used by kas plugins.
|
|
"""
|
|
|
|
import tempfile
|
|
import logging
|
|
import shutil
|
|
import os
|
|
import pprint
|
|
from .libkas import (ssh_cleanup_agent, ssh_setup_agent, ssh_no_host_key_check,
|
|
get_build_environ, repos_fetch, repos_apply_patches)
|
|
from .includehandler import IncludeException
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2017'
|
|
|
|
|
|
class Macro:
|
|
"""
|
|
Contains commands and provide method to run them.
|
|
"""
|
|
def __init__(self):
|
|
self.commands = []
|
|
|
|
def add(self, command):
|
|
"""
|
|
Appends commands to the command list.
|
|
"""
|
|
self.commands.append(command)
|
|
|
|
def run(self, ctx, skip=None):
|
|
"""
|
|
Runs command from the command list respective to the configuration.
|
|
"""
|
|
skip = skip or []
|
|
for command in self.commands:
|
|
command_name = str(command)
|
|
if command_name in skip:
|
|
continue
|
|
logging.debug('execute %s', command_name)
|
|
command.execute(ctx)
|
|
|
|
|
|
class Command:
|
|
"""
|
|
An abstract class that defines the interface of a command.
|
|
"""
|
|
|
|
def execute(self, ctx):
|
|
"""
|
|
This method executes the command.
|
|
"""
|
|
pass
|
|
|
|
|
|
class SetupHome(Command):
|
|
"""
|
|
Setups the home directory of kas.
|
|
"""
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.tmpdirname = tempfile.mkdtemp()
|
|
|
|
def __del__(self):
|
|
shutil.rmtree(self.tmpdirname)
|
|
|
|
def __str__(self):
|
|
return 'setup_home'
|
|
|
|
def execute(self, ctx):
|
|
with open(self.tmpdirname + '/.wgetrc', 'w') as fds:
|
|
fds.write('\n')
|
|
with open(self.tmpdirname + '/.netrc', 'w') as fds:
|
|
fds.write('\n')
|
|
with open(self.tmpdirname + '/.gitconfig', 'w') as fds:
|
|
fds.write('[User]\n'
|
|
'\temail = kas@example.com\n'
|
|
'\tname = Kas User\n')
|
|
ctx.environ['HOME'] = self.tmpdirname
|
|
|
|
|
|
class SetupDir(Command):
|
|
"""
|
|
Creates the build directory.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'setup_dir'
|
|
|
|
def execute(self, ctx):
|
|
os.chdir(ctx.kas_work_dir)
|
|
if not os.path.exists(ctx.build_dir):
|
|
os.mkdir(ctx.build_dir)
|
|
|
|
|
|
class SetupSSHAgent(Command):
|
|
"""
|
|
Setup the ssh agent configuration.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'setup_ssh_agent'
|
|
|
|
def execute(self, ctx):
|
|
ssh_setup_agent(ctx)
|
|
ssh_no_host_key_check(ctx)
|
|
|
|
|
|
class CleanupSSHAgent(Command):
|
|
"""
|
|
Remove all the identities and stop the ssh-agent instance.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'cleanup_ssh_agent'
|
|
|
|
def execute(self, ctx):
|
|
ssh_cleanup_agent(ctx)
|
|
|
|
|
|
class SetupEnviron(Command):
|
|
"""
|
|
Setups the kas environment.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'setup_environ'
|
|
|
|
def execute(self, ctx):
|
|
ctx.environ.update(get_build_environ(ctx, ctx.build_dir))
|
|
|
|
|
|
class WriteBBConfig(Command):
|
|
"""
|
|
Writes bitbake configuration files into the build directory.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'write_bbconfig'
|
|
|
|
def execute(self, ctx):
|
|
def _write_bblayers_conf(ctx):
|
|
filename = ctx.build_dir + '/conf/bblayers.conf'
|
|
if not os.path.isdir(os.path.dirname(filename)):
|
|
os.makedirs(os.path.dirname(filename))
|
|
with open(filename, 'w') as fds:
|
|
fds.write(ctx.config.get_bblayers_conf_header())
|
|
fds.write('BBLAYERS ?= " \\\n ')
|
|
fds.write(' \\\n '.join(
|
|
sorted(layer for repo in ctx.config.get_repos()
|
|
for layer in repo.layers)))
|
|
fds.write('"\n')
|
|
|
|
def _write_local_conf(ctx):
|
|
filename = ctx.build_dir + '/conf/local.conf'
|
|
with open(filename, 'w') as fds:
|
|
fds.write(ctx.config.get_local_conf_header())
|
|
fds.write('MACHINE ??= "{}"\n'.format(
|
|
ctx.config.get_machine()))
|
|
fds.write('DISTRO ??= "{}"\n'.format(
|
|
ctx.config.get_distro()))
|
|
fds.write('BBMULTICONFIG ?= "{}"\n'.format(
|
|
ctx.config.get_multiconfig()))
|
|
|
|
_write_bblayers_conf(ctx)
|
|
_write_local_conf(ctx)
|
|
|
|
|
|
class ReposFetch(Command):
|
|
"""
|
|
Fetches repositories defined in the configuration
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'repos_fetch'
|
|
|
|
def execute(self, ctx):
|
|
repos_fetch(ctx, ctx.config.get_repos())
|
|
|
|
|
|
class ReposApplyPatches(Command):
|
|
"""
|
|
Applies the patches defined in the configuration to the repositories.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'repos_apply_patches'
|
|
|
|
def execute(self, ctx):
|
|
repos_apply_patches(ctx, ctx.config.get_repos())
|
|
|
|
|
|
class ReposCheckout(Command):
|
|
"""
|
|
Ensures that the right revision of each repo is check out.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'repos_checkout'
|
|
|
|
def execute(self, ctx):
|
|
for repo in ctx.config.get_repos():
|
|
repo.checkout(ctx)
|
|
|
|
|
|
class SetupRepos(Command):
|
|
"""
|
|
Setup repos including the include logic
|
|
"""
|
|
|
|
def __str__(self):
|
|
return 'setup_repos'
|
|
|
|
def execute(self, ctx):
|
|
missing_repo_names = ctx.config.find_missing_repos()
|
|
missing_repo_names_old = None
|
|
|
|
# pylint: disable=pointless-string-statement
|
|
"""XXX This will be refactored"""
|
|
# pylint: disable=protected-access
|
|
|
|
while missing_repo_names:
|
|
if missing_repo_names == missing_repo_names_old:
|
|
raise IncludeException('Could not fetch all repos needed by '
|
|
'includes.')
|
|
|
|
logging.debug('Missing repos for complete config:\n%s',
|
|
pprint.pformat(missing_repo_names))
|
|
|
|
ctx.config.repo_dict = ctx.config._get_repo_dict()
|
|
|
|
missing_repos = [ctx.config.repo_dict[repo_name]
|
|
for repo_name in missing_repo_names
|
|
if repo_name in ctx.config.repo_dict]
|
|
|
|
repos_fetch(ctx, missing_repos)
|
|
|
|
for repo in missing_repos:
|
|
repo.checkout(ctx)
|
|
|
|
ctx.config.repo_dict = ctx.config._get_repo_dict()
|
|
|
|
repo_paths = {r: ctx.config.repo_dict[r].path for r
|
|
in ctx.config.repo_dict}
|
|
missing_repo_names_old = missing_repo_names
|
|
|
|
(ctx.config._config, missing_repo_names) = \
|
|
ctx.config.handler.get_config(repos=repo_paths)
|
|
|
|
# now fetch everything with complete config and check out layers
|
|
# except if keep_config is set
|
|
if not ctx.keep_config:
|
|
repos_fetch(ctx, ctx.config.get_repos())
|
|
|
|
for repo in ctx.config.get_repos():
|
|
repo.checkout(ctx)
|
|
|
|
logging.debug('Configuration from config file:\n%s',
|
|
pprint.pformat(ctx.config._config))
|