def tearDown(self):

gc.collect()

def test_new_should_raise_on_invalid_repo_location(self):

path = read_only_fixture("repo.sh", "empty")

self.assertRaises(InvalidGitRepositoryError, Repo, path)

@with_rw_directory(script="repo.sh", args=("template",))

def test_init_rejects_unsafe_options(self, tdir):

template_dir = osp.join(tdir, "template")

unsafe_options = [

{"template": template_dir},

{"templa": template_dir},

{"separate_git_dir": osp.join(tdir, "git-dir")},

{"separate_git_di": osp.join(tdir, "git-dir")},

]

for index, kwargs in enumerate(unsafe_options):

repo_dir = osp.join(tdir, f"repo-{index}")

with self.assertRaises(UnsafeOptionError):

Repo.init(repo_dir, **kwargs)

assert not osp.exists(repo_dir)

@with_rw_directory(script="repo.sh", args=("template",))

def test_init_allows_explicitly_unsafe_options(self, tdir):

with Repo.init(osp.join(tdir, "repo"), template=osp.join(tdir, "template"), allow_unsafe_options=True) as repo:

assert repo.git_dir

def test_new_should_raise_on_invalid_repo_location_within_repo(self):

path = read_only_fixture("repo.sh", "nested") / "repo" / "subdir"

self.assertRaises(InvalidGitRepositoryError, Repo, path)

def test_new_should_raise_on_non_existent_path(self):

path = read_only_fixture("repo.sh", "empty") / "foobar"

self.assertRaises(NoSuchPathError, Repo, path)

def test_repo_discovery_prefers_dotgit(self):

root = read_only_fixture("repo.sh", "prefers-dotgit")

for name in ("linked-worktree", "bare"):

path = root / name

with self.subTest(layout=name), Repo(path) as repo:

expected = Git(path).rev_parse("--absolute-git-dir")

assert osp.samefile(repo.git_dir, expected)

def test_repo_discovery_honors_explicit_git_dir(self):

root = read_only_fixture("repo.sh", "explicit-git-dir")

git_dir = root / "repo.git"

with mock.patch.dict(os.environ, {"GIT_DIR": os.fspath(git_dir)}):

for path in (None, ""):

with Repo(path) as repo, self.subTest(path=path):

assert osp.samefile(repo.git_dir, git_dir)

worktree = root / "worktree"

with cwd(worktree), mock.patch.dict(os.environ, {"GIT_DIR": ""}):

with Repo() as repo:

assert osp.samefile(repo.git_dir, worktree / ".git")

def test_repo_discovery_uses_native_worktree_configuration(self):

root = read_only_fixture("repo.sh", "worktree-config")

git_dir = root / "main" / ".git"

configured, overridden = root / "configured", root / "overridden"

with Repo(git_dir) as reopened:

assert osp.samefile(reopened.working_tree_dir, configured)

assert osp.samefile(reopened.git.rev_parse("--show-toplevel"), configured)

with mock.patch.dict(os.environ, {"GIT_WORK_TREE": str(overridden)}):

with Repo(git_dir) as reopened:

assert osp.samefile(reopened.working_tree_dir, overridden)

with mock.patch.dict(os.environ, {"GIT_COMMON_DIR": str(git_dir)}):

with Repo(git_dir) as reopened:

assert osp.samefile(reopened.working_tree_dir, root / "main")

def test_repo_discovery_rejects_invalid_metadata(self):

root = read_only_fixture("repo.sh", "invalid-metadata")

for name in (

"HEAD",

"commondir-empty",

"commondir-invalid",

"linked-worktree",

"gitfile-text",

"gitfile-empty",

"gitfile-loop",

"gitfile-invalid",

):

path = root / name

with cwd(path), self.subTest(metadata=name):

self.assertRaises(InvalidGitRepositoryError, Repo, path)

path = root / "empty-environment"

for variable in ("GIT_COMMON_DIR", "GIT_OBJECT_DIRECTORY"):

with mock.patch.dict(os.environ, {variable: ""}), self.subTest(metadata=variable):

self.assertRaises(InvalidGitRepositoryError, Repo, path)

def test_repo_discovery_rejects_dangling_commondir(self):

from gix import testtools

root = read_only_fixture("repo.sh", "dangling-commondir")

if not testtools.fixture_has_symlinks(root):

pytest.skip("fixture filesystem cannot create symlinks")

