SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactor repo checkout

Browse Source 
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>
This commit is contained in:
Andreas Reichel
2018-08-13 14:11:22 +02:00
committed by Daniel Wagner
parent 3bada55d30
commit 7b18e5ec3b
7 changed files with 258 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
kas/repos.py
View File

@@ -75,6 +75,7 @@ class Repo:
"""
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
@@ -100,7 +101,7 @@ class Repo:
# No version control operation on repository
if path is None:
path = Repo.get_root_path(os.path.dirname(config.filename),
config.environ)
config.context.environ)
logging.info('Using %s as root for repository %s', path,
name)
@@ -108,11 +109,11 @@ class Repo:
disable_operations = True
else:
if path is None:
path = os.path.join(config.kas_work_dir, name)
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(config.kas_work_dir, path)
path = os.path.join(ctx.kas_work_dir, path)
if typ == 'git':
return GitRepo(url, path, refspec, layers, patches,
@@ -148,7 +149,7 @@ class RepoImpl(Repo):
"""
@asyncio.coroutine
def fetch_async(self, config):
def fetch_async(self, ctx):
"""
Start asynchronous repository fetch.
"""
@@ -157,13 +158,13 @@ class RepoImpl(Repo):
if not os.path.exists(self.path):
os.makedirs(os.path.dirname(self.path), exist_ok=True)
sdir = os.path.join(config.get_repo_ref_dir() or '',
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, config),
env=config.environ,
cwd=config.kas_work_dir)
(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
@@ -174,7 +175,7 @@ class RepoImpl(Repo):
# Does refspec exist in the current repository?
(retc, output) = yield from run_cmd_async(self.contains_refspec_cmd(),
env=config.environ,
env=ctx.environ,
cwd=self.path,
fail=False,
liveupdate=False)
@@ -185,7 +186,7 @@ class RepoImpl(Repo):
# No it is missing, try to fetch
(retc, output) = yield from run_cmd_async(self.fetch_cmd(),
env=config.environ,
env=ctx.environ,
cwd=self.path,
fail=False)
if retc:
@@ -195,7 +196,7 @@ class RepoImpl(Repo):
logging.info('Repository %s updated', self.name)
return 0
def checkout(self, config):
def checkout(self, ctx):
"""
Checks out the correct revision of the repo.
"""
@@ -204,7 +205,7 @@ class RepoImpl(Repo):
# Check if repos is dirty
(_, output) = run_cmd(self.is_dirty_cmd(),
env=config.environ, cwd=self.path,
env=ctx.environ, cwd=self.path,
fail=False)
if output:
logging.warning('Repo %s is dirty. no checkout', self.name)
@@ -212,7 +213,7 @@ class RepoImpl(Repo):
# Check if current HEAD is what in the config file is defined.
(_, output) = run_cmd(self.current_rev_cmd(),
env=config.environ, cwd=self.path)
env=ctx.environ, cwd=self.path)
if output.strip() == self.refspec:
logging.info('Repo %s has already checkout out correct '
@@ -222,7 +223,7 @@ class RepoImpl(Repo):
run_cmd(self.checkout_cmd(), cwd=self.path)
@asyncio.coroutine
def apply_patches_async(self, config):
def apply_patches_async(self, ctx):
"""
Applies patches to repository asynchronously.
"""
@@ -230,7 +231,7 @@ class RepoImpl(Repo):
return 0
for patch in self._patches:
other_repo = config.repo_dict.get(patch['repo'], None)
other_repo = ctx.config.repo_dict.get(patch['repo'], None)
if not other_repo:
logging.warning('Could not find referenced repo. '
@@ -257,20 +258,20 @@ class RepoImpl(Repo):
continue
(retc, output) = yield from run_cmd_async(cmd,
env=config.environ,
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
logging.info('Patch applied. '
'(patch path: %s, repo: %s, patch entry: %s)',
path, self.name, patch['id'])
else:
logging.info('Patch applied. '
'(patch path: %s, repo: %s, patch entry: %s)',
path, self.name, patch['id'])
return 0
@@ -280,9 +281,9 @@ class GitRepo(RepoImpl):
"""
# pylint: disable=no-self-use,missing-docstring
def clone_cmd(self, gitsrcdir, config):
def clone_cmd(self, gitsrcdir, ctx):
cmd = ['git', 'clone', '-q', self.url, self.path]
if config.get_repo_ref_dir() and os.path.exists(gitsrcdir):
if ctx.kas_repo_ref_dir and os.path.exists(gitsrcdir):
cmd.extend(['--reference', gitsrcdir])
return cmd