amont 1.48.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
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

//! The Rust checks and the toolchain pin: the cargo that answers must be the
//! one the repository pins, or the check says so rather than judging with
//! another.
#![cfg(unix)]

mod common;
use common::Repo;

use std::os::unix::fs::PermissionsExt;
use std::process::{Command, Stdio};

/// A fake `cargo` that reports one version and accepts every subcommand.
fn shim_cargo(r: &Repo, version: &str) {
    let dir = r.path(".git/toolshims");
    std::fs::create_dir_all(&dir).expect("mkdir");
    let p = dir.join("cargo");
    std::fs::write(
        &p,
        format!(
            "#!/bin/sh\ncase \"$1\" in --version) echo \"cargo {version} (fake)\";; esac\nexit 0\n"
        ),
    )
    .expect("write");
    std::fs::set_permissions(&p, std::fs::Permissions::from_mode(0o755)).expect("chmod");
}

/// A fake `rustup` whose `run <pin> cargo …` runs the shim cargo — a rustup
/// that has the pinned toolchain — and which records the pin it was asked
/// for. Without it the host's rustup, when there is one, would answer for
/// its own toolchains and the test would be about the host.
fn shim_rustup(r: &Repo) {
    let dir = r.path(".git/toolshims");
    let cargo = dir.join("cargo");
    let asked = dir.join("rustup-asked");
    let p = dir.join("rustup");
    std::fs::write(
        &p,
        format!(
            "#!/bin/sh\nif [ \"$1\" = run ]; then echo \"$2\" >> \"{}\"; shift 3; exec \"{}\" \"$@\"; fi\nexit 1\n",
            asked.display(),
            cargo.display()
        ),
    )
    .expect("write");
    std::fs::set_permissions(&p, std::fs::Permissions::from_mode(0o755)).expect("chmod");
}

/// The shim directory first on PATH; the real PATH follows for git.
fn shimmed_path(r: &Repo) -> String {
    format!(
        "{}:{}",
        r.path(".git/toolshims").display(),
        std::env::var("PATH").unwrap_or_default()
    )
}

fn clippy(r: &Repo) -> (i32, String) {
    clippy_with_path(r, &shimmed_path(r))
}

/// The same check with an explicit PATH: the no-rustup case needs one that
/// carries git and nothing of the host's toolchains.
fn clippy_with_path(r: &Repo, path: &str) -> (i32, String) {
    let out = Command::new(env!("CARGO_BIN_EXE_amont"))
        .arg("--hooks-dir")
        .arg(r.path(".git/hooks"))
        .arg("pre-commit-clippy")
        .current_dir(&r.dir)
        .env("PATH", path)
        .stdin(Stdio::null())
        .output()
        .expect("run");
    (
        out.status.code().unwrap_or(-1),
        format!(
            "{}{}",
            String::from_utf8_lossy(&out.stdout),
            String::from_utf8_lossy(&out.stderr)
        ),
    )
}

fn rust_repo(pin: &str) -> Repo {
    let r = Repo::new();
    r.stage(
        "Cargo.toml",
        "[package]\nname = \"x\"\nversion = \"0.1.0\"\nedition = \"2021\"\n",
    );
    r.stage("src/lib.rs", "pub fn x() {}\n");
    r.stage(
        "rust-toolchain.toml",
        &format!("[toolchain]\nchannel = \"{pin}\"\n"),
    );
    r
}

#[test]
fn a_cargo_that_is_not_the_pinned_toolchain_fails_the_check() {
    let r = rust_repo("9.99.0");
    shim_cargo(&r, "1.0.0");
    shim_rustup(&r);
    let (code, out) = clippy(&r);
    assert_ne!(code, 0, "must not judge with the wrong toolchain: {out}");
    assert!(
        out.contains("cargo is 1.0.0") && out.contains("pins 9.99.0"),
        "names both versions: {out}"
    );
    assert!(out.contains("rustup shim"), "names the fix: {out}");
}

#[test]
fn the_pinned_toolchain_runs_the_check_through_rustup() {
    let r = rust_repo("1.0.0");
    shim_cargo(&r, "1.0.0");
    shim_rustup(&r);
    let (code, out) = clippy(&r);
    assert_eq!(
        code, 0,
        "the pin matches, clippy (the shim) runs and passes: {out}"
    );
    assert!(!out.contains("pins"), "no mismatch talk: {out}");
    // Every cargo call went through `rustup run <pin>`: that is what keeps
    // one toolchain for the rustc processes cargo spawns.
    let asked = std::fs::read_to_string(r.path(".git/toolshims/rustup-asked")).unwrap_or_default();
    assert!(
        !asked.is_empty() && asked.lines().all(|l| l == "1.0.0"),
        "rustup was asked for the pin on every call: {asked:?}"
    );
}