self.assertRaises(InvalidGitRepositoryError, Repo, root / "repo")

def test_repo_discovery_rejects_dotgit_stat_errors(self):

from gix import testtools

root = read_only_fixture("repo.sh", "dotgit-loop")

if not testtools.fixture_has_symlinks(root):

pytest.skip("fixture filesystem cannot create symlinks")

self.assertRaises(InvalidGitRepositoryError, Repo, root / "repo" / "child", search_parent_directories=True)

def test_gitfile_resolution_does_not_read_storage_in_python(self):

dotgit = read_only_fixture("repo.sh", "missing-gitfile-target") / ".git"

reader = mock.mock_open(read_data=b"")

with mock.patch("builtins.open", reader):

assert find_worktree_git_dir(dotgit) is None

reader.assert_not_called()

def test_relative_gitfile_resolution_uses_gitfile_directory(self):

root = read_only_fixture("repo.sh", "relative-gitfile")

with Repo(root / "source") as source, Repo(root / "unrelated") as unrelated:

checkout = root / "checkout"

dotgit = checkout / ".git"

with cwd(unrelated.working_tree_dir), Repo(checkout) as reopened:

assert osp.samefile(reopened.git_dir, source.git_dir)

assert osp.samefile(find_worktree_git_dir(dotgit), source.git_dir)

def test_repo_discovery_uses_storage_environment(self):

root = read_only_fixture("repo.sh", "storage-environment")

git_dir, common_dir = root / "git", root / "common"

with cwd(root), mock.patch.dict(os.environ, {"GIT_DIR": "git", "GIT_COMMON_DIR": "common"}):

repo = Repo()

with repo:

assert osp.samefile(repo.common_dir, common_dir)

assert osp.samefile(repo.odb.root_path(), common_dir / "objects")

assert repo.bare

assert osp.samefile(repo.git.rev_parse("--absolute-git-dir"), git_dir)

assert osp.samefile(repo.git.rev_parse("--git-common-dir"), common_dir)

environment = dict(os.environ)

environment["GIT_DIR"] = "git-file"

environment.pop("GIT_COMMON_DIR", None)

with cwd(root), mock.patch.dict(os.environ, environment, clear=True), Repo() as repo:

assert osp.samefile(repo.git.rev_parse("--absolute-git-dir"), root / "git-file")

if sys.platform.startswith("linux"):

with Repo(root / "git-bytes") as repo:

assert osp.samefile(repo.common_dir, root / os.fsdecode(b"common-\xff"))

def test_repo_discovery_preserves_object_directory(self):

root = read_only_fixture("repo.sh", "object-directory")

object_dir = root / "objects"

blob_hexsha = (root / "blob-id").read_text().strip()

with cwd(root), mock.patch.dict(os.environ, {"GIT_DIR": "git", "GIT_OBJECT_DIRECTORY": "objects"}):

repo = Repo()

with repo:

assert osp.samefile(repo.odb.root_path(), object_dir)

assert repo.odb.has_object(bytes.fromhex(blob_hexsha))

assert repo.git.cat_file("blob", blob_hexsha) == "custom object database"

assert repo.alternates == []

def test_repo_creation_from_different_paths(self):

path = read_only_fixture(

"history.sh", self.rorepo.working_dir, self.rorepo.head.commit.hexsha, "tree-layout", "worktree"

)

rw_repo = Repo(path / "repo")

r_from_gitdir = Repo(rw_repo.git_dir)

self.assertEqual(r_from_gitdir.git_dir, rw_repo.git_dir)

assert r_from_gitdir.git_dir.endswith(".git")

assert not rw_repo.git.working_dir.endswith(".git")

self.assertEqual(r_from_gitdir.git.working_dir, rw_repo.git.working_dir)

def test_repo_creation_pathlib(self):

path = read_only_fixture(

"history.sh", self.rorepo.working_dir, self.rorepo.head.commit.hexsha, "tree-layout", "worktree"

)

rw_repo = Repo(path / "repo")

r_from_gitdir = Repo(pathlib.Path(rw_repo.git_dir))

self.assertEqual(r_from_gitdir.git_dir, rw_repo.git_dir)

def test_repo_creation_pathlike(self):

path = read_only_fixture(

"history.sh", self.rorepo.working_dir, self.rorepo.head.commit.hexsha, "tree-layout", "worktree"

)

rw_repo = Repo(path / "repo")

