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
//! Parallel index-pack hashing: byte-identical `.idx` vs system `git index-pack`.

use std::io::Write;
use std::path::Path;
use std::process::{Command, Stdio};
use std::sync::OnceLock;

use grit_lib::objects::hash::Parallelism;
use grit_lib::objects::index_pack::{install_pack_bytes, IngestPackOptions};
use grit_lib::objects::odb::Odb;
use grit_lib::objects::pack::write_v2_pack_index_with_trailer;
use grit_lib::objects::unpack_objects::pack_index_records_with_threads;
use grit_lib::objects::HashAlgo;

const GIT_ENV: &[(&str, &str)] = &[
    ("GIT_CONFIG_GLOBAL", "/dev/null"),
    ("GIT_CONFIG_SYSTEM", "/dev/null"),
    ("GIT_CONFIG_NOSYSTEM", "1"),
    ("GIT_AUTHOR_NAME", "T"),
    ("GIT_AUTHOR_EMAIL", "t@example.com"),
    ("GIT_COMMITTER_NAME", "T"),
    ("GIT_COMMITTER_EMAIL", "t@example.com"),
];

const DEFAULT_MIN_PACK_OBJECTS: u32 = 50_000;
const FILES_PER_COMMIT: usize = 8;

struct DeltaPackFixture {
    pack: Vec<u8>,
    hash_algo: HashAlgo,
    _keep: tempfile::TempDir,
}

fn target_min_pack_objects() -> u32 {
    std::env::var("GRIT_INDEX_PACK_PARALLEL_OBJECTS")
        .ok()
        .and_then(|v| v.parse().ok())
        .filter(|&n| n >= 100)
        .unwrap_or(DEFAULT_MIN_PACK_OBJECTS)
}

fn git_ok(dir: &Path, args: &[&str]) -> bool {
    let mut cmd = Command::new("git");
    cmd.current_dir(dir).args(args);
    for (k, v) in GIT_ENV {
        cmd.env(k, v);
    }
    cmd.output().map(|o| o.status.success()).unwrap_or(false)
}

fn git_run(dir: &Path, args: &[&str]) {
    let mut cmd = Command::new("git");
    cmd.current_dir(dir).args(args);
    for (k, v) in GIT_ENV {
        cmd.env(k, v);
    }
    let out = cmd.output().expect("git");
    assert!(
        out.status.success(),
        "git {:?}: {}",
        args,
        String::from_utf8_lossy(&out.stderr)
    );
}

fn write_fast_import_script(out: &mut Vec<u8>, min_objects: u32) -> std::io::Result<()> {
    let min_commits = (min_objects as usize).div_ceil(FILES_PER_COMMIT) + 2;
    out.extend_from_slice(b"feature done\n");
    out.extend_from_slice(b"commit refs/heads/main\nmark :1\n");
    out.extend_from_slice(b"committer T <t@example.com> 1000000000 +0000\n");
    out.extend_from_slice(b"data 4\ninit\n");
    out.extend_from_slice(b"M 100644 inline seed.txt\n");
    out.extend_from_slice(b"data 5\nseed\n\n");

    for i in 1..min_commits {
        let msg = format!("c{i}");
        writeln!(out, "commit refs/heads/main")?;
        writeln!(out, "mark :{}", i + 1)?;
        writeln!(out, "committer T <t@example.com> 1000000000 +0000")?;
        writeln!(out, "data {}", msg.len())?;
        writeln!(out, "{msg}")?;
        writeln!(out, "from :{i}")?;
        for f in 0..FILES_PER_COMMIT {
            let path = format!("d/{i:05}/{f:02}.txt");
            let payload = format!("payload commit={i} file={f}\n");
            writeln!(out, "M 100644 inline {path}")?;
            writeln!(out, "data {}", payload.len())?;
            write!(out, "{payload}")?;
            out.push(b'\n');
        }
    }
    out.extend_from_slice(b"done\n");
    Ok(())
}

