Use DiagCtx in tidy CI check

Author: Kobzol

src/tools/tidy/src/diagnostics.rs

@@ -111,6 +111,11 @@ impl RunningCheck {
         tidy_error(&t.to_string()).expect("failed to output error");
     }
 
+    /// Immediately output a warning.
+    pub fn warning<T: Display>(&mut self, t: T) {
+        eprintln!("WARNING: {t}");
+    }
+
     /// Output an informational message
     pub fn message<T: Display>(&mut self, t: T) {
         eprintln!("{t}");

src/tools/tidy/src/lib.rs

@@ -13,6 +13,8 @@ use build_helper::git::{GitConfig, get_closest_upstream_commit};
 use build_helper::stage0_parser::{Stage0Config, parse_stage0_file};
 use termcolor::WriteColor;
 
+use crate::diagnostics::{DiagCtx, RunningCheck};
+
 macro_rules! static_regex {
     ($re:literal) => {{
         static RE: ::std::sync::LazyLock<::regex::Regex> =
@@ -66,7 +68,9 @@ pub struct CiInfo {
 }
 
 impl CiInfo {
-    pub fn new(bad: &mut bool) -> Self {
+    pub fn new(diag_ctx: DiagCtx) -> Self {
+        let mut check = diag_ctx.start_check("CI history");
+
         let stage0 = parse_stage0_file();
         let Stage0Config { nightly_branch, git_merge_commit_email, .. } = stage0.config;
 
@@ -79,11 +83,14 @@ impl CiInfo {
         let base_commit = match get_closest_upstream_commit(None, &info.git_config(), info.ci_env) {
             Ok(Some(commit)) => Some(commit),
             Ok(None) => {
-                info.error_if_in_ci("no base commit found", bad);
+                info.error_if_in_ci("no base commit found", &mut check);
                 None
             }
             Err(error) => {
-                info.error_if_in_ci(&format!("failed to retrieve base commit: {error}"), bad);
+                info.error_if_in_ci(
+                    &format!("failed to retrieve base commit: {error}"),
+                    &mut check,
+                );
                 None
             }
         };
@@ -98,12 +105,11 @@ impl CiInfo {
         }
     }
 
-    pub fn error_if_in_ci(&self, msg: &str, bad: &mut bool) {
+    pub fn error_if_in_ci(&self, msg: &str, check: &mut RunningCheck) {
         if self.ci_env.is_running_in_ci() {
-            *bad = true;
-            eprintln!("tidy check error: {msg}");
+            check.error(msg);
         } else {
-            eprintln!("tidy check warning: {msg}. Some checks will be skipped.");
+            check.warning(format!("{msg}. Some checks will be skipped."));
         }
     }
 }

src/tools/tidy/src/main.rs

@@ -8,7 +8,6 @@ use std::collections::VecDeque;
 use std::num::NonZeroUsize;
 use std::path::PathBuf;
 use std::str::FromStr;
-use std::sync::atomic::AtomicBool;
 use std::thread::{self, ScopedJoinHandle, scope};
 use std::{env, process};
 
@@ -51,11 +50,8 @@ fn main() {
     let extra_checks =
         cfg_args.iter().find(|s| s.starts_with("--extra-checks=")).map(String::as_str);
 
-    let mut bad = false;
-    let ci_info = CiInfo::new(&mut bad);
-    let bad = std::sync::Arc::new(AtomicBool::new(bad));
-
-    let mut diag_ctx = DiagCtx::new(verbose);
+    let diag_ctx = DiagCtx::new(verbose);
+    let ci_info = CiInfo::new(diag_ctx.clone());
 
     let drain_handles = |handles: &mut VecDeque<ScopedJoinHandle<'_, ()>>| {
         // poll all threads for completion before awaiting the oldest one

src/tools/tidy/src/triagebot.rs

@@ -40,7 +40,7 @@ pub fn check(path: &Path, diag_ctx: DiagCtx) {
         }
     } else {
         check.error(
-            "triagebot.toml missing [mentions.*] section, this wrong for rust-lang/rust repo."
+            "triagebot.toml missing [mentions.*] section, this wrong for rust-lang/rust repo.",
         );
     }
 

src/tools/tidy/src/x_version.rs

@@ -14,7 +14,7 @@ pub fn check(root: &Path, cargo: &Path, diag_ctx: DiagCtx) {
         Err(e) => {
             check.error(format!("failed to run `cargo`: {e}"));
             return;
-        },
+        }
     };
 
     let cargo_list = child.wait_with_output().unwrap();
@@ -53,9 +53,7 @@ pub fn check(root: &Path, cargo: &Path, diag_ctx: DiagCtx) {
                 )
             }
         } else {
-            check.error(
-                "Unable to parse the latest version of `x` at `src/tools/x/Cargo.toml`"
-            )
+            check.error("Unable to parse the latest version of `x` at `src/tools/x/Cargo.toml`")
         }
     } else {
         check.error(format!("failed to check version of `x`: {}", cargo_list.status))