xtask: Refactor error message

Refactor "out of sync" manpages, tmt test files error messages out to a
separate function. Also update the error message to ask to run `just
update-generated`

Signed-off-by: Pragyan Poudyal <pragyanpoudyal41999@gmail.com>

Author: Johan-Liebert1

crates/xtask/src/man.rs

@@ -10,6 +10,8 @@ use serde::{Deserialize, Serialize};
 use std::{fs, io::Write};
 use xshell::{Shell, cmd};
 
+use crate::out_of_sync_error;
+
 /// Represents a CLI option extracted from the JSON dump
 #[derive(Debug, Serialize, Deserialize)]
 pub struct CliOption {
@@ -664,10 +666,7 @@ pub fn check_manpages(sh: &Shell) -> Result<()> {
         let filename = format!("bootc-{}.8.md", command_parts.join("-"));
         let filepath = Utf8Path::new("docs/src/man").join(&filename);
         if !filepath.exists() {
-            anyhow::bail!(
-                "{} is missing; run `cargo xtask update-generated` to create it",
-                filepath
-            );
+            return out_of_sync_error(&format!("{filepath} is missing"));
         }
     }
 
@@ -729,10 +728,7 @@ fn check_markdown_options(
         return Ok(());
     };
     if new_content != content {
-        anyhow::bail!(
-            "{} is out of date; run `cargo xtask update-generated` to update it",
-            markdown_path
-        );
+        return out_of_sync_error(&format!("{markdown_path} is out of date"));
     }
     Ok(())
 }
@@ -750,10 +746,7 @@ fn check_markdown_subcommands(
         return Ok(());
     };
     if new_content != content {
-        anyhow::bail!(
-            "{} is out of date; run `cargo xtask update-generated` to update it",
-            markdown_path
-        );
+        return out_of_sync_error(&format!("{markdown_path} is out of date"));
     }
     Ok(())
 }

crates/xtask/src/tmt.rs

@@ -34,7 +34,7 @@ const DISTRO_CENTOS_9: &str = "centos-9";
 
 // Import the argument types from xtask.rs
 use crate::bcvk::BcvkInstallOpts;
-use crate::{RunTmtArgs, SealState, TmtProvisionArgs};
+use crate::{RunTmtArgs, SealState, TmtProvisionArgs, out_of_sync_error};
 
 /// Generate a random alphanumeric suffix for VM names
 fn generate_random_suffix() -> String {
@@ -941,16 +941,10 @@ pub(crate) fn check_integration() -> Result<()> {
         .with_context(|| format!("Reading {}", integration_fmf_path))?;
 
     if tests_generated != tests_on_disk {
-        anyhow::bail!(
-            "{} is out of date; run `cargo xtask update-generated` to update it",
-            tests_fmf_path
-        );
+        return out_of_sync_error(&format!("{tests_fmf_path} is out of date"));
     }
     if integration_generated != integration_on_disk {
-        anyhow::bail!(
-            "{} is out of date; run `cargo xtask update-generated` to update it",
-            integration_fmf_path
-        );
+        return out_of_sync_error(&format!("{integration_fmf_path} is out of date"));
     }
 
     Ok(())

crates/xtask/src/xtask.rs

@@ -40,6 +40,11 @@ const TAR_REPRODUCIBLE_OPTS: &[&str] = &[
     "--pax-option=exthdr.name=%d/PaxHeaders/%f,delete=atime,delete=ctime",
 ];
 
+/// Helper function to write out out-of-sync error messages for manpages, tmt tests
+fn out_of_sync_error(message: &str) -> Result<()> {
+    anyhow::bail!("{}; run `just update-generated` to update it", message)
+}
+
 /// Build tasks for bootc
 #[derive(Debug, Parser)]
 #[command(name = "xtask")]
@@ -623,9 +628,7 @@ fn check_json_schemas(sh: &Shell) -> Result<()> {
         let on_disk =
             std::fs::read_to_string(target).with_context(|| format!("Reading {target}"))?;
         if generated != on_disk {
-            anyhow::bail!(
-                "{target} is out of date; run `cargo xtask update-generated` to update it"
-            );
+            return out_of_sync_error(&format!("{target} is out of date"));
         }
     }
     Ok(())