zerus 0.15.0

Lightweight tool for creating project-specific and/or general offline crates.io mirrors
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

use std::{fs::File, io::Write, process::Output};

use assert_cmd::Command;
use insta::assert_snapshot;
use tempfile::Builder;

#[test]
fn test_old_nightly_version() {
    let nightly_ver = "nightly-2024-05-19";
    let path = assert_cmd::cargo::cargo_bin("zerus");
    let mut cmd = Command::new(path);

    let tmp_dir = Builder::new().tempdir_in("./").unwrap();
    let tmp_dir_path = tmp_dir.keep();
    let output = cmd
        .env("ZERUS_LOG_TEST", "1") // deterministic log output (no timestamps/ANSI)
        .env("RAYON_NUM_THREADS", "1") // deterministic ordering
        .args([
            "--verbose",
            "mirror",
            tmp_dir_path.to_str().unwrap(),
            "--build-std",
            nightly_ver,
        ])
        .output()
        .unwrap();
    assert_success(&output);

    let rustup_home_output = std::process::Command::new("rustup")
        .args(["show", "home"])
        .output()
        .unwrap();
    let rustup_home = std::str::from_utf8(&rustup_home_output.stdout).unwrap();
    let rustup_home = rustup_home.to_string().replace("\n", "");
    // The full verbose activity log now goes through `tracing` to stderr.
    // `ZERUS_LOG_TEST=1` strips timestamps/ANSI so this is deterministic.
    let output = std::str::from_utf8(&output.stderr).unwrap().to_string();

    // replace Create <TMP_DIR>
    let tmp_dir = tmp_dir_path.to_str().unwrap();
    let output = output.replace(&tmp_dir, "<TMP_DIR>");

    // replace RUSTUP_HOME
    let output = output.replace(&rustup_home, "<RUSTUP_HOME>");

    // replace NIGHTLY_VER
    let output = output.replace(&nightly_ver, "<NIGHTLY_VER>");

    assert_snapshot!(output);

    test_build_std(nightly_ver, tmp_dir_path.to_path_buf(), 8081);
}

#[test]
fn test_new_nightly_version() {
    let nightly_ver = "nightly-2024-10-09";
    let path = assert_cmd::cargo::cargo_bin("zerus");
    let mut cmd = Command::new(path);

    let tmp_dir = Builder::new().tempdir_in("./").unwrap();
    let tmp_dir_path = tmp_dir.keep();
    let output = cmd
        .env("ZERUS_LOG_TEST", "1") // deterministic log output (no timestamps/ANSI)
        .env("RAYON_NUM_THREADS", "1") // deterministic ordering
        .args([
            "--verbose",
            "mirror",
            tmp_dir_path.to_str().unwrap(),
            "--build-std",
            nightly_ver,
        ])
        .output()
        .unwrap();
    assert_success(&output);

    let rustup_home_output = std::process::Command::new("rustup")
        .args(["show", "home"])
        .output()
        .unwrap();
    let rustup_home = std::str::from_utf8(&rustup_home_output.stdout).unwrap();
    let rustup_home = rustup_home.to_string().replace("\n", "");
    // The full verbose activity log now goes through `tracing` to stderr.
    // `ZERUS_LOG_TEST=1` strips timestamps/ANSI so this is deterministic.
    let output = std::str::from_utf8(&output.stderr).unwrap().to_string();

    // replace Create <TMP_DIR>
    let tmp_dir = tmp_dir_path.to_str().unwrap();
    let output = output.replace(&tmp_dir, "<TMP_DIR>");

    // replace RUSTUP_HOME
    let output = output.replace(&rustup_home, "<RUSTUP_HOME>");

    // replace NIGHTLY_VER
    let output = output.replace(&nightly_ver, "<NIGHTLY_VER>");

    assert_snapshot!(output);

    test_build_std(nightly_ver, tmp_dir_path.to_path_buf(), 8080);
}

#[test]
fn test_get_feature_gated() {
    let path = assert_cmd::cargo::cargo_bin("zerus");
    let mut cmd = Command::new(path);

    let tmp_dir = Builder::new().tempdir_in("./").unwrap();
    let tmp_dir_path = tmp_dir.keep();
    let output = cmd
        .env("RUST_LOG", "none")
        .args([
            "--verbose",
            "mirror",
            tmp_dir_path.to_str().unwrap(),
            "--crate",
            "deku@0.20.3",
            "--get-feature-gated",
        ])
        .output()
        .unwrap();
    assert_success(&output);
}

