/usr/lib/python3/dist-packages/vcstools/git.py is in python3-vcstools 0.1.39-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 | # Software License Agreement (BSD License)
#
# Copyright (c) 2010, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided
# with the distribution.
# * Neither the name of Willow Garage, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
"""
git vcs support.
refnames in git can be branchnames, hashes, partial hashes, tags. On
checkout, git will disambiguate by checking them in that order, taking
the first that applies
This class aims to provide git for linear centralized workflows. This
means in case of ambiguity, we assume that the only relevant remote
is the one named "origin", and we assume that commits once on origin
remain on origin.
A challenge with git is that it has strong reasonable conventions, but
is very allowing for breaking them. E.g. it is possible to name
remotes and branches with names like "refs/heads/master", give
branches and tags the same name, or a valid SHA-ID as name, etc.
Similarly git allows plenty of ways to reference any object, in case
of ambiguities, git attempts to take the most reasonable
disambiguation, and in some cases warns.
"""
from __future__ import absolute_import, print_function, unicode_literals
import os
import sys
import shutil
import tempfile
import gzip
import dateutil.parser # For parsing date strings
from distutils.version import LooseVersion
import logging
from vcstools.vcs_base import VcsClientBase, VcsError
from vcstools.common import sanitized, normalized_rel_path, run_shell_command
from vcstools.git_archive_all import *
class GitError(Exception):
pass
def _git_diff_path_submodule_change(diff, rel_path_prefix):
"""
Parses git diff result and changes the filename prefixes.
"""
if diff is None:
return None
INIT = 0
INDIFF = 1
# small state machine makes sure we never touch anything inside
# the actual diff
state = INIT
result = ""
s_list = [line for line in diff.split(os.linesep)]
subrel_path = rel_path_prefix
for line in s_list:
newline = line
if line.startswith("Entering '"):
state = INIT
submodulepath = line.rstrip("'")[len("Entering '"):]
subrel_path = os.path.join(rel_path_prefix, submodulepath)
continue
if line.startswith("diff --git "):
state = INIT
if state == INIT:
if line.startswith("@@"):
state = INDIFF
else:
if line.startswith("---") and not line.startswith("--- /dev/null"):
newline = "--- " + subrel_path + line[5:]
if line.startswith("+++") and not line.startswith("+++ /dev/null"):
newline = "+++ " + subrel_path + line[5:]
if line.startswith("diff --git"):
# first replacing b in case path starts with a/
newline = line.replace(" b/", " " + subrel_path + "/", 1)
newline = newline.replace(" a/", " " + subrel_path + "/", 1)
if newline != '':
result += newline + '\n'
return result
def _get_git_version():
"""Looks up git version by calling git --version.
:raises: VcsError if git is not installed or returns
something unexpected"""
try:
cmd = 'git --version'
value, version, _ = run_shell_command(cmd, shell=True)
if value != 0:
raise VcsError("git --version returned %s, maybe git is not installed" % (value))
prefix = 'git version '
if version is not None and version.startswith(prefix):
version = version[len(prefix):].strip()
else:
raise VcsError("git --version returned invalid string: '%s'" % version)
except VcsError as exc:
raise VcsError("Could not determine whether git is installed: %s" % exc)
return version
class GitClient(VcsClientBase):
def __init__(self, path):
"""
:raises: VcsError if git not detected
"""
VcsClientBase.__init__(self, 'git', path)
self.gitversion = _get_git_version()
@staticmethod
def get_environment_metadata():
metadict = {}
try:
version = _get_git_version()
resetkeep = LooseVersion(version) >= LooseVersion('1.7.1')
submodules = LooseVersion(version) > LooseVersion('1.7')
metadict["features"] = "'reset --keep': %s, submodules: %s" % (resetkeep, submodules)
except VcsError:
version = "No git installed"
metadict["version"] = version
return metadict
def get_url(self):
"""
:returns: git URL of the directory path (output of git info command), or None if it cannot be determined
"""
if self.detect_presence():
cmd = "git config --get remote.%s.url" % self._get_default_remote()
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
return output.rstrip()
return None
def _get_default_remote(self):
"""
in order to support users who name their default origin
something else than origin, read remote name.
"""
# TODO: maybe pick other remote depending on context
return 'origin'
@staticmethod
def static_detect_presence(path):
# There is a proposed implementation of detect_presence which might be
# more future proof, but would depend on parsing the output of git
# See: https://github.com/vcstools/vcstools/pull/10
return os.path.exists(os.path.join(path, '.git'))
def checkout(self, url, version=None, verbose=False, shallow=False, timeout=None):
"""calls git clone and then, if version was given, update(version)"""
if url is None or url.strip() == '':
raise ValueError('Invalid empty url : "%s"' % url)
# since we cannot know whether version names a branch, clone master initially
cmd = 'git clone'
if shallow:
cmd += ' --depth 1'
if LooseVersion(self.gitversion) >= LooseVersion('1.7.10'):
cmd += ' --no-single-branch'
if version is None:
# quicker than using _do_update, but undesired when switching branches next
cmd += ' --recursive'
cmd += ' %s %s' % (url, self._path)
value, _, msg = run_shell_command(cmd,
shell=True,
no_filter=True,
show_stdout=verbose,
timeout=timeout,
verbose=verbose)
if value != 0:
if msg:
self.logger.error('%s' % msg)
return False
try:
# update to make sure we are on the right branch. Do not
# check for "master" here, as default branch could be anything
if version is not None:
return self._do_update(version,
verbose=verbose,
fast_foward=True,
timeout=timeout,
update_submodules=True)
else:
return True
except GitError:
return False
def _update_submodules(self, verbose=False, timeout=None):
# update submodules ( and init if necessary ).
if LooseVersion(self.gitversion) > LooseVersion('1.7'):
cmd = "git submodule update --init --recursive"
value, _, _ = run_shell_command(cmd,
shell=True,
cwd=self._path,
show_stdout=True,
timeout=timeout,
verbose=verbose)
if value != 0:
return False
return True
def update(self, version=None, verbose=False, force_fetch=False, timeout=None):
"""
if version is None, attempts fast-forwarding current branch, if any.
Else interprets version as a local branch, remote branch, tagname,
hash, etc.
If it is a branch, attempts to move to it unless
already on it, and to fast-forward, unless not a tracking
branch. Else go untracked on tag or whatever version is. Does
not leave if current commit would become dangling.
:return: True if already up-to-date with remote or after successful fast_foward
"""
if not self.detect_presence():
return False
try:
# fetch in any case to get updated tags even if we don't need them
self._do_fetch()
return self._do_update(refname=version, verbose=verbose, timeout=timeout)
except GitError:
return False
def _do_update(self,
refname=None,
verbose=False,
fast_foward=True,
timeout=None,
update_submodules=True):
'''
updates without fetching, thus any necessary fetching must be done before
allows arguments to reduce unnecessary steps after checkout
:param fast_foward: if false, does not perform fast-forward
:param update_submodules: if false, does not attempt to update submodules
'''
# are we on any branch?
current_branch = self._get_branch()
branch_parent = None
if current_branch:
# local branch might be named differently from remote by user, we respect that
same_branch = (refname == current_branch)
if not same_branch:
(branch_parent, remote) = self._get_branch_parent(current_branch=current_branch)
if not refname:
# ! changing refname to cause fast-forward
refname = branch_parent
same_branch = True
else:
same_branch = (refname == branch_parent)
if same_branch and not branch_parent:
# avoid expensive checking branch parent again later
fast_foward = False
else:
same_branch = False
if not refname:
# we are neither tracking, nor did we get any refname to update to
return (not update_submodules) or self._update_submodules(verbose=verbose,
timeout=timeout)
default_remote = self._get_default_remote()
if same_branch:
if fast_foward:
if not branch_parent and current_branch:
(branch_parent, remote) = self._get_branch_parent(current_branch=current_branch)
if remote != default_remote:
# if remote is not origin, must not fast-forward (because based on origin)
logger = logging.getLogger('vcstools')
logger.warn("vcstools only handles branches tracking default remote,"
" branch '%s' tracks remote '%s'.\nRepository path is '%s'."
% (current_branch, remote, self._path))
branch_parent = None
# already on correct branch, fast-forward if there is a parent
if branch_parent:
if not self._do_fast_forward(branch_parent=branch_parent,
fetch=False,
verbose=verbose):
return False
else:
# refname can be a different branch or something else than a branch
refname_is_local_branch = self._is_local_branch(refname)
if refname_is_local_branch:
# might also be remote branch, but we treat it as local
refname_is_remote_branch = False
else:
refname_is_remote_branch = self._is_remote_branch(refname, fetch=False)
refname_is_branch = refname_is_remote_branch or refname_is_local_branch
current_version = None
# shortcut if version is the same as requested
if not refname_is_branch:
current_version = self.get_version()
if current_version == refname:
return (not update_submodules) or self._update_submodules(verbose=verbose,
timeout=timeout)
if current_branch is None:
if not current_version:
current_version = self.get_version()
# prevent commit from becoming dangling
if self._is_commit_in_orphaned_subtree(current_version, fetch=False):
# commit becomes dangling unless we move to one of its descendants
if not self._rev_list_contains(refname, current_version, fetch=False):
# TODO: should raise error instead of printing message
sys.stderr.write("vcstools refusing to move away from dangling commit, to protect your work.\n")
return False
# git checkout makes all the decisions for us
self._do_checkout(refname, verbose=verbose, fetch=False)
if refname_is_local_branch:
# if we just switched to a local tracking branch (not created one), we should also fast forward
(new_branch_parent, remote) = self._get_branch_parent(current_branch=refname)
if remote != default_remote:
# if remote is not origin, must not fast-forward (because based on origin)
sys.stderr.write("vcstools only handles branches tracking default remote," +
" branch '%s' tracks remote '%s'\n" % (current_branch, remote))
new_branch_parent = None
if new_branch_parent is not None:
if fast_foward:
if not self._do_fast_forward(branch_parent=new_branch_parent,
fetch=False,
verbose=verbose):
return False
return (not update_submodules) or self._update_submodules(verbose=verbose, timeout=timeout)
def get_current_version_label(self):
"""
For git we change the label to clarify when a different remote
is configured.
"""
branch = self._get_branch()
if branch is None:
return '<detached>'
result = branch
(remote_branch, remote) = self._get_branch_parent()
if remote_branch is not None:
default_remote = self._get_default_remote()
# if not following 'origin/branch', display 'branch < tracked ref'
if (remote_branch != branch or remote != default_remote):
result += ' < '
if remote != default_remote:
result += remote + '/'
result += remote_branch
return result
def get_default_remote_version_label(self):
if self.detect_presence():
_, output, _ = run_shell_command('git remote show %s' % self._get_default_remote(),
shell=True,
cwd=self._path)
for line in output.splitlines():
elems = line.split()
if elems[0:2] == ['HEAD', 'branch:']:
return elems[2]
return None
def get_remote_version(self, fetch=False):
# try tracked branch on origin (returns None if on other remote)
(parent_branch, remote) = self._get_branch_parent(fetch=fetch)
if parent_branch is not None:
return self.get_version(spec=remote+'/'+parent_branch)
def get_version(self, spec=None):
"""
:param spec: (optional) token to identify desired version. For
git, this may be anything accepted by git log, e.g. a tagname,
branchname, or sha-id.
:param fetch: When spec is given, can be used to suppress git fetch call
:returns: current SHA-ID of the repository. Or if spec is
provided, the SHA-ID of a commit specified by some token if found, else None
"""
if self.detect_presence():
command = "git log -1"
if spec is not None:
command += " %s" % sanitized(spec)
command += " --format='%H'"
_, output, _ = run_shell_command(command, shell=True,
no_warn=True, cwd=self._path)
if output.strip() != '':
# On Windows the version can have single quotes around it
version = output.strip().strip("'")
return version # found SHA-ID
elif spec is None:
return None
# we try again after fetching if given spec had not been found
try:
self._do_fetch()
except GitError:
return None
# we repeat the call once again after fetching
_, output, _ = run_shell_command(command, shell=True,
no_warn=True, cwd=self._path)
if output.strip() == '':
# even if after fetching, not found specified version
return None
version = output.strip().strip("'")
return version
return None
def get_diff(self, basepath=None):
response = ''
if basepath is None:
basepath = self._path
if self.path_exists():
rel_path = normalized_rel_path(self._path, basepath)
# git needs special treatment as it only works from inside
# use HEAD to also show staged changes. Maybe should be option?
# injection should be impossible using relpath, but to be sure, we check
cmd = "git diff HEAD --src-prefix=%s/ --dst-prefix=%s/ ." % \
(sanitized(rel_path), sanitized(rel_path))
_, response, _ = run_shell_command(cmd, shell=True, cwd=self._path)
if LooseVersion(self.gitversion) > LooseVersion('1.7'):
cmd = 'git submodule foreach --recursive git diff HEAD'
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
response += _git_diff_path_submodule_change(output, rel_path)
return response
def get_affected_files(self, revision):
cmd = "git show {0} --pretty='format:' --name-only".format(
revision)
code, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
affected = []
if code == 0:
for filename in output.splitlines():
if filename not in ('', None, ):
affected.append(filename)
return affected
def get_log(self, relpath=None, limit=None):
response = []
if relpath is None:
relpath = ''
if self.path_exists() and os.path.exists(os.path.join(self._path, relpath)):
# Get the log
limit_cmd = (("-n %d" % (int(limit))) if limit else "")
GIT_COMMIT_FIELDS = ['id', 'author', 'email', 'date', 'message']
GIT_LOG_FORMAT = '%x1f'.join(['%H', '%an', '%ae', '%ad', '%s']) + '%x1e'
command = "git --work-tree=%s log --format=\"%s\" %s %s " % (self._path, GIT_LOG_FORMAT,
limit_cmd, sanitized(relpath))
return_code, response_str, stderr = run_shell_command(command, shell=True, cwd=self._path)
if return_code == 0:
# Parse response
response = response_str.strip('\n\x1e').split("\x1e")
response = [row.strip().split("\x1f") for row in response]
response = [dict(zip(GIT_COMMIT_FIELDS, row)) for row in response]
# Parse dates
for entry in response:
entry['date'] = dateutil.parser.parse(entry['date'])
return response
def get_status(self, basepath=None, untracked=False):
response = None
if basepath is None:
basepath = self._path
if self.path_exists():
rel_path = normalized_rel_path(self._path, basepath)
# git command only works inside repo
# self._path is safe against command injection, as long as we check path.exists
command = "git status -s "
if not untracked:
command += " -uno"
_, response, _ = run_shell_command(command,
shell=True,
cwd=self._path)
response_processed = ""
for line in response.split('\n'):
if len(line.strip()) > 0:
# prepend relative path
response_processed += '%s%s/%s\n' % (line[0:3],
rel_path,
line[3:])
if LooseVersion(self.gitversion) > LooseVersion('1.7'):
command = "git submodule foreach --recursive git status -s"
if not untracked:
command += " -uno"
_, response2, _ = run_shell_command(command,
shell=True,
cwd=self._path)
for line in response2.split('\n'):
if line.startswith("Entering"):
continue
if len(line.strip()) > 0:
# prepend relative path
response_processed += line[0:3] + rel_path + '/' + line[3:] + '\n'
response = response_processed
return response
def _is_remote_branch(self, branch_name, remote_name=None, fetch=True):
"""
checks list of remote branches for match. Set fetch to False if you just fetched already.
:returns: True if branch_name exists for remote <remote_name> (or 'origin' if None)
:raises: GitError when git fetch fails
"""
if remote_name is None:
remote_name = self._get_default_remote()
if self.path_exists():
if fetch:
self._do_fetch()
_, output, _ = run_shell_command('git branch -r',
shell=True,
cwd=self._path)
for l in output.splitlines():
elem = l.split()[0]
rem_name = elem[:elem.find('/')]
br_name = elem[elem.find('/') + 1:]
if rem_name == remote_name and br_name == branch_name:
return True
return False
def _is_local_branch(self, branch_name):
if self.path_exists():
_, output, _ = run_shell_command('git branch',
shell=True,
cwd=self._path)
for line in output.splitlines():
elems = line.split()
if len(elems) == 1:
if elems[0] == branch_name:
return True
elif len(elems) == 2:
if elems[0] == '*' and elems[1] == branch_name:
return True
return False
def _get_branch(self):
if self.path_exists():
_, output, _ = run_shell_command('git branch',
shell=True,
cwd=self._path)
for line in output.splitlines():
elems = line.split()
if len(elems) == 2 and elems[0] == '*':
return elems[1]
return None
def _get_branch_parent(self, fetch=False, current_branch=None):
"""
:param fetch: if true, performs git fetch first
:param current_branch: if not None, this is used as current branch (else extra shell call)
:returns: (branch, remote) the name of the branch this branch tracks and its remote
:raises: GitError if fetch fails
"""
if not self.path_exists():
return (None, None)
# get name of configured merge ref.
branchname = current_branch or self._get_branch()
if branchname is None:
return (None, None)
cmd = 'git config --get %s' % sanitized('branch.%s.merge' % branchname)
_, output, _ = run_shell_command(cmd,
shell=True,
cwd=self._path)
if not output:
return (None, None)
lines = output.splitlines()
if len(lines) > 1:
sys.stderr.write("vcstools unable to handle multiple merge references for branch %s:\n%s\n"
% (branchname, output))
return (None, None)
# get name of configured remote
cmd = 'git config --get "branch.%s.remote"' % branchname
_, output2, _ = run_shell_command(cmd, shell=True, cwd=self._path)
remote = output2 or self._get_default_remote()
branch_reference = lines[0]
# branch_reference is either refname, or /refs/heads/refname, or
# heads/refname we would like to return refname however,
# user could also have named any branch
# "/refs/heads/refname", for some unholy reason check all
# known branches on remote for refname, then for the odd
# cases, as git seems to do
candidate = branch_reference
if candidate.startswith('refs/'):
candidate = candidate[len('refs/'):]
if candidate.startswith('heads/'):
candidate = candidate[len('heads/'):]
elif candidate.startswith('tags/'):
candidate = candidate[len('tags/'):]
elif candidate.startswith('remotes/'):
candidate = candidate[len('remotes/'):]
result = None
if self._is_remote_branch(candidate, remote_name=remote, fetch=fetch):
result = candidate
elif branch_reference != candidate and self._is_remote_branch(branch_reference,
remote_name=remote,
fetch=False):
result = branch_reference
if result is not None:
return (result, remote)
return None, None
def is_tag(self, tag_name, fetch=True):
"""
checks list of tags for match.
Set fetch to False if you just fetched already.
:returns: True if tag_name among known tags
:raises: GitError when call to git fetch fails
"""
if fetch:
self._do_fetch()
if not tag_name:
raise ValueError('is_tag requires tag_name, got: "%s"' % tag_name)
if self.path_exists():
cmd = 'git tag -l %s' % sanitized(tag_name)
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
lines = output.splitlines()
if len(lines) == 1:
return True
return False
def _rev_list_contains(self, refname, version, fetch=True):
"""
calls git rev-list with refname and returns True if version
can be found in rev-list result
:param refname: a git refname
:param version: an SHA IDs (if partial, caller is responsible
for mismatch)
:returns: True if version is an ancestor commit from refname
:raises: GitError when call to git fetch fails
"""
# to avoid listing unnecessarily many rev-ids, we cut off all
# those we are definitely not interested in
# $ git rev-list foo bar ^baz ^bez
# means "list all the commits which are reachable from foo or
# bar, but not from baz or bez". We use --parents because
# ^baz also excludes baz itself. We could also use git
# show --format=%P to get all parents first and use that,
# not sure what's more performant
if fetch:
self._do_fetch()
if (refname is not None and refname != '' and
version is not None and version != ''):
cmd = 'git rev-list %s ^%s --parents' % (sanitized(refname), sanitized(version))
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
for line in output.splitlines():
# can have 1, 2 or 3 elements (commit, parent1, parent2)
for hashid in line.split(" "):
if hashid.startswith(version):
return True
return False
def _is_commit_in_orphaned_subtree(self, version, mask_self=False, fetch=True):
"""
checks git log --all (the list of all commits reached by
references, meaning branches or tags) for version. If it shows
up, that means git garbage collection will not remove the
commit. Else it would eventually be deleted.
:param version: SHA IDs (if partial, caller is responsible for mismatch)
:param mask_self: whether to consider direct references to this commit
(rather than only references on descendants) as well
:param fetch: whether fetch should be done first for remote refs
:returns: True if version is not recursively referenced by a branch or tag
:raises: GitError if git fetch fails
"""
if fetch:
self._do_fetch()
if version is not None and version != '':
cmd = 'git show-ref -s'
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
refs = output.splitlines()
# 2000 seems like a number the linux shell can cope with
chunksize = 2000
refchunks = [refs[x:x + chunksize] for x in range(0, len(refs), chunksize)]
for refchunk in refchunks:
# git log over all refs except HEAD
cmd = 'git log ' + " ".join(refchunk)
if mask_self:
# %P: parent hashes
cmd += " --pretty=format:%P"
else:
# %H: commit hash
cmd += " --pretty=format:%H"
_, output, _ = run_shell_command(cmd, shell=True, cwd=self._path)
for line in output.splitlines():
if line.strip("'").startswith(version):
return False
return True
return False
def export_repository(self, version, basepath):
if not self.detect_presence():
return False
try:
# since version may relate to remote branch / tag we do not
# know about yet, do fetch if not already done
self._do_fetch()
tmpd_path = tempfile.mkdtemp()
try:
tmpgit = GitClient(tmpd_path)
if tmpgit.checkout(self._path, version=version, shallow=True):
archiver = GitArchiver(main_repo_abspath=tmpgit.get_path(), force_sub=True)
filepath = '{0}.tar.gz'.format(basepath)
archiver.create(filepath)
return filepath
else:
return False
finally:
shutil.rmtree(tmpd_path)
except GitError:
return False
def get_branches(self, local_only=False):
cmd = 'git branch --no-color'
if not local_only:
cmd += ' -a'
result, out, err = run_shell_command(cmd,
cwd=self._path,
shell=True,
show_stdout=False)
branches = []
for line in out.splitlines():
if 'HEAD -> ' in line:
continue
line = line.strip('* ')
branches.append(line)
return branches
def _do_fetch(self, timeout=None):
"""
calls git fetch
:raises: GitError when call fails
"""
cmd = "git fetch"
value1, _, _ = run_shell_command(cmd,
cwd=self._path,
shell=True,
no_filter=True,
timeout=timeout,
show_stdout=True)
# git fetch --tags ONLY fetches new tags and commits used, no other commits!
cmd = "git fetch --tags"
value2, _, _ = run_shell_command(cmd,
cwd=self._path,
shell=True,
no_filter=True,
timeout=timeout,
show_stdout=True)
if value1 != 0 or value2 != 0:
raise GitError('git fetch failed')
def _do_fast_forward(self, branch_parent, fetch=True, verbose=False):
"""Execute git fetch if necessary, and if we can fast-foward,
do so to the last fetched version using git rebase.
:param branch_parent: name of branch we track
:param fetch: whether fetch should be done first for remote refs
:returns: True if up-to-date or after succesful fast-forward
:raises: GitError when git fetch fails
"""
assert branch_parent is not None
current_version = self.get_version()
default_remote = self._get_default_remote()
parent_version = self.get_version("remotes/%s/%s" % (default_remote, branch_parent))
if current_version == parent_version:
return True
# check if we are true ancestor of tracked branch
if not self._rev_list_contains(parent_version,
current_version,
fetch=fetch):
# if not rev_list_contains this version, we are on same
# commit (checked before), have advanced, or have diverged.
# Now check whether tracked branch is a true ancestor of us
if self._rev_list_contains(current_version,
parent_version,
fetch=False):
return True
print("Cannot fast-forward, local repository and remote '%s' have diverged." % branch_parent)
return False
if verbose:
print("Rebasing repository")
# Rebase, do not pull, because somebody could have
# commited in the meantime.
if LooseVersion(self.gitversion) >= LooseVersion('1.7.1'):
# --keep allows o rebase even with local changes, as long as
# local changes are not in files that change between versions
cmd = "git reset --keep remotes/%s/%s" % (default_remote, branch_parent)
value, _, _ = run_shell_command(cmd,
shell=True,
cwd=self._path,
show_stdout=True,
verbose=verbose)
if value == 0:
return True
else:
verboseflag = ''
if verbose:
verboseflag = '-v'
# prior to version 1.7.1, git does not know --keep
# Do not merge, rebase does nothing when there are local changes
cmd = "git rebase %s remotes/%s/%s" % (verboseflag, default_remote, branch_parent)
value, _, _ = run_shell_command(cmd,
shell=True,
cwd=self._path,
show_stdout=True,
verbose=verbose)
if value == 0:
return True
return False
def _do_checkout(self, refname, fetch=True, verbose=False):
"""
meaning git checkout, not vcstools checkout. This works
for local branches, remote branches, tagnames, hashes, etc.
git will create local branch of same name when no such local
branch exists, and also setup tracking. Git decides with own
rules whether local changes would cause conflicts, and refuses
to checkout else.
:raises GitError: when checkout fails
"""
# since refname may relate to remote branch / tag we do not
# know about yet, do fetch if not already done
if fetch:
self._do_fetch()
cmd = "git checkout %s" % (refname)
value, _, _ = run_shell_command(cmd,
shell=True,
cwd=self._path,
show_stdout=verbose,
verbose=verbose)
if value != 0:
raise GitError('Git Checkout failed')
# Backwards compatibility
GITClient = GitClient
|