poky/meta/lib/oeqa/utils/git.py
Markus Lehtonen 979c735678 oeqa.utils.git.GitRepo: new arg to require topdir
Add a new 'is_topdir' argument to the GitRepo init method which
validates that the given path is the top directory of a Git repository.
Without this argument GitRepo also accepts subdirectories of a Git
repository (in which case GitRepo will point to the parent directory
that is the top directory of this repository) which may have undesired
in some cases.

(From OE-Core rev: 044c81bd916fbe7140d184eb103f74786cfef604)

Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:03:47 +01:00

63 lines
2.0 KiB
Python

#
# Copyright (C) 2016 Intel Corporation
#
# Released under the MIT license (see COPYING.MIT)
#
"""Git repository interactions"""
import os
from oeqa.utils.commands import runCmd
class GitError(Exception):
"""Git error handling"""
pass
class GitRepo(object):
"""Class representing a Git repository clone"""
def __init__(self, path, is_topdir=False):
self.top_dir = self._run_git_cmd_at(['rev-parse', '--show-toplevel'],
path)
realpath = os.path.realpath(path)
if is_topdir and realpath != self.top_dir:
raise GitError("{} is not a Git top directory".format(realpath))
@staticmethod
def _run_git_cmd_at(git_args, cwd, **kwargs):
"""Run git command at a specified directory"""
git_cmd = 'git ' if isinstance(git_args, str) else ['git']
git_cmd += git_args
ret = runCmd(git_cmd, ignore_status=True, cwd=cwd, **kwargs)
if ret.status:
cmd_str = git_cmd if isinstance(git_cmd, str) \
else ' '.join(git_cmd)
raise GitError("'{}' failed with exit code {}: {}".format(
cmd_str, ret.status, ret.output))
return ret.output.strip()
def run_cmd(self, git_args, env_update=None):
"""Run Git command"""
env = None
if env_update:
env = os.environ.copy()
env.update(env_update)
return self._run_git_cmd_at(git_args, self.top_dir, env=env)
def rev_parse(self, revision):
"""Do git rev-parse"""
try:
return self.run_cmd(['rev-parse', revision])
except GitError:
# Revision does not exist
return None
def get_current_branch(self):
"""Get current branch"""
try:
# Strip 11 chars, i.e. 'refs/heads' from the beginning
return self.run_cmd(['symbolic-ref', 'HEAD'])[11:]
except GitError:
return None