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
//! `resolve` / `read_object_for_display` compatibility with system `git`.

mod support;

use std::io::Write;
use std::process::{Command, Stdio};

use grit_lib::config::environment::Environment;
use grit_lib::config::environment::RepositoryOptions;
use grit_lib::object_inspect::{format_tree_cat_file_p, ObjectContents, ResolveError};
use grit_lib::objects::ObjectKind;
use grit_lib::repo::Repository;

use support::{
    bare_repo_with_ambiguous_prefix, commit_file, git, git_rev_parse_verify, open_grit_repo,
    HistoryRepo,
};

const ABSENT_GITLINK: &str = "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef";

fn git_cat_file_type(wt: &std::path::Path, spec: &str) -> Option<String> {
    let out = std::process::Command::new("git")
        .current_dir(wt)
        .args(["cat-file", "-t", spec])
        .output()
        .ok()?;
    if !out.status.success() {
        return None;
    }
    Some(String::from_utf8_lossy(&out.stdout).trim().to_owned())
}

fn git_cat_file_size(wt: &std::path::Path, spec: &str) -> Option<u64> {
    let out = std::process::Command::new("git")
        .current_dir(wt)
        .args(["cat-file", "-s", spec])
        .output()
        .ok()?;
    if !out.status.success() {
        return None;
    }
    std::str::from_utf8(&out.stdout).ok()?.trim().parse().ok()
}

fn git_cat_file_p(wt: &std::path::Path, spec: &str) -> Option<Vec<u8>> {
    let out = std::process::Command::new("git")
        .current_dir(wt)
        .args(["cat-file", "-p", spec])
        .output()
        .ok()?;
    if !out.status.success() {
        return None;
    }
    Some(out.stdout)
}

fn setup_rich_fixture() -> HistoryRepo {
    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    commit_file(wt, "README.md", "# hello\n", "initial");
    git(wt, &["tag", "v0.1"]);
    git(wt, &["tag", "-a", "v1.0", "-m", "release one"]);
    git(wt, &["checkout", "-b", "feature"]);
    commit_file(wt, "feature.txt", "feat\n", "on feature");
    git(wt, &["checkout", "main"]);
    commit_file(wt, "main.txt", "main\n", "on main");
    git(
        wt,
        &["merge", "--no-edit", "feature", "-m", "merge feature"],
    );
    commit_file(wt, "after-merge.txt", "done\n", "after merge");
    commit_file(wt, "pack-me.txt", "pack\n", "before repack");
    git(wt, &["repack", "-a", "-d"]);
    hist
}

#[test]
fn resolve_matches_git_rev_parse() {
    let hist = setup_rich_fixture();
    let wt = hist.worktree();
    let repo = open_grit_repo(wt);

    let specs = [
        "HEAD",
        "HEAD~1",
        "HEAD~2",
        "HEAD~3",
        "HEAD~3",
        "HEAD^",
        "HEAD^1",
        "HEAD~2^2",
        "main",
        "feature",
        "v0.1",
        "v1.0",
        "v1.0^{commit}",
        "v1.0^{tag}",
        "v1.0^{}",
        "HEAD^{tree}",
        "HEAD^{commit}",
        "HEAD:README.md",
        "HEAD:feature.txt",
        "main:after-merge.txt",
        "HEAD~1^{tree}",
        "refs/heads/main",
        "refs/tags/v1.0",
        "main~1",
        "main~2",
        "feature~0",
        "@{0}",
        "HEAD~0",
        "main^{commit}",
        "HEAD^{object}",
        "HEAD~4",
        "HEAD~1^{commit}",
        "feature^{}",
        "v0.1^{commit}",
        "HEAD:main.txt",
        "HEAD~2:README.md",
    ];

    for spec in specs {
        let git_oid =
            git_rev_parse_verify(wt, spec).unwrap_or_else(|| panic!("git rev-parse {spec}"));
        let resolved = repo
            .resolve(spec)
            .unwrap_or_else(|e| panic!("grit resolve {spec}: {e}"));
        assert_eq!(resolved.oid, git_oid, "oid mismatch for `{spec}`");
        let git_kind = git_cat_file_type(wt, &git_oid.to_hex())
            .unwrap_or_else(|| panic!("git cat-file -t {}", git_oid.to_hex()));
        assert_eq!(
            kind_str(resolved.kind),
            git_kind.as_str(),
            "kind mismatch for `{spec}`"
        );
    }
}

