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
|
# test_bitmap.py -- Tests for bitmap support
# Copyright (C) 2025 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 bitmap support."""
import os
import tempfile
import unittest
from io import BytesIO
from dulwich.bitmap import (
BITMAP_OPT_FULL_DAG,
BITMAP_OPT_HASH_CACHE,
BITMAP_OPT_LOOKUP_TABLE,
BITMAP_SIGNATURE,
BITMAP_VERSION,
BitmapEntry,
EWAHBitmap,
PackBitmap,
_encode_ewah_words,
read_bitmap_file,
write_bitmap_file,
)
class EWAHCompressionTests(unittest.TestCase):
"""Tests for EWAH compression helper functions."""
def test_encode_empty_words(self):
"""Test encoding empty word list."""
result = _encode_ewah_words([])
self.assertEqual([], result)
def test_encode_single_literal(self):
"""Test encoding single literal word."""
result = _encode_ewah_words([0x123])
# Should be: RLW(0 run, 1 literal) + literal
self.assertEqual(2, len(result))
# RLW bit layout: [literal_words(31)][running_len(32)][running_bit(1)]
# running_bit=0, running_len=0, literal_words=1
expected_rlw = (1 << 33) | (0 << 1) | 0
self.assertEqual(expected_rlw, result[0])
self.assertEqual(0x123, result[1])
def test_encode_zero_run(self):
"""Test encoding run of zeros."""
result = _encode_ewah_words([0, 0, 0])
# Should be: RLW(3 zeros, 0 literals)
self.assertEqual(1, len(result))
# RLW bit layout: [literal_words(31)][running_len(32)][running_bit(1)]
# running_bit=0, running_len=3, literal_words=0
expected_rlw = (0 << 33) | (3 << 1) | 0
self.assertEqual(expected_rlw, result[0])
def test_encode_ones_run(self):
"""Test encoding run of all-ones."""
result = _encode_ewah_words([0xFFFFFFFFFFFFFFFF, 0xFFFFFFFFFFFFFFFF])
# Should be: RLW(2 ones, 0 literals)
self.assertEqual(1, len(result))
# RLW bit layout: [literal_words(31)][running_len(32)][running_bit(1)]
# running_bit=1, running_len=2, literal_words=0
expected_rlw = (0 << 33) | (2 << 1) | 1
self.assertEqual(expected_rlw, result[0])
def test_encode_run_followed_by_literals(self):
"""Test encoding run followed by literal words."""
result = _encode_ewah_words([0, 0, 0x123, 0x456])
# Should be: RLW(2 zeros, 2 literals) + literals
self.assertEqual(3, len(result))
# RLW bit layout: [literal_words(31)][running_len(32)][running_bit(1)]
# running_bit=0, running_len=2, literal_words=2
expected_rlw = (2 << 33) | (2 << 1) | 0
self.assertEqual(expected_rlw, result[0])
self.assertEqual(0x123, result[1])
self.assertEqual(0x456, result[2])
def test_encode_mixed_pattern(self):
"""Test encoding mixed runs and literals."""
result = _encode_ewah_words(
[0, 0, 0x123, 0xFFFFFFFFFFFFFFFF, 0xFFFFFFFFFFFFFFFF]
)
# Should be: RLW(2 zeros, 1 literal) + literal + RLW(2 ones, 0 literals)
self.assertEqual(3, len(result))
class EWAHCompatibilityTests(unittest.TestCase):
"""Tests for EWAH encode/decode compatibility."""
def test_encode_decode_sparse_bitmap(self):
"""Test encoding and decoding a sparse bitmap with runs."""
# Create a bitmap with a pattern that benefits from run-length encoding
# Bits: 0, 1, 128 (has runs of zeros between set bits)
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(1)
bitmap.add(128)
# Encode
encoded = bitmap.encode()
# Decode
bitmap2 = EWAHBitmap(encoded)
# Verify all bits are preserved
self.assertEqual(len(bitmap), len(bitmap2))
self.assertIn(0, bitmap2)
self.assertIn(1, bitmap2)
self.assertIn(128, bitmap2)
self.assertNotIn(2, bitmap2)
self.assertNotIn(127, bitmap2)
def test_encode_decode_dense_bitmap(self):
"""Test encoding and decoding a dense bitmap."""
# Create a bitmap with many consecutive bits set
bitmap = EWAHBitmap()
for i in range(64):
bitmap.add(i)
# Encode
encoded = bitmap.encode()
# Decode
bitmap2 = EWAHBitmap(encoded)
# Verify all bits are preserved
self.assertEqual(64, len(bitmap2))
for i in range(64):
self.assertIn(i, bitmap2)
self.assertNotIn(64, bitmap2)
def test_encode_decode_runs_of_zeros(self):
"""Test encoding and decoding bitmap with long runs of zeros."""
# Create bitmap: bits 0, 200, 400 (lots of zeros in between)
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(200)
bitmap.add(400)
# Encode
encoded = bitmap.encode()
# Decode
bitmap2 = EWAHBitmap(encoded)
# Verify
self.assertEqual(3, len(bitmap2))
self.assertIn(0, bitmap2)
self.assertIn(200, bitmap2)
self.assertIn(400, bitmap2)
self.assertNotIn(1, bitmap2)
self.assertNotIn(199, bitmap2)
self.assertNotIn(201, bitmap2)
def test_encode_decode_mixed_pattern(self):
"""Test encoding and decoding bitmap with mixed dense/sparse regions."""
bitmap = EWAHBitmap()
# Dense region: 0-63
for i in range(64):
bitmap.add(i)
# Sparse region: 200, 300, 400
bitmap.add(200)
bitmap.add(300)
bitmap.add(400)
# Another dense region: 500-563
for i in range(500, 564):
bitmap.add(i)
# Encode
encoded = bitmap.encode()
# Decode
bitmap2 = EWAHBitmap(encoded)
# Verify all bits preserved
self.assertEqual(len(bitmap), len(bitmap2))
for i in range(64):
self.assertIn(i, bitmap2)
self.assertIn(200, bitmap2)
self.assertIn(300, bitmap2)
self.assertIn(400, bitmap2)
for i in range(500, 564):
self.assertIn(i, bitmap2)
# Check some bits that shouldn't be set
self.assertNotIn(64, bitmap2)
self.assertNotIn(199, bitmap2)
self.assertNotIn(201, bitmap2)
self.assertNotIn(499, bitmap2)
def test_encode_decode_preserves_bitwise_ops(self):
"""Test that encode/decode doesn't break bitwise operations."""
# Create two bitmaps
bitmap1 = EWAHBitmap()
bitmap1.add(0)
bitmap1.add(5)
bitmap1.add(100)
bitmap2 = EWAHBitmap()
bitmap2.add(5)
bitmap2.add(10)
bitmap2.add(100)
# Encode and decode both
bitmap1_decoded = EWAHBitmap(bitmap1.encode())
bitmap2_decoded = EWAHBitmap(bitmap2.encode())
# Perform operations on decoded bitmaps
or_result = bitmap1_decoded | bitmap2_decoded
and_result = bitmap1_decoded & bitmap2_decoded
xor_result = bitmap1_decoded ^ bitmap2_decoded
# Verify results
# OR: {0, 5, 10, 100}
self.assertEqual(4, len(or_result))
self.assertIn(0, or_result)
self.assertIn(5, or_result)
self.assertIn(10, or_result)
self.assertIn(100, or_result)
# AND: {5, 100}
self.assertEqual(2, len(and_result))
self.assertIn(5, and_result)
self.assertIn(100, and_result)
# XOR: {0, 10}
self.assertEqual(2, len(xor_result))
self.assertIn(0, xor_result)
self.assertIn(10, xor_result)
def test_round_trip_large_bitmap(self):
"""Test round-trip encoding/decoding of a large bitmap."""
# Create a large bitmap with various patterns
bitmap = EWAHBitmap()
# Add bits at various intervals
for i in range(0, 10000, 7):
bitmap.add(i)
original_bits = set(bitmap.bits)
# Encode and decode
encoded = bitmap.encode()
decoded = EWAHBitmap(encoded)
# Verify all bits preserved
self.assertEqual(original_bits, decoded.bits)
self.assertEqual(len(bitmap), len(decoded))
class EWAHBitmapTests(unittest.TestCase):
"""Tests for EWAH bitmap compression."""
def test_empty_bitmap(self):
"""Test empty bitmap."""
bitmap = EWAHBitmap()
self.assertEqual(0, len(bitmap))
self.assertEqual(0, bitmap.bit_count)
def test_add_bit(self):
"""Test adding bits to bitmap."""
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(5)
bitmap.add(100)
self.assertEqual(3, len(bitmap))
self.assertEqual(101, bitmap.bit_count)
self.assertIn(0, bitmap)
self.assertIn(5, bitmap)
self.assertIn(100, bitmap)
self.assertNotIn(1, bitmap)
self.assertNotIn(99, bitmap)
def test_encode_decode(self):
"""Test encoding and decoding bitmaps."""
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(1)
bitmap.add(64)
bitmap.add(128)
# Encode
data = bitmap.encode()
self.assertIsInstance(data, bytes)
# Decode
bitmap2 = EWAHBitmap(data)
self.assertEqual(len(bitmap), len(bitmap2))
self.assertIn(0, bitmap2)
self.assertIn(1, bitmap2)
self.assertIn(64, bitmap2)
self.assertIn(128, bitmap2)
def test_bitwise_or(self):
"""Test bitwise OR operation."""
bitmap1 = EWAHBitmap()
bitmap1.add(0)
bitmap1.add(5)
bitmap2 = EWAHBitmap()
bitmap2.add(5)
bitmap2.add(10)
result = bitmap1 | bitmap2
self.assertEqual(3, len(result))
self.assertIn(0, result)
self.assertIn(5, result)
self.assertIn(10, result)
def test_bitwise_and(self):
"""Test bitwise AND operation."""
bitmap1 = EWAHBitmap()
bitmap1.add(0)
bitmap1.add(5)
bitmap2 = EWAHBitmap()
bitmap2.add(5)
bitmap2.add(10)
result = bitmap1 & bitmap2
self.assertEqual(1, len(result))
self.assertIn(5, result)
self.assertNotIn(0, result)
self.assertNotIn(10, result)
def test_bitwise_xor(self):
"""Test bitwise XOR operation."""
bitmap1 = EWAHBitmap()
bitmap1.add(0)
bitmap1.add(5)
bitmap2 = EWAHBitmap()
bitmap2.add(5)
bitmap2.add(10)
result = bitmap1 ^ bitmap2
self.assertEqual(2, len(result))
self.assertIn(0, result)
self.assertIn(10, result)
self.assertNotIn(5, result)
class BitmapEntryTests(unittest.TestCase):
"""Tests for bitmap entries."""
def test_create_entry(self):
"""Test creating a bitmap entry."""
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(10)
entry = BitmapEntry(
object_pos=100,
xor_offset=0,
flags=0,
bitmap=bitmap,
)
self.assertEqual(100, entry.object_pos)
self.assertEqual(0, entry.xor_offset)
self.assertEqual(0, entry.flags)
self.assertEqual(bitmap, entry.bitmap)
class PackBitmapTests(unittest.TestCase):
"""Tests for pack bitmap."""
def test_create_bitmap(self):
"""Test creating a pack bitmap."""
bitmap = PackBitmap()
self.assertEqual(BITMAP_VERSION, bitmap.version)
self.assertEqual(BITMAP_OPT_FULL_DAG, bitmap.flags)
self.assertIsNone(bitmap.pack_checksum)
def test_bitmap_with_entries(self):
"""Test bitmap with entries."""
bitmap = PackBitmap()
commit_sha = b"\x00" * 20
ewah_bitmap = EWAHBitmap()
ewah_bitmap.add(0)
ewah_bitmap.add(5)
entry = BitmapEntry(
object_pos=0,
xor_offset=0,
flags=0,
bitmap=ewah_bitmap,
)
bitmap.entries[commit_sha] = entry
self.assertTrue(bitmap.has_commit(commit_sha))
self.assertFalse(bitmap.has_commit(b"\x01" * 20))
def test_iter_commits(self):
"""Test iterating over commits with bitmaps."""
bitmap = PackBitmap()
commit1 = b"\x00" * 20
commit2 = b"\x01" * 20
ewah_bitmap = EWAHBitmap()
entry = BitmapEntry(0, 0, 0, ewah_bitmap)
bitmap.entries[commit1] = entry
bitmap.entries[commit2] = entry
commits = list(bitmap.iter_commits())
self.assertEqual(2, len(commits))
self.assertIn(commit1, commits)
self.assertIn(commit2, commits)
class BitmapFileTests(unittest.TestCase):
"""Tests for bitmap file I/O."""
def test_write_read_empty_bitmap(self):
"""Test writing and reading an empty bitmap."""
bitmap = PackBitmap()
bitmap.pack_checksum = b"\x00" * 20
# Write to bytes
f = BytesIO()
write_bitmap_file(f, bitmap)
# Read back
f.seek(0)
bitmap2 = read_bitmap_file(f)
self.assertEqual(bitmap.version, bitmap2.version)
self.assertEqual(bitmap.flags, bitmap2.flags)
self.assertEqual(bitmap.pack_checksum, bitmap2.pack_checksum)
def test_write_read_with_type_bitmaps(self):
"""Test writing and reading bitmaps with type information."""
bitmap = PackBitmap()
bitmap.pack_checksum = b"\xaa" * 20
# Add some type bitmap data
bitmap.commit_bitmap.add(0)
bitmap.commit_bitmap.add(5)
bitmap.tree_bitmap.add(1)
bitmap.blob_bitmap.add(2)
bitmap.tag_bitmap.add(3)
# Write to bytes
f = BytesIO()
write_bitmap_file(f, bitmap)
# Read back
f.seek(0)
bitmap2 = read_bitmap_file(f)
self.assertEqual(bitmap.version, bitmap2.version)
self.assertEqual(bitmap.pack_checksum, bitmap2.pack_checksum)
# Check type bitmaps
self.assertIn(0, bitmap2.commit_bitmap)
self.assertIn(5, bitmap2.commit_bitmap)
self.assertIn(1, bitmap2.tree_bitmap)
self.assertIn(2, bitmap2.blob_bitmap)
self.assertIn(3, bitmap2.tag_bitmap)
def test_invalid_signature(self):
"""Test reading file with invalid signature."""
f = BytesIO(b"XXXX\x00\x01\x00\x00")
with self.assertRaises(ValueError) as cm:
read_bitmap_file(f)
self.assertIn("Invalid bitmap signature", str(cm.exception))
def test_invalid_version(self):
"""Test reading file with invalid version."""
f = BytesIO(BITMAP_SIGNATURE + b"\x00\x02\x00\x01")
with self.assertRaises(ValueError) as cm:
read_bitmap_file(f)
self.assertIn("Unsupported bitmap version", str(cm.exception))
def test_incomplete_header(self):
"""Test reading file with incomplete header."""
f = BytesIO(BITMAP_SIGNATURE + b"\x00")
with self.assertRaises(ValueError) as cm:
read_bitmap_file(f)
self.assertIn("Incomplete bitmap header", str(cm.exception))
class BitmapIntegrationTests(unittest.TestCase):
"""Integration tests for bitmap functionality."""
def test_round_trip_file(self):
"""Test writing and reading bitmap to/from actual file."""
with tempfile.TemporaryDirectory() as tmpdir:
bitmap_path = os.path.join(tmpdir, "test.bitmap")
# Create bitmap
bitmap = PackBitmap()
bitmap.pack_checksum = b"\xff" * 20
bitmap.commit_bitmap.add(10)
bitmap.tree_bitmap.add(20)
# Write to file
from dulwich.bitmap import write_bitmap
write_bitmap(bitmap_path, bitmap)
# Read back
from dulwich.bitmap import read_bitmap
bitmap2 = read_bitmap(bitmap_path)
self.assertEqual(bitmap.version, bitmap2.version)
self.assertEqual(bitmap.pack_checksum, bitmap2.pack_checksum)
self.assertIn(10, bitmap2.commit_bitmap)
self.assertIn(20, bitmap2.tree_bitmap)
def test_xor_decompression(self):
"""Test XOR decompression of bitmap entries."""
bitmap = PackBitmap()
# Create base bitmap
base_bitmap = EWAHBitmap()
base_bitmap.add(0)
base_bitmap.add(1)
base_bitmap.add(2)
base_entry = BitmapEntry(
object_pos=0,
xor_offset=0,
flags=0,
bitmap=base_bitmap,
)
# Create XOR'd bitmap
# If we XOR base (bits 0,1,2) with XOR bitmap (bits 1,3),
# result should be (bits 0,2,3)
xor_bitmap = EWAHBitmap()
xor_bitmap.add(1)
xor_bitmap.add(3)
xor_entry = BitmapEntry(
object_pos=1,
xor_offset=1, # Reference the previous entry
flags=0,
bitmap=xor_bitmap,
)
# Add entries
base_sha = b"\x00" * 20
xor_sha = b"\x01" * 20
bitmap.entries[base_sha] = base_entry
bitmap.entries_list.append((base_sha, base_entry))
bitmap.entries[xor_sha] = xor_entry
bitmap.entries_list.append((xor_sha, xor_entry))
# Get decompressed bitmap
result = bitmap.get_bitmap(xor_sha)
self.assertIsNotNone(result)
self.assertIn(0, result)
self.assertNotIn(1, result) # XOR cancels this
self.assertIn(2, result)
self.assertIn(3, result)
def test_lookup_table_round_trip(self):
"""Test reading and writing lookup tables."""
with tempfile.TemporaryDirectory() as tmpdir:
bitmap_path = os.path.join(tmpdir, "test.bitmap")
# Create bitmap with lookup table
bitmap = PackBitmap()
bitmap.flags = BITMAP_OPT_FULL_DAG | BITMAP_OPT_LOOKUP_TABLE
bitmap.pack_checksum = b"\xaa" * 20
# Add some bitmap entries (required for lookup table to be written/read)
for i in range(3):
ewah = EWAHBitmap()
ewah.add(i)
entry = BitmapEntry(
object_pos=i,
xor_offset=0,
flags=0,
bitmap=ewah,
)
sha = i.to_bytes(20, byteorder="big")
bitmap.entries[sha] = entry
bitmap.entries_list.append((sha, entry))
bitmap.lookup_table = [
(0, 100, 0),
(1, 200, 0),
(2, 300, 1),
]
# Write to file
from dulwich.bitmap import write_bitmap
write_bitmap(bitmap_path, bitmap)
# Read back
from dulwich.bitmap import read_bitmap
bitmap2 = read_bitmap(bitmap_path)
self.assertEqual(bitmap.flags, bitmap2.flags)
self.assertIsNotNone(bitmap2.lookup_table)
self.assertEqual(3, len(bitmap2.lookup_table))
self.assertEqual((0, 100, 0), bitmap2.lookup_table[0])
self.assertEqual((1, 200, 0), bitmap2.lookup_table[1])
self.assertEqual((2, 300, 1), bitmap2.lookup_table[2])
def test_name_hash_cache_round_trip(self):
"""Test reading and writing name-hash cache."""
with tempfile.TemporaryDirectory() as tmpdir:
bitmap_path = os.path.join(tmpdir, "test.bitmap")
# Create bitmap with name-hash cache
bitmap = PackBitmap()
bitmap.flags = BITMAP_OPT_FULL_DAG | BITMAP_OPT_HASH_CACHE
bitmap.pack_checksum = b"\xbb" * 20
bitmap.name_hash_cache = [0x12345678, 0x9ABCDEF0, 0xFEDCBA98]
# Write to file
from dulwich.bitmap import write_bitmap
write_bitmap(bitmap_path, bitmap)
# Read back
from dulwich.bitmap import read_bitmap
bitmap2 = read_bitmap(bitmap_path)
self.assertEqual(bitmap.flags, bitmap2.flags)
self.assertIsNotNone(bitmap2.name_hash_cache)
self.assertEqual(3, len(bitmap2.name_hash_cache))
self.assertEqual(0x12345678, bitmap2.name_hash_cache[0])
self.assertEqual(0x9ABCDEF0, bitmap2.name_hash_cache[1])
self.assertEqual(0xFEDCBA98, bitmap2.name_hash_cache[2])
class BitmapErrorHandlingTests(unittest.TestCase):
"""Tests for error handling in bitmap reading."""
def test_truncated_header(self):
"""Test reading bitmap with truncated header."""
# Only 10 bytes instead of full header
data = b"BITM\x00\x01\x00\x00\x00\x00"
with self.assertRaises(ValueError) as ctx:
read_bitmap_file(BytesIO(data))
# Should raise ValueError about missing/incomplete header data
self.assertIsInstance(ctx.exception, ValueError)
def test_invalid_signature(self):
"""Test reading bitmap with invalid signature."""
data = b"JUNK\x00\x01\x00\x00" + b"\x00" * 20
with self.assertRaises(ValueError) as ctx:
read_bitmap_file(BytesIO(data))
self.assertIn("signature", str(ctx.exception).lower())
def test_unsupported_version(self):
"""Test reading bitmap with unsupported version."""
data = BITMAP_SIGNATURE
data += b"\x00\x99" # Version 153 (unsupported)
data += b"\x00\x00" # Flags
data += b"\x00\x00\x00\x00" # Entry count
data += b"\x00" * 20 # Pack checksum
with self.assertRaises(ValueError) as ctx:
read_bitmap_file(BytesIO(data))
self.assertIn("version", str(ctx.exception).lower())
def test_truncated_type_bitmap(self):
"""Test reading bitmap with truncated type bitmap data."""
# Valid header
data = BITMAP_SIGNATURE
data += BITMAP_VERSION.to_bytes(2, "big")
data += b"\x00\x00" # Flags
data += b"\x00\x00\x00\x00" # Entry count
data += b"\x00" * 20 # Pack checksum
# Truncated type bitmap (incomplete EWAH header)
data += b"\x00\x00\x00\x05" # bit_count
data += b"\x00\x00" # Incomplete word_count
with self.assertRaises(ValueError) as ctx:
read_bitmap_file(BytesIO(data))
self.assertIn("type bitmap", str(ctx.exception).lower())
def test_truncated_bitmap_entry(self):
"""Test reading bitmap with truncated entry."""
# Valid header with 1 entry
data = BITMAP_SIGNATURE
data += BITMAP_VERSION.to_bytes(2, "big")
data += b"\x00\x00" # Flags
data += b"\x00\x00\x00\x01" # 1 entry
data += b"\x00" * 20 # Pack checksum
# Write empty type bitmaps
for _ in range(4):
empty_ewah = EWAHBitmap().encode()
data += empty_ewah
# Truncated entry (only object position, missing rest)
data += b"\x00\x00\x00\x00" # Object position
# Missing: XOR offset, flags, bitmap data
with self.assertRaises(ValueError) as ctx:
read_bitmap_file(BytesIO(data))
# Should raise ValueError about missing data
self.assertIsInstance(ctx.exception, ValueError)
def test_empty_bitmap_file(self):
"""Test reading completely empty file."""
with self.assertRaises(ValueError):
read_bitmap_file(BytesIO(b""))
def test_bitmap_with_zero_entries(self):
"""Test valid bitmap with zero entries."""
bitmap = PackBitmap()
bitmap.pack_checksum = b"\x00" * 20
f = BytesIO()
write_bitmap_file(f, bitmap)
f.seek(0)
# Should read successfully
bitmap2 = read_bitmap_file(f)
self.assertEqual(0, len(bitmap2.entries))
self.assertIsNotNone(bitmap2.pack_checksum)
class BitmapEdgeCaseTests(unittest.TestCase):
"""Tests for edge cases in bitmap handling."""
def test_very_large_bitmap(self):
"""Test bitmap with many bits set."""
bitmap = EWAHBitmap()
# Add 100,000 bits
for i in range(100000):
if i % 3 == 0: # Every 3rd bit
bitmap.add(i)
# Should encode and decode without issues
encoded = bitmap.encode()
decoded = EWAHBitmap(encoded)
self.assertEqual(len(bitmap), len(decoded))
# Verify a sample of bits
self.assertIn(0, decoded)
self.assertIn(99999, decoded)
self.assertNotIn(1, decoded)
self.assertNotIn(99998, decoded)
def test_bitmap_with_large_gaps(self):
"""Test bitmap with large gaps between set bits."""
bitmap = EWAHBitmap()
bitmap.add(0)
bitmap.add(100000)
bitmap.add(200000)
encoded = bitmap.encode()
decoded = EWAHBitmap(encoded)
self.assertEqual(3, len(decoded))
self.assertIn(0, decoded)
self.assertIn(100000, decoded)
self.assertIn(200000, decoded)
def test_bitmap_all_bits_in_word(self):
"""Test bitmap with all 64 bits in a word set."""
bitmap = EWAHBitmap()
for i in range(64):
bitmap.add(i)
encoded = bitmap.encode()
decoded = EWAHBitmap(encoded)
self.assertEqual(64, len(decoded))
for i in range(64):
self.assertIn(i, decoded)
def test_multiple_flags_combined(self):
"""Test bitmap with multiple flags set."""
bitmap = PackBitmap(
flags=BITMAP_OPT_FULL_DAG | BITMAP_OPT_HASH_CACHE | BITMAP_OPT_LOOKUP_TABLE
)
bitmap.pack_checksum = b"\x00" * 20
bitmap.lookup_table = [(0, 0, 0), (1, 100, 0)]
bitmap.name_hash_cache = [0x12345678, 0xABCDEF00]
# Add an entry
test_bitmap = EWAHBitmap()
test_bitmap.add(0)
test_bitmap.add(5)
entry = BitmapEntry(object_pos=0, xor_offset=0, flags=0, bitmap=test_bitmap)
bitmap.entries[b"\x00" * 20] = entry
# Write and read back
f = BytesIO()
write_bitmap_file(f, bitmap)
f.seek(0)
bitmap2 = read_bitmap_file(f)
self.assertEqual(bitmap.flags, bitmap2.flags)
self.assertTrue(bitmap2.flags & BITMAP_OPT_FULL_DAG)
self.assertTrue(bitmap2.flags & BITMAP_OPT_HASH_CACHE)
self.assertTrue(bitmap2.flags & BITMAP_OPT_LOOKUP_TABLE)
self.assertIsNotNone(bitmap2.lookup_table)
self.assertIsNotNone(bitmap2.name_hash_cache)
class BitmapConfigTests(unittest.TestCase):
"""Tests for bitmap-related configuration settings."""
def test_pack_write_bitmaps_default(self):
"""Test pack.writeBitmaps defaults to false."""
from dulwich.config import ConfigFile
config = ConfigFile()
self.assertFalse(config.get_boolean((b"pack",), b"writeBitmaps", False))
def test_pack_write_bitmaps_true(self):
"""Test pack.writeBitmaps = true."""
from dulwich.config import ConfigFile
config = ConfigFile()
config.set((b"pack",), b"writeBitmaps", b"true")
self.assertTrue(config.get_boolean((b"pack",), b"writeBitmaps", False))
def test_pack_write_bitmaps_false(self):
"""Test pack.writeBitmaps = false."""
from dulwich.config import ConfigFile
config = ConfigFile()
config.set((b"pack",), b"writeBitmaps", b"false")
self.assertFalse(config.get_boolean((b"pack",), b"writeBitmaps", False))
def test_pack_write_bitmap_hash_cache_default(self):
"""Test pack.writeBitmapHashCache defaults to true."""
from dulwich.config import ConfigFile
config = ConfigFile()
self.assertTrue(config.get_boolean((b"pack",), b"writeBitmapHashCache", True))
def test_pack_write_bitmap_hash_cache_false(self):
"""Test pack.writeBitmapHashCache = false."""
from dulwich.config import ConfigFile
config = ConfigFile()
config.set((b"pack",), b"writeBitmapHashCache", b"false")
self.assertFalse(config.get_boolean((b"pack",), b"writeBitmapHashCache", True))
def test_pack_write_bitmap_lookup_table_default(self):
"""Test pack.writeBitmapLookupTable defaults to true."""
from dulwich.config import ConfigFile
config = ConfigFile()
self.assertTrue(config.get_boolean((b"pack",), b"writeBitmapLookupTable", True))
def test_repack_write_bitmaps(self):
"""Test repack.writeBitmaps configuration."""
from dulwich.config import ConfigFile
config = ConfigFile()
config.set((b"repack",), b"writeBitmaps", b"true")
self.assertTrue(config.get_boolean((b"repack",), b"writeBitmaps", False))
def test_pack_use_bitmap_index_default(self):
"""Test pack.useBitmapIndex defaults to true."""
from dulwich.config import ConfigFile
config = ConfigFile()
self.assertTrue(config.get_boolean((b"pack",), b"useBitmapIndex", True))
def test_pack_use_bitmap_index_false(self):
"""Test pack.useBitmapIndex = false."""
from dulwich.config import ConfigFile
config = ConfigFile()
config.set((b"pack",), b"useBitmapIndex", b"false")
self.assertFalse(config.get_boolean((b"pack",), b"useBitmapIndex", True))
|