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>
343 lines
12 KiB
Python
343 lines
12 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 the Repo class.
|
|
"""
|
|
|
|
import os
|
|
import asyncio
|
|
import logging
|
|
from urllib.parse import urlparse
|
|
from .libkas import run_cmd_async, run_cmd
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2017'
|
|
|
|
|
|
class Repo:
|
|
"""
|
|
Represents a repository in the kas configuration.
|
|
"""
|
|
|
|
def __init__(self, url, path, refspec, layers, patches,
|
|
disable_operations):
|
|
# pylint: disable=too-many-arguments
|
|
self.url = url
|
|
self.path = path
|
|
self.refspec = refspec
|
|
self._layers = layers
|
|
self._patches = patches
|
|
self.name = os.path.basename(self.path)
|
|
self.operations_disabled = disable_operations
|
|
|
|
def __getattr__(self, item):
|
|
# pylint: disable=no-else-return
|
|
if item == 'layers':
|
|
if not self._layers:
|
|
return [self.path]
|
|
return [self.path + '/' + l for l in self._layers]
|
|
elif item == 'qualified_name':
|
|
url = urlparse(self.url)
|
|
return ('{url.netloc}{url.path}'
|
|
.format(url=url)
|
|
.replace('@', '.')
|
|
.replace(':', '.')
|
|
.replace('/', '.')
|
|
.replace('*', '.'))
|
|
# Default behaviour
|
|
raise AttributeError
|
|
|
|
def __str__(self):
|
|
return '%s:%s %s %s' % (self.url, self.refspec,
|
|
self.path, self._layers)
|
|
|
|
@staticmethod
|
|
def factory(name, repo_config, config):
|
|
"""
|
|
Return an instance Repo depending on params.
|
|
"""
|
|
ctx = config.context
|
|
layers_dict = repo_config.get('layers', {})
|
|
layers = list(filter(lambda x, laydict=layers_dict:
|
|
str(laydict[x]).lower() not in
|
|
['disabled', 'excluded', 'n', 'no', '0', 'false'],
|
|
layers_dict))
|
|
patches_dict = repo_config.get('patches', {})
|
|
patches = list(
|
|
{
|
|
'id': p,
|
|
'repo': patches_dict[p]['repo'],
|
|
'path': patches_dict[p]['path'],
|
|
}
|
|
for p in sorted(patches_dict)
|
|
if patches_dict[p])
|
|
url = repo_config.get('url', None)
|
|
name = repo_config.get('name', name)
|
|
typ = repo_config.get('type', 'git')
|
|
refspec = repo_config.get('refspec', None)
|
|
path = repo_config.get('path', None)
|
|
disable_operations = False
|
|
|
|
if url is None:
|
|
# No version control operation on repository
|
|
if path is None:
|
|
path = Repo.get_root_path(os.path.dirname(config.filename),
|
|
config.context.environ)
|
|
logging.info('Using %s as root for repository %s', path,
|
|
name)
|
|
|
|
url = path
|
|
disable_operations = True
|
|
else:
|
|
if path is None:
|
|
path = os.path.join(ctx.kas_work_dir, name)
|
|
else:
|
|
if not os.path.isabs(path):
|
|
# Relative pathes are assumed to start from work_dir
|
|
path = os.path.join(ctx.kas_work_dir, path)
|
|
|
|
if typ == 'git':
|
|
return GitRepo(url, path, refspec, layers, patches,
|
|
disable_operations)
|
|
if typ == 'hg':
|
|
return MercurialRepo(url, path, refspec, layers, patches,
|
|
disable_operations)
|
|
raise NotImplementedError('Repo typ "%s" not supported.' % typ)
|
|
|
|
@staticmethod
|
|
def get_root_path(path, environ):
|
|
"""
|
|
Check if path is a version control repo and return its root path.
|
|
"""
|
|
(ret, output) = run_cmd(['git', 'rev-parse', '--show-toplevel'],
|
|
cwd=path, env=environ, fail=False,
|
|
liveupdate=False)
|
|
if ret == 0:
|
|
return output.strip()
|
|
|
|
(ret, output) = run_cmd(['hg', 'root'],
|
|
cwd=path, env=environ, fail=False,
|
|
liveupdate=False)
|
|
if ret == 0:
|
|
return output.strip()
|
|
|
|
return path
|
|
|
|
|
|
class RepoImpl(Repo):
|
|
"""
|
|
Provides a generic implementation for a Repo.
|
|
"""
|
|
|
|
@asyncio.coroutine
|
|
def fetch_async(self, ctx):
|
|
"""
|
|
Start asynchronous repository fetch.
|
|
"""
|
|
if self.operations_disabled:
|
|
return 0
|
|
|
|
if not os.path.exists(self.path):
|
|
os.makedirs(os.path.dirname(self.path), exist_ok=True)
|
|
sdir = os.path.join(ctx.kas_repo_ref_dir or '',
|
|
self.qualified_name)
|
|
logging.debug('Looking for repo ref dir in %s', sdir)
|
|
|
|
(retc, _) = yield from run_cmd_async(self.clone_cmd(sdir, ctx),
|
|
env=ctx.environ,
|
|
cwd=ctx.kas_work_dir)
|
|
if retc == 0:
|
|
logging.info('Repository %s cloned', self.name)
|
|
return retc
|
|
|
|
# take what came out of clone and stick to that forever
|
|
if self.refspec is None:
|
|
return 0
|
|
|
|
# Does refspec exist in the current repository?
|
|
(retc, output) = yield from run_cmd_async(self.contains_refspec_cmd(),
|
|
env=ctx.environ,
|
|
cwd=self.path,
|
|
fail=False,
|
|
liveupdate=False)
|
|
if retc == 0:
|
|
logging.info('Repository %s already contains %s as %s',
|
|
self.name, self.refspec, output.strip())
|
|
return retc
|
|
|
|
# No it is missing, try to fetch
|
|
(retc, output) = yield from run_cmd_async(self.fetch_cmd(),
|
|
env=ctx.environ,
|
|
cwd=self.path,
|
|
fail=False)
|
|
if retc:
|
|
logging.warning('Could not update repository %s: %s',
|
|
self.name, output)
|
|
else:
|
|
logging.info('Repository %s updated', self.name)
|
|
return 0
|
|
|
|
def checkout(self, ctx):
|
|
"""
|
|
Checks out the correct revision of the repo.
|
|
"""
|
|
if self.operations_disabled or self.refspec is None:
|
|
return
|
|
|
|
# Check if repos is dirty
|
|
(_, output) = run_cmd(self.is_dirty_cmd(),
|
|
env=ctx.environ, cwd=self.path,
|
|
fail=False)
|
|
if output:
|
|
logging.warning('Repo %s is dirty. no checkout', self.name)
|
|
return
|
|
|
|
# Check if current HEAD is what in the config file is defined.
|
|
(_, output) = run_cmd(self.current_rev_cmd(),
|
|
env=ctx.environ, cwd=self.path)
|
|
|
|
if output.strip() == self.refspec:
|
|
logging.info('Repo %s has already checkout out correct '
|
|
'refspec. nothing to do', self.name)
|
|
return
|
|
|
|
run_cmd(self.checkout_cmd(), cwd=self.path)
|
|
|
|
@asyncio.coroutine
|
|
def apply_patches_async(self, ctx):
|
|
"""
|
|
Applies patches to repository asynchronously.
|
|
"""
|
|
if self.operations_disabled:
|
|
return 0
|
|
|
|
for patch in self._patches:
|
|
other_repo = ctx.config.repo_dict.get(patch['repo'], None)
|
|
|
|
if not other_repo:
|
|
logging.warning('Could not find referenced repo. '
|
|
'(missing repo: %s, repo: %s, '
|
|
'patch entry: %s)',
|
|
patch['repo'],
|
|
self.name,
|
|
patch['id'])
|
|
continue
|
|
|
|
path = os.path.join(other_repo.path, patch['path'])
|
|
cmd = []
|
|
|
|
if os.path.isfile(path):
|
|
cmd = self.apply_patches_file_cmd(path)
|
|
elif os.path.isdir(path):
|
|
cmd = self.apply_patches_quilt_cmd(path)
|
|
else:
|
|
logging.warning('Could not find patch. '
|
|
'(patch path: %s, repo: %s, patch entry: %s)',
|
|
path,
|
|
self.name,
|
|
patch['id'])
|
|
continue
|
|
|
|
(retc, output) = yield from run_cmd_async(cmd,
|
|
env=ctx.environ,
|
|
cwd=self.path,
|
|
fail=False)
|
|
# pylint: disable=no-else-return
|
|
if retc:
|
|
logging.error('Could not apply patch. Please fix repos and '
|
|
'patches. (patch path: %s, repo: %s, patch '
|
|
'entry: %s, vcs output: %s)',
|
|
path, self.name, patch['id'], output)
|
|
return 1
|
|
else:
|
|
logging.info('Patch applied. '
|
|
'(patch path: %s, repo: %s, patch entry: %s)',
|
|
path, self.name, patch['id'])
|
|
return 0
|
|
|
|
|
|
class GitRepo(RepoImpl):
|
|
"""
|
|
Provides the git implementations for a Repo.
|
|
"""
|
|
# pylint: disable=no-self-use,missing-docstring
|
|
|
|
def clone_cmd(self, gitsrcdir, ctx):
|
|
cmd = ['git', 'clone', '-q', self.url, self.path]
|
|
if ctx.kas_repo_ref_dir and os.path.exists(gitsrcdir):
|
|
cmd.extend(['--reference', gitsrcdir])
|
|
return cmd
|
|
|
|
def contains_refspec_cmd(self):
|
|
return ['git', 'cat-file', '-t', self.refspec]
|
|
|
|
def fetch_cmd(self):
|
|
return ['git', 'fetch', '--all']
|
|
|
|
def is_dirty_cmd(self):
|
|
return ['git', 'diff-index', 'HEAD', '--shortstat']
|
|
|
|
def current_rev_cmd(self):
|
|
return ['git', 'rev-parse', '--verify', 'HEAD']
|
|
|
|
def checkout_cmd(self):
|
|
return ['git', 'checkout', '-q',
|
|
'{refspec}'.format(refspec=self.refspec)]
|
|
|
|
def apply_patches_file_cmd(self, path):
|
|
return ['git', 'am', '-q', path]
|
|
|
|
def apply_patches_quilt_cmd(self, path):
|
|
return ['git', 'quiltimport', '--author', 'kas <kas@example.com>',
|
|
'--patches', path]
|
|
|
|
|
|
class MercurialRepo(RepoImpl):
|
|
"""
|
|
Provides the hg implementations for a Repo.
|
|
"""
|
|
# pylint: disable=no-self-use,missing-docstring,unused-argument
|
|
|
|
def clone_cmd(self, gitsrcdir, config):
|
|
return ['hg', 'clone', self.url, self.path]
|
|
|
|
def contains_refspec_cmd(self):
|
|
return ['hg', 'log', '-r', self.refspec]
|
|
|
|
def fetch_cmd(self):
|
|
return ['hg', 'pull']
|
|
|
|
def is_dirty_cmd(self):
|
|
return ['hg', 'diff']
|
|
|
|
def current_rev_cmd(self):
|
|
return ['hg', 'identify', '-i', '--debug']
|
|
|
|
def checkout_cmd(self):
|
|
return ['hg', 'checkout', '{refspec}'.format(refspec=self.refspec)]
|
|
|
|
def apply_patches_file_cmd(self, path):
|
|
raise NotImplementedError()
|
|
|
|
def apply_patches_quilt_cmd(self, path):
|
|
raise NotImplementedError()
|