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 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
|
# test_worktree.py -- Tests for dulwich.worktree
# Copyright (C) 2024 Jelmer Vernooij <jelmer@jelmer.uk>
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as published by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Tests for dulwich.worktree."""
import os
import shutil
import stat
import tempfile
from unittest import skipIf
from dulwich import porcelain
from dulwich.errors import CommitError
from dulwich.object_store import tree_lookup_path
from dulwich.repo import Repo
from dulwich.worktree import (
WorkTree,
add_worktree,
list_worktrees,
lock_worktree,
move_worktree,
prune_worktrees,
remove_worktree,
repair_worktree,
temporary_worktree,
unlock_worktree,
)
from . import TestCase
class WorkTreeTestCase(TestCase):
"""Base test case for WorkTree tests."""
def setUp(self):
super().setUp()
self.tempdir = tempfile.mkdtemp()
self.test_dir = os.path.join(self.tempdir, "main")
self.repo = Repo.init(self.test_dir, mkdir=True)
# Create initial commit with a file
with open(os.path.join(self.test_dir, "a"), "wb") as f:
f.write(b"contents of file a")
self.repo.get_worktree().stage(["a"])
self.root_commit = self.repo.get_worktree().commit(
message=b"Initial commit",
committer=b"Test Committer <test@nodomain.com>",
author=b"Test Author <test@nodomain.com>",
commit_timestamp=12345,
commit_timezone=0,
author_timestamp=12345,
author_timezone=0,
)
self.worktree = self.repo.get_worktree()
def tearDown(self):
self.repo.close()
super().tearDown()
def write_file(self, filename, content):
"""Helper to write a file in the repo."""
with open(os.path.join(self.test_dir, filename), "wb") as f:
f.write(content)
class WorkTreeInitTests(TestCase):
"""Tests for WorkTree initialization."""
def test_init_with_repo_path(self):
"""Test WorkTree initialization with same path as repo."""
with tempfile.TemporaryDirectory() as tmpdir:
repo = Repo.init(tmpdir)
worktree = WorkTree(repo, tmpdir)
self.assertEqual(worktree.path, tmpdir)
self.assertEqual(worktree._repo, repo)
self.assertTrue(os.path.isabs(worktree.path))
def test_init_with_different_path(self):
"""Test WorkTree initialization with different path from repo."""
with tempfile.TemporaryDirectory() as tmpdir:
repo_path = os.path.join(tmpdir, "repo")
worktree_path = os.path.join(tmpdir, "worktree")
os.makedirs(repo_path)
os.makedirs(worktree_path)
repo = Repo.init(repo_path)
worktree = WorkTree(repo, worktree_path)
self.assertNotEqual(worktree.path, repo.path)
self.assertEqual(worktree.path, worktree_path)
self.assertEqual(worktree._repo, repo)
self.assertTrue(os.path.isabs(worktree.path))
def test_init_with_bytes_path(self):
"""Test WorkTree initialization with bytes path."""
with tempfile.TemporaryDirectory() as tmpdir:
repo = Repo.init(tmpdir)
worktree = WorkTree(repo, tmpdir.encode("utf-8"))
self.assertEqual(worktree.path, tmpdir)
self.assertIsInstance(worktree.path, str)
class WorkTreeStagingTests(WorkTreeTestCase):
"""Tests for WorkTree staging operations."""
def test_stage_absolute(self):
"""Test that staging with absolute paths raises ValueError."""
r = self.repo
os.remove(os.path.join(r.path, "a"))
self.assertRaises(ValueError, self.worktree.stage, [os.path.join(r.path, "a")])
def test_stage_deleted(self):
"""Test staging a deleted file."""
r = self.repo
os.remove(os.path.join(r.path, "a"))
self.worktree.stage(["a"])
self.worktree.stage(["a"]) # double-stage a deleted path
self.assertEqual([], list(r.open_index()))
def test_stage_directory(self):
"""Test staging a directory."""
r = self.repo
os.mkdir(os.path.join(r.path, "c"))
self.worktree.stage(["c"])
self.assertEqual([b"a"], list(r.open_index()))
def test_stage_submodule(self):
"""Test staging a submodule."""
r = self.repo
s = Repo.init(os.path.join(r.path, "sub"), mkdir=True)
s.get_worktree().commit(
message=b"message",
)
self.worktree.stage(["sub"])
self.assertEqual([b"a", b"sub"], list(r.open_index()))
class WorkTreeUnstagingTests(WorkTreeTestCase):
"""Tests for WorkTree unstaging operations."""
def test_unstage_modify_file_with_dir(self):
"""Test unstaging a modified file in a directory."""
os.mkdir(os.path.join(self.repo.path, "new_dir"))
full_path = os.path.join(self.repo.path, "new_dir", "foo")
with open(full_path, "w") as f:
f.write("hello")
porcelain.add(self.repo, paths=[full_path])
porcelain.commit(
self.repo,
message=b"unittest",
committer=b"Jane <jane@example.com>",
author=b"John <john@example.com>",
)
with open(full_path, "a") as f:
f.write("something new")
self.worktree.unstage(["new_dir/foo"])
status = list(porcelain.status(self.repo))
self.assertEqual(
[{"add": [], "delete": [], "modify": []}, [b"new_dir/foo"], []], status
)
def test_unstage_while_no_commit(self):
"""Test unstaging when there are no commits."""
file = "foo"
full_path = os.path.join(self.repo.path, file)
with open(full_path, "w") as f:
f.write("hello")
porcelain.add(self.repo, paths=[full_path])
self.worktree.unstage([file])
status = list(porcelain.status(self.repo))
self.assertEqual([{"add": [], "delete": [], "modify": []}, [], ["foo"]], status)
def test_unstage_add_file(self):
"""Test unstaging a newly added file."""
file = "foo"
full_path = os.path.join(self.repo.path, file)
porcelain.commit(
self.repo,
message=b"unittest",
committer=b"Jane <jane@example.com>",
author=b"John <john@example.com>",
)
with open(full_path, "w") as f:
f.write("hello")
porcelain.add(self.repo, paths=[full_path])
self.worktree.unstage([file])
status = list(porcelain.status(self.repo))
self.assertEqual([{"add": [], "delete": [], "modify": []}, [], ["foo"]], status)
def test_unstage_modify_file(self):
"""Test unstaging a modified file."""
file = "foo"
full_path = os.path.join(self.repo.path, file)
with open(full_path, "w") as f:
f.write("hello")
porcelain.add(self.repo, paths=[full_path])
porcelain.commit(
self.repo,
message=b"unittest",
committer=b"Jane <jane@example.com>",
author=b"John <john@example.com>",
)
with open(full_path, "a") as f:
f.write("broken")
porcelain.add(self.repo, paths=[full_path])
self.worktree.unstage([file])
status = list(porcelain.status(self.repo))
self.assertEqual(
[{"add": [], "delete": [], "modify": []}, [b"foo"], []], status
)
def test_unstage_remove_file(self):
"""Test unstaging a removed file."""
file = "foo"
full_path = os.path.join(self.repo.path, file)
with open(full_path, "w") as f:
f.write("hello")
porcelain.add(self.repo, paths=[full_path])
porcelain.commit(
self.repo,
message=b"unittest",
committer=b"Jane <jane@example.com>",
author=b"John <john@example.com>",
)
os.remove(full_path)
self.worktree.unstage([file])
status = list(porcelain.status(self.repo))
self.assertEqual(
[{"add": [], "delete": [], "modify": []}, [b"foo"], []], status
)
class WorkTreeCommitTests(WorkTreeTestCase):
"""Tests for WorkTree commit operations."""
def test_commit_modified(self):
"""Test committing a modified file."""
r = self.repo
with open(os.path.join(r.path, "a"), "wb") as f:
f.write(b"new contents")
self.worktree.stage(["a"])
commit_sha = self.worktree.commit(
b"modified a",
committer=b"Test Committer <test@nodomain.com>",
author=b"Test Author <test@nodomain.com>",
commit_timestamp=12395,
commit_timezone=0,
author_timestamp=12395,
author_timezone=0,
)
self.assertEqual([self.root_commit], r[commit_sha].parents)
a_mode, a_id = tree_lookup_path(r.get_object, r[commit_sha].tree, b"a")
self.assertEqual(stat.S_IFREG | 0o644, a_mode)
self.assertEqual(b"new contents", r[a_id].data)
@skipIf(not getattr(os, "symlink", None), "Requires symlink support")
def test_commit_symlink(self):
"""Test committing a symlink."""
r = self.repo
os.symlink("a", os.path.join(r.path, "b"))
self.worktree.stage(["a", "b"])
commit_sha = self.worktree.commit(
b"Symlink b",
committer=b"Test Committer <test@nodomain.com>",
author=b"Test Author <test@nodomain.com>",
commit_timestamp=12395,
commit_timezone=0,
author_timestamp=12395,
author_timezone=0,
)
self.assertEqual([self.root_commit], r[commit_sha].parents)
b_mode, b_id = tree_lookup_path(r.get_object, r[commit_sha].tree, b"b")
self.assertEqual(stat.S_IFLNK, b_mode)
self.assertEqual(b"a", r[b_id].data)
class WorkTreeResetTests(WorkTreeTestCase):
"""Tests for WorkTree reset operations."""
def test_reset_index(self):
"""Test resetting the index."""
# Make some changes and stage them
with open(os.path.join(self.repo.path, "a"), "wb") as f:
f.write(b"modified contents")
self.worktree.stage(["a"])
# Reset index should restore to HEAD
self.worktree.reset_index()
# Check that the working tree file was restored
with open(os.path.join(self.repo.path, "a"), "rb") as f:
contents = f.read()
self.assertEqual(b"contents of file a", contents)
class WorkTreeSparseCheckoutTests(WorkTreeTestCase):
"""Tests for WorkTree sparse checkout operations."""
def test_get_sparse_checkout_patterns_empty(self):
"""Test getting sparse checkout patterns when file doesn't exist."""
patterns = self.worktree.get_sparse_checkout_patterns()
self.assertEqual([], patterns)
def test_set_sparse_checkout_patterns(self):
"""Test setting sparse checkout patterns."""
patterns = ["*.py", "docs/"]
self.worktree.set_sparse_checkout_patterns(patterns)
# Read back the patterns
retrieved_patterns = self.worktree.get_sparse_checkout_patterns()
self.assertEqual(patterns, retrieved_patterns)
def test_configure_for_cone_mode(self):
"""Test configuring repository for cone mode."""
self.worktree.configure_for_cone_mode()
config = self.repo.get_config()
self.assertEqual(b"true", config.get((b"core",), b"sparseCheckout"))
self.assertEqual(b"true", config.get((b"core",), b"sparseCheckoutCone"))
def test_infer_cone_mode_false(self):
"""Test inferring cone mode when not configured."""
self.assertFalse(self.worktree.infer_cone_mode())
def test_infer_cone_mode_true(self):
"""Test inferring cone mode when configured."""
self.worktree.configure_for_cone_mode()
self.assertTrue(self.worktree.infer_cone_mode())
def test_set_cone_mode_patterns(self):
"""Test setting cone mode patterns."""
dirs = ["src", "tests"]
self.worktree.set_cone_mode_patterns(dirs)
patterns = self.worktree.get_sparse_checkout_patterns()
expected = ["/*", "!/*/", "/src/", "/tests/"]
self.assertEqual(expected, patterns)
def test_set_cone_mode_patterns_empty(self):
"""Test setting cone mode patterns with empty list."""
self.worktree.set_cone_mode_patterns([])
patterns = self.worktree.get_sparse_checkout_patterns()
expected = ["/*", "!/*/"]
self.assertEqual(expected, patterns)
def test_set_cone_mode_patterns_duplicates(self):
"""Test that duplicate patterns are not added."""
dirs = ["src", "src"] # duplicate
self.worktree.set_cone_mode_patterns(dirs)
patterns = self.worktree.get_sparse_checkout_patterns()
expected = ["/*", "!/*/", "/src/"]
self.assertEqual(expected, patterns)
def test_sparse_checkout_file_path(self):
"""Test getting the sparse checkout file path."""
expected_path = os.path.join(self.repo.controldir(), "info", "sparse-checkout")
actual_path = self.worktree._sparse_checkout_file_path()
self.assertEqual(expected_path, actual_path)
class WorkTreeBackwardCompatibilityTests(WorkTreeTestCase):
"""Tests for backward compatibility of deprecated Repo methods."""
def test_deprecated_stage_delegates_to_worktree(self):
"""Test that deprecated Repo.stage delegates to WorkTree."""
with open(os.path.join(self.repo.path, "new_file"), "w") as f:
f.write("test content")
# This should show a deprecation warning but still work
import warnings
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
self.repo.stage(
["new_file"]
) # Call deprecated method on Repo, not WorkTree
self.assertTrue(len(w) > 0)
self.assertTrue(issubclass(w[0].category, DeprecationWarning))
def test_deprecated_unstage_delegates_to_worktree(self):
"""Test that deprecated Repo.unstage delegates to WorkTree."""
# This should show a deprecation warning but still work
import warnings
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
self.repo.unstage(["a"]) # Call deprecated method on Repo, not WorkTree
self.assertTrue(len(w) > 0)
self.assertTrue(issubclass(w[0].category, DeprecationWarning))
def test_deprecated_sparse_checkout_methods(self):
"""Test that deprecated sparse checkout methods delegate to WorkTree."""
import warnings
# Test get_sparse_checkout_patterns
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
patterns = (
self.repo.get_sparse_checkout_patterns()
) # Call deprecated method on Repo
self.assertEqual([], patterns)
self.assertTrue(len(w) > 0)
self.assertTrue(issubclass(w[0].category, DeprecationWarning))
# Test set_sparse_checkout_patterns
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
self.repo.set_sparse_checkout_patterns(
["*.py"]
) # Call deprecated method on Repo
self.assertTrue(len(w) > 0)
self.assertTrue(issubclass(w[0].category, DeprecationWarning))
def test_pre_commit_hook_fail(self):
"""Test that failing pre-commit hook raises CommitError."""
if os.name != "posix":
self.skipTest("shell hook tests requires POSIX shell")
# Create a failing pre-commit hook
hooks_dir = os.path.join(self.repo.controldir(), "hooks")
os.makedirs(hooks_dir, exist_ok=True)
hook_path = os.path.join(hooks_dir, "pre-commit")
with open(hook_path, "w") as f:
f.write("#!/bin/sh\nexit 1\n")
os.chmod(hook_path, 0o755)
# Try to commit
worktree = self.repo.get_worktree()
with self.assertRaises(CommitError):
worktree.commit(b"No message")
def write_file(self, filename, content):
"""Helper to write a file in the repo."""
with open(os.path.join(self.test_dir, filename), "wb") as f:
f.write(content)
class WorkTreeOperationsTests(WorkTreeTestCase):
"""Tests for worktree operations like add, list, remove."""
def test_list_worktrees_single(self) -> None:
"""Test listing worktrees when only main worktree exists."""
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 1)
self.assertEqual(worktrees[0].path, self.repo.path)
self.assertEqual(worktrees[0].bare, False)
self.assertIsNotNone(worktrees[0].head)
self.assertIsNotNone(worktrees[0].branch)
def test_add_worktree_new_branch(self) -> None:
"""Test adding a worktree with a new branch."""
# Create a commit first
worktree = self.repo.get_worktree()
self.write_file("test.txt", b"test content")
worktree.stage(["test.txt"])
commit_id = worktree.commit(message=b"Initial commit")
# Add a new worktree
wt_path = os.path.join(self.tempdir, "new-worktree")
add_worktree(self.repo, wt_path, branch=b"feature-branch")
# Verify worktree was created
self.assertTrue(os.path.exists(wt_path))
self.assertTrue(os.path.exists(os.path.join(wt_path, ".git")))
# Verify it appears in the list
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 2)
# Find the new worktree in the list
new_wt = None
for wt in worktrees:
if wt.path == wt_path:
new_wt = wt
break
self.assertIsNotNone(new_wt)
self.assertEqual(new_wt.branch, b"refs/heads/feature-branch")
self.assertEqual(new_wt.head, commit_id)
self.assertFalse(new_wt.detached)
def test_add_worktree_detached(self) -> None:
"""Test adding a worktree with detached HEAD."""
# Create a commit
worktree = self.repo.get_worktree()
self.write_file("test.txt", b"test content")
worktree.stage(["test.txt"])
commit_id = worktree.commit(message=b"Initial commit")
# Add a detached worktree
wt_path = os.path.join(self.tempdir, "detached-worktree")
add_worktree(self.repo, wt_path, commit=commit_id, detach=True)
# Verify it's detached
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 2)
for wt in worktrees:
if wt.path == wt_path:
self.assertTrue(wt.detached)
self.assertIsNone(wt.branch)
self.assertEqual(wt.head, commit_id)
def test_add_worktree_existing_path(self) -> None:
"""Test that adding a worktree to existing path fails."""
wt_path = os.path.join(self.tempdir, "existing")
os.mkdir(wt_path)
with self.assertRaises(ValueError) as cm:
add_worktree(self.repo, wt_path)
self.assertIn("Path already exists", str(cm.exception))
def test_add_worktree_branch_already_checked_out(self) -> None:
"""Test that checking out same branch in multiple worktrees fails."""
# Create initial commit
worktree = self.repo.get_worktree()
self.write_file("test.txt", b"test content")
worktree.stage(["test.txt"])
worktree.commit(message=b"Initial commit")
# First worktree should succeed with a new branch
wt_path1 = os.path.join(self.tempdir, "wt1")
add_worktree(self.repo, wt_path1, branch=b"feature")
# Second worktree with same branch should fail
wt_path2 = os.path.join(self.tempdir, "wt2")
with self.assertRaises(ValueError) as cm:
add_worktree(self.repo, wt_path2, branch=b"feature")
self.assertIn("already checked out", str(cm.exception))
# But should work with force=True
add_worktree(self.repo, wt_path2, branch=b"feature", force=True)
def test_remove_worktree(self) -> None:
"""Test removing a worktree."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "to-remove")
add_worktree(self.repo, wt_path)
# Verify it exists
self.assertTrue(os.path.exists(wt_path))
self.assertEqual(len(list_worktrees(self.repo)), 2)
# Remove it
remove_worktree(self.repo, wt_path)
# Verify it's gone
self.assertFalse(os.path.exists(wt_path))
self.assertEqual(len(list_worktrees(self.repo)), 1)
def test_remove_main_worktree_fails(self) -> None:
"""Test that removing the main worktree fails."""
with self.assertRaises(ValueError) as cm:
remove_worktree(self.repo, self.repo.path)
self.assertIn("Cannot remove the main working tree", str(cm.exception))
def test_remove_nonexistent_worktree(self) -> None:
"""Test that removing non-existent worktree fails."""
with self.assertRaises(ValueError) as cm:
remove_worktree(self.repo, "/nonexistent/path")
self.assertIn("Worktree not found", str(cm.exception))
def test_lock_unlock_worktree(self) -> None:
"""Test locking and unlocking a worktree."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "lockable")
add_worktree(self.repo, wt_path)
# Lock it
lock_worktree(self.repo, wt_path, reason="Testing lock")
# Verify it's locked
worktrees = list_worktrees(self.repo)
for wt in worktrees:
if wt.path == wt_path:
self.assertTrue(wt.locked)
# Try to remove locked worktree (should fail)
with self.assertRaises(ValueError) as cm:
remove_worktree(self.repo, wt_path)
self.assertIn("locked", str(cm.exception))
# Unlock it
unlock_worktree(self.repo, wt_path)
# Verify it's unlocked
worktrees = list_worktrees(self.repo)
for wt in worktrees:
if wt.path == wt_path:
self.assertFalse(wt.locked)
# Now removal should work
remove_worktree(self.repo, wt_path)
def test_prune_worktrees(self) -> None:
"""Test pruning worktrees."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "to-prune")
add_worktree(self.repo, wt_path)
# Manually remove the worktree directory
shutil.rmtree(wt_path)
# Verify it still shows up as prunable
worktrees = list_worktrees(self.repo)
prunable_count = sum(1 for wt in worktrees if wt.prunable)
self.assertEqual(prunable_count, 1)
# Prune it
pruned = prune_worktrees(self.repo)
self.assertEqual(len(pruned), 1)
# Verify it's gone from the list
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 1)
def test_prune_dry_run(self) -> None:
"""Test prune with dry_run doesn't remove anything."""
# Create and manually remove a worktree
wt_path = os.path.join(self.tempdir, "dry-run-test")
add_worktree(self.repo, wt_path)
shutil.rmtree(wt_path)
# Dry run should report but not remove
pruned = prune_worktrees(self.repo, dry_run=True)
self.assertEqual(len(pruned), 1)
# Worktree should still be in list
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 2)
def test_prune_locked_worktree_not_pruned(self) -> None:
"""Test that locked worktrees are not pruned."""
# Create and lock a worktree
wt_path = os.path.join(self.tempdir, "locked-prune")
add_worktree(self.repo, wt_path)
lock_worktree(self.repo, wt_path)
# Remove the directory
shutil.rmtree(wt_path)
# Prune should not remove locked worktree
pruned = prune_worktrees(self.repo)
self.assertEqual(len(pruned), 0)
# Worktree should still be in list
worktrees = list_worktrees(self.repo)
self.assertEqual(len(worktrees), 2)
def test_move_worktree(self) -> None:
"""Test moving a worktree."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "to-move")
add_worktree(self.repo, wt_path)
# Create a file in the worktree
test_file = os.path.join(wt_path, "test.txt")
with open(test_file, "w") as f:
f.write("test content")
# Move it
new_path = os.path.join(self.tempdir, "moved")
move_worktree(self.repo, wt_path, new_path)
# Verify old path doesn't exist
self.assertFalse(os.path.exists(wt_path))
# Verify new path exists with contents
self.assertTrue(os.path.exists(new_path))
self.assertTrue(os.path.exists(os.path.join(new_path, "test.txt")))
# Verify it's in the list at new location
worktrees = list_worktrees(self.repo)
paths = [wt.path for wt in worktrees]
self.assertIn(new_path, paths)
self.assertNotIn(wt_path, paths)
def test_move_main_worktree_fails(self) -> None:
"""Test that moving the main worktree fails."""
new_path = os.path.join(self.tempdir, "new-main")
with self.assertRaises(ValueError) as cm:
move_worktree(self.repo, self.repo.path, new_path)
self.assertIn("Cannot move the main working tree", str(cm.exception))
def test_move_to_existing_path_fails(self) -> None:
"""Test that moving to an existing path fails."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Create target directory
new_path = os.path.join(self.tempdir, "existing")
os.makedirs(new_path)
with self.assertRaises(ValueError) as cm:
move_worktree(self.repo, wt_path, new_path)
self.assertIn("Path already exists", str(cm.exception))
def test_repair_worktree_after_manual_move(self) -> None:
"""Test repairing a worktree after manually moving it."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "original")
add_worktree(self.repo, wt_path)
# Manually move the worktree directory (simulating external move)
new_path = os.path.join(self.tempdir, "moved")
shutil.move(wt_path, new_path)
# At this point, the connection is broken
# Repair from the moved worktree
repaired = repair_worktree(self.repo, paths=[new_path])
# Should have repaired the worktree
self.assertEqual(len(repaired), 1)
self.assertEqual(repaired[0], new_path)
# Verify the worktree is now properly connected
worktrees = list_worktrees(self.repo)
paths = [wt.path for wt in worktrees]
self.assertIn(new_path, paths)
def test_repair_worktree_from_main_repo(self) -> None:
"""Test repairing worktree connections from main repository."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Read the .git file to get the control directory
gitdir_file = os.path.join(wt_path, ".git")
with open(gitdir_file, "rb") as f:
content = f.read().strip()
control_dir = content[8:].decode() # Remove "gitdir: " prefix
# Manually corrupt the .git file to point to wrong location
with open(gitdir_file, "wb") as f:
f.write(b"gitdir: /wrong/path\n")
# Repair from main repository
repaired = repair_worktree(self.repo)
# Should have repaired the connection
self.assertEqual(len(repaired), 1)
self.assertEqual(repaired[0], wt_path)
# Verify .git file now points to correct location
with open(gitdir_file, "rb") as f:
content = f.read().strip()
new_control_dir = content[8:].decode()
self.assertEqual(
os.path.abspath(new_control_dir), os.path.abspath(control_dir)
)
def test_repair_worktree_no_repairs_needed(self) -> None:
"""Test repair when no repairs are needed."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Repair - should return empty list since nothing is broken
repaired = repair_worktree(self.repo)
self.assertEqual(len(repaired), 0)
def test_repair_invalid_worktree_path(self) -> None:
"""Test that repairing an invalid path raises an error."""
with self.assertRaises(ValueError) as cm:
repair_worktree(self.repo, paths=["/nonexistent/path"])
self.assertIn("Not a valid worktree", str(cm.exception))
def test_repair_multiple_worktrees(self) -> None:
"""Test repairing multiple worktrees at once."""
# Create two worktrees
wt_path1 = os.path.join(self.tempdir, "wt1")
wt_path2 = os.path.join(self.tempdir, "wt2")
add_worktree(self.repo, wt_path1, branch=b"branch1")
add_worktree(self.repo, wt_path2, branch=b"branch2")
# Manually move both worktrees
new_path1 = os.path.join(self.tempdir, "moved1")
new_path2 = os.path.join(self.tempdir, "moved2")
shutil.move(wt_path1, new_path1)
shutil.move(wt_path2, new_path2)
# Repair both at once
repaired = repair_worktree(self.repo, paths=[new_path1, new_path2])
# Both should be repaired
self.assertEqual(len(repaired), 2)
self.assertIn(new_path1, repaired)
self.assertIn(new_path2, repaired)
def test_repair_worktree_with_relative_paths(self) -> None:
"""Test that repair handles worktrees with relative paths in gitdir."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Manually move the worktree
new_path = os.path.join(self.tempdir, "new-location")
shutil.move(wt_path, new_path)
# Repair from the new location
repaired = repair_worktree(self.repo, paths=[new_path])
# Should have repaired successfully
self.assertEqual(len(repaired), 1)
self.assertEqual(repaired[0], new_path)
# Verify the gitdir pointer was updated
from dulwich.repo import GITDIR, WORKTREES
worktrees_dir = os.path.join(self.repo.controldir(), WORKTREES)
for entry in os.listdir(worktrees_dir):
gitdir_path = os.path.join(worktrees_dir, entry, GITDIR)
if os.path.exists(gitdir_path):
with open(gitdir_path, "rb") as f:
content = f.read().strip()
gitdir_location = os.fsdecode(content)
# Should point to the new .git file location
self.assertTrue(gitdir_location.endswith(".git"))
def test_repair_worktree_container_method(self) -> None:
"""Test the WorkTreeContainer.repair() method."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Manually move it
new_path = os.path.join(self.tempdir, "moved")
shutil.move(wt_path, new_path)
# Use the container method to repair
repaired = self.repo.worktrees.repair(paths=[new_path])
# Should have repaired
self.assertEqual(len(repaired), 1)
self.assertEqual(repaired[0], new_path)
def test_repair_with_missing_gitdir_pointer(self) -> None:
"""Test repair when gitdir pointer file is missing."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Find and remove the gitdir pointer file
from dulwich.repo import GITDIR, WORKTREES
worktrees_dir = os.path.join(self.repo.controldir(), WORKTREES)
for entry in os.listdir(worktrees_dir):
gitdir_path = os.path.join(worktrees_dir, entry, GITDIR)
if os.path.exists(gitdir_path):
os.remove(gitdir_path)
# Repair should not crash, but won't repair anything
repaired = repair_worktree(self.repo, paths=[wt_path])
self.assertEqual(len(repaired), 0)
def test_repair_worktree_with_corrupted_git_file(self) -> None:
"""Test repair with a corrupted .git file."""
# Create a worktree
wt_path = os.path.join(self.tempdir, "worktree")
add_worktree(self.repo, wt_path)
# Corrupt the .git file
gitdir_file = os.path.join(wt_path, ".git")
with open(gitdir_file, "wb") as f:
f.write(b"invalid content\n")
# Attempting to repair should raise an error
with self.assertRaises(ValueError) as cm:
repair_worktree(self.repo, paths=[wt_path])
self.assertIn("Invalid .git file", str(cm.exception))
class TemporaryWorktreeTests(TestCase):
"""Tests for temporary_worktree context manager."""
def setUp(self) -> None:
super().setUp()
self.tempdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.tempdir)
self.repo_path = os.path.join(self.tempdir, "repo")
self.repo = Repo.init(self.repo_path, mkdir=True)
# Create an initial commit so HEAD exists
readme_path = os.path.join(self.repo_path, "README.md")
with open(readme_path, "w") as f:
f.write("# Test Repository\n")
porcelain.add(self.repo, [readme_path])
porcelain.commit(self.repo, message=b"Initial commit")
def test_temporary_worktree_creates_and_cleans_up(self) -> None:
"""Test that temporary worktree is created and cleaned up."""
worktree_path = None
# Use the context manager
with temporary_worktree(self.repo) as worktree:
worktree_path = worktree.path
# Check that worktree exists
self.assertTrue(os.path.exists(worktree_path))
# Check that it's in the list of worktrees
worktrees = list_worktrees(self.repo)
paths = [wt.path for wt in worktrees]
self.assertIn(worktree_path, paths)
# Check that .git file exists in worktree
gitdir_file = os.path.join(worktree_path, ".git")
self.assertTrue(os.path.exists(gitdir_file))
# After context manager exits, check cleanup
self.assertFalse(os.path.exists(worktree_path))
# Check that it's no longer in the list of worktrees
worktrees = list_worktrees(self.repo)
paths = [wt.path for wt in worktrees]
self.assertNotIn(worktree_path, paths)
def test_temporary_worktree_with_custom_prefix(self) -> None:
"""Test temporary worktree with custom prefix."""
custom_prefix = "my-custom-prefix-"
with temporary_worktree(self.repo, prefix=custom_prefix) as worktree:
# Check that the directory name starts with our prefix
dirname = os.path.basename(worktree.path)
self.assertTrue(dirname.startswith(custom_prefix))
def test_temporary_worktree_cleanup_on_exception(self) -> None:
"""Test that cleanup happens even when exception is raised."""
worktree_path = None
class TestException(Exception):
pass
try:
with temporary_worktree(self.repo) as worktree:
worktree_path = worktree.path
self.assertTrue(os.path.exists(worktree_path))
raise TestException("Test exception")
except TestException:
pass
# Cleanup should still happen
self.assertFalse(os.path.exists(worktree_path))
# Check that it's no longer in the list of worktrees
worktrees = list_worktrees(self.repo)
paths = [wt.path for wt in worktrees]
self.assertNotIn(worktree_path, paths)
def test_temporary_worktree_operations(self) -> None:
"""Test that operations can be performed in temporary worktree."""
# Create a test file in main repo
test_file = os.path.join(self.repo_path, "test.txt")
with open(test_file, "w") as f:
f.write("Hello, world!")
porcelain.add(self.repo, [test_file])
porcelain.commit(self.repo, message=b"Initial commit")
with temporary_worktree(self.repo) as worktree:
# Check that the file exists in the worktree
wt_test_file = os.path.join(worktree.path, "test.txt")
self.assertTrue(os.path.exists(wt_test_file))
# Read and verify content
with open(wt_test_file) as f:
content = f.read()
self.assertEqual(content, "Hello, world!")
# Make changes in the worktree
with open(wt_test_file, "w") as f:
f.write("Modified content")
# Changes should be visible in status
status = porcelain.status(worktree)
self.assertIn(b"test.txt", status.unstaged)
|