r_from_gitdir = Repo(PathLikeMock(rw_repo.git_dir))

self.assertEqual(r_from_gitdir.git_dir, rw_repo.git_dir)

@with_rw_repo("HEAD")

def test_description(self, rw_repo):

txt = "Test repository"

rw_repo.description = txt

self.assertEqual(rw_repo.description, txt)

def test_heads_should_return_array_of_head_objects(self):

for head in self.rorepo.heads:

self.assertEqual(Head, head.__class__)

def test_heads_should_populate_head_data(self):

for head in self.rorepo.heads:

assert head.name

self.assertIsInstance(head.commit, Commit)

# END for each head

active_branch = self.rorepo.active_branch

self.assertIsInstance(self.rorepo.heads[active_branch.name], Head)

self.assertEqual(self.rorepo.heads[active_branch.name], active_branch)

def test_tree_from_revision(self):

tree = self.rorepo.tree("release")

self.assertEqual(len(tree.hexsha), 40)

self.assertEqual(tree.type, "tree")

self.assertEqual(self.rorepo.tree(tree), tree)

# Try from an invalid revision that does not exist.

self.assertRaises(BadName, self.rorepo.tree, "hello world")

def test_pickleable(self):

pickle.loads(pickle.dumps(self.rorepo))

def test_commit_from_revision(self):

commit = self.rorepo.commit("annotated")

self.assertEqual(commit.type, "commit")

self.assertEqual(self.rorepo.commit(commit), commit)

def test_commit_from_tag_starting_with_at(self):

with fixture_repo("repo.sh", "at-tag") as repo:

commit = repo.head.commit

self.assertEqual(repo.tags["@foo"].commit, commit)

self.assertEqual(repo.commit("@"), commit)

self.assertEqual(repo.commit("@foo"), commit)

def test_commits(self):

mc = 5

commits = list(self.rorepo.iter_commits("release", max_count=mc))

self.assertEqual(len(commits), mc)

c = commits[0]

self.assertEqual(self.rorepo.git.rev_parse("release"), c.hexsha)

self.assertEqual([self.rorepo.commit("base")], list(c.parents))

self.assertEqual(self.rorepo.git.rev_parse("release^{tree}"), c.tree.hexsha)

self.assertEqual("Fixture Author", c.author.name)

self.assertEqual("author@example.com", c.author.email)

self.assertEqual(978307200, c.authored_date)

self.assertEqual(0, c.author_tz_offset)

self.assertEqual(c.author, c.committer)

self.assertEqual(c.authored_date, c.committed_date)

self.assertEqual(0, c.committer_tz_offset)

self.assertEqual("Release sample project\n", c.message)

c = commits[1]

self.assertIsInstance(c.parents, tuple)

def test_trees(self):

mc = 5

num_trees = 0

for tree in self.rorepo.iter_trees("base", max_count=mc):

num_trees += 1

self.assertIsInstance(tree, Tree)

# END for each tree

self.assertEqual(num_trees, mc)

def _assert_empty_repo(self, repo):

