monochromatic-git-policy-cli 0.5.31

Repository-owned Git policy wrapper: forwards Git commands and checks commits against configured policies.
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

//! What:
//!  Controls for the notices about reference locks and the quoting of the command that clears one.
//! Why:
//!  The command is meant to be pasted into a shell, and the names in it come from the file system, so the controls run the
//!  quoted words through a real shell and require that exactly the named file goes. The wording is pinned as printed.
//!
//! In TS you'd write (pseudocode):
//! ```ts
//! expect(outcome.notice()).toBe("cli-git: left the reference lock ... alone: ...\ncli-git:   rm -- '...'\n");
//! ```
#![cfg(unix)]

use super::*;
use crate::test_support::{fixture, remove};
use std::ffi::OsString;
use std::os::unix::ffi::OsStringExt;
use std::process::Command;

/// A finding with the facts the notice words, and none that vary between runs.
fn found(lock: &str, verdict: Verdict, pid_file: PidFile, companions: &[&str]) -> Found {
    return Found {
        lock: PathBuf::from(lock),
        verdict,
        size: 0,
        born: None,
        pid_file,
        companions: companions.iter().map(PathBuf::from).collect(),
    };
}

/// Names that a shell or a terminal could misread, each of which must survive a trip through `bash -c "rm -- <quoted>"`.
fn awkward_names() -> Vec<OsString> {
    return vec![
        OsString::from("plain.lock"),
        OsString::from("with space.lock"),
        OsString::from("it's$(touch${IFS}pwned);`id`&x|(y).lock"),
        OsString::from("new\nline.lock"),
        OsString::from("escape\u{1b}[31mred.lock"),
        OsString::from("tab\there\\back.lock"),
        OsString::from_vec(vec![b'n', b'o', b't', 0xff, 0xfe, b'.', b'l', b'o', b'c', b'k']),
        OsString::from("-leading-dash.lock"),
    ];
}

/// Every awkward name, quoted, clears exactly its own file in a real shell and runs nothing.
#[test]
fn quoted_names_name_exactly_their_files_in_a_real_shell() {
    let root: PathBuf = fixture("stale-message-quoting");
    for name in awkward_names() {
        let directory: PathBuf = root.join("d");
        std::fs::create_dir_all(directory.as_path()).expect("directory");
        let target: PathBuf = directory.join(&name);
        let bystander: PathBuf = directory.join("bystander");
        std::fs::write(target.as_path(), "").expect("target");
        std::fs::write(bystander.as_path(), "").expect("bystander");
        let command: String = format!("cd \"$1\" && rm -- {}", shell_quote(Path::new(&name)));
        let ran = Command::new("bash").arg("-c").arg(command.as_str()).arg("bash").arg(directory.as_os_str()).output().expect("start bash");
        assert!(ran.status.success(), "{command}: {}", String::from_utf8_lossy(&ran.stderr));
        assert!(!target.exists() && bystander.exists(), "{command}");
        assert!(!directory.join("pwned").exists() && !root.join("pwned").exists(), "{command} ran something");
        assert!(!shell_quote(Path::new(&name)).contains('\u{1b}'), "a terminal escape is printed raw");
        remove(directory.as_path());
    }
    remove(root.as_path());
}

/// A plain name is not quoted, a name with a single quote has it written `'\''`, and an empty name is quoted.
#[test]
fn quoting_leaves_plain_names_alone_and_escapes_single_quotes() {
    assert_eq!(shell_quote(Path::new("/repo/.git/refs/heads/main.lock")), "/repo/.git/refs/heads/main.lock");
    assert_eq!(shell_quote(Path::new("/r/it's.lock")), "'/r/it'\\''s.lock'");
    assert_eq!(shell_quote(Path::new("")), "''");
}