#[test]
fn cat_matches_git_cat_file() {
    let hist = setup_rich_fixture();
    let wt = hist.worktree();
    let repo = open_grit_repo(wt);

    let specs = [
        "HEAD",
        "HEAD^{tree}",
        "HEAD:README.md",
        "v1.0^{tag}",
        "v1.0^{commit}",
        "HEAD~2",
        "feature^{commit}",
    ];

    for spec in specs {
        let resolved = repo.resolve(spec).expect("resolve");
        let git_type = git_cat_file_type(wt, spec).expect("git -t");
        assert_eq!(kind_str(resolved.kind), git_type.as_str());
        let git_size = git_cat_file_size(wt, spec).expect("git -s");
        assert_eq!(resolved.size, git_size, "size for {spec}");

        let git_body = git_cat_file_p(wt, spec).expect("git -p");
        let obj = repo
            .read_object_raw_for_display(&resolved.oid)
            .expect("read object");
        let _parsed = repo
            .read_object_for_display(&resolved.oid)
            .expect("read_object_for_display");

        match git_type.as_str() {
            "blob" => {
                assert!(matches!(_parsed, ObjectContents::Blob(_)));
                assert_eq!(obj.data, git_body, "blob body for {spec}");
            }
            "tree" => {
                assert!(matches!(_parsed, ObjectContents::Tree(_)));
                assert_eq!(resolved.kind, ObjectKind::Tree);
                let grit_body = format_tree_cat_file_p(&repo, &obj.data).expect("format tree");
                assert_eq!(grit_body, git_body, "tree cat-file -p body for {spec}");
            }
            "commit" => {
                assert!(matches!(_parsed, ObjectContents::Commit(_)));
                assert_eq!(obj.data, git_body, "commit body for {spec}");
            }
            "tag" => {
                assert!(matches!(_parsed, ObjectContents::Tag(_)));
                assert_eq!(obj.data, git_body, "tag body for {spec}");
            }
            other => panic!("unexpected kind {other} for {spec}"),
        }
    }
}

#[test]
fn cat_commit_non_utf8_payload_matches_git_cat_file_p() {
    use grit_lib::objects::ObjectId;
    use grit_test_support::{git_hash_object_literally, HashAlgo};

    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    commit_file(wt, "base.txt", "x\n", "base");
    let tree = git(wt, &["rev-parse", "HEAD^{tree}"]).trim().to_string();
    let mut body =
        format!("tree {tree}\nauthor Test <t@test> 0 +0000\ncommitter Test <t@test> 0 +0000\n\n")
            .into_bytes();
    body.push(0xff);
    body.extend_from_slice(b"note\n");
    let oid_hex = git_hash_object_literally(wt, HashAlgo::Sha1, "commit", &body)
        .expect("git hash-object --literally");
    let git_body = git_cat_file_p(wt, &oid_hex).expect("git -p");
    let repo = open_grit_repo(wt);
    let oid = ObjectId::from_hex(&oid_hex).expect("hex");
    let obj = repo.read_object_raw_for_display(&oid).expect("read");
    assert_eq!(obj.data, git_body, "commit payload bytes");
    assert_eq!(
        obj.data.len(),
        git_body.len(),
        "byte length vs git cat-file -p"
    );
    assert!(
        !std::str::from_utf8(&obj.data).is_ok(),
        "fixture should contain non-UTF-8"
    );
}

#[test]
fn cat_tree_missing_gitlink_matches_git_cat_file_p() {
    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    commit_file(wt, "f.txt", "x\n", "init");
    let tree_oid = {
        let mut child = Command::new("git")
            .current_dir(wt)
            .args(["mktree"])
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .spawn()
            .expect("mktree");
        writeln!(
            child.stdin.as_mut().expect("stdin"),
            "160000 commit {ABSENT_GITLINK}\tsubmodule"
        )
        .unwrap();
        let out = child.wait_with_output().expect("mktree wait");
        assert!(
            out.status.success(),
            "mktree: {}",
            String::from_utf8_lossy(&out.stderr)
        );
        String::from_utf8(out.stdout).unwrap().trim().to_string()
    };
    let spec = tree_oid.as_str();
    let git_body = git_cat_file_p(wt, spec).expect("git -p");
    assert!(
        git_body
            .split(|&b| b == b'\n')
            .any(|line| line.starts_with(b"160000 commit ")),
        "git should label gitlink as commit: {}",
        String::from_utf8_lossy(&git_body)
    );
    let repo = open_grit_repo(wt);
    let oid = grit_lib::objects::ObjectId::from_hex(&tree_oid).expect("hex");
    let obj = repo.read_object_raw_for_display(&oid).expect("read tree");
    let grit_body = format_tree_cat_file_p(&repo, &obj.data).expect("format tree");
    assert_eq!(grit_body, git_body, "tree with absent gitlink");
}

#[test]
fn cat_nested_tree_directory_mode_matches_git() {
    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    std::fs::create_dir_all(wt.join("dir")).expect("mkdir");
    commit_file(wt, "dir/file", "nested\n", "nested dir");
    let spec = "HEAD^{tree}";
    let git_body = git_cat_file_p(wt, spec).expect("git -p");
    assert!(
        git_body.windows(6).any(|w| w == b"040000"),
        "git should print six-digit tree mode: {}",
        String::from_utf8_lossy(&git_body)
    );
    let repo = open_grit_repo(wt);
    let resolved = repo.resolve(spec).expect("resolve");
    let obj = repo
        .read_object_raw_for_display(&resolved.oid)
        .expect("read");
    let grit_body = format_tree_cat_file_p(&repo, &obj.data).expect("format tree");
    assert_eq!(grit_body, git_body, "nested tree cat-file -p");
}