"""Test all kinds of things with an empty, freshly initialized repo.

# Entries should be empty.

self.assertEqual(len([(e.path, e.stage) for e in repo.index.iter_entries()]), 0)

# head is accessible.

assert repo.head

assert repo.head.ref

assert not repo.head.is_valid()

# We can change the head to some other ref.

head_ref = Head.from_path(repo, Head.to_full_path("some_head"))

assert not head_ref.is_valid()

repo.head.ref = head_ref

# is_dirty can handle all kwargs.

for args in ((1, 0, 0), (0, 1, 0), (0, 0, 1)):

assert not repo.is_dirty(*args)

# END for each arg

# We can add a file to the index (if we are not bare).

if not repo.bare:

pass

# END test repos with working tree

@with_rw_directory(script="repo.sh", args=("empty-repo",))

def test_clone_from_keeps_env(self, rw_dir):

original_repo = Repo(osp.join(rw_dir, "repo"))

environment = {"entry1": "value", "another_entry": "10"}

cloned = Repo.clone_from(original_repo.git_dir, osp.join(rw_dir, "clone"), env=environment)

for key, value in environment.items():

self.assertEqual(cloned.git.environment()[key], value)

self.assertEqual(cloned.git.environment()["GIT_DIR"], cloned.git_dir)

self.assertEqual(cloned.git.environment()["GIT_WORK_TREE"], cloned.working_tree_dir)

@pytest.mark.skipif(os.name != "nt", reason="Specifically for Windows drive-rooted paths.")

@with_rw_directory(script="repo.sh", args=("empty-repo",))

def test_clone_from_drive_rooted_destination(self, rw_dir):

original_repo = Repo(osp.join(rw_dir, "repo"))

with cwd(rw_dir):

destination = osp.join(rw_dir, "clone")

_drive, rooted_destination = osp.splitdrive(destination)

cloned = Repo.clone_from(original_repo.git_dir, rooted_destination)

assert osp.samefile(cloned.working_tree_dir, destination)

@with_rw_directory(script="repo.sh", args=("empty-repo",))

def test_date_format(self, rw_dir):

repo = Repo(osp.join(rw_dir, "repo"))

# @-timestamp is the format used by git commit hooks.

repo.index.commit("Commit messages", commit_date="@1400000000 +0000")

@with_rw_repo("HEAD")

def test_max_chunk_size(self, repo):

class TestOutputStream(TestBase):

def __init__(self, max_chunk_size):

self.max_chunk_size = max_chunk_size

def write(self, b):

self.assertTrue(len(b) <= self.max_chunk_size)

for chunk_size in [16, 128, 1024]:

repo.git.status(output_stream=TestOutputStream(chunk_size), max_chunk_size=chunk_size)

repo.git.log(

n=100,

output_stream=TestOutputStream(io.DEFAULT_BUFFER_SIZE),

max_chunk_size=None,

)

repo.git.log(

n=100,

output_stream=TestOutputStream(io.DEFAULT_BUFFER_SIZE),

max_chunk_size=-10,

)

repo.git.log(n=100, output_stream=TestOutputStream(io.DEFAULT_BUFFER_SIZE))

def test_init(self):

with writable_fixture("repo.sh", "empty") as temporary, cwd(temporary.path()):

git_dir_rela = "repos/foo/bar.git"

git_dir_abs = osp.abspath(git_dir_rela)

# With specific path

for path in (git_dir_rela, git_dir_abs):

r = Repo.init(path=path, bare=True)

self.assertIsInstance(r, Repo)

assert r.bare is True

assert not r.has_separate_working_tree()

assert osp.isdir(r.git_dir)

self._assert_empty_repo(r)

# Test clone

clone_path = path + "_clone"

rc = r.clone(clone_path)

self._assert_empty_repo(rc)

try:

rmtree(clone_path)

except OSError:

# When relative paths are used, the clone may actually be inside of

# the parent directory.

pass

# END exception handling

# Try again, this time with the absolute version.

rc = Repo.clone_from(r.git_dir, clone_path)

self._assert_empty_repo(rc)

rmtree(git_dir_abs)

try:

rmtree(clone_path)

except OSError:

# When relative paths are used, the clone may actually be inside of

# the parent directory.

pass

# END exception handling

# END for each path

os.makedirs(git_dir_rela)

os.chdir(git_dir_rela)

r = Repo.init(bare=False)

assert r.bare is False

assert not r.has_separate_working_tree()

self._assert_empty_repo(r)

def test_bare_property(self):

self.rorepo.bare

@with_rw_repo("HEAD")

def test_daemon_export(self, rw_repo):

orig_val = rw_repo.daemon_export

rw_repo.daemon_export = not orig_val

self.assertEqual(rw_repo.daemon_export, (not orig_val))

rw_repo.daemon_export = orig_val

self.assertEqual(rw_repo.daemon_export, orig_val)

def test_daemon_export_without_git_dir(self):

repo = Repo.__new__(Repo)

repo.git_dir = None

self.assertFalse(repo._get_daemon_export())

repo._set_daemon_export(True)

def test_alternates(self):

root = read_only_fixture("repo.sh", "alternates")

with Repo(root / "repo") as repo, Repo(root / "source") as source:

assert repo.alternates == []

objects = osp.join(source.common_dir, "objects")

with repo.git.custom_environment(GIT_ALTERNATE_OBJECT_DIRECTORIES=objects):

assert len(repo.alternates) == 1

assert osp.samefile(repo.alternates[0], objects)

with pytest.raises(AttributeError):

repo.alternates = []

def test_alternates_use_common_dir(self):

root = read_only_fixture("repo.sh", "shared-worktree", self.rorepo.working_dir)

with Repo(root / "shared") as repo, Repo(root / "linked") as linked:

assert linked.alternates == repo.alternates

assert len(linked.alternates) >= 1

assert osp.samefile(linked.alternates[0], self.rorepo.odb.root_path())

def test_repr(self):

assert repr(self.rorepo).startswith("<git.repo.base.Repo ")

def test_is_dirty_with_bare_repository(self):

orig_value = self.rorepo._bare

self.rorepo._bare = True

self.assertFalse(self.rorepo.is_dirty())

self.rorepo._bare = orig_value

def test_is_dirty(self):

self.rorepo._bare = False

for index in (0, 1):

for working_tree in (0, 1):

for untracked_files in (0, 1):

assert self.rorepo.is_dirty(index, working_tree, untracked_files) in (True, False)

# END untracked files

# END working tree

# END index

orig_val = self.rorepo._bare

self.rorepo._bare = True

assert self.rorepo.is_dirty() is False

self.rorepo._bare = orig_val

def test_is_dirty_pathspec(self):

self.rorepo._bare = False

for index in (0, 1):

for working_tree in (0, 1):

for untracked_files in (0, 1):

assert self.rorepo.is_dirty(index, working_tree, untracked_files, path=":!foo") in (True, False)

# END untracked files

# END working tree

# END index

orig_val = self.rorepo._bare

self.rorepo._bare = True

assert self.rorepo.is_dirty() is False

self.rorepo._bare = orig_val

def test_is_dirty_with_path(self):

for state in ("clean", "worktree", "index", "untracked"):

with fixture_repo("repo.sh", "dirty", state) as repo:

assert repo.is_dirty(path="git") is (state != "clean")

assert repo.is_dirty(path="doc") is False

if state == "index":

assert repo.is_dirty(index=False, path="git") is False

if state == "untracked":

assert repo.is_dirty(untracked_files=True, path="doc") is True

def test_is_dirty_with_pathlib_and_pathlike(self):

with fixture_repo("repo.sh", "dirty", "worktree") as repo:

assert repo.is_dirty(path=Path("git")) is True

assert repo.is_dirty(path=PathLikeMock("git")) is True

assert repo.is_dirty(path=Path("doc")) is False

assert repo.is_dirty(path=PathLikeMock("doc")) is False

def test_head(self):

self.assertEqual(self.rorepo.head.reference.object, self.rorepo.active_branch.object)

def test_index(self):

index = self.rorepo.index

self.assertIsInstance(index, IndexFile)

def test_tag(self):

assert self.rorepo.tag("refs/tags/base").commit

def test_tag_to_full_tag_path(self):

tags = ["base", "tags/base", "refs/tags/base"]

value_errors = []

for tag in tags:

try:

self.rorepo.tag(tag)

except ValueError as valueError:

value_errors.append(valueError.args[0])

self.assertEqual(value_errors, [])

def test_archive(self):

with tempfile.NamedTemporaryFile("wb", suffix="archive-test", delete=False) as stream:

self.rorepo.archive(stream, "release", path="doc")

assert stream.tell()

os.remove(stream.name) # Do it this way so we can inspect the file on failure.

def test_archive_rejects_unsafe_options(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

output_marker = osp.join(tdir, "pwn")

with self.assertRaises(UnsafeOptionError):

self.rorepo.archive(io.BytesIO(), "release", exec=f"touch {output_marker}")

assert not osp.exists(output_marker)

with self.assertRaises(UnsafeOptionError):

self.rorepo.archive(io.BytesIO(), "release", output=output_marker)

assert not osp.exists(output_marker)

with self.assertRaises(UnsafeOptionError):

self.rorepo.archive(io.BytesIO(), "release", add_file=output_marker)

with self.assertRaises(UnsafeOptionError):

self.rorepo.archive(io.BytesIO(), "release", add_virtual_file="file:content")

def test_archive_rejects_unsafe_remote_protocol(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

output_marker = osp.join(tdir, "pwn")

with self.assertRaises(UnsafeProtocolError):

self.rorepo.archive(io.BytesIO(), "HEAD", remote=f"ext::sh -c touch% {output_marker}")

assert not osp.exists(output_marker)

def test_archive_preserves_positional_allow_unsafe_options(self):

with mock.patch.object(Git, "_call_process") as git:

self.rorepo.archive(io.BytesIO(), "HEAD", None, True, exec="git-upload-archive")

git.assert_called_once()

def test_archive_accepts_stringifiable_remote(self):

class StringifiableRemote:

def __str__(self):

return "origin"

with mock.patch.object(Git, "_call_process") as git:

self.rorepo.archive(io.BytesIO(), "HEAD", remote=StringifiableRemote())

git.assert_called_once()

def test_archive_rejects_unsafe_falsey_remote_protocol(self):

class FalseyRemote:

def __bool__(self):

return False

def __str__(self):

return "ext::sh -c true"

with self.assertRaises(UnsafeProtocolError):

self.rorepo.archive(io.BytesIO(), "HEAD", remote=FalseyRemote())

def test_iter_commits_rejects_unsafe_revision(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

target = osp.join(tdir, "pwn")

with self.assertRaises(UnsafeOptionError):

list(self.rorepo.iter_commits(f"--output={target}", max_count=1))

def test_should_display_blame_information(self):

original_call = Git._call_process

git = mock.Mock(return_value=fixture("blame"))

def blame_only(command, method, *args, **kwargs):

if method == "blame":

return git(method, *args, **kwargs)

return original_call(command, method, *args, **kwargs)

patcher = mock.patch.object(Git, "_call_process", blame_only)

patcher.start()

self.addCleanup(patcher.stop)

b = self.rorepo.blame("master", "lib/git.py")

self.assertEqual(13, len(b))

self.assertEqual(2, len(b[0]))

# self.assertEqual(25, reduce(lambda acc, x: acc + len(x[-1]), b))

self.assertEqual(hash(b[0][0]), hash(b[9][0]))

c = b[0][0]

self.assertTrue(git.called)

self.assertEqual("634396b2f541a9f2d58b00be1a07f0c358b999b3", c.hexsha)

self.assertEqual("Tom Preston-Werner", c.author.name)

self.assertEqual("tom@mojombo.com", c.author.email)

self.assertEqual(1191997100, c.authored_date)

self.assertEqual("Tom Preston-Werner", c.committer.name)

self.assertEqual("tom@mojombo.com", c.committer.email)

self.assertEqual(1191997100, c.committed_date)

self.assertRaisesRegex(

BadObject,

"634396b2f541a9f2d58b00be1a07f0c358b999b3",

lambda: c.message,

)

# Test the 'lines per commit' entries.

tlist = b[0][1]

self.assertTrue(tlist)

self.assertTrue(isinstance(tlist[0], str))

self.assertTrue(len(tlist) < sum(len(t) for t in tlist)) # Test for single-char bug.

# BINARY BLAME

git.return_value = fixture("blame_binary")

blames = self.rorepo.blame("master", "rps")

self.assertEqual(len(blames), 2)

def test_blame_real(self):

c = 0

nml = 0 # Amount of multi-lines per blame.

for item in self.rorepo.head.commit.tree.traverse(

predicate=lambda i, d: i.type == "blob" and i.path.endswith(".py")

):

c += 1

for b in self.rorepo.blame(self.rorepo.head, item.path):

nml += int(len(b[1]) > 1)

# END for each item to traverse

assert c, "Should have executed at least one blame command"

assert nml, "There should at least be one blame commit that contains multiple lines"

def test_blame_rejects_unsafe_revision(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

output_marker = osp.join(tdir, "pwn")

for option in ("--output", "--contents", "-S", "-wS", "--ignore-revs-file"):

with self.assertRaises(UnsafeOptionError):

self.rorepo.blame(f"{option}={output_marker}", "README.md")

with self.assertRaises(UnsafeOptionError):

list(self.rorepo.blame_incremental(f"{option}={output_marker}", "README.md"))

assert not osp.exists(output_marker)

def test_blame_rejects_unsafe_options(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

output_marker = osp.join(tdir, "pwn")

with self.assertRaises(UnsafeOptionError):

self.rorepo.blame("HEAD", "README.md", output=output_marker)

assert not osp.exists(output_marker)

def test_blame_rejects_unsafe_rev_opts(self):

tdir = str(read_only_fixture("repo.sh", "empty"))

output_marker = osp.join(tdir, "pwn")

with self.assertRaises(UnsafeOptionError):

self.rorepo.blame("HEAD", "README.md", rev_opts=(f"--output={output_marker}",))

assert not osp.exists(output_marker)

@mock.patch.object(Git, "_call_process")

def test_blame_incremental(self, git):

# Loop over two fixtures, create a test fixture for 2.11.1+ syntax.

for git_fixture in ("blame_incremental", "blame_incremental_2.11.1_plus"):

git.return_value = fixture(git_fixture)

blame_output = self.rorepo.blame_incremental("9debf6b0aafb6f7781ea9d1383c86939a1aacde3", "AUTHORS")

blame_output = list(blame_output)

self.assertEqual(len(blame_output), 5)

# Check all outputted line numbers.

ranges = flatten([entry.linenos for entry in blame_output])

self.assertEqual(

ranges,

flatten(

[

range(2, 3),

range(14, 15),

range(1, 2),

range(3, 14),

range(15, 17),

]

),

)

commits = [entry.commit.hexsha[:7] for entry in blame_output]

self.assertEqual(commits, ["82b8902", "82b8902", "c76852d", "c76852d", "c76852d"])

# Original filenames.

self.assertSequenceEqual(

[entry.orig_path for entry in blame_output],

["AUTHORS"] * len(blame_output),

)

# Original line numbers.

orig_ranges = flatten([entry.orig_linenos for entry in blame_output])

self.assertEqual(

orig_ranges,

flatten(

[

range(2, 3),

range(14, 15),

range(1, 2),

range(2, 13),

range(13, 15),

]

),

)

def test_blame_incremental_preserves_historical_paths(self):

self.maxDiff = None

paths = (

b"plain.txt",

b" spaced name.txt ",

"café.txt".encode(),

b"byte-\xff.txt",

b'"literal-\\303\\251.txt"',

b'quote"name.txt',

b"back\\slash.txt",

b"control\a\b\t\n\v\f\r.txt",

)

for quote_path in ("true", "false"):

for i, path in enumerate(paths):

with self.subTest(quote_path=quote_path, path=path), fixture_repo(

"blame-paths.sh", quote_path, subdir=str(i)

) as repo:

entries = list(repo.blame_incremental("HEAD", "current.txt"))

original = repo.commit("HEAD~2")

self.assertEqual(

sorted(entries, key=lambda e: e.linenos.start),

[

(original, range(1, 2), safe_decode(path), range(1, 2)),

(repo.head.commit, range(2, 3), "current.txt", range(2, 3)),

(original, range(3, 4), safe_decode(path), range(3, 4)),

],

)

self.assertEqual(list(repo.blame("HEAD", "current.txt", incremental=True)), entries)

def test_blame_preserves_line_content(self):

"""Blame returns each line's exact bytes, not a whitespace-stripped version."""

