cargo-reclaim 0.2.2

Safe Cargo cleanup for target directories, stale artifacts, and Cargo home caches
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

use std::ffi::OsStr;

use super::foundation::{ActiveObservationProvider, ActiveObservationScope};

pub const DISABLE_ACTIVE_PROCESS_DETECTION_ENV: &str =
    "CARGO_RECLAIM_DISABLE_ACTIVE_PROCESS_DETECTION";

pub fn platform_active_observation_provider() -> impl ActiveObservationProvider {
    PlatformActiveObservationProvider
}

struct PlatformActiveObservationProvider;

impl ActiveObservationProvider for PlatformActiveObservationProvider {
    fn observe(&self, scope: &ActiveObservationScope) -> crate::planner::ActiveObservation {
        if active_process_detection_disabled() {
            return crate::planner::ActiveObservation::not_attempted();
        }

        #[cfg(target_os = "linux")]
        {
            super::procfs::ProcfsActiveObservationProvider::default().observe(scope)
        }

        #[cfg(not(target_os = "linux"))]
        {
            super::sysinfo_provider::SysinfoActiveObservationProvider.observe(scope)
        }
    }
}

fn active_process_detection_disabled() -> bool {
    std::env::var_os(DISABLE_ACTIVE_PROCESS_DETECTION_ENV)
        .as_deref()
        .is_some_and(disable_env_value_is_truthy)
}

fn disable_env_value_is_truthy(value: &OsStr) -> bool {
    let value = value.to_string_lossy();
    let value = value.trim();
    !value.is_empty()
        && !matches!(
            value.to_ascii_lowercase().as_str(),
            "0" | "false" | "no" | "off"
        )
}

#[cfg(test)]
mod tests {
    use std::ffi::OsStr;

    use super::disable_env_value_is_truthy;

    #[test]
    fn disable_active_process_detection_env_parses_truthy_values() {
        assert!(disable_env_value_is_truthy(OsStr::new("1")));
        assert!(disable_env_value_is_truthy(OsStr::new("true")));
        assert!(disable_env_value_is_truthy(OsStr::new("yes")));
        assert!(disable_env_value_is_truthy(OsStr::new("ON")));
    }

    #[test]
    fn disable_active_process_detection_env_ignores_falsey_values() {
        assert!(!disable_env_value_is_truthy(OsStr::new("")));
        assert!(!disable_env_value_is_truthy(OsStr::new("0")));
        assert!(!disable_env_value_is_truthy(OsStr::new("false")));
        assert!(!disable_env_value_is_truthy(OsStr::new("no")));
        assert!(!disable_env_value_is_truthy(OsStr::new("off")));
    }
}