grit-lib 0.5.21

Core library for the grit Git implementation
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
//! Pack corruption resilience (upstream t5303).

mod pack_delta_scenarios;

use grit_lib::objects::odb::Odb;
use grit_lib::objects::pack::{
    clear_pack_cache, packed_delta_base_oid, packed_full_object_slice, read_object_from_packs,
    read_packed_delta_dependency, PackedDeltaDependency,
};
use grit_lib::objects::{ObjectId, ObjectKind};
use grit_test_support::objects::{
    flip_byte_at, hash_loose_object, overwrite_range, DeltaOps, HashAlgo,
    ObjectKind as PackObjectKind, PackBuilder, RepoFixture,
};

use pack_delta_scenarios::{
    finish_synthetic_pack, install_hand_pack, odb_at, run_algo, write_loose_blob,
};

/// Three-blob chain: blob1, blob2 delta on blob1, blob3 delta on blob2 (depth 2).
struct T5303Pack {
    repo: RepoFixture,
    blob1: ObjectId,
    blob2: ObjectId,
    blob3: ObjectId,
    pack_path: std::path::PathBuf,
    file1: Vec<u8>,
    file2: Vec<u8>,
    file3: Vec<u8>,
    ref_deltas: bool,
}

impl T5303Pack {
    fn build_ofs(algo: HashAlgo) -> Self {
        Self::build_inner(algo, false)
    }

    fn build_ref(algo: HashAlgo) -> Self {
        Self::build_inner(algo, true)
    }

    fn build_inner(algo: HashAlgo, ref_deltas: bool) -> Self {
        let mut file1 = vec![0u8; 2000];
        let mut file2 = vec![0u8; 1800];
        let mut file3 = vec![0u8; 1800];
        for (i, b) in file1.iter_mut().enumerate() {
            *b = (i % 251) as u8;
        }
        file2.copy_from_slice(&file1[..1800]);
        file3.copy_from_slice(&file1[..1800]);
        file1.extend_from_slice(b" base ");
        file2.extend_from_slice(b" delta1 ");
        file3.extend_from_slice(b" delta delta2 ");
        file2.extend_from_slice(&[0u8; 150]);
        file3.extend_from_slice(&[0u8; 100]);

        let blob1 = ObjectId::from_hex(&hash_loose_object(algo, "blob", &file1)).unwrap();
        let blob2 = ObjectId::from_hex(&hash_loose_object(algo, "blob", &file2)).unwrap();
        let blob3 = ObjectId::from_hex(&hash_loose_object(algo, "blob", &file3)).unwrap();

        let delta2 = delta_between(&file1, &file2);
        let delta3 = delta_between(&file2, &file3);

        let repo = RepoFixture::init(algo).expect("init");
        let objects = repo.objects_dir();
        let stem = if ref_deltas { "t5303-ref" } else { "t5303-ofs" };
        let pack_path = install_hand_pack(&objects, stem, algo, |builder| {
            builder.add_full(PackObjectKind::Blob, &file1);
            if ref_deltas {
                builder.add_ref_delta(blob1.as_bytes(), &delta2, delta2.len());
                builder.add_ref_delta(blob2.as_bytes(), &delta3, delta3.len());
            } else {
                builder.add_ofs_delta(0, &delta2, delta2.len());
                builder.add_ofs_delta(1, &delta3, delta3.len());
            }
        });

        Self {
            repo,
            blob1,
            blob2,
            blob3,
            pack_path,
            file1,
            file2,
            file3,
            ref_deltas,
        }
    }

    fn objects(&self) -> std::path::PathBuf {
        self.repo.objects_dir()
    }
}

fn after_object_header(pack: &[u8], offset: u64) -> usize {
    let mut p = offset as usize;
    let first = *pack.get(p).expect("header byte");
    let type_code = (first >> 4) & 0x7;
    let mut c = first;
    p += 1;
    while c & 0x80 != 0 {
        c = *pack.get(p).expect("size cont");
        p += 1;
    }
    if type_code == 6 {
        while pack[p] & 0x80 != 0 {
            p += 1;
        }
        p += 1;
    } else if type_code == 7 {
        p += 20;
    }
    p
}

