stow-cli 0.4.1

CLI that routes rustc invocations through the stow public artifact cache
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

//! The `rustc` wrapper's stdout must stay byte-identical to the wrapped
//! compiler's.
//!
//! Cargo probes `rustc -vV` *through* `RUSTC_WRAPPER` and hashes the
//! resulting version string into every unit's `-C metadata`. One log line
//! on stdout changes that hash — and because each line carries a timestamp,
//! it changes on every invocation, so no dependency can ever hit the cache
//! and any package with a build script fails outright.

use std::process::Command;

fn rustc_path() -> String {
    std::env::var("RUSTC").unwrap_or_else(|_| "rustc".to_owned())
}

fn plain_version_output() -> Vec<u8> {
    let output = Command::new(rustc_path())
        .arg("-vV")
        .output()
        .expect("run rustc -vV");
    assert!(output.status.success(), "rustc -vV failed");
    output.stdout
}

fn wrapper_version_output(env: &[(&str, &str)]) -> Vec<u8> {
    let mut command = Command::new(env!("CARGO_BIN_EXE_stow-cli"));
    command.arg("rustc").arg(rustc_path()).arg("-vV");
    command.env_remove("RUST_LOG");
    for (key, value) in env {
        command.env(key, value);
    }
    let output = command.output().expect("run stow-cli rustc -vV");
    assert!(
        output.status.success(),
        "stow-cli rustc -vV failed: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    output.stdout
}

#[test]
fn rustc_probe_stdout_is_never_polluted_by_logging() {
    let expected = plain_version_output();

    // Every combination of log filter and the wrapper-tracing escape hatch
    // must leave stdout untouched.
    for rust_log in ["", "info", "debug", "trace", "stow_cli=trace"] {
        for trace_wrapped in ["", "0", "1"] {
            let mut env = Vec::new();
            if !rust_log.is_empty() {
                env.push(("RUST_LOG", rust_log));
            }
            if !trace_wrapped.is_empty() {
                env.push(("STOW_TRACE_WRAPPED_COMPILERS", trace_wrapped));
            }
            let actual = wrapper_version_output(&env);
            assert_eq!(
                String::from_utf8_lossy(&actual),
                String::from_utf8_lossy(&expected),
                "stdout differs with RUST_LOG={rust_log:?} \
                 STOW_TRACE_WRAPPED_COMPILERS={trace_wrapped:?}"
            );
        }
    }
}