bestool 2.2.2

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
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use bestool_alertd::check::{CheckOutcome, 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 the result replay. By default the
/// replay shows only warning, broken, and failing checks; `--all` shows
/// everything (the live progress view always shows every check regardless).
pub fn keep_in_replay(status: &CheckStatus, show_all: bool) -> bool {
	if show_all {
		return true;
	}
	matches!(
		status,
		CheckStatus::Warning(_) | CheckStatus::Broken(_) | CheckStatus::Fail(_)
	)
}

/// Sort `results` into severity-grouped order, alphabetical within each group.
///
/// The instance identity is the sort key because a bare name no longer
/// identifies a check: sorting by it alone would interleave a machine check
/// with an application check of the same name, and two clusters' checks with
/// each other.
pub fn sort_grouped(results: &mut [CheckOutcome]) {
	// Keyed by instance, so two clusters' checks of one name sort apart rather
	// than tying. Cached because the key is a formatted string: comparing it
	// afresh on every comparison would format it O(N log N) times.
	results.sort_by_cached_key(|o| (severity_key(&o.check.status), o.row_id()));
}

/// Filter `results` for the replay by the `show_all` flag, leaving them sorted.
pub fn filter_and_sort(results: &[CheckOutcome], show_all: bool) -> Vec<CheckOutcome> {
	let mut out: Vec<CheckOutcome> = results
		.iter()
		.filter(|o| keep_in_replay(&o.check.status, show_all))
		.cloned()
		.collect();
	sort_grouped(&mut out);
	out
}

#[cfg(test)]
mod tests {
	use bestool_alertd::{check::Check, subject::Subject};

	use super::*;

	fn on(check: Check) -> CheckOutcome {
		CheckOutcome {
			subject: Subject::Machine,
			check,
			on_wire: true,
		}
	}
	fn pass(name: &'static str) -> CheckOutcome {
		on(Check::pass(name, "ok"))
	}
	fn warn(name: &'static str) -> CheckOutcome {
		on(Check::warning(name, "deg", "reason"))
	}
	fn broken(name: &'static str) -> CheckOutcome {
		on(Check::broken(name, "broke", "reason"))
	}
	fn fail(name: &'static str) -> CheckOutcome {
		on(Check::fail(name, "bad", "reason"))
	}
	fn skip(name: &'static str) -> CheckOutcome {
		on(Check::skip(name, "not run", "reason"))
	}

	#[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(|o| o.check.name).collect();
		assert_eq!(
			names,
			vec!["charlie", "delta", "gamma", "alpha", "yak", "beta", "apple", "zebra"]
		);
	}

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

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

	#[test]
	fn filter_and_sort_default_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, false);
		let names: Vec<&str> = out.iter().map(|o| o.check.name).collect();
		assert_eq!(names, vec!["b", "e", "d"]);
	}
}