mbx 1.18.0

A build cache for Rust projects
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

//! Keep the developer's own mbx setup out of the integration tests.

use std::process::Command;

/// Hide the developer's own mbx setup from the child: the settings it reads
/// from the environment, and on Unix the directories it reads a global
/// `config.toml` from. `test/test_helper/common_setup.bash` does the same for
/// the Bats suites. Cargo and rustup keep their real homes so the toolchain
/// still resolves.
///
/// Every test names the settings it needs after this, so a scrubbed variable
/// that a test cares about comes back with the test's own value.
pub fn isolate_host(command: &mut Command) -> &mut Command {
    scrub_settings(command);
    #[cfg(unix)]
    {
        let real_home = std::env::var_os("HOME").map(std::path::PathBuf::from);
        for (name, default) in [("CARGO_HOME", ".cargo"), ("RUSTUP_HOME", ".rustup")] {
            let value = std::env::var_os(name)
                .map(std::path::PathBuf::from)
                .or_else(|| real_home.as_ref().map(|home| home.join(default)));
            if let Some(value) = value {
                command.env(name, value);
            }
        }
        let home = isolated_home();
        command
            .env("HOME", home)
            .env("XDG_CACHE_HOME", home.join(".cache"))
            .env("XDG_CONFIG_HOME", home.join(".config"))
            .env("XDG_DATA_HOME", home.join(".local/share"));
    }
    command
}

/// A setting in the environment outranks the same setting in a configuration
/// file, so hiding the file is not enough on its own: an exported
/// `MBX_TARGET_ROOT` moves managed targets out of a test's store exactly as
/// `[target] root` does. Drop the whole namespace rather than name the
/// settings that bite today, since the next one to bite would arrive silently.
///
/// `MBX_LOG` stays. It only raises mbx's own diagnostics, and running one of
/// these tests under it is how a developer sees what mbx did. The extra stderr
/// it produces can fail a test that asserts on stderr, which is a deliberate
/// act rather than something the machine decides.
///
/// This applies on every platform. Windows resolves the configuration
/// directory through known-folder APIs rather than the environment, so a
/// global `config.toml` on a Windows developer's machine is still visible
/// here; isolating it needs a way to point mbx at a different file.
fn scrub_settings(command: &mut Command) {
    for (name, _) in std::env::vars_os() {
        let key = name.to_string_lossy().to_ascii_uppercase();
        if key.starts_with("MBX_") && key != "MBX_LOG" {
            command.env_remove(&name);
        }
    }
}

/// Shared by every test in the run, as the real home was. No test writes mbx
/// configuration, so a global configuration file never exists here.
#[cfg(unix)]
fn isolated_home() -> &'static std::path::Path {
    static HOME: std::sync::OnceLock<std::path::PathBuf> = std::sync::OnceLock::new();
    HOME.get_or_init(|| {
        let home = std::path::Path::new(env!("CARGO_TARGET_TMPDIR")).join("isolated-home");
        std::fs::create_dir_all(&home).unwrap();
        home
    })
}