From fafd262230d87b9d14c911ec24bfaf34e7bd97fe Mon Sep 17 00:00:00 2001 From: Wataru Otsubo Date: Mon, 14 Apr 2025 07:10:54 +0000 Subject: [PATCH] Add functionality to overwrite xml metadata with env var --- README-ja.md | 2 +- README.md | 2 +- src/io.rs | 120 +++++++++++++++++++++++++++++++++++---------------- src/main.rs | 11 ++++- 4 files changed, 94 insertions(+), 41 deletions(-) diff --git a/README-ja.md b/README-ja.md index 7e770e3..ddda1ba 100644 --- a/README-ja.md +++ b/README-ja.md @@ -33,7 +33,7 @@ cargo build --features=bin --bins --release `target/release`に入ってるバイナリファイルを実行するか、`cargo run -- `で実行できます。 -詳しくは`--help`を見てください。 +詳しくは(`-h`ではなく)`--help`を見てください。 ### ライブラリクレートの使い方 diff --git a/README.md b/README.md index 9685c6f..e9fd84e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ to build. Execute the binary generated in `target/release/`, or run with `cargo run -- `. -See the `--help` for more information. +See the `--help`(not `-h`) for more information. ### Library crate usage diff --git a/src/io.rs b/src/io.rs index 8b2b1eb..bdf712f 100644 --- a/src/io.rs +++ b/src/io.rs @@ -1,11 +1,15 @@ //! File IO for generated codes. -use std::{collections::HashMap, fs, io, path, process}; +use std::{collections::HashMap, env, ffi::OsString, fs, io, path, process}; use thiserror::Error; use crate::types::XmlGitInfo; +const ENVVAR_XML_GIT_DESCRIBE: &str = "XML_GIT_DESCRIBE"; +const ENVVAR_XML_GIT_TIMESTAMP: &str = "XML_GIT_TIMESTAMP"; +const ENVVAR_XML_GIT_SHA: &str = "XML_GIT_SHA"; + #[derive(Debug, Error)] pub enum XmlGitInfoError { #[error("io error while getting xml git info: {msg} {source}")] @@ -16,6 +20,8 @@ pub enum XmlGitInfoError { }, #[error("git failed: {msg}: {stderr}")] CommandFailed { msg: &'static str, stderr: String }, + #[error("env var {var} is not unicode: {}", s.to_string_lossy())] + NotUnicodeEnvVar { var: &'static str, s: OsString }, } impl XmlGitInfoError { @@ -25,44 +31,84 @@ impl XmlGitInfoError { } pub(crate) fn get_xml_gitinfo(xml_path: &path::Path) -> Result { - let describe = process::Command::new("git") - .args(["describe", "--always", "--dirty"]) - .current_dir(xml_path.parent().unwrap()) - .output() - .map_err(|e| XmlGitInfoError::io_error(e, "git describe"))?; - let describe = if describe.status.success() { - String::from_utf8_lossy(&describe.stdout).trim().to_owned() - } else { - return Err(XmlGitInfoError::CommandFailed { - msg: "git describe", - stderr: String::from_utf8_lossy(&describe.stderr).into_owned(), - }); + let describe = match env::var(ENVVAR_XML_GIT_DESCRIBE) { + Ok(describe) => describe, + Err(env::VarError::NotUnicode(s)) => { + return Err(XmlGitInfoError::NotUnicodeEnvVar { + var: ENVVAR_XML_GIT_DESCRIBE, + s, + }); + } + Err(env::VarError::NotPresent) => { + let out_describe = process::Command::new("git") + .args(["describe", "--always", "--dirty"]) + .current_dir(xml_path.parent().unwrap()) + .output() + .map_err(|e| XmlGitInfoError::io_error(e, "git describe"))?; + let describe = if out_describe.status.success() { + String::from_utf8_lossy(&out_describe.stdout) + .trim() + .to_owned() + } else { + return Err(XmlGitInfoError::CommandFailed { + msg: "git describe", + stderr: String::from_utf8_lossy(&out_describe.stderr).into_owned(), + }); + }; + describe + } }; - let timestamp = process::Command::new("git") - .args(["log", "-1", "--pretty=format:'%cI'"]) - .current_dir(xml_path.parent().unwrap()) - .output() - .map_err(|e| XmlGitInfoError::io_error(e, "git log (timestamp)"))?; - let timestamp = if timestamp.status.success() { - String::from_utf8_lossy(×tamp.stdout).trim().to_owned() - } else { - return Err(XmlGitInfoError::CommandFailed { - msg: "git log (timestamp)", - stderr: String::from_utf8_lossy(×tamp.stderr).into_owned(), - }); + let timestamp = match env::var(ENVVAR_XML_GIT_TIMESTAMP) { + Ok(timestamp) => timestamp, + Err(env::VarError::NotUnicode(s)) => { + return Err(XmlGitInfoError::NotUnicodeEnvVar { + var: ENVVAR_XML_GIT_TIMESTAMP, + s, + }); + } + Err(env::VarError::NotPresent) => { + let timestamp_out = process::Command::new("git") + .args(["log", "-1", "--pretty=format:'%cI'"]) + .current_dir(xml_path.parent().unwrap()) + .output() + .map_err(|e| XmlGitInfoError::io_error(e, "git log (timestamp)"))?; + let timestamp = if timestamp_out.status.success() { + String::from_utf8_lossy(×tamp_out.stdout) + .trim() + .to_owned() + } else { + return Err(XmlGitInfoError::CommandFailed { + msg: "git log (timestamp)", + stderr: String::from_utf8_lossy(×tamp_out.stderr).into_owned(), + }); + }; + timestamp + } }; - let sha = process::Command::new("git") - .args(["rev-parse", "HEAD"]) - .current_dir(xml_path.parent().unwrap()) - .output() - .map_err(|e| XmlGitInfoError::io_error(e, "git rev-parse (sha)"))?; - let git_sha = if sha.status.success() { - String::from_utf8_lossy(&sha.stdout).trim().to_owned() - } else { - return Err(XmlGitInfoError::CommandFailed { - msg: "git rev-parse (sha)", - stderr: String::from_utf8_lossy(&sha.stderr).into_owned(), - }); + let git_sha = match env::var(ENVVAR_XML_GIT_SHA) { + Ok(sha) => sha, + Err(env::VarError::NotUnicode(s)) => { + return Err(XmlGitInfoError::NotUnicodeEnvVar { + var: ENVVAR_XML_GIT_SHA, + s, + }); + } + Err(env::VarError::NotPresent) => { + let sha = process::Command::new("git") + .args(["rev-parse", "HEAD"]) + .current_dir(xml_path.parent().unwrap()) + .output() + .map_err(|e| XmlGitInfoError::io_error(e, "git rev-parse (sha)"))?; + let git_sha = if sha.status.success() { + String::from_utf8_lossy(&sha.stdout).trim().to_owned() + } else { + return Err(XmlGitInfoError::CommandFailed { + msg: "git rev-parse (sha)", + stderr: String::from_utf8_lossy(&sha.stderr).into_owned(), + }); + }; + git_sha + } }; Ok(XmlGitInfo { describe, diff --git a/src/main.rs b/src/main.rs index 01ca8e7..6208678 100644 --- a/src/main.rs +++ b/src/main.rs @@ -3,11 +3,16 @@ use std::path; use anyhow::Result; use clap::{Parser, Subcommand}; -/// Generate register interface from register map xml. +/// Validate the register map xml and generate register interface from register map xml. +/// See `help` with each commands to see detailed explanations. #[derive(Parser, Debug)] -#[command(version, about)] +#[command(version, about, long_about)] struct Args { /// Input XML register map. + /// + /// The path must be a valid git repository to get git metadata. + /// You can also force these metadata with environmental variables `XML_GIT_DESCRIBE`, + /// `XML_GIT_TIMESTAMP` and `XML_GIT_SHA`. xml: path::PathBuf, #[command(subcommand)] command: Commands, @@ -23,6 +28,8 @@ enum Commands { out: path::PathBuf, }, /// Generate flattened register map in CSV. + /// + /// Also run validation before generation. #[cfg(feature = "flatmap")] Flatmap { /// Flattened csv out path.