with fixture_repo("blame-content.sh") as repo:

lines = [line for _commit, blamed in repo.blame("HEAD", "file.txt") for line in blamed]

self.assertEqual(lines, ["alpha ", "beta", "\t", "crlf\r", "gamma"])

def test_blame_preserves_timezones(self):

with fixture_repo("blame-content.sh") as repo:

for incremental in (False, True):

for rev in ("HEAD", None):

with self.subTest(incremental=incremental, rev=rev):

entry = next(iter(repo.blame(rev, "file.txt", incremental=incremental)))

commit = entry[0]

porcelain = repo.git.blame(rev, "--line-porcelain", "--", "file.txt")

offsets = dict(

line.split(" ", 1)

for line in porcelain.splitlines()

if line.startswith(("author-tz ", "committer-tz "))

)

with mock.patch.object(

Commit, "_set_cache_", side_effect=AssertionError("unexpected object read")

):

if rev is None:

self.assertEqual(commit.hexsha, "0" * 40)

else:

self.assertEqual(commit.author_tz_offset, -19800)

self.assertEqual(commit.committer_tz_offset, 14400)

self.assertEqual(commit.authored_datetime.strftime("%z"), offsets["author-tz"])

self.assertEqual(commit.committed_datetime.strftime("%z"), offsets["committer-tz"])

