grit-lib 0.5.26

Core library for the grit Git implementation
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

//! Loose-ref lock collision and broken-ref update errors.

#![allow(clippy::unwrap_used, clippy::expect_used)]

use crate::support;

use std::fs;

use grit_lib::error::Error;
use grit_lib::objects::ObjectId;
use grit_lib::refs::store::RefStoreError;
use grit_lib::refs::{
    delete_ref, delete_ref_cas, lock_path_for_ref, read_raw_ref,
    verify_refname_available_for_create, write_ref, RawRefLookup,
};
use grit_lib::repo::{InitOptions, Repository};
use std::collections::{BTreeSet, HashSet};
use tempfile::tempdir;

fn oid(byte: u8) -> ObjectId {
    ObjectId::from_bytes(&[byte; 20]).expect("oid")
}

#[test]
fn read_raw_ref_reports_directory_at_ref_path() {
    let dir = tempdir().expect("tempdir");
    Repository::init(
        dir.path(),
        &InitOptions::new()
            .with_initial_branch("main".to_owned())
            .with_ref_storage(grit_lib::RefStorageFormat::Files),
    )
    .expect("init");
    let git_dir = dir.path().join(".git");
    fs::create_dir_all(git_dir.join("refs/heads/dir-as-ref")).expect("dir ref");
    assert!(matches!(
        read_raw_ref(&git_dir, "refs/heads/dir-as-ref").expect("read"),
        RawRefLookup::IsDirectory
    ));
    assert!(matches!(
        read_raw_ref(&git_dir, "refs/heads/no-such-ref").expect("read"),
        RawRefLookup::NotFound
    ));
}

#[test]
fn write_ref_fails_when_lock_file_exists() {
    let dir = tempdir().expect("tempdir");
    Repository::init(
        dir.path(),
        &InitOptions::new()
            .with_initial_branch("main".to_owned())
            .with_ref_storage(grit_lib::RefStorageFormat::Files),
    )
    .expect("init");
    let git_dir = dir.path().join(".git");
    let oid = |n: u8| support::stored_commit(&git_dir, n);
    let ref_path = git_dir.join("refs/heads/locked");
    fs::create_dir_all(ref_path.parent().unwrap()).expect("parent");
    fs::write(&ref_path, format!("{}\n", oid(1).to_hex())).expect("seed");
    let lock_path = lock_path_for_ref(&ref_path);
    fs::write(&lock_path, b"held").expect("lock");
    let is_lock_held = |err: &Error| match err {
        Error::LockHeld { path, .. } => *path == lock_path,
        Error::RefStore(RefStoreError::LockHeld { name }) => name == "refs/heads/locked",
        _ => false,
    };
    let err = write_ref(&git_dir, "refs/heads/locked", &oid(2)).expect_err("lock held");
    assert!(
        is_lock_held(&err),
        "expected a typed lock error, got {err:?}"
    );
    let err = delete_ref_cas(&git_dir, "refs/heads/locked", oid(1)).expect_err("lock held");
    assert!(
        is_lock_held(&err),
        "expected a typed lock error, got {err:?}"
    );
    let err = delete_ref(&git_dir, "refs/heads/locked").expect_err("lock held");
    assert!(
        is_lock_held(&err),
        "expected a typed lock error, got {err:?}"
    );
    assert_eq!(fs::read(&lock_path).expect("foreign lock kept"), b"held");
    assert_eq!(
        fs::read_to_string(&ref_path).expect("ref unchanged"),
        format!("{}\n", oid(1).to_hex())
    );
}

#[test]
fn write_ref_rejects_broken_existing_ref_file() {
    let dir = tempdir().expect("tempdir");
    Repository::init(
        dir.path(),
        &InitOptions::new()
            .with_initial_branch("main".to_owned())
            .with_ref_storage(grit_lib::RefStorageFormat::Files),
    )
    .expect("init");
    let git_dir = dir.path().join(".git");
    fs::write(git_dir.join("refs/heads/broken"), b"not-a-valid-oid\n").expect("broken");
    assert!(write_ref(&git_dir, "refs/heads/broken", &oid(3)).is_err());
}

#[test]
fn delete_ref_cas_and_directory_in_the_way() {
    let dir = tempdir().expect("tempdir");
    Repository::init(
        dir.path(),
        &InitOptions::new()
            .with_initial_branch("main".to_owned())
            .with_ref_storage(grit_lib::RefStorageFormat::Files),
    )
    .expect("init");
    let git_dir = dir.path().join(".git");
    let oid = |n: u8| support::stored_commit(&git_dir, n);
    write_ref(&git_dir, "refs/heads/del", &oid(4)).expect("seed");
    delete_ref_cas(&git_dir, "refs/heads/del", oid(4)).expect("delete");
    write_ref(&git_dir, "refs/heads/parent/leaf", &oid(5)).expect("child");
    assert!(write_ref(&git_dir, "refs/heads/parent", &oid(6)).is_err());
    delete_ref(&git_dir, "refs/heads/parent/leaf").expect("cleanup");
    let extras = BTreeSet::new();
    let skip = HashSet::new();
    assert!(
        verify_refname_available_for_create(&git_dir, "refs/heads/new", &extras, &skip).is_ok()
    );
}