#[test]
fn test_generate_manifest_and_cull() {
    let zerus = assert_cmd::cargo::cargo_bin("zerus");

    let tmp_dir = Builder::new().tempdir_in("./").unwrap();
    let mirror = tmp_dir.path();

    // fake mirror layout: crates/{prefix}/{name}/{version}/{name}-{version}.crate
    let crates = [
        ("se/rd", "serde", "1.0.210"),
        ("to/ki", "tokio", "1.40.0"),
        ("3/s", "syn", "2.0.77"),
    ];
    for (prefix, name, version) in crates {
        let dir = mirror.join("crates").join(prefix).join(name).join(version);
        std::fs::create_dir_all(&dir).unwrap();
        File::create(dir.join(format!("{name}-{version}.crate"))).unwrap();
    }

    // generate-manifest writes sorted name@version lines
    let manifest_path = mirror.join("manifest.txt");
    let output = Command::new(&zerus)
        .args([
            "generate-manifest",
            mirror.to_str().unwrap(),
            "--output",
            manifest_path.to_str().unwrap(),
        ])
        .output()
        .unwrap();
    assert_success(&output);
    assert_eq!(
        std::fs::read_to_string(&manifest_path).unwrap(),
        "serde@1.0.210\nsyn@2.0.77\ntokio@1.40.0\n"
    );

    // manifest of previously transferred crates, including one not on disk
    let transferred = mirror.join("transferred.txt");
    std::fs::write(&transferred, "serde@1.0.210\nsyn@2.0.77\nanyhow@1.0.0\n").unwrap();

    let serde_crate = mirror.join("crates/se/rd/serde/1.0.210/serde-1.0.210.crate");
    let syn_crate = mirror.join("crates/3/s/syn/2.0.77/syn-2.0.77.crate");
    let tokio_crate = mirror.join("crates/to/ki/tokio/1.40.0/tokio-1.40.0.crate");

    // dry-run removes nothing
    let output = Command::new(&zerus)
        .args([
            "cull",
            mirror.to_str().unwrap(),
            transferred.to_str().unwrap(),
            "--dry-run",
        ])
        .output()
        .unwrap();
    assert_success(&output);
    assert!(serde_crate.exists());
    assert!(syn_crate.exists());
    assert!(tokio_crate.exists());

    // cull removes listed crates, prunes empty dirs, and keeps the rest
    let output = Command::new(&zerus)
        .args([
            "cull",
            mirror.to_str().unwrap(),
            transferred.to_str().unwrap(),
        ])
        .output()
        .unwrap();
    assert_success(&output);
    assert!(!serde_crate.exists());
    assert!(!mirror.join("crates/se").exists());
    assert!(!syn_crate.exists());
    assert!(!mirror.join("crates/3").exists());
    assert!(tokio_crate.exists());

    // only the remaining crate shows up in a new manifest
    let output = Command::new(&zerus)
        .args(["generate-manifest", mirror.to_str().unwrap()])
        .output()
        .unwrap();
    assert_success(&output);
    assert_eq!(
        std::str::from_utf8(&output.stdout).unwrap(),
        "tokio@1.40.0\n"
    );
}

fn test_build_std(nightly_ver: &str, tmp_dir_path: std::path::PathBuf, port: u32) {
    // Build our own index from the downloaded .crate files
    let path = assert_cmd::cargo::cargo_bin("zerus");
    let mut cmd = Command::new(path);
    let output = cmd
        .env("RUST_LOG", "none")
        .args([
            "update-index",
            tmp_dir_path.to_str().unwrap(),
            "--dl-url",
            &format!("http://127.0.0.1:{port}"),
        ])
        .output()
        .unwrap();
    assert_success(&output);

    // Create a temp directory for a cargo project
    let tmp_dir_cargo = Builder::new().tempdir_in("./").unwrap();
    let tmp_dir_cargo_path = tmp_dir_cargo.keep();

    // host the crates with a dummy python3 http server
    let _server_handle = std::process::Command::new("python3")
        .args([
            "-m",
            "http.server",
            "-d",
            tmp_dir_path.to_str().unwrap(),
            &port.to_string(),
        ])
        .spawn()
        .expect("python3 server command failed to start");

    // create the cargo project
    std::process::Command::new("cargo")
        .args([&format!("+{nightly_ver}"), "new", "testing"])
        .current_dir(&tmp_dir_cargo_path)
        .output()
        .unwrap();
    std::process::Command::new("mkdir")
        .args(["-p", ".cargo"])
        .current_dir(&tmp_dir_cargo_path.join("testing/"))
        .output()
        .unwrap();
    // write a config file
    // 1. static binary
    // 2. build-std
    // 3. use our crates
    let mut file = File::create(&tmp_dir_cargo_path.join("testing/.cargo/config.toml")).unwrap();
    file.write_all(
        &format!(
            r#"
[source.zerus]
registry = "sparse+http://127.0.0.1:{port}/crates.io-index/"

[source.crates-io]
replace-with = "zerus"

[build]
rustflags = [
    "-C", "panic=abort",
    "-C", "target-feature=+crt-static",
]

[unstable]
build-std = ["std", "panic_abort"]
build-std-features = ["panic_immediate_abort"]
"#,
        )
        .into_bytes(),
    )
    .unwrap();

    // Run cross to create a *-musl binary that will build -Zbuild-std
    // for a specific nightly version
    let output = std::process::Command::new("cross")
        .args([
            &format!("+{nightly_ver}"),
            "build",
            "--target",
            "x86_64-unknown-linux-musl",
        ])
        // Allow access to local python server
        .env("CROSS_CONTAINER_OPTS", "--network=host")
        .current_dir(&tmp_dir_cargo_path.join("testing/"))
        .output()
        .unwrap();
    assert_success(&output);
}

fn assert_success(output: &Output) {
    if !output.status.success() {
        let stdout = String::from_utf8(output.stdout.clone()).unwrap();
        println!("stdout: {}", stdout);
        let stderr = String::from_utf8(output.stderr.clone()).unwrap();
        println!("stderr: {}", stderr);
        panic!("not success");
    }
}