@mock.patch.object(Git, "_call_process")

def test_blame_complex_revision(self, git):

git.return_value = fixture("blame_complex_revision")

res = self.rorepo.blame("HEAD~10..HEAD", "README.md")

self.assertEqual(len(res), 1)

self.assertEqual(len(res[0][1]), 83, "Unexpected amount of parsed blame lines")

@mock.patch.object(Git, "_call_process_safe")

def test_blame_accepts_rev_opts(self, git):

expected_args = ["blame", "HEAD", "-M", "-C", "-C", "--no-textconv", "--", "README.md"]

boilerplate_kwargs = {"p": True, "stdout_as_string": False}

git.return_value = b""

self.rorepo.blame("HEAD", "README.md", rev_opts=["-M", "-C", "-C"])

git.assert_called_once_with(*expected_args, **boilerplate_kwargs)

def test_blame_content_with_carriage_returns(self):

# A lone CR inside a line of content, followed by text shaped like blame

# porcelain headers for a forged commit and author.

forged = "\r".join(

[

"ok",

"0" * 40 + " 2 2 1",

"author Forged Author",

"author-mail <forged@example.com>",

"author-time 1000000000",

"committer Forged Author",

"committer-mail <forged@example.com>",

"committer-time 1000000000",

"\tforged()",

]

)

