|
| 1 | +// SPDX-License-Identifier: GPL-3.0-or-later |
| 2 | +// Copyright (C) 2026 Mohamed Hammad |
| 3 | + |
| 4 | +//! Cross-field contract checks for [`DeclaredState`]. |
| 5 | +
|
| 6 | +use crate::declared::DeclaredState; |
| 7 | +use crate::errors::ContractViolation; |
| 8 | +use crate::host::ArchLevel; |
| 9 | +use std::collections::BTreeMap; |
| 10 | + |
| 11 | +/// Check cross-field contracts on a parsed host configuration. |
| 12 | +/// |
| 13 | +/// Serde catches type and enum errors at parse time. This function adds |
| 14 | +/// the invariants serde cannot express: |
| 15 | +/// |
| 16 | +/// - **`DUPLICATE_PACKAGES`** — every package name appears in at most one |
| 17 | +/// list across [`PackageSet`](crate::PackageSet), |
| 18 | +/// [`RemovePolicy::packages`](crate::RemovePolicy), and |
| 19 | +/// [`RemovePolicy::ignore`](crate::RemovePolicy). |
| 20 | +/// - **`KERNEL_MODULES_NOT_UNIQUE`** — `kernel.modules` and |
| 21 | +/// `kernel.blacklist` each contain unique entries, and the two sets are |
| 22 | +/// disjoint. |
| 23 | +/// - **`ARCH_LEVEL_MISMATCH`** — `meta.arch_level = "v3"` forbids a |
| 24 | +/// non-empty `packages.cachyos-v4`, and symmetrically. |
| 25 | +/// |
| 26 | +/// # Errors |
| 27 | +/// Returns every violation found, not just the first. |
| 28 | +pub fn validate(d: &DeclaredState) -> Result<(), Vec<ContractViolation>> { |
| 29 | + let mut violations = Vec::new(); |
| 30 | + check_duplicate_packages(d, &mut violations); |
| 31 | + check_kernel_modules_unique(d, &mut violations); |
| 32 | + check_arch_level_matches_packages(d, &mut violations); |
| 33 | + if violations.is_empty() { |
| 34 | + Ok(()) |
| 35 | + } else { |
| 36 | + Err(violations) |
| 37 | + } |
| 38 | +} |
| 39 | + |
| 40 | +fn check_duplicate_packages(d: &DeclaredState, violations: &mut Vec<ContractViolation>) { |
| 41 | + let p = &d.packages; |
| 42 | + let lists: [(&str, &[String]); 8] = [ |
| 43 | + ("packages.core", &p.core), |
| 44 | + ("packages.cachyos", &p.cachyos), |
| 45 | + ("packages.cachyos-v3", &p.cachyos_v3), |
| 46 | + ("packages.cachyos-v4", &p.cachyos_v4), |
| 47 | + ("packages.aur", &p.aur), |
| 48 | + ("packages.cargo", &p.cargo), |
| 49 | + ("remove.packages", &d.remove.packages), |
| 50 | + ("remove.ignore", &d.remove.ignore), |
| 51 | + ]; |
| 52 | + |
| 53 | + let mut seen: BTreeMap<String, Vec<&str>> = BTreeMap::new(); |
| 54 | + for (label, items) in lists { |
| 55 | + for name in items { |
| 56 | + seen.entry(name.clone()).or_default().push(label); |
| 57 | + } |
| 58 | + } |
| 59 | + |
| 60 | + for (name, sources) in seen { |
| 61 | + if sources.len() > 1 { |
| 62 | + violations.push(ContractViolation { |
| 63 | + id: ContractViolation::DUPLICATE_PACKAGES, |
| 64 | + message: format!("'{}' appears in {}", name, sources.join(", ")), |
| 65 | + }); |
| 66 | + } |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +fn check_kernel_modules_unique(d: &DeclaredState, violations: &mut Vec<ContractViolation>) { |
| 71 | + let modules = &d.kernel.modules; |
| 72 | + let blacklist = &d.kernel.blacklist; |
| 73 | + |
| 74 | + if let Some(dup) = first_duplicate(modules) { |
| 75 | + violations.push(ContractViolation { |
| 76 | + id: ContractViolation::KERNEL_MODULES_NOT_UNIQUE, |
| 77 | + message: format!("'{dup}' appears more than once in kernel.modules"), |
| 78 | + }); |
| 79 | + } |
| 80 | + if let Some(dup) = first_duplicate(blacklist) { |
| 81 | + violations.push(ContractViolation { |
| 82 | + id: ContractViolation::KERNEL_MODULES_NOT_UNIQUE, |
| 83 | + message: format!("'{dup}' appears more than once in kernel.blacklist"), |
| 84 | + }); |
| 85 | + } |
| 86 | + |
| 87 | + for name in modules { |
| 88 | + if blacklist.contains(name) { |
| 89 | + violations.push(ContractViolation { |
| 90 | + id: ContractViolation::KERNEL_MODULES_NOT_UNIQUE, |
| 91 | + message: format!("'{name}' appears in both kernel.modules and kernel.blacklist"), |
| 92 | + }); |
| 93 | + } |
| 94 | + } |
| 95 | +} |
| 96 | + |
| 97 | +fn check_arch_level_matches_packages(d: &DeclaredState, violations: &mut Vec<ContractViolation>) { |
| 98 | + match d.host.arch_level { |
| 99 | + ArchLevel::V3 if !d.packages.cachyos_v4.is_empty() => { |
| 100 | + violations.push(ContractViolation { |
| 101 | + id: ContractViolation::ARCH_LEVEL_MISMATCH, |
| 102 | + message: "meta.arch_level = 'v3' but packages.cachyos-v4 is non-empty".to_owned(), |
| 103 | + }); |
| 104 | + } |
| 105 | + ArchLevel::V4 if !d.packages.cachyos_v3.is_empty() => { |
| 106 | + violations.push(ContractViolation { |
| 107 | + id: ContractViolation::ARCH_LEVEL_MISMATCH, |
| 108 | + message: "meta.arch_level = 'v4' but packages.cachyos-v3 is non-empty".to_owned(), |
| 109 | + }); |
| 110 | + } |
| 111 | + _ => {} |
| 112 | + } |
| 113 | +} |
| 114 | + |
| 115 | +fn first_duplicate(items: &[String]) -> Option<&str> { |
| 116 | + let mut seen = std::collections::BTreeSet::new(); |
| 117 | + for item in items { |
| 118 | + if !seen.insert(item.as_str()) { |
| 119 | + return Some(item.as_str()); |
| 120 | + } |
| 121 | + } |
| 122 | + None |
| 123 | +} |
| 124 | + |
| 125 | +#[cfg(test)] |
| 126 | +#[allow( |
| 127 | + clippy::expect_used, |
| 128 | + clippy::unwrap_used, |
| 129 | + clippy::panic, |
| 130 | + reason = "tests may use expect()/unwrap()/panic!() per Plan §4.2 + CLAUDE.md" |
| 131 | +)] |
| 132 | +mod tests { |
| 133 | + use super::*; |
| 134 | + use crate::parse::from_resolved_toml; |
| 135 | + |
| 136 | + const MINIMAL: &str = include_str!("../../../fixtures/schema/host_minimal.toml"); |
| 137 | + const FULL: &str = include_str!("../../../fixtures/schema/host_full.toml"); |
| 138 | + |
| 139 | + #[test] |
| 140 | + fn validate_clean_minimal() { |
| 141 | + let d = from_resolved_toml(MINIMAL).expect("parse"); |
| 142 | + assert!(validate(&d).is_ok()); |
| 143 | + } |
| 144 | + |
| 145 | + #[test] |
| 146 | + fn validate_clean_full_fixture() { |
| 147 | + let d = from_resolved_toml(FULL).expect("parse"); |
| 148 | + validate(&d).expect("full fixture must satisfy every contract"); |
| 149 | + } |
| 150 | + |
| 151 | + #[test] |
| 152 | + fn validate_duplicate_packages() { |
| 153 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 154 | + d.packages.core.push("htop".to_owned()); |
| 155 | + d.packages.aur.push("htop".to_owned()); |
| 156 | + |
| 157 | + let err = validate(&d).expect_err("duplicate must be flagged"); |
| 158 | + assert_eq!(err.len(), 1); |
| 159 | + assert_eq!(err[0].id, ContractViolation::DUPLICATE_PACKAGES); |
| 160 | + assert!(err[0].message.contains("htop")); |
| 161 | + assert!(err[0].message.contains("packages.core")); |
| 162 | + assert!(err[0].message.contains("packages.aur")); |
| 163 | + } |
| 164 | + |
| 165 | + #[test] |
| 166 | + fn validate_kernel_modules_overlap() { |
| 167 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 168 | + d.kernel.modules = vec!["nvidia".to_owned(), "nouveau".to_owned()]; |
| 169 | + d.kernel.blacklist = vec!["nouveau".to_owned()]; |
| 170 | + |
| 171 | + let err = validate(&d).expect_err("overlap must be flagged"); |
| 172 | + assert!( |
| 173 | + err.iter() |
| 174 | + .any(|v| v.id == ContractViolation::KERNEL_MODULES_NOT_UNIQUE |
| 175 | + && v.message.contains("nouveau") |
| 176 | + && v.message.contains("kernel.modules") |
| 177 | + && v.message.contains("kernel.blacklist")) |
| 178 | + ); |
| 179 | + } |
| 180 | + |
| 181 | + #[test] |
| 182 | + fn validate_kernel_modules_duplicate_within_list() { |
| 183 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 184 | + d.kernel.modules = vec!["nvidia".to_owned(), "nvidia".to_owned()]; |
| 185 | + |
| 186 | + let err = validate(&d).expect_err("duplicate must be flagged"); |
| 187 | + assert!( |
| 188 | + err.iter() |
| 189 | + .any(|v| v.id == ContractViolation::KERNEL_MODULES_NOT_UNIQUE |
| 190 | + && v.message.contains("nvidia")) |
| 191 | + ); |
| 192 | + } |
| 193 | + |
| 194 | + #[test] |
| 195 | + fn validate_arch_level_v3_with_v4_packages() { |
| 196 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 197 | + d.host.arch_level = ArchLevel::V3; |
| 198 | + d.packages.cachyos_v4 = vec!["firefox".to_owned()]; |
| 199 | + |
| 200 | + let err = validate(&d).expect_err("arch-level mismatch must be flagged"); |
| 201 | + assert_eq!(err.len(), 1); |
| 202 | + assert_eq!(err[0].id, ContractViolation::ARCH_LEVEL_MISMATCH); |
| 203 | + } |
| 204 | + |
| 205 | + #[test] |
| 206 | + fn validate_arch_level_v4_with_v3_packages() { |
| 207 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 208 | + d.host.arch_level = ArchLevel::V4; |
| 209 | + d.packages.cachyos_v3 = vec!["openssl".to_owned()]; |
| 210 | + |
| 211 | + let err = validate(&d).expect_err("arch-level mismatch must be flagged"); |
| 212 | + assert_eq!(err.len(), 1); |
| 213 | + assert_eq!(err[0].id, ContractViolation::ARCH_LEVEL_MISMATCH); |
| 214 | + } |
| 215 | + |
| 216 | + #[test] |
| 217 | + fn validate_collects_multiple_violations() { |
| 218 | + let mut d = from_resolved_toml(MINIMAL).expect("parse"); |
| 219 | + d.packages.core.push("htop".to_owned()); |
| 220 | + d.packages.aur.push("htop".to_owned()); |
| 221 | + d.kernel.modules = vec!["x".to_owned(), "x".to_owned()]; |
| 222 | + |
| 223 | + let err = validate(&d).expect_err("two violations expected"); |
| 224 | + assert!( |
| 225 | + err.iter() |
| 226 | + .any(|v| v.id == ContractViolation::DUPLICATE_PACKAGES) |
| 227 | + ); |
| 228 | + assert!( |
| 229 | + err.iter() |
| 230 | + .any(|v| v.id == ContractViolation::KERNEL_MODULES_NOT_UNIQUE) |
| 231 | + ); |
| 232 | + } |
| 233 | +} |
0 commit comments