# Copyright 2010-2020 The pygit2 contributors # # This file is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License, version 2, # as published by the Free Software Foundation. # # In addition to the permissions in the GNU General Public License, # the authors give you unlimited permission to link the compiled # version of this file into combinations with other programs, # and to distribute those combinations without any restriction # coming from the use of this file. (The General Public License # restrictions do apply in other respects; for example, they cover # modification of the file, and distribution when not linked into # a combined executable.) # # This file is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; see the file COPYING. If not, write to # the Free Software Foundation, 51 Franklin Street, Fifth Floor, # Boston, MA 02110-1301, USA. """Tests for Repository objects.""" # Standard Library import shutil import tempfile import os from os.path import join, realpath from pathlib import Path from urllib.request import pathname2url import pytest # pygit2 import pygit2 from pygit2 import init_repository, clone_repository, discover_repository from pygit2 import Oid from . import utils def test_is_empty(testrepo): assert not testrepo.is_empty def test_is_bare(testrepo): assert not testrepo.is_bare def test_get_path(testrepo_path): testrepo, path = testrepo_path expected = realpath(join(path, '.git')) assert realpath(testrepo.path) == expected def test_get_workdir(testrepo_path): testrepo, path = testrepo_path expected = realpath(path) assert realpath(testrepo.workdir) == expected def test_set_workdir(testrepo): directory = tempfile.mkdtemp() testrepo.workdir = directory assert realpath(testrepo.workdir) == realpath(directory) def test_checkout_ref(testrepo): ref_i18n = testrepo.lookup_reference('refs/heads/i18n') # checkout i18n with conflicts and default strategy should # not be possible with pytest.raises(pygit2.GitError): testrepo.checkout(ref_i18n) # checkout i18n with GIT_CHECKOUT_FORCE head = testrepo.head head = testrepo[head.target] assert 'new' not in head.tree testrepo.checkout(ref_i18n, strategy=pygit2.GIT_CHECKOUT_FORCE) head = testrepo.head head = testrepo[head.target] assert head.hex == ref_i18n.target.hex assert 'new' in head.tree assert 'bye.txt' not in testrepo.status() def test_checkout_branch(testrepo): branch_i18n = testrepo.lookup_branch('i18n') # checkout i18n with conflicts and default strategy should # not be possible with pytest.raises(pygit2.GitError): testrepo.checkout(branch_i18n) # checkout i18n with GIT_CHECKOUT_FORCE head = testrepo.head head = testrepo[head.target] assert 'new' not in head.tree testrepo.checkout(branch_i18n, strategy=pygit2.GIT_CHECKOUT_FORCE) head = testrepo.head head = testrepo[head.target] assert head.hex == branch_i18n.target.hex assert 'new' in head.tree assert 'bye.txt' not in testrepo.status() def test_checkout_index(testrepo): # some changes to working dir with open(os.path.join(testrepo.workdir, 'hello.txt'), 'w') as f: f.write('new content') # checkout index assert 'hello.txt' in testrepo.status() testrepo.checkout(strategy=pygit2.GIT_CHECKOUT_FORCE) assert 'hello.txt' not in testrepo.status() def test_checkout_head(testrepo): # some changes to the index with open(os.path.join(testrepo.workdir, 'bye.txt'), 'w') as f: f.write('new content') testrepo.index.add('bye.txt') # checkout from index should not change anything assert 'bye.txt' in testrepo.status() testrepo.checkout(strategy=pygit2.GIT_CHECKOUT_FORCE) assert 'bye.txt' in testrepo.status() # checkout from head will reset index as well testrepo.checkout('HEAD', strategy=pygit2.GIT_CHECKOUT_FORCE) assert 'bye.txt' not in testrepo.status() def test_checkout_alternative_dir(testrepo): ref_i18n = testrepo.lookup_reference('refs/heads/i18n') extra_dir = os.path.join(testrepo.workdir, 'extra-dir') os.mkdir(extra_dir) assert len(os.listdir(extra_dir)) == 0 testrepo.checkout(ref_i18n, directory=extra_dir) assert not len(os.listdir(extra_dir)) == 0 def test_checkout_paths(testrepo): ref_i18n = testrepo.lookup_reference('refs/heads/i18n') ref_master = testrepo.lookup_reference('refs/heads/master') testrepo.checkout(ref_master) testrepo.checkout(ref_i18n, paths=['new']) status = testrepo.status() assert status['new'] == pygit2.GIT_STATUS_INDEX_NEW def test_merge_base(testrepo): commit = testrepo.merge_base( '5ebeeebb320790caf276b9fc8b24546d63316533', '4ec4389a8068641da2d6578db0419484972284c8') assert commit.hex == 'acecd5ea2924a4b900e7e149496e1f4b57976e51' # Create a commit without any merge base to any other sig = pygit2.Signature("me", "me@example.com") indep = testrepo.create_commit(None, sig, sig, "a new root commit", testrepo[commit].peel(pygit2.Tree).id, []) assert testrepo.merge_base(indep, commit) is None def test_descendent_of(testrepo): assert not testrepo.descendant_of( '5ebeeebb320790caf276b9fc8b24546d63316533', '4ec4389a8068641da2d6578db0419484972284c8') assert not testrepo.descendant_of( '5ebeeebb320790caf276b9fc8b24546d63316533', '5ebeeebb320790caf276b9fc8b24546d63316533') assert testrepo.descendant_of( '5ebeeebb320790caf276b9fc8b24546d63316533', 'acecd5ea2924a4b900e7e149496e1f4b57976e51') assert not testrepo.descendant_of( 'acecd5ea2924a4b900e7e149496e1f4b57976e51', '5ebeeebb320790caf276b9fc8b24546d63316533') with pytest.raises(pygit2.GitError): testrepo.descendant_of( '2' * 40, # a valid but inexistent SHA '5ebeeebb320790caf276b9fc8b24546d63316533') def test_ahead_behind(testrepo): ahead, behind = testrepo.ahead_behind( '5ebeeebb320790caf276b9fc8b24546d63316533', '4ec4389a8068641da2d6578db0419484972284c8') assert 1 == ahead assert 2 == behind ahead, behind = testrepo.ahead_behind( '4ec4389a8068641da2d6578db0419484972284c8', '5ebeeebb320790caf276b9fc8b24546d63316533') assert 2 == ahead assert 1 == behind def test_reset_hard(testrepo): ref = "5ebeeebb320790caf276b9fc8b24546d63316533" with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() assert "hola mundo\n" in lines assert "bonjour le monde\n" in lines testrepo.reset( ref, pygit2.GIT_RESET_HARD) assert testrepo.head.target.hex == ref with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() #Hard reset will reset the working copy too assert "hola mundo\n" not in lines assert "bonjour le monde\n" not in lines def test_reset_soft(testrepo): ref = "5ebeeebb320790caf276b9fc8b24546d63316533" with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() assert "hola mundo\n" in lines assert "bonjour le monde\n" in lines testrepo.reset( ref, pygit2.GIT_RESET_SOFT) assert testrepo.head.target.hex == ref with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() #Soft reset will not reset the working copy assert "hola mundo\n" in lines assert "bonjour le monde\n" in lines #soft reset will keep changes in the index diff = testrepo.diff(cached=True) with pytest.raises(KeyError): diff[0] def test_reset_mixed(testrepo): ref = "5ebeeebb320790caf276b9fc8b24546d63316533" with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() assert "hola mundo\n" in lines assert "bonjour le monde\n" in lines testrepo.reset( ref, pygit2.GIT_RESET_MIXED) assert testrepo.head.target.hex == ref with open(os.path.join(testrepo.workdir, "hello.txt")) as f: lines = f.readlines() #mixed reset will not reset the working copy assert "hola mundo\n" in lines assert "bonjour le monde\n" in lines #mixed reset will set the index to match working copy diff = testrepo.diff(cached=True) assert "hola mundo\n" in diff.patch assert "bonjour le monde\n" in diff.patch def test_stash(testrepo): # some changes to working dir with open(os.path.join(testrepo.workdir, 'hello.txt'), 'w') as f: f.write('new content') sig = pygit2.Signature('Stasher', 'stasher@example.com') testrepo.stash(sig, include_untracked=True) assert 'hello.txt' not in testrepo.status() testrepo.stash_apply() assert 'hello.txt' in testrepo.status() testrepo.stash_drop() with pytest.raises(KeyError): testrepo.stash_pop() def test_revert(testrepo): master = testrepo.head.peel() commit_to_revert = testrepo['4ec4389a8068641da2d6578db0419484972284c8'] parent = commit_to_revert.parents[0] commit_diff_stats = ( parent.tree.diff_to_tree(commit_to_revert.tree).stats ) revert_index = testrepo.revert_commit(commit_to_revert, master) revert_diff_stats = revert_index.diff_to_tree(master.tree).stats assert revert_diff_stats.insertions == commit_diff_stats.deletions assert revert_diff_stats.deletions == commit_diff_stats.insertions assert revert_diff_stats.files_changed == commit_diff_stats.files_changed def test_diff_patch(testrepo): new_content = ['bye world', 'adiós', 'au revoir monde'] new_content = ''.join(x + os.linesep for x in new_content) # create the patch with open(os.path.join(testrepo.workdir, 'hello.txt'), 'wb') as f: f.write(new_content.encode('utf-8')) patch = testrepo.diff().patch # rollback all changes testrepo.checkout('HEAD', strategy=pygit2.GIT_CHECKOUT_FORCE) # Check apply type error with pytest.raises(TypeError): testrepo.apply('HEAD') # Apply the patch and compare diff = pygit2.Diff.parse_diff(patch) testrepo.apply(diff) with open(os.path.join(testrepo.workdir, 'hello.txt'), 'rb') as f: content = f.read().decode('utf-8') assert content == new_content def test_diff_applies(testrepo): new_content = ['bye world', 'adiós', 'au revoir monde'] new_content = ''.join(x + os.linesep for x in new_content) # create the patch with open(os.path.join(testrepo.workdir, 'hello.txt'), 'wb') as f: f.write(new_content.encode('utf-8')) patch = testrepo.diff().patch # rollback all changes testrepo.checkout('HEAD', strategy=pygit2.GIT_CHECKOUT_FORCE) # apply the patch and compare diff = pygit2.Diff.parse_diff(patch) assert testrepo.applies(diff) with open(os.path.join(testrepo.workdir, 'hello.txt'), 'rb') as f: content = f.read().decode('utf-8') assert content != new_content def test_default_signature(testrepo): config = testrepo.config config['user.name'] = 'Random J Hacker' config['user.email'] ='rjh@example.com' sig = testrepo.default_signature assert 'Random J Hacker' == sig.name assert 'rjh@example.com' == sig.email def test_new_repo(tmp_path): repo = init_repository(tmp_path, False) oid = repo.write(pygit2.GIT_OBJ_BLOB, "Test") assert type(oid) == Oid assert os.path.exists(os.path.join(tmp_path, '.git')) def test_no_arg(tmp_path): repo = init_repository(tmp_path) assert not repo.is_bare def test_no_arg_aspath(tmp_path): repo = init_repository(Path(tmp_path)) assert not repo.is_bare def test_pos_arg_false(tmp_path): repo = init_repository(tmp_path, False) assert not repo.is_bare def test_pos_arg_true(tmp_path): repo = init_repository(tmp_path, True) assert repo.is_bare def test_keyword_arg_false(tmp_path): repo = init_repository(tmp_path, bare=False) assert not repo.is_bare def test_keyword_arg_true(tmp_path): repo = init_repository(tmp_path, bare=True) assert repo.is_bare def test_discover_repo(tmp_path): repo = init_repository(tmp_path, False) subdir = os.path.join(tmp_path, "test1", "test2") os.makedirs(subdir) assert repo.path == discover_repository(subdir) @utils.fspath def test_discover_repo_aspath(tmp_path): repo = init_repository(Path(tmp_path), False) subdir = Path(tmp_path) / "test1" / "test2" os.makedirs(subdir) assert repo.path == discover_repository(subdir) def test_discover_repo_not_found(): assert discover_repository(tempfile.tempdir) is None def test_bytes_string(): repo_path = b'./test/data/testrepo.git/' pygit2.Repository(repo_path) def test_unicode_string(): # String is unicode because of unicode_literals repo_path = './test/data/testrepo.git/' pygit2.Repository(repo_path) def test_aspath(): repo_path = Path('./test/data/testrepo.git/') pygit2.Repository(repo_path) def test_clone_repository(tmp_path): repo_path = "./test/data/testrepo.git/" repo = clone_repository(repo_path, tmp_path) assert not repo.is_empty assert not repo.is_bare def test_clone_repository_aspath(tmp_path): repo_path = Path("./test/data/testrepo.git/") repo = clone_repository(repo_path, Path(tmp_path)) assert not repo.is_empty assert not repo.is_bare def test_clone_bare_repository(tmp_path): repo_path = "./test/data/testrepo.git/" repo = clone_repository(repo_path, tmp_path, bare=True) assert not repo.is_empty assert repo.is_bare def test_clone_repository_and_remote_callbacks(tmp_path): src_repo_relpath = "./test/data/testrepo.git/" repo_path = os.path.join(tmp_path, "clone-into") url = pathname2url(os.path.realpath(src_repo_relpath)) if url.startswith('///'): url = 'file:' + url else: url = 'file://' + url def create_repository(path, bare): return init_repository(path, bare) # here we override the name def create_remote(repo, name, url): return repo.remotes.create("custom_remote", url) repo = clone_repository(url, repo_path, repository=create_repository, remote=create_remote) assert not repo.is_empty assert 'refs/remotes/custom_remote/master' in repo.listall_references() assert b'refs/remotes/custom_remote/master' in repo.raw_listall_references() assert repo.remotes["custom_remote"] is not None @utils.requires_network def test_clone_with_credentials(tmp_path): url = 'https://github.com/libgit2/TestGitRepository' credentials = pygit2.UserPass("libgit2", "libgit2") callbacks = pygit2.RemoteCallbacks(credentials=credentials) repo = clone_repository(url, tmp_path, callbacks=callbacks) assert not repo.is_empty @utils.requires_network def test_clone_bad_credentials(tmp_path): class MyCallbacks(pygit2.RemoteCallbacks): def credentials(self, url, username, allowed): raise RuntimeError('Unexpected error') url = "https://github.com/github/github" with pytest.raises(RuntimeError) as exc: clone_repository(url, tmp_path, callbacks=MyCallbacks()) assert str(exc.value) == 'Unexpected error' def test_clone_with_checkout_branch(tmp_path): # create a test case which isolates the remote test_repo = clone_repository('./test/data/testrepo.git', os.path.join(tmp_path, 'testrepo-orig.git'), bare=True) test_repo.create_branch('test', test_repo[test_repo.head.target]) repo = clone_repository(test_repo.path, os.path.join(tmp_path, 'testrepo.git'), checkout_branch='test', bare=True) assert repo.lookup_reference('HEAD').target == 'refs/heads/test' # FIXME The tests below are commented because they are broken: # # - test_clone_push_url: Passes, but does nothing useful. # # - test_clone_fetch_spec: Segfaults because of a bug in libgit2 0.19, # this has been fixed already, so wait for 0.20 # # - test_clone_push_spec: Passes, but does nothing useful. # #def test_clone_push_url(): # repo_path = "./test/data/testrepo.git/" # repo = clone_repository( # repo_path, tmp_path, push_url="custom_push_url" # ) # assert not repo.is_empty # # FIXME: When pygit2 supports retrieving the pushurl parameter, # # enable this test # # assert repo.remotes[0].pushurl == "custom_push_url" # #def test_clone_fetch_spec(): # repo_path = "./test/data/testrepo.git/" # repo = clone_repository(repo_path, tmp_path, # fetch_spec="refs/heads/test") # assert not repo.is_empty # # FIXME: When pygit2 retrieve the fetchspec we passed to git clone. # # fetchspec seems to be going through, but the Repository class is # # not getting it. # # assert repo.remotes[0].fetchspec == "refs/heads/test" # #def test_clone_push_spec(): # repo_path = "./test/data/testrepo.git/" # repo = clone_repository(repo_path, tmp_path, # push_spec="refs/heads/test") # assert not repo.is_empty # # FIXME: When pygit2 supports retrieving the pushspec parameter, # # enable this test # # not sure how to test this either... couldn't find pushspec # # assert repo.remotes[0].fetchspec == "refs/heads/test" def test_worktree(testrepo): worktree_name = 'foo' worktree_dir = tempfile.mkdtemp() # Delete temp path so that it's not present when we attempt to add the # worktree later os.rmdir(worktree_dir) def _check_worktree(worktree): # Confirm the name attribute matches the specified name assert worktree.name == worktree_name # Confirm the path attribute points to the correct path assert os.path.realpath(worktree.path) == os.path.realpath(worktree_dir) # The "gitdir" in a worktree should be a file with a reference to # the actual gitdir. Let's make sure that the path exists and is a # file. assert os.path.isfile(os.path.join(worktree_dir, '.git')) # We should have zero worktrees assert testrepo.list_worktrees() == [] # Add a worktree worktree = testrepo.add_worktree(worktree_name, worktree_dir) # Check that the worktree was added properly _check_worktree(worktree) # We should have one worktree now assert testrepo.list_worktrees() == [worktree_name] # We should also have a branch of the same name assert worktree_name in testrepo.listall_branches() # Test that lookup_worktree() returns a properly-instantiated # pygit2._Worktree object _check_worktree(testrepo.lookup_worktree(worktree_name)) # Remove the worktree dir shutil.rmtree(worktree_dir) # Prune the worktree. For some reason, libgit2 treats a worktree as # valid unless both the worktree directory and data dir under # $GIT_DIR/worktrees are gone. This doesn't make much sense since the # normal usage involves removing the worktree directory and then # pruning. So, for now we have to force the prune. This may be # something to take up with libgit2. worktree.prune(True) assert testrepo.list_worktrees() == [] @utils.fspath def test_worktree_aspath(testrepo): worktree_name = 'foo' worktree_dir = Path(tempfile.mkdtemp()) # Delete temp path so that it's not present when we attempt to add the # worktree later os.rmdir(worktree_dir) testrepo.add_worktree(worktree_name, worktree_dir) assert testrepo.list_worktrees() == [worktree_name] def test_worktree_custom_ref(testrepo): worktree_name = 'foo' worktree_dir = tempfile.mkdtemp() branch_name = 'version1' # New branch based on head tip = testrepo.revparse_single('HEAD') worktree_ref = testrepo.branches.create(branch_name, tip) # Delete temp path so that it's not present when we attempt to add the # worktree later os.rmdir(worktree_dir) # Add a worktree for the given ref worktree = testrepo.add_worktree(worktree_name, worktree_dir, worktree_ref) # We should have one worktree now assert testrepo.list_worktrees() == [worktree_name] # We should not have a branch of the same name assert worktree_name not in testrepo.listall_branches() # The given ref is checked out in the "worktree repository" assert worktree_ref.is_checked_out() # Remove the worktree dir and prune the worktree shutil.rmtree(worktree_dir) worktree.prune(True) assert testrepo.list_worktrees() == [] # The ref is no longer checked out assert worktree_ref.is_checked_out() == False # The branch still exists assert branch_name in testrepo.branches def test_open_extended(tmp_path): with utils.TemporaryRepository('dirtyrepo.tar', tmp_path) as path: orig_repo = pygit2.Repository(path) assert not orig_repo.is_bare assert orig_repo.path assert orig_repo.workdir # GIT_REPOSITORY_OPEN_NO_SEARCH subdir_path = os.path.join(path, "subdir") repo = pygit2.Repository(subdir_path) assert not repo.is_bare assert repo.path == orig_repo.path assert repo.workdir == orig_repo.workdir with pytest.raises(pygit2.GitError): repo = pygit2.Repository(subdir_path, pygit2.GIT_REPOSITORY_OPEN_NO_SEARCH) # GIT_REPOSITORY_OPEN_NO_DOTGIT gitdir_path = join(path, ".git") with pytest.raises(pygit2.GitError): repo = pygit2.Repository(path, pygit2.GIT_REPOSITORY_OPEN_NO_DOTGIT) repo = pygit2.Repository(gitdir_path, pygit2.GIT_REPOSITORY_OPEN_NO_DOTGIT) assert not repo.is_bare assert repo.path == orig_repo.path assert repo.workdir == orig_repo.workdir # GIT_REPOSITORY_OPEN_BARE repo = pygit2.Repository(gitdir_path, pygit2.GIT_REPOSITORY_OPEN_BARE) assert repo.is_bare assert repo.path == orig_repo.path assert not repo.workdir