fn build_delta_pack_fixture(sha256: bool) -> DeltaPackFixture {
    let min_objects = target_min_pack_objects();
    let tmp = tempfile::tempdir().expect("tempdir");
    let dir = tmp.path();
    if sha256 {
        if !git_ok(&dir, &["init", "--object-format=sha256", "-b", "main"]) {
            panic!("system git lacks sha256 object format");
        }
    } else {
        git_run(&dir, &["init", "-b", "main"]);
    }

    let mut script = Vec::new();
    write_fast_import_script(&mut script, min_objects).expect("fast-import script");
    let mut child = Command::new("git");
    child
        .current_dir(&dir)
        .args(["fast-import", "--quiet"])
        .stdin(Stdio::piped())
        .stdout(Stdio::null())
        .stderr(Stdio::piped());
    for (k, v) in GIT_ENV {
        child.env(k, v);
    }
    let mut child = child.spawn().expect("spawn fast-import");
    {
        let mut stdin = child.stdin.take().expect("stdin");
        stdin.write_all(&script).expect("write fast-import");
    }
    let out = child.wait_with_output().expect("wait fast-import");
    assert!(
        out.status.success(),
        "git fast-import (script {} bytes): {}",
        script.len(),
        String::from_utf8_lossy(&out.stderr)
    );

    git_run(&dir, &["repack", "-adf", "--depth=50", "-q"]);
    let pack_dir = dir.join(".git/objects/pack");
    let pack_path = std::fs::read_dir(&pack_dir)
        .expect("pack dir")
        .filter_map(|e| e.ok())
        .map(|e| e.path())
        .find(|p| p.extension().is_some_and(|x| x == "pack"))
        .expect("repack must produce a .pack");
    let pack = std::fs::read(&pack_path).expect("read pack");
    let count = u32::from_be_bytes([pack[8], pack[9], pack[10], pack[11]]);
    assert!(
        count >= min_objects,
        "pack should contain at least {min_objects} objects, header count {count}"
    );

    let git_dir = dir.join(".git");
    let odb = Odb::new(git_dir.join("objects").as_path()).with_config_git_dir(git_dir.clone());
    let hash_algo = if sha256 {
        HashAlgo::Sha256
    } else {
        HashAlgo::Sha1
    };
    assert_eq!(odb.hash_algo(), hash_algo);
    let hb = hash_algo.len();
    assert!(
        pack.len() > 12 + hb,
        "pack must include a {hb}-byte trailer"
    );

    DeltaPackFixture {
        pack,
        hash_algo,
        _keep: tmp,
    }
}

static FIXTURE_SHA1: OnceLock<DeltaPackFixture> = OnceLock::new();
static FIXTURE_SHA256: OnceLock<Option<DeltaPackFixture>> = OnceLock::new();

fn shared_fixture_sha1() -> &'static DeltaPackFixture {
    FIXTURE_SHA1.get_or_init(|| build_delta_pack_fixture(false))
}

fn shared_fixture_sha256() -> Option<&'static DeltaPackFixture> {
    FIXTURE_SHA256
        .get_or_init(|| {
            let tmp = tempfile::tempdir().ok()?;
            if !git_ok(tmp.path(), &["init", "--object-format=sha256"]) {
                return None;
            }
            drop(tmp);
            Some(build_delta_pack_fixture(true))
        })
        .as_ref()
}

