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
|
# test_midx.py -- Tests for multi-pack-index
# 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 multi-pack-index (MIDX) functionality."""
import os
import tempfile
from io import BytesIO
from unittest import TestCase
from dulwich.midx import (
HASH_ALGORITHM_SHA1,
MultiPackIndex,
write_midx,
write_midx_file,
)
class MIDXWriteTests(TestCase):
"""Tests for writing MIDX files."""
def test_write_empty_midx(self):
"""Test writing an empty MIDX file."""
f = BytesIO()
pack_entries = []
checksum = write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
# Checksum should be 20 bytes
self.assertEqual(20, len(checksum))
# Should be able to read it back
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
self.assertEqual(0, len(midx))
self.assertEqual(0, midx.pack_count)
self.assertEqual([], midx.pack_names)
def test_write_single_pack_midx(self):
"""Test writing a MIDX file with a single pack."""
f = BytesIO()
# Create some fake pack entries
pack_entries = [
(
"pack-abc123.idx",
[
(b"\x01" * 20, 100, 0x12345678), # sha, offset, crc32
(b"\x02" * 20, 200, 0x87654321),
(b"\x03" * 20, 300, 0xABCDEF00),
],
)
]
checksum = write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
self.assertEqual(20, len(checksum))
# Read it back
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
self.assertEqual(3, len(midx))
self.assertEqual(1, midx.pack_count)
self.assertEqual(["pack-abc123.idx"], midx.pack_names)
# Check object lookups
result = midx.object_offset(b"\x01" * 20)
self.assertIsNotNone(result)
pack_name, offset = result
self.assertEqual("pack-abc123.idx", pack_name)
self.assertEqual(100, offset)
result = midx.object_offset(b"\x02" * 20)
self.assertIsNotNone(result)
pack_name, offset = result
self.assertEqual("pack-abc123.idx", pack_name)
self.assertEqual(200, offset)
result = midx.object_offset(b"\x03" * 20)
self.assertIsNotNone(result)
pack_name, offset = result
self.assertEqual("pack-abc123.idx", pack_name)
self.assertEqual(300, offset)
# Check non-existent object
result = midx.object_offset(b"\xff" * 20)
self.assertIsNone(result)
def test_write_multiple_packs_midx(self):
"""Test writing a MIDX file with multiple packs."""
f = BytesIO()
pack_entries = [
(
"pack-111.idx",
[
(b"\x01" * 20, 100, 0),
(b"\x03" * 20, 300, 0),
],
),
(
"pack-222.idx",
[
(b"\x02" * 20, 50, 0),
(b"\x04" * 20, 150, 0),
],
),
]
checksum = write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
self.assertEqual(20, len(checksum))
# Read it back
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
self.assertEqual(4, len(midx))
self.assertEqual(2, midx.pack_count)
self.assertEqual(["pack-111.idx", "pack-222.idx"], midx.pack_names)
# Objects should be findable across packs
result = midx.object_offset(b"\x01" * 20)
self.assertIsNotNone(result)
self.assertEqual("pack-111.idx", result[0])
result = midx.object_offset(b"\x02" * 20)
self.assertIsNotNone(result)
self.assertEqual("pack-222.idx", result[0])
def test_write_large_offsets(self):
"""Test writing a MIDX file with large offsets (>= 2^31)."""
f = BytesIO()
large_offset = 2**32 # Offset that requires LOFF chunk
pack_entries = [
(
"pack-large.idx",
[
(b"\x01" * 20, 100, 0),
(b"\x02" * 20, large_offset, 0), # Large offset
],
)
]
checksum = write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
self.assertEqual(20, len(checksum))
# Read it back
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
self.assertEqual(2, len(midx))
# Small offset should work
result = midx.object_offset(b"\x01" * 20)
self.assertIsNotNone(result)
self.assertEqual(100, result[1])
# Large offset should work
result = midx.object_offset(b"\x02" * 20)
self.assertIsNotNone(result)
self.assertEqual(large_offset, result[1])
def test_write_midx_file(self):
"""Test writing a MIDX file to disk."""
with tempfile.TemporaryDirectory() as tmpdir:
midx_path = os.path.join(tmpdir, "multi-pack-index")
pack_entries = [
(
"pack-test.idx",
[
(b"\xaa" * 20, 1000, 0),
],
)
]
checksum = write_midx_file(midx_path, pack_entries, HASH_ALGORITHM_SHA1)
self.assertEqual(20, len(checksum))
# Verify file was created
self.assertTrue(os.path.exists(midx_path))
# Read it back from disk
with open(midx_path, "rb") as f:
midx = MultiPackIndex(midx_path, file=f, contents=f.read())
self.assertEqual(1, len(midx))
result = midx.object_offset(b"\xaa" * 20)
self.assertIsNotNone(result)
self.assertEqual("pack-test.idx", result[0])
self.assertEqual(1000, result[1])
class MIDXContainsTests(TestCase):
"""Tests for MIDX __contains__ method."""
def test_contains_object(self):
"""Test checking if an object is in the MIDX."""
f = BytesIO()
pack_entries = [
(
"pack-test.idx",
[
(b"\x01" * 20, 100, 0),
(b"\x02" * 20, 200, 0),
],
)
]
write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
self.assertTrue(b"\x01" * 20 in midx)
self.assertTrue(b"\x02" * 20 in midx)
self.assertFalse(b"\xff" * 20 in midx)
class MIDXIterEntriesTests(TestCase):
"""Tests for MIDX iterentries method."""
def test_iterentries(self):
"""Test iterating over MIDX entries."""
f = BytesIO()
pack_entries = [
(
"pack-111.idx",
[
(b"\x01" * 20, 100, 0),
(b"\x03" * 20, 300, 0),
],
),
(
"pack-222.idx",
[
(b"\x02" * 20, 50, 0),
],
),
]
write_midx(f, pack_entries, HASH_ALGORITHM_SHA1)
f.seek(0)
midx = MultiPackIndex("test.midx", file=f, contents=f.read())
entries = list(midx.iterentries())
self.assertEqual(3, len(entries))
# Entries should be sorted by SHA
self.assertEqual(b"\x01" * 20, entries[0][0])
self.assertEqual("pack-111.idx", entries[0][1])
self.assertEqual(100, entries[0][2])
self.assertEqual(b"\x02" * 20, entries[1][0])
self.assertEqual("pack-222.idx", entries[1][1])
self.assertEqual(50, entries[1][2])
self.assertEqual(b"\x03" * 20, entries[2][0])
self.assertEqual("pack-111.idx", entries[2][1])
self.assertEqual(300, entries[2][2])
|
