|
| 1 | +use std::collections::BTreeMap; |
| 2 | +use std::io::Write; |
| 3 | +use std::path::Path; |
| 4 | + |
| 5 | +use anyhow::Context; |
| 6 | +use build_helper::metrics::{JsonNode, JsonRoot, TestOutcome, TestSuite, TestSuiteMetadata}; |
| 7 | + |
| 8 | +pub fn postprocess_metrics(metrics_path: &Path, summary_path: &Path) -> anyhow::Result<()> { |
| 9 | + let metrics = load_metrics(metrics_path)?; |
| 10 | + let suites = get_test_suites(&metrics); |
| 11 | + |
| 12 | + if suites.is_empty() { |
| 13 | + return Ok(()); |
| 14 | + } |
| 15 | + |
| 16 | + let aggregated = aggregate_test_suites(&suites); |
| 17 | + let table = render_table(aggregated); |
| 18 | + |
| 19 | + let mut file = std::fs::File::options() |
| 20 | + .append(true) |
| 21 | + .create(true) |
| 22 | + .open(summary_path) |
| 23 | + .with_context(|| format!("Cannot open summary file at {summary_path:?}"))?; |
| 24 | + writeln!(file, "\n# Test results\n")?; |
| 25 | + writeln!(file, "{table}")?; |
| 26 | + |
| 27 | + Ok(()) |
| 28 | +} |
| 29 | + |
| 30 | +fn render_table(suites: BTreeMap<String, TestSuiteRecord>) -> String { |
| 31 | + use std::fmt::Write; |
| 32 | + |
| 33 | + let mut table = "| Test suite | Passed ✅ | Ignored 🚫 | Failed ❌ |\n".to_string(); |
| 34 | + writeln!(table, "|:------|------:|------:|------:|").unwrap(); |
| 35 | + |
| 36 | + fn write_row( |
| 37 | + buffer: &mut String, |
| 38 | + name: &str, |
| 39 | + record: &TestSuiteRecord, |
| 40 | + surround: &str, |
| 41 | + ) -> std::fmt::Result { |
| 42 | + let TestSuiteRecord { passed, ignored, failed } = record; |
| 43 | + let total = (record.passed + record.ignored + record.failed) as f64; |
| 44 | + let passed_pct = ((*passed as f64) / total) * 100.0; |
| 45 | + let ignored_pct = ((*ignored as f64) / total) * 100.0; |
| 46 | + let failed_pct = ((*failed as f64) / total) * 100.0; |
| 47 | + |
| 48 | + write!(buffer, "| {surround}{name}{surround} |")?; |
| 49 | + write!(buffer, " {surround}{passed} ({passed_pct:.0}%){surround} |")?; |
| 50 | + write!(buffer, " {surround}{ignored} ({ignored_pct:.0}%){surround} |")?; |
| 51 | + writeln!(buffer, " {surround}{failed} ({failed_pct:.0}%){surround} |")?; |
| 52 | + |
| 53 | + Ok(()) |
| 54 | + } |
| 55 | + |
| 56 | + let mut total = TestSuiteRecord::default(); |
| 57 | + for (name, record) in suites { |
| 58 | + write_row(&mut table, &name, &record, "").unwrap(); |
| 59 | + total.passed += record.passed; |
| 60 | + total.ignored += record.ignored; |
| 61 | + total.failed += record.failed; |
| 62 | + } |
| 63 | + write_row(&mut table, "Total", &total, "**").unwrap(); |
| 64 | + table |
| 65 | +} |
| 66 | + |
| 67 | +#[derive(Default)] |
| 68 | +struct TestSuiteRecord { |
| 69 | + passed: u64, |
| 70 | + ignored: u64, |
| 71 | + failed: u64, |
| 72 | +} |
| 73 | + |
| 74 | +fn aggregate_test_suites(suites: &[&TestSuite]) -> BTreeMap<String, TestSuiteRecord> { |
| 75 | + let mut records: BTreeMap<String, TestSuiteRecord> = BTreeMap::new(); |
| 76 | + for suite in suites { |
| 77 | + let name = match &suite.metadata { |
| 78 | + TestSuiteMetadata::CargoPackage { crates, stage, .. } => { |
| 79 | + format!("{} (stage {stage})", crates.join(", ")) |
| 80 | + } |
| 81 | + TestSuiteMetadata::Compiletest { suite, stage, .. } => { |
| 82 | + format!("{suite} (stage {stage})") |
| 83 | + } |
| 84 | + }; |
| 85 | + let record = records.entry(name).or_default(); |
| 86 | + for test in &suite.tests { |
| 87 | + match test.outcome { |
| 88 | + TestOutcome::Passed => { |
| 89 | + record.passed += 1; |
| 90 | + } |
| 91 | + TestOutcome::Failed => { |
| 92 | + record.failed += 1; |
| 93 | + } |
| 94 | + TestOutcome::Ignored { .. } => { |
| 95 | + record.ignored += 1; |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | + records |
| 101 | +} |
| 102 | + |
| 103 | +fn get_test_suites(metrics: &JsonRoot) -> Vec<&TestSuite> { |
| 104 | + fn visit_test_suites<'a>(nodes: &'a [JsonNode], suites: &mut Vec<&'a TestSuite>) { |
| 105 | + for node in nodes { |
| 106 | + match node { |
| 107 | + JsonNode::RustbuildStep { children, .. } => { |
| 108 | + visit_test_suites(&children, suites); |
| 109 | + } |
| 110 | + JsonNode::TestSuite(suite) => { |
| 111 | + suites.push(&suite); |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + let mut suites = vec![]; |
| 118 | + for invocation in &metrics.invocations { |
| 119 | + visit_test_suites(&invocation.children, &mut suites); |
| 120 | + } |
| 121 | + suites |
| 122 | +} |
| 123 | + |
| 124 | +fn load_metrics(path: &Path) -> anyhow::Result<JsonRoot> { |
| 125 | + let metrics = std::fs::read_to_string(path) |
| 126 | + .with_context(|| format!("Cannot read JSON metrics from {path:?}"))?; |
| 127 | + let metrics: JsonRoot = serde_json::from_str(&metrics) |
| 128 | + .with_context(|| format!("Cannot deserialize JSON metrics from {path:?}"))?; |
| 129 | + Ok(metrics) |
| 130 | +} |
0 commit comments