fn git_index_pack_idx(pack: &[u8], hash_algo: HashAlgo, threads: usize) -> (Vec<u8>, Vec<u8>) {
    let dir = tempfile::tempdir().expect("scratch");
    if hash_algo == HashAlgo::Sha256 {
        git_run(
            dir.path(),
            &["init", "--object-format=sha256", "-b", "main"],
        );
    } else {
        git_run(dir.path(), &["init", "-b", "main"]);
    }
    let pack_path = dir.path().join("fixture.pack");
    std::fs::write(&pack_path, pack).expect("write pack");
    let mut args = vec!["index-pack"];
    let threads_arg = format!("--threads={threads}");
    args.push(&threads_arg);
    args.push(
        pack_path
            .file_name()
            .and_then(|s| s.to_str())
            .expect("pack name"),
    );
    let mut cmd = Command::new("git");
    cmd.current_dir(dir.path()).args(args);
    for (k, v) in GIT_ENV {
        cmd.env(k, v);
    }
    cmd.env("GIT_TEST_NO_WRITE_REV_INDEX", "1");
    let out = cmd.output().expect("git index-pack");
    assert!(
        out.status.success(),
        "git index-pack: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    let idx = std::fs::read(dir.path().join("fixture.idx")).expect("read git idx");
    let pack_on_disk = std::fs::read(&pack_path).expect("read indexed pack");
    verify_pack_with_git(&pack_on_disk, &idx, hash_algo);
    (idx, pack_on_disk)
}

fn grit_index_bytes(pack: &[u8], odb: &Odb, threads: usize) -> Vec<u8> {
    let parallelism = Parallelism::resolve(Some(threads));
    let records = pack_index_records_with_threads(pack, odb, parallelism).expect("grit index");
    let hb = odb.hash_algo().len();
    let trailer = &pack[pack.len() - hb..];
    let entries: Vec<_> = records
        .into_iter()
        .map(|r| (r.oid, r.offset, r.crc32))
        .collect();
    let dir = tempfile::tempdir().expect("idx scratch");
    let idx_path = dir.path().join("grit.idx");
    write_v2_pack_index_with_trailer(&idx_path, &entries, trailer, hb, Some(threads))
        .expect("write idx");
    std::fs::read(&idx_path).expect("read grit idx")
}

fn verify_pack_with_git(pack: &[u8], idx: &[u8], hash_algo: HashAlgo) {
    let dir = tempfile::tempdir().expect("verify scratch");
    std::fs::write(dir.path().join("f.pack"), pack).expect("write pack");
    std::fs::write(dir.path().join("f.idx"), idx).expect("write idx");
    let mut args = vec!["verify-pack", "-v"];
    let sha256_flag = "sha256";
    if hash_algo == HashAlgo::Sha256 {
        args.push("--object-format");
        args.push(sha256_flag);
    }
    args.push("f.idx");
    let out = Command::new("git")
        .current_dir(dir.path())
        .args(&args)
        .env("GIT_CONFIG_GLOBAL", "/dev/null")
        .env("GIT_CONFIG_SYSTEM", "/dev/null")
        .output()
        .expect("verify-pack");
    assert!(
        out.status.success(),
        "git verify-pack -v: {}",
        String::from_utf8_lossy(&out.stderr)
    );
}

fn write_repo_format(git_dir: &Path, sha256: bool) {
    std::fs::create_dir_all(git_dir.join("objects")).expect("objects");
    if sha256 {
        std::fs::write(
            git_dir.join("config"),
            "[core]\n\trepositoryformatversion = 1\n[extensions]\n\tobjectFormat = sha256\n",
        )
        .expect("write sha256 config");
    } else {
        std::fs::write(
            git_dir.join("config"),
            "[core]\n\trepositoryformatversion = 0\n",
        )
        .expect("write config");
    }
}

fn assert_idx_matches_git(pack: &[u8], hash_algo: HashAlgo, threads: usize) {
    let tmp = tempfile::tempdir().expect("odb");
    let git_dir = tmp.path().join(".git");
    write_repo_format(&git_dir, hash_algo == HashAlgo::Sha256);
    let odb = Odb::new(git_dir.join("objects").as_path()).with_config_git_dir(git_dir);
    assert_eq!(odb.hash_algo(), hash_algo);
    let (git_idx, pack_on_disk) = git_index_pack_idx(pack, hash_algo, threads);
    let grit_idx = grit_index_bytes(&pack_on_disk, &odb, threads);
    assert_eq!(
        grit_idx, git_idx,
        "grit .idx must match git index-pack (--threads={threads})"
    );
    verify_pack_with_git(&pack_on_disk, &grit_idx, hash_algo);
}

#[test]
fn parallel_index_pack_matches_git_sha1_threads_1_and_8() {
    let fx = shared_fixture_sha1();
    assert_idx_matches_git(&fx.pack, fx.hash_algo, 1);
    assert_idx_matches_git(&fx.pack, fx.hash_algo, 8);
}

#[test]
fn parallel_index_pack_matches_git_sha256_threads_1_and_8() {
    let Some(fx) = shared_fixture_sha256() else {
        eprintln!("skip: sha256 object format unavailable");
        return;
    };
    assert_idx_matches_git(&fx.pack, fx.hash_algo, 1);
    assert_idx_matches_git(&fx.pack, fx.hash_algo, 8);
}

/// Deep OFS + REF delta chain: `.idx` / `.rev` must match across thread counts.
#[test]
fn idx_rev_identical_threads_1_2_4_8_deep_delta_chain() {
    use grit_lib::objects::delta_encode::encode_lcp_delta;
    use grit_lib::objects::pack_rev::build_pack_rev_bytes_from_index_order_offsets_and_checksum;
    use grit_lib::objects::ObjectKind;
    use grit_test_support::objects::{HashAlgo as FixtureAlgo, ObjectKind as PK, PackBuilder};

    let mut pb = PackBuilder::new(FixtureAlgo::Sha1);
    let mut content = b"chain-root\n".to_vec();
    let mut base_idx = pb.add_full(PK::Blob, &content);
    for _ in 0..40 {
        let mut next = content.clone();
        next.push(b'!');
        let delta = encode_lcp_delta(&content, &next).expect("delta");
        base_idx = pb.add_ofs_delta(base_idx, &delta, delta.len());
        content = next;
    }
    let ref_base = b"ref-base-for-delta\n";
    let _ref_base_idx = pb.add_full(PK::Blob, ref_base);
    let scratch_odb = Odb::new(tempfile::tempdir().expect("odb").path());
    let ref_oid = scratch_odb.hash(ObjectKind::Blob, ref_base).expect("hash");
    let mut ref_target = ref_base.to_vec();
    ref_target.extend_from_slice(b"++");
    let ref_delta = encode_lcp_delta(ref_base, &ref_target).expect("ref delta");
    pb.add_ref_delta(ref_oid.as_bytes(), &ref_delta, ref_delta.len());
    let pack = pb.build().bytes;

    let tmp = tempfile::tempdir().expect("tempdir");
    let git_dir = tmp.path().join(".git");
    write_repo_format(&git_dir, false);
    let odb = Odb::new(git_dir.join("objects").as_path()).with_config_git_dir(git_dir);

    let (git_idx, pack_on_disk) = git_index_pack_idx(&pack, HashAlgo::Sha1, 8);

    let mut reference_idx = None;
    let mut reference_rev = None;
    for threads in [1_usize, 2, 4, 8] {
        let grit_idx = grit_index_bytes(&pack_on_disk, &odb, threads);
        if reference_idx.is_none() {
            reference_idx = Some(grit_idx.clone());
        }
        assert_eq!(
            &grit_idx,
            reference_idx.as_ref().expect("reference"),
            "grit idx must be stable across threads={threads}"
        );
        assert_eq!(
            grit_idx, git_idx,
            "grit idx must match git index-pack at threads={threads}"
        );
        let hb = odb.hash_algo().len();
        let trailer = &pack_on_disk[pack_on_disk.len() - hb..];
        let scratch = tempfile::tempdir().expect("idx");
        let idx_path = scratch.path().join("t.idx");
        std::fs::write(&idx_path, &grit_idx).expect("write idx");
        let index = grit_lib::objects::pack::read_pack_index(&idx_path).expect("parse");
        let offsets: Vec<u64> = index.iter().map(|e| e.offset().expect("offset")).collect();
        let grit_rev =
            build_pack_rev_bytes_from_index_order_offsets_and_checksum(&offsets, trailer);
        if reference_rev.is_none() {
            reference_rev = Some(grit_rev.clone());
        }
        assert_eq!(
            &grit_rev,
            reference_rev.as_ref().expect("rev reference"),
            "grit rev must be stable across threads={threads}"
        );
    }
}

#[test]
fn install_pack_path_matches_git_index() {
    let fx = shared_fixture_sha1();
    let pack = fx.pack.clone();
    let hash_algo = fx.hash_algo;
    let tmp = tempfile::tempdir().expect("install");
    let odb = Odb::new(tmp.path().join("objects").as_path());
    install_pack_bytes(
        pack.clone(),
        &odb,
        &IngestPackOptions {
            fix_thin: false,
            threads: Some(8),
            skip_post_index_verify: false,
            ..Default::default()
        },
    )
    .expect("install");
    let pack_dir = tmp.path().join("objects").join("pack");
    let idx_path = std::fs::read_dir(&pack_dir)
        .expect("pack dir")
        .filter_map(|e| e.ok())
        .map(|e| e.path())
        .find(|p| p.extension().is_some_and(|x| x == "idx"))
        .expect("installed idx");
    let grit_idx = std::fs::read(&idx_path).expect("read installed idx");
    let (git_idx, pack_on_disk) = git_index_pack_idx(&pack, hash_algo, 8);
    let _ = pack_on_disk;
    assert_eq!(grit_idx, git_idx);
}

#[test]
fn concurrent_installs_of_one_pack_into_one_repo_all_succeed() {
    let fx = shared_fixture_sha1();
    let tmp = tempfile::tempdir().expect("repo");
    git_run(tmp.path(), &["init", "-q", "-b", "main"]);
    let objects = tmp.path().join(".git/objects");
    let barrier = std::sync::Barrier::new(4);
    std::thread::scope(|s| {
        let handles: Vec<_> = (0..4)
            .map(|_| {
                s.spawn(|| {
                    let odb = Odb::new(objects.as_path());
                    barrier.wait();
                    install_pack_bytes(
                        fx.pack.clone(),
                        &odb,
                        &IngestPackOptions {
                            fix_thin: false,
                            threads: Some(2),
                            ..Default::default()
                        },
                    )
                })
            })
            .collect();
        for h in handles {
            h.join()
                .expect("join")
                .expect("every concurrent install succeeds");
        }
    });

    let names: Vec<String> = std::fs::read_dir(objects.join("pack"))
        .expect("pack dir")
        .filter_map(|e| e.ok())
        .map(|e| e.file_name().to_string_lossy().into_owned())
        .collect();
    assert_eq!(
        names.iter().filter(|n| n.ends_with(".pack")).count(),
        1,
        "{names:?}"
    );
    assert_eq!(
        names.iter().filter(|n| n.ends_with(".idx")).count(),
        1,
        "{names:?}"
    );
    assert!(
        names
            .iter()
            .all(|n| !n.starts_with('.') && !n.starts_with("tmp_")),
        "leftover staging files: {names:?}"
    );
    git_run(tmp.path(), &["fsck", "--strict", "--no-dangling"]);
}