zccache 1.11.8

Local-first compiler cache for C/C++/Rust/Emscripten
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

//! Tests for `run_post_link_deploy_hook`.
//!
//! These tests use a tiny helper program that writes a file next to the
//! provided output path and exits 0, simulating a real deploy tool like
//! `clang-tool-chain-libdeploy`. They verify:
//!   - the hook runs when invoked
//!   - failures don't panic / propagate (hook is best-effort)
//!   - the env is propagated

use super::super::*;

/// Run the hook with a command that creates a sidecar file next to the
/// output. Verifies the sidecar appears — this is the contract that
/// `side_effect::detect_side_effects` relies on.
#[cfg(unix)] // uses /bin/sh; Windows has its own test below
#[tokio::test]
async fn post_link_deploy_hook_runs_and_creates_sidecar() {
    let dir = tempfile::tempdir().unwrap();
    let output = dir.path().join("app");
    std::fs::write(&output, b"binary").unwrap();

    // Fake deploy tool: creates a sidecar DLL next to the passed path.
    let script = dir.path().join("fake_deploy.sh");
    std::fs::write(
        &script,
        "#!/bin/sh\ntouch \"$(dirname \"$1\")/libruntime.so\"\n",
    )
    .unwrap();
    std::process::Command::new("chmod")
        .args(["+x"])
        .arg(&script)
        .status()
        .unwrap();

    let cmd_str = script.to_string_lossy().to_string();
    let lineage = super::super::super::lineage::Lineage::current(None, None);
    run_post_link_deploy_hook(&cmd_str, &output, None, &lineage).await;

    assert!(
        dir.path().join("libruntime.so").exists(),
        "hook should have created the sidecar"
    );
}

/// Hook that exits non-zero must not panic — failures are best-effort.
#[cfg(unix)]
#[tokio::test]
async fn post_link_deploy_hook_failure_is_non_fatal() {
    let dir = tempfile::tempdir().unwrap();
    let output = dir.path().join("app");
    std::fs::write(&output, b"binary").unwrap();

    // Just exit 1 — no side effect.
    let lineage = super::super::super::lineage::Lineage::current(None, None);
    run_post_link_deploy_hook("false", &output, None, &lineage).await;
    // If we reached here without panic, the test passes. A warning should
    // have been logged by the hook.
}

/// Nonexistent program — hook should log a warning, not panic.
#[tokio::test]
async fn post_link_deploy_hook_nonexistent_program_is_non_fatal() {
    let dir = tempfile::tempdir().unwrap();
    let output = dir.path().join("app.dll");
    std::fs::write(&output, b"binary").unwrap();

    let lineage = super::super::super::lineage::Lineage::current(None, None);
    run_post_link_deploy_hook(
        "this-program-does-not-exist-zccache-test-12345",
        &output,
        None,
        &lineage,
    )
    .await;
    // No panic = pass.
}

/// Empty command string — must early-return without attempting to spawn.
#[tokio::test]
async fn post_link_deploy_hook_empty_cmd_is_noop() {
    let dir = tempfile::tempdir().unwrap();
    let output = dir.path().join("app.dll");
    std::fs::write(&output, b"binary").unwrap();

    let lineage = super::super::super::lineage::Lineage::current(None, None);
    run_post_link_deploy_hook("", &output, None, &lineage).await;
    run_post_link_deploy_hook("   ", &output, None, &lineage).await;
    // No panic = pass.
}

/// Env is propagated to the hook process.
#[cfg(unix)]
#[tokio::test]
async fn post_link_deploy_hook_propagates_env() {
    let dir = tempfile::tempdir().unwrap();
    let output = dir.path().join("app");
    std::fs::write(&output, b"binary").unwrap();

    // Script reads $ZCCACHE_TEST_MARKER from env and writes it to a
    // marker file next to the output.
    let script = dir.path().join("read_env.sh");
    std::fs::write(
        &script,
        "#!/bin/sh\nprintf '%s' \"$ZCCACHE_TEST_MARKER\" > \"$(dirname \"$1\")/marker.txt\"\n",
    )
    .unwrap();
    std::process::Command::new("chmod")
        .args(["+x"])
        .arg(&script)
        .status()
        .unwrap();

    let env = vec![
        (
            "PATH".to_string(),
            std::env::var("PATH").unwrap_or_default(),
        ),
        ("ZCCACHE_TEST_MARKER".to_string(), "hello-hook".to_string()),
    ];
    let lineage = super::super::super::lineage::Lineage::current(None, None);
    run_post_link_deploy_hook(&script.to_string_lossy(), &output, Some(&env), &lineage).await;

    let marker = std::fs::read_to_string(dir.path().join("marker.txt")).unwrap();
    assert_eq!(marker, "hello-hook");
}