zccache 1.12.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
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

//! Allowed-class gating, proc-macro vs shared-library heuristics, and
//! package-id-based exclusion of workspace/path dependencies. Also
//! covers `package_name_from_id` parsing.

use super::super::*;
use super::{
    sample_plan, synthetic_target, synthetic_target_with_package_exclusions,
    synthetic_target_with_proc_macro_outputs,
};

#[test]
fn thin_plan_respects_explicit_class_gates_for_dependency_metadata_and_outputs() {
    let dir = tempfile::tempdir().unwrap();
    synthetic_target(dir.path());
    let mut plan = sample_plan(dir.path(), RustPlanMode::Thin);
    plan.allowed_artifact_classes = vec![RustArtifactClass::Rlib, RustArtifactClass::Rmeta];
    let cache = dir.path().join("cache");

    let saved = save_rust_plan_local(&plan, &cache).unwrap();
    assert_eq!(saved.saved_file_count, 2);
    assert_eq!(
        saved
            .skipped_reasons
            .get("artifact_class_disallowed_by_plan"),
        Some(&4)
    );
    assert_eq!(
        saved
            .skipped_reasons
            .get("workspace_or_path_dependency_excluded_by_plan"),
        Some(&2)
    );
    assert!(saved
        .skipped_samples
        .iter()
        .any(|sample| sample.path.ends_with("debug/deps/serde-abc.d")));
    assert!(saved.skipped_samples.iter().any(|sample| sample
        .path
        .ends_with("debug/.fingerprint/serde-abc/dep-lib-serde")));
    assert!(saved.skipped_samples.iter().any(|sample| sample
        .path
        .ends_with("debug/build/serde-abc/invoked.timestamp")));
    assert!(saved
        .skipped_samples
        .iter()
        .any(|sample| sample.path.ends_with("debug/build/serde-abc/out/gen.rs")));
}

#[test]
fn thin_plan_saves_and_restores_likely_proc_macro_dylibs_without_shared_libs() {
    let dir = tempfile::tempdir().unwrap();
    synthetic_target_with_proc_macro_outputs(dir.path());
    let mut plan = sample_plan(dir.path(), RustPlanMode::Thin);
    plan.allowed_artifact_classes = vec![
        RustArtifactClass::Rlib,
        RustArtifactClass::Rmeta,
        RustArtifactClass::DepInfo,
        RustArtifactClass::ProcMacro,
        RustArtifactClass::CargoFingerprint,
        RustArtifactClass::BuildScriptMetadata,
        RustArtifactClass::BuildScriptOutput,
    ];
    let cache = dir.path().join("cache");

    let saved = save_rust_plan_local(&plan, &cache).unwrap();
    assert_eq!(saved.saved_file_count, 7);
    assert_eq!(
        saved
            .skipped_reasons
            .get("artifact_class_disallowed_by_plan"),
        Some(&1)
    );
    assert!(saved.skipped_samples.iter().any(|sample| {
        sample
            .path
            .ends_with("debug/deps/libserde_shared-def456.dll")
            || sample
                .path
                .ends_with("debug/deps/libserde_shared-def456.so")
    }));

    std::fs::remove_dir_all(plan.target_dir.as_path()).unwrap();
    let restored = restore_rust_plan_local(&plan, &cache).unwrap();
    assert_eq!(restored.restored_file_count, 7);
    assert!(plan
        .target_dir
        .join(if cfg!(windows) {
            "debug/deps/libproc_macro2-def456.dll"
        } else {
            "debug/deps/libproc_macro2-def456.so"
        })
        .exists());
    assert!(!plan
        .target_dir
        .join(if cfg!(windows) {
            "debug/deps/libserde_shared-def456.dll"
        } else {
            "debug/deps/libserde_shared-def456.so"
        })
        .exists());
}

#[test]
fn thin_plan_skips_likely_proc_macro_dylibs_when_disallowed() {
    let dir = tempfile::tempdir().unwrap();
    synthetic_target_with_proc_macro_outputs(dir.path());
    let mut plan = sample_plan(dir.path(), RustPlanMode::Thin);
    plan.allowed_artifact_classes = vec![
        RustArtifactClass::Rlib,
        RustArtifactClass::Rmeta,
        RustArtifactClass::DepInfo,
        RustArtifactClass::SharedLib,
        RustArtifactClass::CargoFingerprint,
        RustArtifactClass::BuildScriptMetadata,
        RustArtifactClass::BuildScriptOutput,
    ];
    let cache = dir.path().join("cache");

    let saved = save_rust_plan_local(&plan, &cache).unwrap();
    assert_eq!(saved.saved_file_count, 7);
    assert_eq!(
        saved
            .skipped_reasons
            .get("artifact_class_disallowed_by_plan"),
        Some(&1)
    );
    assert!(saved.skipped_samples.iter().any(|sample| {
        sample
            .path
            .ends_with("debug/deps/libproc_macro2-def456.dll")
            || sample.path.ends_with("debug/deps/libproc_macro2-def456.so")
    }));
}

#[test]
fn package_name_parsing_handles_cargo_package_id_shapes() {
    assert_eq!(
        package_name_from_id("registry+https://github.com/rust-lang/crates.io-index#serde@1.0.0"),
        Some("serde".to_string())
    );
    assert_eq!(
        package_name_from_id("path+file:///repo#my-crate@0.1.0"),
        Some("my_crate".to_string())
    );
}

#[test]
fn thin_package_exclusions_match_deps_fingerprint_and_build_by_package_stem() {
    let dir = tempfile::tempdir().unwrap();
    synthetic_target_with_package_exclusions(dir.path());
    let mut plan = sample_plan(dir.path(), RustPlanMode::Thin);
    plan.packages.workspace_package_ids =
        vec!["registry+https://github.com/rust-lang/crates.io-index#app@0.1.0".to_string()];
    plan.packages.excluded_path_package_ids =
        vec!["path+file:///workspace/local_dep#local-dep@0.1.0".to_string()];
    let cache = dir.path().join("cache");

    let saved = save_rust_plan_local(&plan, &cache).unwrap();
    assert_eq!(saved.saved_file_count, 6);
    assert_eq!(
        saved
            .skipped_reasons
            .get("workspace_or_path_dependency_excluded_by_plan"),
        Some(&12)
    );
    assert_eq!(saved.skipped_reasons.get("transient_state"), Some(&1));
    assert!(saved
        .skipped_samples
        .iter()
        .any(|sample| sample.path.ends_with("debug/deps/libapp-abc.rlib")));
    assert!(saved.skipped_samples.iter().any(|sample| sample
        .path
        .ends_with("debug/.fingerprint/app-abc/dep-lib-app")));
    assert!(saved.skipped_samples.iter().any(|sample| sample
        .path
        .ends_with("debug/build/local_dep-abc/out/gen.rs")));
}