amont 1.5.0

Opinionated git hooks that judge what you are committing, not what is on disk
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

//! pre-commit-branch-pattern — the push-time contract, said at the first
//! commit instead of after the work is stacked on a name that has to change.
//!
//! The states it must stay QUIET in matter more than the one it speaks in:
//! a warning that fires on detached heads, remoteless repositories or
//! branches the server already accepted trains people to stop reading it —
//! `usual-name`'s lesson, which this check is a second application of.

mod common;
use common::Repo;
use std::process::Command;

fn run_check(r: &Repo) -> (i32, String) {
    let out = Command::new(env!("CARGO_BIN_EXE_amont"))
        .arg("run")
        .arg("pre-commit-branch-pattern")
        .current_dir(&r.dir)
        .output()
        .expect("amont run");
    (
        out.status.code().unwrap_or(-1),
        format!(
            "{}{}",
            String::from_utf8_lossy(&out.stdout),
            String::from_utf8_lossy(&out.stderr)
        ),
    )
}

fn with_remote(r: &Repo) {
    // A configured remote is all the check consults; it never touches the
    // network, so the URL can be nonsense.
    r.git(&["remote", "add", "origin", "/nowhere/in/particular"]);
}

/// A conforming name passes, and says so like the pre-push check does.
#[test]
fn a_conforming_branch_passes() {
    let r = Repo::new();
    r.stage("a.txt", "x\n");
    r.git(&["commit", "-m", "chore: init"]);
    r.git(&["checkout", "-q", "-b", "feat/good-name"]);
    with_remote(&r);
    let (code, out) = run_check(&r);
    assert_eq!(code, 0, "{out}");
    assert!(out.contains("conforms"), "{out}");
}

/// The one state it speaks in: an off-contract name that a remote exists to
/// eventually refuse — warned, with the rename command, and NOT blocking.
#[test]
fn an_off_contract_branch_warns_without_blocking() {
    let r = Repo::new();
    r.stage("a.txt", "x\n");
    r.git(&["commit", "-m", "chore: init"]);
    r.git(&["checkout", "-q", "-b", "definitely-not-conforming"]);
    with_remote(&r);
    let (code, out) = run_check(&r);
    assert_eq!(code, 0, "a warning must not block: {out}");
    assert!(out.contains("refused at push time"), "{out}");
    assert!(out.contains("git branch -m"), "the fix is named: {out}");
}

/// No remote, no contract to gate: a purely local repository stays quiet.
#[test]
fn a_remoteless_repository_is_quiet() {
    let r = Repo::new();
    r.stage("a.txt", "x\n");
    r.git(&["commit", "-m", "chore: init"]);
    r.git(&["checkout", "-q", "-b", "off-pattern"]);
    let (code, out) = run_check(&r);
    assert_eq!(code, 0, "{out}");
    assert!(!out.contains("refused"), "{out}");
}

/// pre-push authorises a branch the server already has by its non-zero
/// remote oid; the remote-tracking ref is the local mirror of that fact, so
/// an off-contract name that predates the contract keeps committing quietly.
#[test]
fn a_branch_the_remote_already_has_is_quiet() {
    let r = Repo::new();
    r.stage("a.txt", "x\n");
    r.git(&["commit", "-m", "chore: init"]);
    r.git(&["checkout", "-q", "-b", "legacy-name"]);
    with_remote(&r);
    r.git(&["update-ref", "refs/remotes/origin/legacy-name", "HEAD"]);
    let (code, out) = run_check(&r);
    assert_eq!(code, 0, "{out}");
    assert!(!out.contains("refused"), "{out}");
}

/// A detached head names no branch — rebase, cherry-pick and bisect all
/// commit from one, and none of those is the moment to discuss naming.
#[test]
fn a_detached_head_is_quiet() {
    let r = Repo::new();
    r.stage("a.txt", "x\n");
    r.git(&["commit", "-m", "chore: init"]);
    with_remote(&r);
    r.git(&["checkout", "-q", "--detach", "HEAD"]);
    let (code, out) = run_check(&r);
    assert_eq!(code, 0, "{out}");
    assert!(!out.contains("refused"), "{out}");
}