fn ref_delta_base_oid_offset(pack: &[u8], offset: u64) -> u64 {
    let mut p = offset as usize;
    let first = *pack.get(p).expect("header byte");
    let type_code = (first >> 4) & 0x7;
    assert_eq!(type_code, 7, "expected REF_DELTA");
    let mut c = first;
    p += 1;
    while c & 0x80 != 0 {
        c = *pack.get(p).expect("size cont");
        p += 1;
    }
    u64::try_from(p).expect("ref base oid offset")
}

fn delta_zlib_payload_offset(pack: &[u8], offset: u64) -> u64 {
    u64::try_from(after_object_header(pack, offset)).expect("zlib start")
}

fn ofs_delta_distance_offset(pack: &[u8], offset: u64) -> u64 {
    let mut p = offset as usize;
    let first = *pack.get(p).expect("header byte");
    let mut c = first;
    p += 1;
    while c & 0x80 != 0 {
        c = *pack.get(p).expect("size cont");
        p += 1;
    }
    u64::try_from(p).expect("ofs distance offset")
}

fn install_redundant_t5303_chain(
    objects: &std::path::Path,
    algo: HashAlgo,
    fx: &T5303Pack,
    stem: &str,
) {
    let mut redundant = PackBuilder::new(algo);
    redundant.add_full(PackObjectKind::Blob, &fx.file1);
    let d2 = delta_between(&fx.file1, &fx.file2);
    if fx.ref_deltas {
        redundant.add_ref_delta(fx.blob1.as_bytes(), &d2, d2.len());
        let d3 = delta_between(&fx.file2, &fx.file3);
        redundant.add_ref_delta(fx.blob2.as_bytes(), &d3, d3.len());
    } else {
        redundant.add_ofs_delta(0, &d2, d2.len());
        let d3 = delta_between(&fx.file2, &fx.file3);
        redundant.add_ofs_delta(1, &d3, d3.len());
    }
    let built = redundant.build();
    finish_synthetic_pack(
        objects,
        stem,
        algo,
        &built,
        &[(fx.blob1, 0), (fx.blob2, 1), (fx.blob3, 2)],
    );
}

fn delta_between(base: &[u8], target: &[u8]) -> Vec<u8> {
    let mut d = DeltaOps::new();
    d.header(base.len(), target.len());
    let lcp = base
        .iter()
        .zip(target.iter())
        .take_while(|(a, b)| a == b)
        .count();
    d.copy(0, lcp);
    if target.len() > lcp {
        d.insert(&target[lcp..]);
    }
    d.finish()
}

fn assert_read_fails(odb: &Odb, oid: &ObjectId) {
    assert!(
        odb.read(oid).is_err(),
        "expected read failure for {}",
        oid.to_hex()
    );
}

fn assert_read_ok(odb: &Odb, oid: &ObjectId, expected: &[u8]) {
    let obj = odb.read(oid).expect("read");
    assert_eq!(obj.kind, ObjectKind::Blob);
    assert_eq!(obj.data, expected);
}

fn assert_t5303_chain_metadata(fx: &T5303Pack) {
    let odb = odb_at(&fx.objects());
    assert_read_ok(&odb, &fx.blob1, &fx.file1);
    assert_read_ok(&odb, &fx.blob2, &fx.file2);
    assert_read_ok(&odb, &fx.blob3, &fx.file3);

    let pack_bytes = std::fs::read(&fx.pack_path).expect("read pack");
    let idx =
        grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx")).expect("idx");
    for entry in idx.iter() {
        let oid = ObjectId::from_bytes(entry.oid()).expect("oid");
        if oid == fx.blob1 {
            continue;
        }
        let off = entry.offset().expect("index offset");
        let dep = read_packed_delta_dependency(&pack_bytes, off, 20)
            .expect("dep parse")
            .expect("delta");
        if fx.ref_deltas {
            assert!(
                matches!(dep, PackedDeltaDependency::RefBase { .. }),
                "REF pack delta must report RefBase"
            );
        } else {
            assert!(
                matches!(dep, PackedDeltaDependency::OfsBase { .. }),
                "OFS pack delta must report OfsBase"
            );
        }
    }
    assert!(packed_full_object_slice(&fx.objects(), &fx.blob1)
        .expect("slice lookup")
        .is_some());
}

