420bf399b3
If a remote branch is referenced as refs/heads/<branch>, also drop the heads/ from the local branch name to have a consistent naming. This wasn't noticed so far because the primary use case of refs/ is addressing symbolic refs in upstream, and the related test case (test_refspec_absolute) was papering over another hidden kas issues while using refs/heads/. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
510 lines
18 KiB
Python
510 lines
18 KiB
Python
# kas - setup tool for bitbake based projects
|
|
#
|
|
# Copyright (c) Siemens AG, 2017-2019
|
|
#
|
|
# 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 re
|
|
import os
|
|
import sys
|
|
import logging
|
|
from urllib.parse import urlparse
|
|
from tempfile import TemporaryDirectory
|
|
from .context import get_context
|
|
from .libkas import run_cmd_async, run_cmd
|
|
from .kasusererror import KasUserError
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
|
|
|
|
|
|
class UnsupportedRepoTypeError(KasUserError, NotImplementedError):
|
|
"""
|
|
The requested repo type is unsupported / not implemented
|
|
"""
|
|
pass
|
|
|
|
|
|
class RepoRefError(KasUserError):
|
|
"""
|
|
The requested repo reference is invalid, missing or could not be found
|
|
"""
|
|
pass
|
|
|
|
|
|
class PatchFileNotFound(KasUserError, FileNotFoundError):
|
|
"""
|
|
The requested patch file was not found
|
|
"""
|
|
pass
|
|
|
|
|
|
class PatchMappingError(KasUserError):
|
|
"""
|
|
The requested patch can not be related to a repo
|
|
"""
|
|
pass
|
|
|
|
|
|
class PatchApplyError(KasUserError):
|
|
"""
|
|
The provided patch file could not be applied
|
|
"""
|
|
|
|
|
|
class Repo:
|
|
"""
|
|
Represents a repository in the kas configuration.
|
|
"""
|
|
|
|
def __init__(self, name, url, path, refspec, layers, patches,
|
|
disable_operations):
|
|
self.name = name
|
|
self.url = url
|
|
self.path = path
|
|
self.refspec = refspec
|
|
self._layers = layers
|
|
self._patches = patches
|
|
self.operations_disabled = disable_operations
|
|
|
|
def __getattr__(self, item):
|
|
if item == 'layers':
|
|
return [os.path.join(self.path, layer).rstrip(os.sep + '.')
|
|
for layer in self._layers]
|
|
elif item == 'qualified_name':
|
|
url = urlparse(self.url)
|
|
return ('{url.netloc}{url.path}'
|
|
.format(url=url)
|
|
.replace('@', '.')
|
|
.replace(':', '.')
|
|
.replace('/', '.')
|
|
.replace('*', '.'))
|
|
elif item == 'effective_url':
|
|
mirrors = os.environ.get('KAS_PREMIRRORS', '')
|
|
for mirror in mirrors.split('\n'):
|
|
try:
|
|
expr, subst = mirror.split()
|
|
if re.match(expr, self.url):
|
|
return re.sub(expr, subst, self.url)
|
|
except ValueError:
|
|
continue
|
|
return self.url
|
|
elif item == 'revision':
|
|
if not self.refspec:
|
|
return None
|
|
(_, output) = run_cmd(self.resolve_branch_cmd(),
|
|
cwd=self.path, fail=False)
|
|
if output:
|
|
return output.strip()
|
|
return self.refspec
|
|
|
|
# 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, repo_defaults, repo_fallback_path,
|
|
repo_overrides={}):
|
|
"""
|
|
Returns a Repo instance depending on params.
|
|
"""
|
|
layers_dict = repo_config.get('layers', {'': None})
|
|
layers = list(filter(lambda x, laydict=layers_dict:
|
|
str(laydict[x]).lower() not in
|
|
['disabled', 'excluded', 'n', 'no', '0', 'false'],
|
|
layers_dict))
|
|
default_patch_repo = repo_defaults.get('patches', {}).get('repo', None)
|
|
patches_dict = repo_config.get('patches', {})
|
|
patches = []
|
|
for p in sorted(patches_dict):
|
|
if not patches_dict[p]:
|
|
continue
|
|
this_patch = {
|
|
'id': p,
|
|
'repo': patches_dict[p].get('repo', default_patch_repo),
|
|
'path': patches_dict[p]['path'],
|
|
}
|
|
if this_patch['repo'] is None:
|
|
raise PatchMappingError(
|
|
'No repo specified for patch entry "{}" and no '
|
|
'default repo specified.'.format(p))
|
|
|
|
patches.append(this_patch)
|
|
|
|
url = repo_config.get('url', None)
|
|
name = repo_config.get('name', name)
|
|
typ = repo_config.get('type', 'git')
|
|
refspec = repo_overrides.get('refspec', repo_config.get('refspec',
|
|
repo_defaults.get('refspec', None)))
|
|
if refspec is None and url is not None:
|
|
raise RepoRefError('No refspec specified for repository "{}". '
|
|
'This is only allowed for local repositories.'
|
|
.format(name))
|
|
|
|
path = repo_config.get('path', None)
|
|
disable_operations = False
|
|
|
|
if path is None:
|
|
if url is None:
|
|
path = Repo.get_root_path(repo_fallback_path)
|
|
logging.info('Using %s as root for repository %s', path,
|
|
name)
|
|
else:
|
|
path = os.path.join(get_context().kas_work_dir, name)
|
|
elif not os.path.isabs(path):
|
|
# Relative pathes are assumed to start from work_dir
|
|
path = os.path.join(get_context().kas_work_dir, path)
|
|
|
|
if url is None:
|
|
# No version control operation on repository
|
|
url = path
|
|
disable_operations = True
|
|
|
|
if typ == 'git':
|
|
return GitRepo(name, url, path, refspec, layers, patches,
|
|
disable_operations)
|
|
if typ == 'hg':
|
|
return MercurialRepo(name, url, path, refspec, layers, patches,
|
|
disable_operations)
|
|
raise UnsupportedRepoTypeError('Repo type "%s" not supported.' % typ)
|
|
|
|
@staticmethod
|
|
def get_root_path(path, fallback=True):
|
|
"""
|
|
Checks if path is under version control and returns its root path.
|
|
"""
|
|
(ret, output) = run_cmd(['git', 'rev-parse', '--show-toplevel'],
|
|
cwd=path, fail=False, liveupdate=False)
|
|
if ret == 0:
|
|
return output.strip()
|
|
|
|
(ret, output) = run_cmd(['hg', 'root'],
|
|
cwd=path, fail=False, liveupdate=False)
|
|
if ret == 0:
|
|
return output.strip()
|
|
|
|
return path if fallback else None
|
|
|
|
|
|
class RepoImpl(Repo):
|
|
"""
|
|
Provides a generic implementation for a Repo.
|
|
"""
|
|
|
|
async def fetch_async(self):
|
|
"""
|
|
Starts asynchronous repository fetch.
|
|
"""
|
|
|
|
if self.operations_disabled:
|
|
return 0
|
|
|
|
refdir = get_context().kas_repo_ref_dir
|
|
sdir = os.path.join(refdir, self.qualified_name) if refdir else None
|
|
|
|
# fetch to refdir
|
|
if refdir and not os.path.exists(sdir):
|
|
os.makedirs(refdir, exist_ok=True)
|
|
with TemporaryDirectory(prefix=self.qualified_name + '.',
|
|
dir=refdir) as tmpdir:
|
|
(retc, _) = await run_cmd_async(
|
|
self.clone_cmd(tmpdir, createref=True),
|
|
cwd=get_context().kas_work_dir)
|
|
|
|
logging.debug('Created repo ref for %s', self.qualified_name)
|
|
try:
|
|
os.rename(tmpdir, sdir)
|
|
if sys.version_info < (3, 8):
|
|
# recreate dir so cleanup handler can delete it
|
|
os.makedirs(tmpdir, exist_ok=True)
|
|
except OSError:
|
|
logging.debug('repo %s already cloned by other instance',
|
|
self.qualified_name)
|
|
|
|
if not os.path.exists(self.path):
|
|
os.makedirs(os.path.dirname(self.path), exist_ok=True)
|
|
(retc, _) = await run_cmd_async(
|
|
self.clone_cmd(sdir, createref=False),
|
|
cwd=get_context().kas_work_dir)
|
|
|
|
logging.info('Repository %s cloned', self.name)
|
|
|
|
# Make sure the remote origin is set to the value
|
|
# in the kas file to avoid surprises
|
|
try:
|
|
(retc, output) = await run_cmd_async(
|
|
self.set_remote_url_cmd(),
|
|
cwd=self.path,
|
|
liveupdate=False)
|
|
except NotImplementedError:
|
|
logging.warning('Repo implementation does not support changing '
|
|
'the remote url.')
|
|
|
|
# take what came out of clone and stick to that forever
|
|
if self.refspec is None:
|
|
return 0
|
|
|
|
if not get_context().update:
|
|
# Does refspec exist in the current repository?
|
|
(retc, output) = await run_cmd_async(self.contains_refspec_cmd(),
|
|
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
|
|
|
|
# Try to fetch if refspec is missing or if --update argument was passed
|
|
(retc, output) = await run_cmd_async(self.fetch_cmd(),
|
|
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):
|
|
"""
|
|
Checks out the correct revision of the repo.
|
|
"""
|
|
if self.operations_disabled or self.refspec is None:
|
|
return
|
|
|
|
if not get_context().force_checkout:
|
|
# Check if repos is dirty
|
|
(_, output) = run_cmd(self.is_dirty_cmd(),
|
|
cwd=self.path,
|
|
fail=False)
|
|
if output:
|
|
logging.warning('Repo %s is dirty - no checkout', self.name)
|
|
return
|
|
|
|
(_, output) = run_cmd(self.resolve_branch_cmd(),
|
|
cwd=self.path, fail=False)
|
|
if output:
|
|
desired_ref = output.strip()
|
|
is_branch = True
|
|
else:
|
|
desired_ref = self.refspec
|
|
is_branch = False
|
|
|
|
run_cmd(self.checkout_cmd(desired_ref, is_branch), cwd=self.path)
|
|
|
|
async def apply_patches_async(self):
|
|
"""
|
|
Applies patches to a repository asynchronously.
|
|
"""
|
|
if self.operations_disabled or not self._patches:
|
|
return 0
|
|
|
|
(retc, _) = await run_cmd_async(self.prepare_patches_cmd(),
|
|
cwd=self.path)
|
|
|
|
my_patches = []
|
|
|
|
for patch in self._patches:
|
|
other_repo = get_context().config.repo_dict.get(patch['repo'],
|
|
None)
|
|
|
|
if not other_repo:
|
|
raise PatchMappingError(
|
|
'Could not find referenced repo. '
|
|
'(missing repo: {}, repo: {}, patch entry: {})'
|
|
.format(patch['repo'], self.name, patch['id']))
|
|
|
|
path = os.path.join(other_repo.path, patch['path'])
|
|
cmd = []
|
|
|
|
if os.path.isfile(path):
|
|
my_patches.append((path, patch['id']))
|
|
elif os.path.isdir(path) \
|
|
and os.path.isfile(os.path.join(path, 'series')):
|
|
with open(os.path.join(path, 'series')) as f:
|
|
for line in f:
|
|
if line.startswith('#'):
|
|
continue
|
|
p = os.path.join(path, line.split(' #')[0].rstrip())
|
|
if os.path.isfile(p):
|
|
my_patches.append((p, patch['id']))
|
|
else:
|
|
raise PatchFileNotFound(p)
|
|
else:
|
|
raise PatchFileNotFound(
|
|
'Could not find patch. '
|
|
'(patch path: {}, repo: {}, patch entry: {})'
|
|
.format(path, self.name, patch['id']))
|
|
|
|
for (path, patch_id) in my_patches:
|
|
cmd = self.apply_patches_file_cmd(path)
|
|
(retc, output) = await run_cmd_async(
|
|
cmd, cwd=self.path, fail=False)
|
|
if retc:
|
|
raise PatchApplyError(
|
|
'Could not apply patch. Please fix repos and '
|
|
'patches. (patch path: {}, repo: {}, patch '
|
|
'entry: {}, vcs output: {})'
|
|
.format(path, self.name, patch_id, output))
|
|
|
|
logging.info('Patch applied. '
|
|
'(patch path: %s, repo: %s, patch entry: %s)',
|
|
path, self.name, patch_id)
|
|
|
|
cmd = self.add_cmd()
|
|
(retc, output) = await run_cmd_async(
|
|
cmd, cwd=self.path, fail=False)
|
|
if retc:
|
|
raise PatchApplyError(
|
|
'Could not add patched files. repo: {}, vcs output: {})'
|
|
.format(self.name, output))
|
|
|
|
cmd = self.commit_cmd()
|
|
(retc, output) = await run_cmd_async(
|
|
cmd, cwd=self.path, fail=False)
|
|
if retc:
|
|
raise PatchApplyError(
|
|
'Could not commit patch changes. repo: {}, vcs output: {})'
|
|
.format(self.name, output))
|
|
|
|
return 0
|
|
|
|
|
|
class GitRepo(RepoImpl):
|
|
"""
|
|
Provides the git functionality for a Repo.
|
|
"""
|
|
|
|
def remove_ref_prefix(self, refspec):
|
|
ref_prefix = 'refs/'
|
|
return refspec[refspec.startswith(ref_prefix) and len(ref_prefix):]
|
|
|
|
def add_cmd(self):
|
|
return ['git', 'add', '-A']
|
|
|
|
def clone_cmd(self, srcdir, createref):
|
|
cmd = ['git', 'clone', '-q']
|
|
if createref:
|
|
cmd.extend([self.effective_url, '--bare', srcdir])
|
|
elif srcdir:
|
|
cmd.extend([srcdir, '--reference', srcdir, self.path])
|
|
else:
|
|
cmd.extend([self.effective_url, self.path])
|
|
return cmd
|
|
|
|
def commit_cmd(self):
|
|
return ['git', 'commit', '-a', '--author', 'kas <kas@example.com>',
|
|
'-m', 'msg']
|
|
|
|
def contains_refspec_cmd(self):
|
|
return ['git', 'cat-file', '-t', self.remove_ref_prefix(self.refspec)]
|
|
|
|
def fetch_cmd(self):
|
|
cmd = ['git', 'fetch', '-q']
|
|
if self.refspec.startswith('refs/'):
|
|
cmd.extend(['origin',
|
|
'+' + self.refspec
|
|
+ ':refs/remotes/origin/'
|
|
+ self.remove_ref_prefix(self.refspec)])
|
|
|
|
return cmd
|
|
|
|
def is_dirty_cmd(self):
|
|
return ['git', 'status', '-s']
|
|
|
|
def resolve_branch_cmd(self):
|
|
return ['git', 'rev-parse', '--verify', '-q',
|
|
'origin/{refspec}'.
|
|
format(refspec=self.remove_ref_prefix(self.refspec))]
|
|
|
|
def checkout_cmd(self, desired_ref, is_branch):
|
|
cmd = ['git', 'checkout', '-q', self.remove_ref_prefix(desired_ref)]
|
|
if is_branch:
|
|
branch = self.remove_ref_prefix(self.refspec)
|
|
branch = branch[branch.startswith('heads/') and len('heads/'):]
|
|
cmd.extend(['-B', branch])
|
|
if get_context().force_checkout:
|
|
cmd.append('--force')
|
|
return cmd
|
|
|
|
def prepare_patches_cmd(self):
|
|
return ['git', 'checkout', '-q', '-B',
|
|
'patched-{refspec}'.
|
|
format(refspec=self.remove_ref_prefix(self.refspec))]
|
|
|
|
def apply_patches_file_cmd(self, path):
|
|
return ['git', 'apply', '--whitespace=nowarn', path]
|
|
|
|
def set_remote_url_cmd(self):
|
|
return ['git', 'remote', 'set-url', 'origin', self.effective_url]
|
|
|
|
|
|
class MercurialRepo(RepoImpl):
|
|
"""
|
|
Provides the hg functionality for a Repo.
|
|
"""
|
|
|
|
def add_cmd(self):
|
|
return ['hg', 'add']
|
|
|
|
def clone_cmd(self, srcdir, createref):
|
|
# Mercurial does not support repo references (object caches)
|
|
if createref:
|
|
return ['true']
|
|
return ['hg', 'clone', self.effective_url, self.path]
|
|
|
|
def commit_cmd(self):
|
|
return ['hg', 'commit', '--user', 'kas <kas@example.com>', '-m', 'msg']
|
|
|
|
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 resolve_branch_cmd(self):
|
|
# We never need to care about creating tracking branches in mercurial
|
|
return ['false']
|
|
|
|
def checkout_cmd(self, desired_ref, is_branch):
|
|
cmd = ['hg', 'checkout', desired_ref]
|
|
if get_context().force_checkout:
|
|
cmd.append('--clean')
|
|
return cmd
|
|
|
|
def prepare_patches_cmd(self):
|
|
return ['hg', 'branch', '-f',
|
|
'patched-{refspec}'.format(refspec=self.refspec)]
|
|
|
|
def apply_patches_file_cmd(self, path):
|
|
return ['hg', 'import', '--no-commit', path]
|
|
|
|
def set_remote_url_cmd(self):
|
|
raise NotImplementedError()
|