with fixture_repo("repo.sh", "blame-carriage-returns") as repo:

blames = repo.blame("HEAD", "file.txt")

self.assertEqual(len(blames), 1)

self.assertEqual(blames[0][0], repo.head.commit)

self.assertEqual(blames[0][0].author.name, "GitPython Tests")

self.assertEqual(blames[0][1], ["first", forged])

def test_untracked_files(self):

for command in ("index", "git"):

with fixture_repo("repo.sh", "untracked", write=True) as repo:

files = ["test _myfile", "test_other_file", "_çava verböten", "çava-----verböten"]

assert sorted(repo.untracked_files) == sorted(files)

repo_add = repo.index.add if command == "index" else repo.git.add

repo_add(repo.untracked_files)

assert repo.untracked_files == []

# END for each run

def test_untracked_files_with_unquoted_unicode_and_escapes(self):

paths = {"plain.txt", "caf\u00e9.txt", "caf\u00e9\x7f.txt", " leading.txt"}

for quote_path in ("true", "false"):

with self.subTest(quote_path=quote_path), fixture_repo("repo.sh", "untracked-unicode", quote_path) as repo:

baseline = repo.git.status("--porcelain=v1", "-z", "--untracked-files=all", stdout_as_string=False)

assert set(baseline.rstrip(b"\0").split(b"\0")) == {b"?? " + path.encode("utf-8") for path in paths}

