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
|
# test_commit_graph.py -- Tests for commit graph functionality
# 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.
"""Tests for Git commit graph functionality."""
import io
import os
import struct
import tempfile
import unittest
from dulwich.commit_graph import (
CHUNK_COMMIT_DATA,
CHUNK_OID_FANOUT,
CHUNK_OID_LOOKUP,
COMMIT_GRAPH_SIGNATURE,
COMMIT_GRAPH_VERSION,
HASH_VERSION_SHA1,
CommitGraph,
CommitGraphChunk,
CommitGraphEntry,
find_commit_graph_file,
generate_commit_graph,
get_reachable_commits,
read_commit_graph,
)
class CommitGraphEntryTests(unittest.TestCase):
"""Tests for CommitGraphEntry."""
def test_init(self) -> None:
commit_id = b"a" * 40
tree_id = b"b" * 40
parents = [b"c" * 40, b"d" * 40]
generation = 42
commit_time = 1234567890
entry = CommitGraphEntry(commit_id, tree_id, parents, generation, commit_time)
self.assertEqual(entry.commit_id, commit_id)
self.assertEqual(entry.tree_id, tree_id)
self.assertEqual(entry.parents, parents)
self.assertEqual(entry.generation, generation)
self.assertEqual(entry.commit_time, commit_time)
def test_repr(self) -> None:
entry = CommitGraphEntry(b"a" * 40, b"b" * 40, [], 1, 1000)
repr_str = repr(entry)
self.assertIn("CommitGraphEntry", repr_str)
self.assertIn("generation=1", repr_str)
class CommitGraphChunkTests(unittest.TestCase):
"""Tests for CommitGraphChunk."""
def test_init(self) -> None:
chunk = CommitGraphChunk(b"TEST", b"test data")
self.assertEqual(chunk.chunk_id, b"TEST")
self.assertEqual(chunk.data, b"test data")
def test_repr(self) -> None:
chunk = CommitGraphChunk(b"TEST", b"x" * 100)
repr_str = repr(chunk)
self.assertIn("CommitGraphChunk", repr_str)
self.assertIn("size=100", repr_str)
class CommitGraphTests(unittest.TestCase):
"""Tests for CommitGraph."""
def test_init(self) -> None:
graph = CommitGraph()
self.assertEqual(graph.hash_version, HASH_VERSION_SHA1)
self.assertEqual(len(graph.entries), 0)
self.assertEqual(len(graph.chunks), 0)
def test_len(self) -> None:
graph = CommitGraph()
self.assertEqual(len(graph), 0)
# Add a dummy entry
entry = CommitGraphEntry(b"a" * 40, b"b" * 40, [], 1, 1000)
graph.entries.append(entry)
self.assertEqual(len(graph), 1)
def test_iter(self) -> None:
graph = CommitGraph()
entry1 = CommitGraphEntry(b"a" * 40, b"b" * 40, [], 1, 1000)
entry2 = CommitGraphEntry(b"c" * 40, b"d" * 40, [], 2, 2000)
graph.entries.extend([entry1, entry2])
entries = list(graph)
self.assertEqual(len(entries), 2)
self.assertEqual(entries[0], entry1)
self.assertEqual(entries[1], entry2)
def test_get_entry_by_oid_missing(self) -> None:
graph = CommitGraph()
result = graph.get_entry_by_oid(b"f" * 40)
self.assertIsNone(result)
def test_get_generation_number_missing(self) -> None:
graph = CommitGraph()
result = graph.get_generation_number(b"f" * 40)
self.assertIsNone(result)
def test_get_parents_missing(self) -> None:
graph = CommitGraph()
result = graph.get_parents(b"f" * 40)
self.assertIsNone(result)
def test_from_invalid_signature(self) -> None:
data = b"XXXX" + b"\\x00" * 100
f = io.BytesIO(data)
try:
with self.assertRaises(ValueError) as cm:
CommitGraph.from_file(f)
self.assertIn("Invalid commit graph signature", str(cm.exception))
finally:
f.close()
def test_from_invalid_version(self) -> None:
data = COMMIT_GRAPH_SIGNATURE + struct.pack(">B", 99) + b"\\x00" * 100
f = io.BytesIO(data)
try:
with self.assertRaises(ValueError) as cm:
CommitGraph.from_file(f)
self.assertIn("Unsupported commit graph version", str(cm.exception))
finally:
f.close()
def test_from_invalid_hash_version(self) -> None:
data = (
COMMIT_GRAPH_SIGNATURE
+ struct.pack(">B", COMMIT_GRAPH_VERSION)
+ struct.pack(">B", 99) # Invalid hash version
+ b"\\x00" * 100
)
f = io.BytesIO(data)
try:
with self.assertRaises(ValueError) as cm:
CommitGraph.from_file(f)
self.assertIn("Unsupported hash version", str(cm.exception))
finally:
f.close()
def create_minimal_commit_graph_data(self) -> bytes:
"""Create minimal valid commit graph data for testing."""
# Create the data in order and calculate offsets properly
# Header: signature + version + hash_version + num_chunks + base_graph_count
header = (
COMMIT_GRAPH_SIGNATURE
+ struct.pack(">B", COMMIT_GRAPH_VERSION)
+ struct.pack(">B", HASH_VERSION_SHA1)
+ struct.pack(">B", 3) # 3 chunks
+ struct.pack(">B", 0)
) # 0 base graphs
# Table of contents: 4 entries (3 chunks + terminator) = 4 * 12 = 48 bytes
toc_size = 4 * 12
# Calculate chunk offsets from start of file
header_size = 8
chunk1_offset = header_size + toc_size # OID Fanout
chunk2_offset = chunk1_offset + 256 * 4 # OID Lookup (after fanout)
chunk3_offset = chunk2_offset + 20 # Commit Data (after 1 commit * 20 bytes)
terminator_offset = (
chunk3_offset + 36
) # After commit data (1 commit * 36 bytes)
# Build table of contents
toc = (
CHUNK_OID_FANOUT
+ struct.pack(">Q", chunk1_offset)
+ CHUNK_OID_LOOKUP
+ struct.pack(">Q", chunk2_offset)
+ CHUNK_COMMIT_DATA
+ struct.pack(">Q", chunk3_offset)
+ b"\x00\x00\x00\x00"
+ struct.pack(">Q", terminator_offset)
)
# OID Fanout chunk (256 * 4 bytes)
fanout = b""
for i in range(256):
if i < 0xAA: # Our test commit starts with 0xaa
fanout += struct.pack(">L", 0)
else:
fanout += struct.pack(">L", 1) # 1 commit total
# OID Lookup chunk (1 commit = 20 bytes)
commit_oid = b"\xaa" + b"\x00" * 19
oid_lookup = commit_oid
# Commit Data chunk (1 commit = 20 + 16 = 36 bytes)
tree_oid = b"\xbb" + b"\x00" * 19
parent1_pos = 0x70000000 # GRAPH_PARENT_MISSING
parent2_pos = 0x70000000 # GRAPH_PARENT_MISSING
generation = 1
commit_time = 1234567890
gen_and_time = (generation << 2) | (commit_time >> 32)
commit_data = (
tree_oid
+ struct.pack(">LL", parent1_pos, parent2_pos)
+ struct.pack(">LL", gen_and_time, commit_time & 0xFFFFFFFF)
)
return header + toc + fanout + oid_lookup + commit_data
def test_from_minimal_valid_file(self) -> None:
"""Test parsing a minimal but valid commit graph file."""
data = self.create_minimal_commit_graph_data()
f = io.BytesIO(data)
graph = CommitGraph.from_file(f)
self.assertEqual(graph.hash_version, HASH_VERSION_SHA1)
self.assertEqual(len(graph), 1)
# Check the parsed entry
entry = graph.entries[0]
self.assertEqual(entry.commit_id, b"aa" + b"00" * 19)
self.assertEqual(entry.tree_id, b"bb" + b"00" * 19)
self.assertEqual(entry.parents, []) # No parents
self.assertEqual(entry.generation, 1)
self.assertEqual(entry.commit_time, 1234567890)
# Test lookup methods
commit_oid = b"aa" + b"00" * 19
self.assertEqual(graph.get_generation_number(commit_oid), 1)
self.assertEqual(graph.get_parents(commit_oid), [])
self.assertIsNotNone(graph.get_entry_by_oid(commit_oid))
def test_missing_required_chunks(self) -> None:
"""Test error handling for missing required chunks."""
# Create data with header but no chunks
header = (
COMMIT_GRAPH_SIGNATURE
+ struct.pack(">B", COMMIT_GRAPH_VERSION)
+ struct.pack(">B", HASH_VERSION_SHA1)
+ struct.pack(">B", 0) # 0 chunks
+ struct.pack(">B", 0)
)
# TOC with just terminator
toc = b"\\x00\\x00\\x00\\x00" + struct.pack(">Q", 12)
data = header + toc
f = io.BytesIO(data)
with self.assertRaises(ValueError) as cm:
CommitGraph.from_file(f)
self.assertIn("Missing required OID lookup chunk", str(cm.exception))
def test_write_empty_graph_raises(self) -> None:
"""Test that writing empty graph raises ValueError."""
graph = CommitGraph()
f = io.BytesIO()
with self.assertRaises(ValueError):
graph.write_to_file(f)
def test_write_and_read_round_trip(self) -> None:
"""Test writing and reading a commit graph."""
# Create a simple commit graph
graph = CommitGraph()
entry = CommitGraphEntry(
commit_id=b"aa" + b"00" * 19,
tree_id=b"bb" + b"00" * 19,
parents=[],
generation=1,
commit_time=1234567890,
)
graph.entries.append(entry)
graph._oid_to_index = {bytes.fromhex(entry.commit_id.decode()): 0}
# Write to bytes
f = io.BytesIO()
graph.write_to_file(f)
# Read back
f.seek(0)
read_graph = CommitGraph.from_file(f)
# Verify
self.assertEqual(len(read_graph), 1)
read_entry = read_graph.entries[0]
self.assertEqual(read_entry.commit_id, entry.commit_id)
self.assertEqual(read_entry.tree_id, entry.tree_id)
self.assertEqual(read_entry.parents, entry.parents)
self.assertEqual(read_entry.generation, entry.generation)
self.assertEqual(read_entry.commit_time, entry.commit_time)
class CommitGraphFileOperationsTests(unittest.TestCase):
"""Tests for commit graph file operations."""
def setUp(self) -> None:
self.tempdir = tempfile.mkdtemp()
def tearDown(self) -> None:
import shutil
shutil.rmtree(self.tempdir, ignore_errors=True)
def test_read_commit_graph_missing_file(self) -> None:
"""Test reading from non-existent file."""
missing_path = os.path.join(self.tempdir, "missing.graph")
result = read_commit_graph(missing_path)
self.assertIsNone(result)
def test_read_commit_graph_invalid_file(self) -> None:
"""Test reading from invalid file."""
invalid_path = os.path.join(self.tempdir, "invalid.graph")
with open(invalid_path, "wb") as f:
f.write(b"invalid data")
with self.assertRaises(ValueError):
read_commit_graph(invalid_path)
def test_find_commit_graph_file_missing(self) -> None:
"""Test finding commit graph file when it doesn't exist."""
result = find_commit_graph_file(self.tempdir)
self.assertIsNone(result)
def test_find_commit_graph_file_standard_location(self) -> None:
"""Test finding commit graph file in standard location."""
# Create .git/objects/info/commit-graph
objects_dir = os.path.join(self.tempdir, "objects")
info_dir = os.path.join(objects_dir, "info")
os.makedirs(info_dir)
graph_path = os.path.join(info_dir, "commit-graph")
with open(graph_path, "wb") as f:
f.write(b"dummy")
result = find_commit_graph_file(self.tempdir)
self.assertEqual(result, graph_path.encode())
def test_find_commit_graph_file_chain_location(self) -> None:
"""Test finding commit graph file in chain location."""
# Create .git/objects/info/commit-graphs/graph-{hash}.graph
objects_dir = os.path.join(self.tempdir, "objects")
info_dir = os.path.join(objects_dir, "info")
graphs_dir = os.path.join(info_dir, "commit-graphs")
os.makedirs(graphs_dir)
graph_path = os.path.join(graphs_dir, "graph-abc123.graph")
with open(graph_path, "wb") as f:
f.write(b"dummy")
result = find_commit_graph_file(self.tempdir)
self.assertEqual(result, graph_path.encode())
def test_find_commit_graph_file_prefers_standard(self) -> None:
"""Test that standard location is preferred over chain location."""
# Create both locations
objects_dir = os.path.join(self.tempdir, "objects")
info_dir = os.path.join(objects_dir, "info")
graphs_dir = os.path.join(info_dir, "commit-graphs")
os.makedirs(info_dir)
os.makedirs(graphs_dir)
# Standard location
standard_path = os.path.join(info_dir, "commit-graph")
with open(standard_path, "wb") as f:
f.write(b"standard")
# Chain location
chain_path = os.path.join(graphs_dir, "graph-abc123.graph")
with open(chain_path, "wb") as f:
f.write(b"chain")
result = find_commit_graph_file(self.tempdir)
self.assertEqual(result, standard_path.encode())
class CommitGraphGenerationTests(unittest.TestCase):
"""Tests for commit graph generation functionality."""
def setUp(self) -> None:
self.tempdir = tempfile.mkdtemp()
def tearDown(self) -> None:
import shutil
shutil.rmtree(self.tempdir, ignore_errors=True)
def test_generate_commit_graph_empty(self) -> None:
"""Test generating commit graph with no commits."""
from dulwich.object_store import MemoryObjectStore
object_store = MemoryObjectStore()
graph = generate_commit_graph(object_store, [])
self.assertEqual(len(graph), 0)
def test_generate_commit_graph_single_commit(self) -> None:
"""Test generating commit graph with single commit."""
from dulwich.object_store import MemoryObjectStore
from dulwich.objects import Commit, Tree
object_store = MemoryObjectStore()
# Create a tree and commit
tree = Tree()
object_store.add_object(tree)
commit = Commit()
commit.tree = tree.id
commit.author = b"Test Author <test@example.com>"
commit.committer = b"Test Author <test@example.com>"
commit.commit_time = commit.author_time = 1234567890
commit.commit_timezone = commit.author_timezone = 0
commit.message = b"Test commit"
object_store.add_object(commit)
# Generate graph
graph = generate_commit_graph(object_store, [commit.id])
self.assertEqual(len(graph), 1)
entry = graph.entries[0]
self.assertEqual(entry.commit_id, commit.id)
self.assertEqual(entry.tree_id, commit.tree)
self.assertEqual(entry.parents, [])
self.assertEqual(entry.generation, 1)
self.assertEqual(entry.commit_time, 1234567890)
def test_get_reachable_commits(self) -> None:
"""Test getting reachable commits."""
from dulwich.object_store import MemoryObjectStore
from dulwich.objects import Commit, Tree
object_store = MemoryObjectStore()
# Create tree
tree = Tree()
object_store.add_object(tree)
# Create commit chain: commit1 -> commit2
commit1 = Commit()
commit1.tree = tree.id
commit1.author = commit1.committer = b"Test <test@example.com>"
commit1.commit_time = commit1.author_time = 1234567890
commit1.commit_timezone = commit1.author_timezone = 0
commit1.message = b"First commit"
object_store.add_object(commit1)
commit2 = Commit()
commit2.tree = tree.id
commit2.parents = [commit1.id]
commit2.author = commit2.committer = b"Test <test@example.com>"
commit2.commit_time = commit2.author_time = 1234567891
commit2.commit_timezone = commit2.author_timezone = 0
commit2.message = b"Second commit"
object_store.add_object(commit2)
# Get reachable commits from commit2
reachable = get_reachable_commits(object_store, [commit2.id])
# Should include both commits
self.assertEqual(len(reachable), 2)
self.assertIn(commit1.id, reachable)
self.assertIn(commit2.id, reachable)
def test_write_commit_graph_to_file(self) -> None:
"""Test writing commit graph to file."""
from dulwich.object_store import DiskObjectStore
from dulwich.objects import Commit, Tree
# Create a disk object store
object_store_path = os.path.join(self.tempdir, "objects")
os.makedirs(object_store_path, exist_ok=True)
object_store = DiskObjectStore(object_store_path)
# Create a tree and commit
tree = Tree()
object_store.add_object(tree)
commit = Commit()
commit.tree = tree.id
commit.author = b"Test Author <test@example.com>"
commit.committer = b"Test Author <test@example.com>"
commit.commit_time = commit.author_time = 1234567890
commit.commit_timezone = commit.author_timezone = 0
commit.message = b"Test commit"
object_store.add_object(commit)
# Write commit graph using ObjectStore method
object_store.write_commit_graph([commit.id], reachable=False)
# Verify file was created
graph_path = os.path.join(object_store_path, "info", "commit-graph")
self.assertTrue(os.path.exists(graph_path))
# Read back and verify
graph = read_commit_graph(graph_path)
self.assertIsNotNone(graph)
assert graph is not None # For mypy
self.assertEqual(len(graph), 1)
entry = graph.entries[0]
self.assertEqual(entry.commit_id, commit.id)
self.assertEqual(entry.tree_id, commit.tree)
def test_object_store_commit_graph_methods(self) -> None:
"""Test ObjectStore commit graph methods."""
from dulwich.object_store import DiskObjectStore
from dulwich.objects import Commit, Tree
# Create a disk object store
object_store_path = os.path.join(self.tempdir, "objects")
os.makedirs(object_store_path, exist_ok=True)
object_store = DiskObjectStore(object_store_path)
# Initially no commit graph
self.assertIsNone(object_store.get_commit_graph()) # type: ignore[no-untyped-call]
# Create a tree and commit
tree = Tree()
object_store.add_object(tree)
commit = Commit()
commit.tree = tree.id
commit.author = b"Test Author <test@example.com>"
commit.committer = b"Test Author <test@example.com>"
commit.commit_time = commit.author_time = 1234567890
commit.commit_timezone = commit.author_timezone = 0
commit.message = b"Test commit"
object_store.add_object(commit)
# Write commit graph (disable reachable to avoid traversal issue)
object_store.write_commit_graph([commit.id], reachable=False)
# Now should have commit graph
self.assertIsNotNone(object_store.get_commit_graph()) # type: ignore[no-untyped-call]
# Test update (should still have commit graph)
object_store.write_commit_graph()
self.assertIsNot(None, object_store.get_commit_graph()) # type: ignore[no-untyped-call]
def test_parents_provider_commit_graph_integration(self) -> None:
"""Test that ParentsProvider uses commit graph when available."""
from dulwich.object_store import DiskObjectStore
from dulwich.objects import Commit, Tree
from dulwich.repo import ParentsProvider
# Create a disk object store
object_store_path = os.path.join(self.tempdir, "objects")
os.makedirs(object_store_path, exist_ok=True)
object_store = DiskObjectStore(object_store_path)
# Create a tree and two commits
tree = Tree()
object_store.add_object(tree)
# First commit (no parents)
commit1 = Commit()
commit1.tree = tree.id
commit1.author = commit1.committer = b"Test <test@example.com>"
commit1.commit_time = commit1.author_time = 1234567890
commit1.commit_timezone = commit1.author_timezone = 0
commit1.message = b"First commit"
object_store.add_object(commit1)
# Second commit (child of first)
commit2 = Commit()
commit2.tree = tree.id
commit2.parents = [commit1.id]
commit2.author = commit2.committer = b"Test <test@example.com>"
commit2.commit_time = commit2.author_time = 1234567891
commit2.commit_timezone = commit2.author_timezone = 0
commit2.message = b"Second commit"
object_store.add_object(commit2)
# Write commit graph
object_store.write_commit_graph([commit1.id, commit2.id], reachable=False)
# Test ParentsProvider with commit graph
provider = ParentsProvider(object_store)
# Verify commit graph is loaded
self.assertIsNotNone(provider.commit_graph)
# Test parent lookups
parents1 = provider.get_parents(commit1.id) # type: ignore[no-untyped-call]
self.assertEqual(parents1, [])
parents2 = provider.get_parents(commit2.id) # type: ignore[no-untyped-call]
self.assertEqual(parents2, [commit1.id])
# Test fallback behavior by creating provider without commit graph
object_store_no_graph_path = os.path.join(self.tempdir, "objects2")
os.makedirs(object_store_no_graph_path, exist_ok=True)
object_store_no_graph = DiskObjectStore(object_store_no_graph_path)
object_store_no_graph.add_object(tree)
object_store_no_graph.add_object(commit1)
object_store_no_graph.add_object(commit2)
provider_no_graph = ParentsProvider(object_store_no_graph)
self.assertIsNone(provider_no_graph.commit_graph)
# Should still work via commit object fallback
parents1_fallback = provider_no_graph.get_parents(commit1.id) # type: ignore[no-untyped-call]
self.assertEqual(parents1_fallback, [])
parents2_fallback = provider_no_graph.get_parents(commit2.id) # type: ignore[no-untyped-call]
self.assertEqual(parents2_fallback, [commit1.id])
def test_graph_operations_use_commit_graph(self) -> None:
"""Test that graph operations use commit graph when available."""
from dulwich.graph import can_fast_forward, find_merge_base
from dulwich.object_store import DiskObjectStore
from dulwich.objects import Commit, Tree
from dulwich.repo import Repo
# Create a disk object store
object_store_path = os.path.join(self.tempdir, "objects")
os.makedirs(object_store_path, exist_ok=True)
object_store = DiskObjectStore(object_store_path)
# Create a tree and a more complex commit graph for testing
tree = Tree()
object_store.add_object(tree)
# Create commit chain: commit1 -> commit2 -> commit3
# \-> commit4 -> commit5 (merge)
commit1 = Commit()
commit1.tree = tree.id
commit1.author = commit1.committer = b"Test <test@example.com>"
commit1.commit_time = commit1.author_time = 1234567890
commit1.commit_timezone = commit1.author_timezone = 0
commit1.message = b"First commit"
object_store.add_object(commit1)
commit2 = Commit()
commit2.tree = tree.id
commit2.parents = [commit1.id]
commit2.author = commit2.committer = b"Test <test@example.com>"
commit2.commit_time = commit2.author_time = 1234567891
commit2.commit_timezone = commit2.author_timezone = 0
commit2.message = b"Second commit"
object_store.add_object(commit2)
commit3 = Commit()
commit3.tree = tree.id
commit3.parents = [commit2.id]
commit3.author = commit3.committer = b"Test <test@example.com>"
commit3.commit_time = commit3.author_time = 1234567892
commit3.commit_timezone = commit3.author_timezone = 0
commit3.message = b"Third commit"
object_store.add_object(commit3)
# Branch from commit2
commit4 = Commit()
commit4.tree = tree.id
commit4.parents = [commit2.id]
commit4.author = commit4.committer = b"Test <test@example.com>"
commit4.commit_time = commit4.author_time = 1234567893
commit4.commit_timezone = commit4.author_timezone = 0
commit4.message = b"Fourth commit (branch)"
object_store.add_object(commit4)
# Merge commit
commit5 = Commit()
commit5.tree = tree.id
commit5.parents = [commit3.id, commit4.id]
commit5.author = commit5.committer = b"Test <test@example.com>"
commit5.commit_time = commit5.author_time = 1234567894
commit5.commit_timezone = commit5.author_timezone = 0
commit5.message = b"Merge commit"
object_store.add_object(commit5)
# Create refs
refs_path = os.path.join(self.tempdir, "refs")
os.makedirs(refs_path, exist_ok=True)
repo_path = self.tempdir
repo = Repo.init(repo_path)
repo.object_store = object_store
# Test graph operations WITHOUT commit graph first
merge_base_no_graph = find_merge_base(repo, [commit3.id, commit4.id])
can_ff_no_graph = can_fast_forward(repo, commit1.id, commit3.id)
# Now write commit graph
object_store.write_commit_graph(
[commit1.id, commit2.id, commit3.id, commit4.id, commit5.id],
reachable=False,
)
# Verify commit graph is loaded by creating new repo instance
repo2 = Repo(repo_path)
self.addCleanup(repo2.close)
repo2.object_store = object_store
# Verify commit graph is available
commit_graph = repo2.object_store.get_commit_graph() # type: ignore[no-untyped-call]
self.assertIsNotNone(commit_graph)
# Test graph operations WITH commit graph
merge_base_with_graph = find_merge_base(repo2, [commit3.id, commit4.id])
can_ff_with_graph = can_fast_forward(repo2, commit1.id, commit3.id)
# Results should be identical
self.assertEqual(
merge_base_no_graph,
merge_base_with_graph,
"Merge base should be same with and without commit graph",
)
self.assertEqual(
can_ff_no_graph,
can_ff_with_graph,
"Fast-forward detection should be same with and without commit graph",
)
# Expected results
self.assertEqual(
merge_base_with_graph,
[commit2.id],
"Merge base of commit3 and commit4 should be commit2",
)
self.assertTrue(
can_ff_with_graph, "Should be able to fast-forward from commit1 to commit3"
)
# Test that ParentsProvider in the repo uses commit graph
parents_provider = repo2.parents_provider()
self.assertIsNotNone(
parents_provider.commit_graph,
"Repository's parents provider should have commit graph",
)
# Verify parent lookups work through the provider
self.assertEqual(parents_provider.get_parents(commit1.id), []) # type: ignore[no-untyped-call]
self.assertEqual(parents_provider.get_parents(commit2.id), [commit1.id]) # type: ignore[no-untyped-call]
self.assertEqual(
parents_provider.get_parents(commit5.id),
[commit3.id, commit4.id], # type: ignore[no-untyped-call]
)
def test_performance_with_commit_graph(self) -> None:
"""Test that using commit graph provides performance benefits."""
from dulwich.graph import find_merge_base
from dulwich.object_store import DiskObjectStore
from dulwich.objects import Commit, Tree
from dulwich.repo import Repo
# Create a larger commit history to better measure performance
object_store_path = os.path.join(self.tempdir, "objects")
os.makedirs(object_store_path, exist_ok=True)
object_store = DiskObjectStore(object_store_path)
tree = Tree()
object_store.add_object(tree)
# Create a chain of 20 commits
commits: list[Commit] = []
for i in range(20):
commit = Commit()
commit.tree = tree.id
if i > 0:
commit.parents = [commits[i - 1].id]
commit.author = commit.committer = b"Test <test@example.com>"
commit.commit_time = commit.author_time = 1234567890 + i
commit.commit_timezone = commit.author_timezone = 0
commit.message = f"Commit {i}".encode()
object_store.add_object(commit)
commits.append(commit)
# Create repository
repo_path = self.tempdir
repo = Repo.init(repo_path)
repo.object_store = object_store
# Time operations without commit graph
for _ in range(10): # Run multiple times for better measurement
find_merge_base(repo, [commits[0].id, commits[-1].id])
# Write commit graph
object_store.write_commit_graph([c.id for c in commits], reachable=False)
# Create new repo instance to pick up commit graph
repo2 = Repo(repo_path)
self.addCleanup(repo2.close)
repo2.object_store = object_store
# Verify commit graph is loaded
self.assertIsNotNone(repo2.object_store.get_commit_graph()) # type: ignore[no-untyped-call]
# Time operations with commit graph
for _ in range(10): # Run multiple times for better measurement
find_merge_base(repo2, [commits[0].id, commits[-1].id])
# With commit graph should be at least as fast (usually faster)
# We don't assert a specific speedup since it depends on the machine
# But we verify both approaches give the same result
result_no_graph = find_merge_base(repo, [commits[0].id, commits[-1].id])
result_with_graph = find_merge_base(repo2, [commits[0].id, commits[-1].id])
self.assertEqual(
result_no_graph,
result_with_graph,
"Results should be identical with and without commit graph",
)
self.assertEqual(
result_with_graph, [commits[0].id], "Merge base should be the first commit"
)
if __name__ == "__main__":
unittest.main()
|