bestool 1.30.1

BES Deployment tooling
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

use bestool_alertd::doctor::check::{Check, CheckStatus};

/// Severity order key for grouping completed checks: lower value = less severe,
/// renders nearer the top of the list and further from the result line.
pub fn severity_key(status: &CheckStatus) -> u8 {
	match status {
		CheckStatus::Pass => 0,
		CheckStatus::Skip(_) => 1,
		CheckStatus::Warning(_) => 2,
		CheckStatus::Broken(_) => 3,
		CheckStatus::Fail(_) => 4,
	}
}

/// Whether a completed check should appear in human-readable output under the
/// given `only_failing` filter. The filter hides pass and skip outcomes.
pub fn keep_under_filter(status: &CheckStatus, only_failing: bool) -> bool {
	if !only_failing {
		return true;
	}
	matches!(
		status,
		CheckStatus::Warning(_) | CheckStatus::Broken(_) | CheckStatus::Fail(_)
	)
}

/// Sort `results` into severity-grouped, alphabetical-within-group order.
pub fn sort_grouped(results: &mut [(Check, bool)]) {
	results.sort_by(|a, b| {
		severity_key(&a.0.status)
			.cmp(&severity_key(&b.0.status))
			.then_with(|| a.0.name.cmp(b.0.name))
	});
}

/// Filter `results` by the `only_failing` flag, leaving them sorted.
pub fn filter_and_sort(results: &[(Check, bool)], only_failing: bool) -> Vec<(Check, bool)> {
	let mut out: Vec<(Check, bool)> = results
		.iter()
		.filter(|(c, _)| keep_under_filter(&c.status, only_failing))
		.cloned()
		.collect();
	sort_grouped(&mut out);
	out
}

#[cfg(test)]
mod tests {
	use super::*;

	fn pass(name: &'static str) -> (Check, bool) {
		(Check::pass(name, "ok"), true)
	}
	fn warn(name: &'static str) -> (Check, bool) {
		(Check::warning(name, "deg", "reason"), true)
	}
	fn broken(name: &'static str) -> (Check, bool) {
		(Check::broken(name, "broke", "reason"), true)
	}
	fn fail(name: &'static str) -> (Check, bool) {
		(Check::fail(name, "bad", "reason"), true)
	}
	fn skip(name: &'static str) -> (Check, bool) {
		(Check::skip(name, "not run", "reason"), true)
	}

	#[test]
	fn severity_key_orders_least_to_most() {
		assert!(severity_key(&CheckStatus::Pass) < severity_key(&CheckStatus::Skip("".into())));
		assert!(
			severity_key(&CheckStatus::Skip("".into()))
				< severity_key(&CheckStatus::Warning("".into()))
		);
		assert!(
			severity_key(&CheckStatus::Warning("".into()))
				< severity_key(&CheckStatus::Broken("".into()))
		);
		assert!(
			severity_key(&CheckStatus::Broken("".into()))
				< severity_key(&CheckStatus::Fail("".into()))
		);
	}

	#[test]
	fn sort_grouped_pass_skip_warn_broken_fail_alphabetical() {
		let mut results = vec![
			fail("zebra"),
			pass("delta"),
			warn("alpha"),
			broken("beta"),
			skip("gamma"),
			pass("charlie"),
			fail("apple"),
			warn("yak"),
		];
		sort_grouped(&mut results);
		let names: Vec<&str> = results.iter().map(|(c, _)| c.name).collect();
		assert_eq!(
			names,
			vec!["charlie", "delta", "gamma", "alpha", "yak", "beta", "apple", "zebra"]
		);
	}

	#[test]
	fn keep_under_filter_hides_pass_and_skip() {
		assert!(!keep_under_filter(&CheckStatus::Pass, true));
		assert!(!keep_under_filter(&CheckStatus::Skip("".into()), true));
		assert!(keep_under_filter(&CheckStatus::Warning("".into()), true));
		assert!(keep_under_filter(&CheckStatus::Broken("".into()), true));
		assert!(keep_under_filter(&CheckStatus::Fail("".into()), true));
	}

	#[test]
	fn keep_under_filter_off_keeps_everything() {
		assert!(keep_under_filter(&CheckStatus::Pass, false));
		assert!(keep_under_filter(&CheckStatus::Skip("".into()), false));
		assert!(keep_under_filter(&CheckStatus::Warning("".into()), false));
		assert!(keep_under_filter(&CheckStatus::Broken("".into()), false));
		assert!(keep_under_filter(&CheckStatus::Fail("".into()), false));
	}

	#[test]
	fn filter_and_sort_with_only_failing_drops_pass_and_skip() {
		let input = vec![
			pass("a"),
			warn("b"),
			skip("c"),
			fail("d"),
			broken("e"),
			pass("f"),
		];
		let out = filter_and_sort(&input, true);
		let names: Vec<&str> = out.iter().map(|(c, _)| c.name).collect();
		assert_eq!(names, vec!["b", "e", "d"]);
	}
}