bomdrift 0.9.9

SBOM diff with supply-chain risk signals (CVEs, typosquats, maintainer-age).
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
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

//! Single source of truth for date/time. Honors `SOURCE_DATE_EPOCH` so
//! every timestamp/date emitted by bomdrift in production paths is
//! reproducible across runs when the env var is set.
//!
//! Why one module: byte-deterministic SARIF, VEX (v0.9), baseline expiry,
//! and any audit-log-style output must agree on "now" / "today". This
//! module is the only place we read the system clock or `SOURCE_DATE_EPOCH`.

use std::env;

use anyhow::{Context, Result, anyhow};
use time::format_description::well_known::Rfc3339;
use time::macros::format_description;
use time::{Date, OffsetDateTime};

/// Returns the current time in UTC, honoring `SOURCE_DATE_EPOCH` when set.
///
/// The env is read on every call (not cached at startup) so test fixtures
/// can vary it between scenarios. If `SOURCE_DATE_EPOCH` is set but
/// malformed, we fall back to `now_utc()` rather than panic — this matches
/// the reproducible-builds spec's "best-effort" guidance.
///
/// # Example
///
/// ```
/// // SAFETY: doctest is single-threaded.
/// unsafe { std::env::set_var("SOURCE_DATE_EPOCH", "1700000000"); }
/// let t = bomdrift::clock::now();
/// assert_eq!(t.unix_timestamp(), 1700000000);
/// unsafe { std::env::remove_var("SOURCE_DATE_EPOCH"); }
/// ```
pub fn now() -> OffsetDateTime {
    if let Ok(raw) = env::var("SOURCE_DATE_EPOCH")
        && let Ok(secs) = raw.trim().parse::<i64>()
        && let Ok(t) = OffsetDateTime::from_unix_timestamp(secs)
    {
        return t;
    }
    OffsetDateTime::now_utc()
}

/// Today's date in UTC, honoring `SOURCE_DATE_EPOCH`.
pub fn today() -> Date {
    now().date()
}

/// Format an `OffsetDateTime` as RFC 3339 (e.g. `2026-04-29T12:34:56Z`).
pub fn format_rfc3339(t: OffsetDateTime) -> String {
    t.format(&Rfc3339)
        .unwrap_or_else(|_| "1970-01-01T00:00:00Z".to_string())
}

/// Strict `YYYY-MM-DD` parser. Rejects non-zero-padded inputs (e.g.
/// `2026-4-29`) so baseline files don't drift between locales/tools.
pub fn parse_ymd(s: &str) -> Result<Date> {
    let fmt = format_description!("[year]-[month]-[day]");
    Date::parse(s, fmt).with_context(|| format!("invalid YYYY-MM-DD date: {s:?}"))
}

/// Format a `Date` as `YYYY-MM-DD` (zero-padded).
pub fn format_ymd(d: Date) -> String {
    let fmt = format_description!("[year]-[month]-[day]");
    d.format(fmt).unwrap_or_else(|_| "1970-01-01".to_string())
}

/// Returns true when `expires` is strictly before `today()`.
pub fn is_expired(expires: Date) -> bool {
    expires < today()
}

/// Convenience: parse a `YYYY-MM-DD` string and return whether it has
/// expired relative to `today()`. Surface parse errors to caller.
pub fn is_expired_str(s: &str) -> Result<bool> {
    parse_ymd(s).map(is_expired).map_err(|e| anyhow!("{e}"))
}

/// Test-only helper: process-wide mutex serializing `SOURCE_DATE_EPOCH`
/// mutations across `cargo test`'s default thread pool. Hold the
/// returned guard for the duration of the test.
///
/// Used by every test that touches `SOURCE_DATE_EPOCH` — `clock`,
/// `baseline`, `vex`, `enrich::registry`. Without this, parallel tests
/// race on the env var and the consumer reads system-clock garbage,
/// causing intermittent failures (PR #22 ubuntu-latest, v0.9.5).
#[cfg(test)]
pub(crate) fn test_env_lock() -> std::sync::MutexGuard<'static, ()> {
    use std::sync::{Mutex, OnceLock};
    static LOCK: OnceLock<Mutex<()>> = OnceLock::new();
    LOCK.get_or_init(|| Mutex::new(()))
        .lock()
        .unwrap_or_else(|e| e.into_inner())
}

#[cfg(test)]
mod tests {
    #![allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        clippy::todo,
        clippy::unimplemented
    )]
    use super::*;

    /// Re-export at module level for the existing tests below.
    fn env_lock() -> std::sync::MutexGuard<'static, ()> {
        test_env_lock()
    }

    #[test]
    fn parse_ymd_accepts_valid() {
        let d = parse_ymd("2026-04-29").unwrap();
        assert_eq!(format_ymd(d), "2026-04-29");
    }

    #[test]
    fn parse_ymd_rejects_malformed() {
        assert!(parse_ymd("2026/04/29").is_err());
        assert!(parse_ymd("not-a-date").is_err());
        assert!(parse_ymd("").is_err());
    }

    #[test]
    fn parse_ymd_rejects_non_zero_padded() {
        assert!(parse_ymd("2026-4-29").is_err());
        assert!(parse_ymd("2026-04-9").is_err());
    }

    #[test]
    fn now_honors_source_date_epoch() {
        let _g = env_lock();
        // 2026-05-01T00:00:00Z = 1777593600
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::set_var("SOURCE_DATE_EPOCH", "1777593600");
        }
        let t = now();
        assert_eq!(t.unix_timestamp(), 1777593600);
        assert_eq!(format_ymd(t.date()), "2026-05-01");
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::remove_var("SOURCE_DATE_EPOCH");
        }
    }

    #[test]
    fn now_is_read_per_call_not_cached() {
        let _g = env_lock();
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::set_var("SOURCE_DATE_EPOCH", "1000000000");
        }
        let a = now();
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::set_var("SOURCE_DATE_EPOCH", "2000000000");
        }
        let b = now();
        assert_ne!(a.unix_timestamp(), b.unix_timestamp());
        assert_eq!(a.unix_timestamp(), 1000000000);
        assert_eq!(b.unix_timestamp(), 2000000000);
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::remove_var("SOURCE_DATE_EPOCH");
        }
    }

    #[test]
    fn malformed_source_date_epoch_falls_back() {
        let _g = env_lock();
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::set_var("SOURCE_DATE_EPOCH", "not-a-number");
        }
        // Should not panic; returns system clock now.
        let _ = now();
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::remove_var("SOURCE_DATE_EPOCH");
        }
    }

    #[test]
    fn format_rfc3339_round_trip() {
        let t = OffsetDateTime::from_unix_timestamp(1777593600).unwrap();
        let s = format_rfc3339(t);
        assert_eq!(s, "2026-05-01T00:00:00Z");
    }

    #[test]
    fn is_expired_ordering() {
        let _g = env_lock();
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::set_var("SOURCE_DATE_EPOCH", "1777593600");
        } // 2026-05-01
        assert!(is_expired(parse_ymd("2026-04-30").unwrap()));
        assert!(!is_expired(parse_ymd("2026-05-01").unwrap()));
        assert!(!is_expired(parse_ymd("2026-05-02").unwrap()));
        // SAFETY: env mutation guarded by process-wide mutex above.
        unsafe {
            env::remove_var("SOURCE_DATE_EPOCH");
        }
    }
}