/// The notice for a lock that nothing proves stale, as printed, with the command that clears it and its companions.
#[test]
fn an_unproven_lock_is_described_with_the_command_that_clears_it() {
    let outcome: Outcome = Outcome {
        left: vec![found("/r/.git/refs/remotes/origin/main.lock", Verdict::Unproven(String::from("no pid file beside it names a holder")), PidFile::Absent, &[])],
        ..Outcome::default()
    };
    let expected: &str = "cli-git: left the reference lock /r/.git/refs/remotes/origin/main.lock alone: no pid file beside it names a holder.\n\
cli-git: it is 0 bytes. If no Git process is running in this repository, clear it with:\n\
cli-git:   rm -- /r/.git/refs/remotes/origin/main.lock\n\
cli-git: Git writes a process number beside its locks only when `core.lockfilePid` is on. The wrapper turns it on for the Git it starts; `git config --global core.lockfilePid true` does it for the rest, so the next lock can be proven.\n";
    assert_eq!(outcome.notice(), expected);
}

/// The packed-references lock names its pid file and staging file in the command, and a lock of an adversarial name is quoted.
#[test]
fn the_command_names_the_companions_and_quotes_an_odd_reference() {
    let outcome: Outcome = Outcome {
        left: vec![
            found("/r/.git/packed-refs.lock", Verdict::Unproven(String::from("why")), PidFile::Older(7), &["/r/.git/packed-refs~pid.lock", "/r/.git/packed-refs.new"]),
            found("/r/.git/refs/heads/it's$(x).lock", Verdict::Unproven(String::from("why")), PidFile::Older(7), &[]),
        ],
        ..Outcome::default()
    };
    let text: String = outcome.notice();
    assert!(text.contains("cli-git:   rm -- /r/.git/packed-refs.lock '/r/.git/packed-refs~pid.lock' /r/.git/packed-refs.new\n"), "{text}");
    assert!(text.contains("cli-git:   rm -- '/r/.git/refs/heads/it'\\''s$(x).lock'\n"), "{text}");
    assert!(!text.contains("core.lockfilePid"), "the hint is only for locks without a pid file: {text}");
}

/// The notice for a removed lock, and for a lock a running process holds, as printed.
#[test]
fn a_removed_lock_and_a_held_lock_are_worded_as_printed() {
    let outcome: Outcome = Outcome {
        cleared: vec![
            found("/r/.git/refs/heads/a.lock", Verdict::Stale(Proof::PidGone(41)), PidFile::Names(41), &[]),
            found("/r/.git/refs/heads/b.lock", Verdict::Stale(Proof::PidReused { pid: 42, command: String::from("sleep") }), PidFile::Names(42), &[]),
            found("/r/.git/packed-refs.new", Verdict::Stale(Proof::OrphanStaging), PidFile::Absent, &[]),
        ],
        left: vec![found("/r/.git/refs/heads/d.lock", Verdict::Held(String::from("process 43 (git), which the pid file beside it names, is running")), PidFile::Names(43), &[])],
        displaced: vec![PathBuf::from("/r/.git/cli-git-stale-lock-1-0-ff")],
    };
    let expected: &str = "cli-git: removed the reference lock /r/.git/refs/heads/a.lock, left by a Git that is gone: process 41, named by the pid file beside it, has ended.\n\
cli-git: removed the reference lock /r/.git/refs/heads/b.lock, left by a Git that is gone: process 42, named by the pid file beside it, has ended and the number now belongs to `sleep`.\n\
cli-git: removed the packed-references staging file /r/.git/packed-refs.new, left by a Git that is gone: Git makes this staging file only while it holds `packed-refs.lock`, and that lock is gone.\n\
cli-git: the reference lock /r/.git/refs/heads/d.lock is in use: process 43 (git), which the pid file beside it names, is running; it was left alone.\n\
cli-git: a lock file was set aside while a new lock took its place, and is left at /r/.git/cli-git-stale-lock-1-0-ff; look at it before removing it.\n";
    assert_eq!(outcome.notice(), expected);
}

/// A pass that found nothing to say prints nothing.
#[test]
fn a_pass_with_nothing_to_say_prints_nothing() {
    assert_eq!(Outcome::default().notice(), "");
}