git-async 0.1.1

An async-first library for reading git repositories
Documentation 
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

use crate::test::repo::TestRepo;
use std::{
    fs::{self, OpenOptions, read_dir, remove_file},
    io::{self, Write},
    os::unix::ffi::OsStrExt,
};

pub fn make_file(repo: &TestRepo, file_name: impl AsRef<std::path::Path>) -> io::Result<fs::File> {
    let mut f = OpenOptions::new()
        .write(true)
        .create_new(true)
        .open(repo.location.path().join(file_name))?;
    f.flush()?;
    Ok(f)
}

pub fn make_basic_repo() -> io::Result<TestRepo> {
    let repo = TestRepo::new()?;
    make_file(&repo, "a-file")?;
    repo.run_git(["add", "--all"])?;
    repo.commit(
        "a commit",
        "a user",
        "an-email-address",
        "2000-01-01T00:00:00Z",
    )?;
    repo.tag_annotated(
        "a-fat-tag",
        "HEAD",
        "a tag",
        "a user",
        "an-email-address",
        "2000-01-01T00:00:00Z",
    )?;
    make_file(&repo, "another-file")?;
    repo.run_git(["add", "--all"])?;
    repo.run_git(["stash"])?;
    Ok(repo)
}

pub fn make_packfile_repo() -> io::Result<TestRepo> {
    // This test helper is sensitive to git's packfile algorithm.
    // Expected data was generated with git 2.52.0.
    let repo = make_basic_repo()?;
    let head_id = repo
        .run_git(["rev-parse", "HEAD"])
        .unwrap()
        .trim_ascii_end()
        .to_vec();
    assert_eq!(head_id, b"78dc5b70bd81aa46ec7dfce87a69826e354a916b");
    repo.run_git(["gc"])?;
    repo.run_git(["pack-refs", "--all"])?;
    let mut heads_entries = read_dir(repo.location.path().join(".git").join("refs").join("heads"))?;
    assert!(heads_entries.next().is_none());
    let mut tags_entries = read_dir(repo.location.path().join(".git").join("refs").join("tags"))?;
    assert!(tags_entries.next().is_none());
    Ok(repo)
}

pub fn get_pack_id(repo: &TestRepo) -> io::Result<Vec<u8>> {
    let pack_dir_entries = read_dir(
        repo.location
            .path()
            .join(".git")
            .join("objects")
            .join("pack"),
    )?
    .collect::<Result<Vec<_>, _>>()?;
    let mut pack_ids = pack_dir_entries
        .iter()
        .filter_map(|entry| {
            entry
                .file_name()
                .as_bytes()
                .strip_prefix(b"pack-")
                .and_then(|s| s.strip_suffix(b".idx"))
                .map(<[u8]>::to_vec)
        })
        .collect::<Vec<_>>();
    assert_eq!(pack_ids.len(), 1);

    let pack_id = pack_ids.pop().unwrap();
    let idx_file_expected_path = repo
        .location
        .path()
        .join(".git")
        .join("objects")
        .join("pack")
        .join(format!("pack-{}.idx", str::from_utf8(&pack_id).unwrap()));
    assert!(
        OpenOptions::new()
            .read(true)
            .open(idx_file_expected_path)
            .is_ok()
    );
    Ok(pack_id)
}

pub fn make_similar_commits(test_repo: &TestRepo) -> io::Result<()> {
    for chr in 0x61..(0x61 + 26) {
        make_file(test_repo, str::from_utf8(&[chr]).unwrap())?;
    }
    test_repo.run_git(["add", "--all"])?;
    test_repo
        .commit(
            "commit 2",
            "a user",
            "an-email-address",
            "2000-01-01T00:00:00Z",
        )
        .unwrap();
    remove_file(test_repo.location.path().join("m"))?;
    test_repo.run_git(["add", "--all"])?;
    test_repo.commit(
        "commit 3",
        "a user",
        "an-email-address",
        "2000-01-01T00:00:00Z",
    )?;
    remove_file(test_repo.location.path().join("t"))?;
    test_repo.run_git(["add", "--all"])?;
    test_repo.commit(
        "commit 4",
        "a user",
        "an-email-address",
        "2000-01-01T00:00:00Z",
    )?;
    Ok(())
}