#[test]
fn a_pin_rustup_does_not_have_names_the_install() {
    let r = rust_repo("1.0.0");
    shim_cargo(&r, "1.0.0");
    // A rustup on PATH that has no such toolchain: `run` fails, nothing answers.
    let p = r.path(".git/toolshims/rustup");
    std::fs::write(&p, "#!/bin/sh\nexit 1\n").expect("write");
    std::fs::set_permissions(&p, std::fs::Permissions::from_mode(0o755)).expect("chmod");
    let (code, out) = clippy(&r);
    assert_ne!(code, 0, "{out}");
    assert!(out.contains("rustup toolchain install 1.0.0"), "{out}");
}

#[test]
fn a_channel_name_is_left_to_rustup() {
    let r = rust_repo("stable");
    shim_cargo(&r, "1.0.0");
    shim_rustup(&r);
    let (code, out) = clippy(&r);
    assert_eq!(code, 0, "nothing to hold `stable` against: {out}");
}

/// No rustup to ask: the first cargo on PATH is used, and still held against
/// the pin. PATH is the shim dir plus the system dirs — git, no rustup, no
/// cargo of the host's — so the host cannot answer for the test.
fn bare_path(r: &Repo) -> String {
    format!("{}:/usr/bin:/bin", r.path(".git/toolshims").display())
}

#[test]
fn without_rustup_the_path_cargo_is_used_and_still_checked() {
    let r = rust_repo("1.0.0");
    shim_cargo(&r, "1.0.0");
    let (code, out) = clippy_with_path(&r, &bare_path(&r));
    assert_eq!(code, 0, "fallback cargo matches the pin: {out}");

    let r = rust_repo("2.0.0");
    shim_cargo(&r, "1.0.0");
    let (code, out) = clippy_with_path(&r, &bare_path(&r));
    assert_ne!(code, 0, "fallback cargo does not match the pin: {out}");
    assert!(
        out.contains("cargo is 1.0.0") && out.contains("pins 2.0.0"),
        "{out}"
    );
}

/// A `cargo` shim that answers the version probes and records every clippy
/// call as `<cwd> <args>`.
fn recording_cargo(r: &Repo) -> std::path::PathBuf {
    let dir = r.path(".git/toolshims");
    std::fs::create_dir_all(&dir).expect("mkdir");
    let log = dir.join("calls");
    let p = dir.join("cargo");
    std::fs::write(
        &p,
        format!(
            "#!/bin/sh\ncase \"$1\" in\n  --version) echo 'cargo 1.0.0 (fake)';;\n  \
             clippy) [ \"$2\" = --version ] && {{ echo clippy; exit 0; }}; \
             echo \"$PWD $*\" >> \"{}\";;\nesac\nexit 0\n",
            log.display()
        ),
    )
    .expect("write");
    std::fs::set_permissions(&p, std::fs::Permissions::from_mode(0o755)).expect("chmod");
    log
}

/// Pre-commit clippy judges the package that owns the staged source, from
/// its own root and without `--workspace`; a staged lockfile makes it judge
/// the whole workspace (ADR-0009, `hooks.clippy-scope`).
#[test]
fn clippy_judges_the_staged_package_unless_the_lockfile_is_staged() {
    let r = Repo::new();
    r.stage(
        "Cargo.toml",
        "[workspace]\nmembers = [\"crates/a\", \"crates/b\"]\nresolver = \"2\"\n",
    );
    for c in ["a", "b"] {
        r.stage(
            &format!("crates/{c}/Cargo.toml"),
            &format!("[package]\nname = \"{c}\"\nversion = \"0.1.0\"\nedition = \"2021\"\n"),
        );
        r.stage(&format!("crates/{c}/src/lib.rs"), "pub fn x() {}\n");
    }
    r.stage("Cargo.lock", "version = 3\n");
    r.commit("init");
    let log = recording_cargo(&r);
    let path = shimmed_path(&r);

    r.stage("crates/a/src/lib.rs", "pub fn x() {}\npub fn y() {}\n");
    let (code, out) = clippy_with_path(&r, &path);
    assert_eq!(code, 0, "{out}");
    let calls = std::fs::read_to_string(&log).unwrap_or_default();
    assert!(
        calls.lines().count() == 1
            && calls.contains("crates/a clippy --all-targets")
            && !calls.contains("--workspace"),
        "one call, in crates/a, without --workspace:\n{calls}"
    );

    std::fs::remove_file(&log).expect("reset");
    r.stage("Cargo.lock", "version = 3\n# bumped\n");
    let (code, out) = clippy_with_path(&r, &path);
    assert_eq!(code, 0, "{out}");
    let calls = std::fs::read_to_string(&log).unwrap_or_default();
    assert!(
        calls.contains("clippy --workspace"),
        "a staged lockfile judges the workspace:\n{calls}"
    );
}