assert set(repo.untracked_files) == paths

assert repo.is_dirty(untracked_files=True)

def test_config_reader(self):

reader = self.rorepo.config_reader() # All config files.

assert reader.read_only

reader = self.rorepo.config_reader("repository") # Single config file.

assert reader.read_only

@with_rw_repo("HEAD")

def test_config_writer(self, rw_repo):

for config_level in rw_repo.config_level:

try:

with rw_repo.config_writer(config_level) as writer:

self.assertFalse(writer.read_only)

except OSError:

# It's okay not to get a writer for some configuration files if we

# have no permissions.

pass

def test_config_level_paths(self):

for config_level in self.rorepo.config_level:

assert self.rorepo._get_config_path(config_level)

@with_rw_repo("HEAD")

def test_creation_deletion(self, rw_repo):

# Just a very quick test to assure it generally works. There are specialized

# cases in the test_refs module.

head = rw_repo.create_head("new_head", "HEAD~1")

rw_repo.delete_head(head)

try:

tag = rw_repo.create_tag("new_tag", "HEAD~2")

finally:

rw_repo.delete_tag(tag)

with rw_repo.config_writer():

pass

try:

remote = rw_repo.create_remote("new_remote", "git@server:repo.git")

finally:

rw_repo.delete_remote(remote)

def test_comparison_and_hash(self):

# This is only a preliminary test, more testing done in test_index.

self.assertEqual(self.rorepo, self.rorepo)

self.assertFalse(self.rorepo != self.rorepo)

self.assertEqual(len({self.rorepo, self.rorepo}), 1)

def test_git_cmd(self):

# Test CatFileContentStream, just to be very sure we have no fencepost errors.

# The last \n is the terminating newline that it expects.

l1 = b"0123456789\n"

l2 = b"abcdefghijklmnopqrstxy\n"

l3 = b"z\n"

d = l1 + l2 + l3 + b"\n"

l1p = l1[:5]

# Full size.

# Size is without terminating newline.

def mkfull():

return Git.CatFileContentStream(len(d) - 1, BytesIO(d))

ts = 5

def mktiny():

return Git.CatFileContentStream(ts, BytesIO(d))

# readlines no limit

s = mkfull()