#[test]
fn t5303_initial_chain_reads_and_dependency_metadata_ofs_and_ref() {
    run_algo(HashAlgo::Sha1, |algo| {
        for ref_deltas in [false, true] {
            clear_pack_cache();
            let fx = if ref_deltas {
                T5303Pack::build_ref(algo)
            } else {
                T5303Pack::build_ofs(algo)
            };
            assert_t5303_chain_metadata(&fx);
        }
    });
}

#[test]
fn t5303_corrupt_first_object_header_then_recover_via_loose() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        flip_byte_at(&fx.pack_path, 12).expect("corrupt header");
        clear_pack_cache();
        let odb = odb_at(&fx.objects());
        assert_read_fails(&odb, &fx.blob1);
        assert_read_fails(&odb, &fx.blob2);
        assert_read_fails(&odb, &fx.blob3);

        write_loose_blob(&fx.objects(), algo, &fx.file1);
        clear_pack_cache();
        assert_read_ok(&odb, &fx.blob1, &fx.file1);
        assert_read_ok(&odb, &fx.blob2, &fx.file2);
        assert_read_ok(&odb, &fx.blob3, &fx.file3);
    });
}

#[test]
fn t5303_corrupt_first_object_data_then_recover_via_loose() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
            .expect("idx");
        let off1 = idx
            .find_offset(&fx.blob1)
            .expect("lookup")
            .expect("blob1 off");
        flip_byte_at(&fx.pack_path, off1 + 4).expect("corrupt blob1 zlib payload");
        clear_pack_cache();
        let odb = odb_at(&fx.objects());
        assert_read_fails(&odb, &fx.blob1);

        write_loose_blob(&fx.objects(), algo, &fx.file1);
        clear_pack_cache();
        assert_read_ok(&odb, &fx.blob1, &fx.file1);
        assert_read_ok(&odb, &fx.blob2, &fx.file2);
    });
}

#[test]
fn t5303_corrupt_first_delta_zlib_then_recover_via_loose() {
    run_algo(HashAlgo::Sha1, |algo| {
        for ref_deltas in [false, true] {
            clear_pack_cache();
            let fx = if ref_deltas {
                T5303Pack::build_ref(algo)
            } else {
                T5303Pack::build_ofs(algo)
            };
            let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
                .expect("idx");
            let pack = std::fs::read(&fx.pack_path).expect("read pack");
            let off2 = idx
                .find_offset(&fx.blob2)
                .expect("lookup")
                .expect("blob2 off");
            let zlib = delta_zlib_payload_offset(&pack, off2);
            flip_byte_at(&fx.pack_path, zlib + 2).expect("corrupt delta zlib");
            clear_pack_cache();
            let odb = odb_at(&fx.objects());
            assert_read_fails(&odb, &fx.blob2);

            write_loose_blob(&fx.objects(), algo, &fx.file2);
            install_redundant_t5303_chain(&fx.objects(), algo, &fx, "redundant-zlib");
            clear_pack_cache();
            let got2 = read_object_from_packs(&fx.objects(), &fx.blob2).expect("recover blob2");
            assert_eq!(got2.data, fx.file2);
            let got3 = read_object_from_packs(&fx.objects(), &fx.blob3).expect("recover blob3");
            assert_eq!(got3.data, fx.file3);
        }
    });
}

