From 9444431a61d90a8692b4d9be8850c29a70dc04aa Mon Sep 17 00:00:00 2001 From: Wataru Otsubo Date: Thu, 10 Apr 2025 02:54:01 +0900 Subject: [PATCH 1/3] new(nix): build with nixpkgs buildRustPackage --- .gitignore | 1 + flake.lock | 82 +++++++++++++++++++++++++ flake.nix | 37 +++++++++++ nix/endcap-sl-software-ri-generator.nix | 11 ++++ 4 files changed, 131 insertions(+) create mode 100644 flake.lock create mode 100644 flake.nix create mode 100644 nix/endcap-sl-software-ri-generator.nix diff --git a/.gitignore b/.gitignore index ea8c4bf..8ea0ee8 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +result* diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..d28d4ad --- /dev/null +++ b/flake.lock @@ -0,0 +1,82 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1744098102, + "narHash": "sha256-tzCdyIJj9AjysC3OuKA+tMD/kDEDAF9mICPDU7ix0JA=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "c8cd81426f45942bb2906d5ed2fe21d2f19d95b7", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs", + "rust-overlay": "rust-overlay" + } + }, + "rust-overlay": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1744166053, + "narHash": "sha256-mpI7OzFwp+fUeDtZYQbVZ2YmtxTN2UNrrOwbYD27xKU=", + "owner": "oxalica", + "repo": "rust-overlay", + "rev": "896158be1835589db6f42f45ef0a49b8b492cc66", + "type": "github" + }, + "original": { + "owner": "oxalica", + "repo": "rust-overlay", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..6a76064 --- /dev/null +++ b/flake.nix @@ -0,0 +1,37 @@ +{ + description = "A very basic flake"; + + inputs = { + nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + rust-overlay = { + url = "github:oxalica/rust-overlay"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + }; + + outputs = + { + nixpkgs, + flake-utils, + rust-overlay, + ... + }: + flake-utils.lib.eachDefaultSystem ( + system: + let + pkgs = import nixpkgs { + inherit system; + overlays = [ rust-overlay.overlays.default ]; + }; + in + { + devShells.default = pkgs.mkShell { + packages = [ + pkgs.rust-bin.stable.latest.default + ]; + }; + packages.default = pkgs.callPackage ./nix/endcap-sl-software-ri-generator.nix { }; + } + ); +} diff --git a/nix/endcap-sl-software-ri-generator.nix b/nix/endcap-sl-software-ri-generator.nix new file mode 100644 index 0000000..0ffc9b7 --- /dev/null +++ b/nix/endcap-sl-software-ri-generator.nix @@ -0,0 +1,11 @@ +{ rustPlatform }: +# https://nixos.org/manual/nixpkgs/stable/#rust +rustPlatform.buildRustPackage { + pname = "endcap-sl-software-ri-generator"; + version = "0.3.0"; + + src = ../.; + cargoLock.lockFile = ../Cargo.lock; + + buildFeatures = [ "bin" ]; +} From fafd262230d87b9d14c911ec24bfaf34e7bd97fe Mon Sep 17 00:00:00 2001 From: Wataru Otsubo Date: Mon, 14 Apr 2025 07:10:54 +0000 Subject: [PATCH 2/3] 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. From 12332e8565820294a1468e34ceb623b661e7f8cc Mon Sep 17 00:00:00 2001 From: Wataru Otsubo Date: Mon, 14 Apr 2025 16:21:45 +0900 Subject: [PATCH 3/3] update(CHANGELOG): on !17 --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 840fc67..317a18b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [unreleased] +### Added + +- Packagin with Nix flakes (with nixpkgs buildRustPackage) [!16](https://gitlab.cern.ch/wotsubo/endcap-sl-software-ri-generator/-/merge_requests/16) +- Now xml metadata can be overwritten with corresponding environmental variables. [!17](https://gitlab.cern.ch/wotsubo/endcap-sl-software-ri-generator/-/merge_requests/17) + ## [0.3.1] - 2025-04-11 ### Changed