#[test]
fn resolve_and_cat_follow_replace_refs() {
    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    commit_file(wt, "f.txt", "x\n", "init");
    let head = git_rev_parse_verify(wt, "HEAD").expect("HEAD");
    let blob_body = b"replacement";
    let mut child = Command::new("git")
        .current_dir(wt)
        .args(["hash-object", "-w", "--stdin"])
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .spawn()
        .expect("hash-object");
    child
        .stdin
        .as_mut()
        .expect("stdin")
        .write_all(blob_body)
        .expect("write blob");
    let out = child.wait_with_output().expect("hash-object wait");
    assert!(out.status.success());
    let blob_hex = String::from_utf8(out.stdout).unwrap().trim().to_string();
    let replace_dir = wt.join(".git/refs/replace");
    std::fs::create_dir_all(&replace_dir).expect("mkdir replace");
    std::fs::write(replace_dir.join(head.to_hex()), format!("{blob_hex}\n")).expect("replace ref");

    let repo = open_grit_repo(wt);
    let resolved = repo.resolve("HEAD").expect("resolve HEAD");
    assert_eq!(resolved.oid, head);
    assert_eq!(resolved.kind, ObjectKind::Blob);
    assert_eq!(resolved.size, blob_body.len() as u64);
    assert_eq!(
        git_cat_file_type(wt, "HEAD").as_deref(),
        Some("blob"),
        "git -t HEAD"
    );
    let git_body = git_cat_file_p(wt, "HEAD").expect("git -p");
    let obj = repo
        .read_object_raw_for_display(&resolved.oid)
        .expect("read replaced");
    assert_eq!(obj.data, git_body);
    assert_eq!(obj.data, blob_body);
}

#[test]
fn resolve_and_cat_respect_git_no_replace_objects() {
    let hist = HistoryRepo::init();
    let wt = hist.worktree();
    commit_file(wt, "f.txt", "x\n", "init");
    let head = git_rev_parse_verify(wt, "HEAD").expect("HEAD");
    let blob_body = b"replacement";
    let mut child = Command::new("git")
        .current_dir(wt)
        .args(["hash-object", "-w", "--stdin"])
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .spawn()
        .expect("hash-object");
    child
        .stdin
        .as_mut()
        .expect("stdin")
        .write_all(blob_body)
        .expect("write blob");
    let out = child.wait_with_output().expect("hash-object wait");
    assert!(out.status.success());
    let blob_hex = String::from_utf8(out.stdout).unwrap().trim().to_string();
    std::fs::create_dir_all(wt.join(".git/refs/replace")).expect("mkdir replace");
    std::fs::write(
        wt.join(".git/refs/replace").join(head.to_hex()),
        format!("{blob_hex}\n"),
    )
    .expect("write replace ref");

    let mut env = Environment::empty();
    env.git_no_replace_objects = true;
    let repo = Repository::discover(Some(wt), &RepositoryOptions::with_environment(env))
        .expect("discover");
    let resolved = repo.resolve("HEAD").expect("resolve HEAD");
    assert_eq!(resolved.kind, ObjectKind::Commit);
    assert_eq!(
        git_cat_file_type(wt, "HEAD").as_deref(),
        Some("blob"),
        "git still follows replace for HEAD spec"
    );
    let git_no_replace = Command::new("git")
        .current_dir(wt)
        .env("GIT_NO_REPLACE_OBJECTS", "1")
        .args(["cat-file", "-t", "HEAD"])
        .output()
        .expect("git -t");
    assert!(git_no_replace.status.success());
    assert_eq!(
        String::from_utf8_lossy(&git_no_replace.stdout).trim(),
        "commit"
    );
    assert_eq!(kind_str(resolved.kind), "commit");
}

#[test]
fn ambiguous_short_oid_is_typed_error() {
    let (_dir, bare_repo, prefix) = bare_repo_with_ambiguous_prefix(8_000);
    let err = bare_repo.resolve(&prefix).expect_err("ambiguous");
    match err {
        ResolveError::AmbiguousShortObject { spec, candidates } => {
            assert_eq!(spec, prefix);
            assert!(candidates.len() > 1, "expected multiple candidates");
        }
        other => panic!("expected AmbiguousShortObject, got {other:?}"),
    }
}

fn kind_str(kind: ObjectKind) -> &'static str {
    match kind {
        ObjectKind::Blob => "blob",
        ObjectKind::Tree => "tree",
        ObjectKind::Commit => "commit",
        ObjectKind::Tag => "tag",
    }
}