#[test]
fn t5303_corrupt_ref_delta_base_oid_then_recover() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ref(algo);
        let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
            .expect("idx");
        let pack = std::fs::read(&fx.pack_path).expect("read pack");
        let off3 = idx
            .find_offset(&fx.blob3)
            .expect("lookup")
            .expect("blob3 off");
        let base_oid_off = ref_delta_base_oid_offset(&pack, off3);
        flip_byte_at(&fx.pack_path, base_oid_off).expect("flip ref base oid byte");
        flip_byte_at(&fx.pack_path, base_oid_off + 1).expect("flip ref base oid byte 2");
        clear_pack_cache();
        let odb = odb_at(&fx.objects());
        assert_read_fails(&odb, &fx.blob3);

        write_loose_blob(&fx.objects(), algo, &fx.file3);
        install_redundant_t5303_chain(&fx.objects(), algo, &fx, "redundant-ref-base");
        clear_pack_cache();
        let got = read_object_from_packs(&fx.objects(), &fx.blob3).expect("recover blob3");
        assert_eq!(got.data, fx.file3);
        let _ = odb;
    });
}

#[test]
fn t5303_corrupt_first_delta_header_then_recover_partial_via_loose_blob2() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
            .expect("idx");
        let off2 = idx
            .find_offset(&fx.blob2)
            .expect("lookup")
            .expect("blob2 off");
        let end3 = idx
            .find_offset(&fx.blob3)
            .expect("lookup")
            .map(|o| o as usize)
            .unwrap_or_else(|| std::fs::metadata(&fx.pack_path).unwrap().len() as usize - 20);
        for pos in (off2 as usize)..end3.min((off2 as usize) + 64) {
            flip_byte_at(&fx.pack_path, pos as u64).ok();
        }
        clear_pack_cache();
        let odb = odb_at(&fx.objects());
        assert_read_fails(&odb, &fx.blob2);

        write_loose_blob(&fx.objects(), algo, &fx.file2);
        clear_pack_cache();
        assert_read_ok(&odb, &fx.blob2, &fx.file2);
        assert_read_ok(&odb, &fx.blob3, &fx.file3);
    });
}

#[test]
fn t5303_corrupt_ofs_delta_distance_variants_then_recover() {
    run_algo(HashAlgo::Sha1, |algo| {
        for (label, byte) in [("zero", 0u8), ("nonzero", 0x01u8)] {
            clear_pack_cache();
            let fx = T5303Pack::build_ofs(algo);
            let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
                .expect("idx");
            let pack = std::fs::read(&fx.pack_path).expect("read pack");
            let off2 = idx
                .find_offset(&fx.blob2)
                .expect("lookup")
                .expect("blob2 off");
            let dist = ofs_delta_distance_offset(&pack, off2);
            if byte == 0 {
                flip_byte_at(&fx.pack_path, dist).expect("corrupt ofs distance");
            } else {
                overwrite_range(&fx.pack_path, dist, &[byte]).expect("corrupt ofs distance");
            }
            clear_pack_cache();
            let odb = odb_at(&fx.objects());
            assert_read_fails(&odb, &fx.blob2);

            let mut redundant = PackBuilder::new(algo);
            redundant.add_full(PackObjectKind::Blob, &fx.file1);
            let d2 = delta_between(&fx.file1, &fx.file2);
            redundant.add_ofs_delta(0, &d2, d2.len());
            let d3 = delta_between(&fx.file2, &fx.file3);
            redundant.add_ofs_delta(1, &d3, d3.len());
            let built = redundant.build();
            finish_synthetic_pack(
                &fx.objects(),
                "redundant-ofs",
                algo,
                &built,
                &[(fx.blob1, 0), (fx.blob2, 1), (fx.blob3, 2)],
            );
            clear_pack_cache();
            let got2 = read_object_from_packs(&fx.objects(), &fx.blob2).expect("recover blob2");
            assert_eq!(got2.data, fx.file2);
            let got3 = read_object_from_packs(&fx.objects(), &fx.blob3).expect("recover blob3");
            assert_eq!(got3.data, fx.file3);
            let _ = label;
        }
    });
}

