grit-lib 0.5.25

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
128
129
130

//! Sign-off and `(cherry picked from commit …)` rewriting vs system `git commit -s` and
//! `git cherry-pick -x`.

use std::path::Path;

use grit_lib::commit::trailers::{
    append_signoff_trailer, finalize_cherry_pick_message, format_signoff_line,
};
use grit_lib::config::environment::Environment;
use grit_lib::config::ConfigSet;
use grit_test_support::git;
use tempfile::TempDir;

/// Identity `grit_test_support::git` commits with.
const NAME: &str = "Test";
const EMAIL: &str = "test@example.com";

const MESSAGES: &[&str] = &[
    "Subject\n",
    "Subject\n\nBody text.\n",
    "Subject\n\nOneWordBodyThatsNotA-S-o-B\n",
    "Subject\n\nSigned-off-by: Test <test@example.com>\n",
    "Subject\n\nSigned-off-by: Test <test@example.com>\nAcked-by: X\n",
    "Subject\n\nSigned-off-by: A <a@example.com>\n",
    "Subject\n\nAcked-by: X\n",
    "Subject\n\nBody\n\nack: someone\n",
    "Subject\n\nfree text\nmore text\nmore\nSigned-off-by: A <a@example.com>\n",
    "Subject\n\nBody\n\nReviewed-by: Y\n  continued\n",
    "Subject\n\n(cherry picked from commit 0123456789abcdef0123456789abcdef01234567)\n",
];

/// Messages compared only against `git commit --signoff`.
const SIGNOFF_ONLY_MESSAGES: &[&str] = &["Signed-off-by: Test <test@example.com>\n"];

fn init_repo(config: &[(&str, &str)]) -> TempDir {
    let dir = TempDir::new().expect("tempdir");
    git(dir.path(), &["init", "-q", "-b", "main", "."]);
    for (key, value) in config {
        git(dir.path(), &["config", key, value]);
    }
    git(dir.path(), &["commit", "-q", "--allow-empty", "-m", "base"]);
    git(dir.path(), &["tag", "base"]);
    dir
}

fn repo_config(repo: &Path) -> ConfigSet {
    ConfigSet::load(&Environment::empty(), Some(&repo.join(".git")), false).expect("load config")
}

/// Commits `message` verbatim on top of `base` and returns the new commit id.
fn commit_verbatim(repo: &Path, message: &str, extra: &[&str]) -> String {
    let msg_path = repo.join(".git/TEST_MSG");
    std::fs::write(&msg_path, message).expect("write message");
    let msg_arg = msg_path.to_string_lossy().into_owned();
    let mut args = vec!["commit", "-q", "--cleanup=verbatim", "-F", &msg_arg];
    args.extend_from_slice(extra);
    git(repo, &args);
    git(repo, &["rev-parse", "HEAD"]).trim().to_string()
}

fn head_message(repo: &Path) -> String {
    let raw = git(repo, &["cat-file", "commit", "HEAD"]);
    raw.split_once("\n\n")
        .map(|(_, message)| message.trim_end().to_string())
        .expect("commit message")
}

fn assert_signoff_matches_git(config: &[(&str, &str)]) {
    let dir = init_repo(config);
    let repo = dir.path();
    let cfg = repo_config(repo);
    let sob = format_signoff_line(NAME, EMAIL);
    for message in MESSAGES.iter().chain(SIGNOFF_ONLY_MESSAGES) {
        git(repo, &["reset", "-q", "--hard", "base"]);
        commit_verbatim(repo, message, &["--allow-empty", "--signoff"]);
        let mut grit = (*message).to_string();
        append_signoff_trailer(&mut grit, &sob, &cfg);
        // Trailing newlines are compared loosely: the git helper may trim its output.
        assert_eq!(grit.trim_end(), head_message(repo), "message {message:?}");
    }
}

fn assert_cherry_pick_matches_git(config: &[(&str, &str)]) {
    let dir = init_repo(config);
    let repo = dir.path();
    let cfg = repo_config(repo);
    for (i, message) in MESSAGES.iter().enumerate() {
        for signoff in [false, true] {
            git(repo, &["reset", "-q", "--hard", "base"]);
            let file = format!("f{i}.txt");
            std::fs::write(repo.join(&file), format!("{i}\n")).expect("write file");
            git(repo, &["add", &file]);
            let picked = commit_verbatim(repo, message, &[]);
            git(repo, &["reset", "-q", "--hard", "base"]);
            let mut args = vec!["cherry-pick", "-x"];
            if signoff {
                args.push("-s");
            }
            args.push(&picked);
            git(repo, &args);
            let grit =
                finalize_cherry_pick_message(message, true, signoff, NAME, EMAIL, &cfg, &picked);
            assert_eq!(
                grit.trim_end(),
                head_message(repo),
                "message {message:?}, signoff {signoff}"
            );
        }
    }
}

#[test]
fn signoff_matches_git_commit_signoff() {
    assert_signoff_matches_git(&[]);
}

#[test]
fn signoff_with_trailer_alias_matches_git_commit_signoff() {
    assert_signoff_matches_git(&[("trailer.ack.key", "Acked-by")]);
}

#[test]
fn cherry_pick_origin_line_matches_git_cherry_pick_x() {
    assert_cherry_pick_matches_git(&[]);
}

#[test]
fn cherry_pick_origin_line_with_trailer_alias_matches_git_cherry_pick_x() {
    assert_cherry_pick_matches_git(&[("trailer.ack.key", "Acked-by")]);
}