#[test]
fn t5303_corrupt_delta_base_to_wrong_object_then_recover_via_loose() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        let idx = grit_lib::objects::pack::read_pack_index(&fx.pack_path.with_extension("idx"))
            .expect("idx");
        let pack = std::fs::read(&fx.pack_path).expect("read pack");
        let off3 = idx
            .find_offset(&fx.blob3)
            .expect("lookup")
            .expect("blob3 off");
        let dist = ofs_delta_distance_offset(&pack, off3);
        overwrite_range(&fx.pack_path, dist, &[0x20, 0x33]).expect("wrong base ofs");
        clear_pack_cache();
        let odb = odb_at(&fx.objects());
        assert_read_fails(&odb, &fx.blob3);

        let mut redundant = PackBuilder::new(algo);
        redundant.add_full(PackObjectKind::Blob, &fx.file1);
        let d2 = delta_between(&fx.file1, &fx.file2);
        redundant.add_ofs_delta(0, &d2, d2.len());
        let d3 = delta_between(&fx.file2, &fx.file3);
        redundant.add_ofs_delta(1, &d3, d3.len());
        let built = redundant.build();
        finish_synthetic_pack(
            &fx.objects(),
            "redundant-b3",
            algo,
            &built,
            &[(fx.blob1, 0), (fx.blob2, 1), (fx.blob3, 2)],
        );
        clear_pack_cache();
        let got = read_object_from_packs(&fx.objects(), &fx.blob3).expect("recover blob3");
        assert_eq!(got.data, fx.file3);
        let _ = odb;
    });
}

#[test]
fn t5303_redundant_pack_recovers_when_primary_corrupt() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        let primary = fx.pack_path.clone();
        let objects = fx.objects();

        // Good redundant pack with blob1 and blob2 only.
        install_hand_pack(&objects, "redundant", algo, |builder| {
            builder.add_full(PackObjectKind::Blob, &fx.file1);
            let d2 = delta_between(&fx.file1, &fx.file2);
            builder.add_ofs_delta(0, &d2, d2.len());
        });

        let idx =
            grit_lib::objects::pack::read_pack_index(&primary.with_extension("idx")).expect("idx");
        let off2 = idx.find_offset(&fx.blob2).expect("lookup").expect("off2");
        flip_byte_at(&primary, off2).expect("break primary delta");
        clear_pack_cache();

        let odb = odb_at(&objects);
        assert_read_ok(&odb, &fx.blob1, &fx.file1);
        assert_read_ok(&odb, &fx.blob2, &fx.file2);
        assert_read_ok(&odb, &fx.blob3, &fx.file3);

        assert_eq!(
            packed_delta_base_oid(&objects, &fx.blob2)
                .expect("base")
                .map(|o| o.to_hex()),
            Some(fx.blob1.to_hex())
        );
    });
}

#[test]
fn t5303_packed_full_object_slice_skips_crc_mismatch_and_reads_redundant() {
    run_algo(HashAlgo::Sha1, |algo| {
        clear_pack_cache();
        let fx = T5303Pack::build_ofs(algo);
        let objects = fx.objects();
        let good_pack = std::fs::read(&fx.pack_path).expect("read good");
        install_hand_pack(&objects, "good-copy", algo, |builder| {
            builder.add_full(PackObjectKind::Blob, &fx.file1);
            let d2 = delta_between(&fx.file1, &fx.file2);
            builder.add_ofs_delta(0, &d2, d2.len());
            let d3 = delta_between(&fx.file2, &fx.file3);
            builder.add_ofs_delta(1, &d3, d3.len());
        });

        flip_byte_at(&fx.pack_path, 12 + 50).expect("flip primary blob bytes");
        clear_pack_cache();
        assert!(
            packed_full_object_slice(&objects, &fx.blob1)
                .expect("lookup")
                .is_some(),
            "redundant full slice should remain available"
        );
        let got = read_object_from_packs(&objects, &fx.blob1).expect("read blob1");
        assert_eq!(got.data, fx.file1);
        let _ = good_pack;
    });
}