Add --versions to show version tool information

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

Cargo.lock

@@ -1,4 +1,8 @@
 [workspace]
+# Make sure new resolver is used to avoid unifying dependency features between
+# runtime and build dependencies.
+# See: https://github.com/rust-lang/cargo/issues/2589
+resolver = "2"
 
 members = [
     # Linux and Windows tool to inspect and customize the system

Cargo.toml

@@ -2,7 +2,8 @@
 name = "framework_lib"
 version = "0.1.0"
 edition = "2021"
--rust-version = "1.61"
+rust-version = "1.61"
+build = "build.rs"
 
 [features]
 default = ["linux"]
@@ -25,6 +26,9 @@ cros_ec_driver = []
 # Chromium EC driver by DHowett
 win_driver = []
 
+[build-dependencies]
+built = { version = "0.5", no-default-features = true, features = ["chrono", "git2"] }
+
 [dependencies]
 lazy_static = "1.4.0"
 regex = { version = "1.6.0", optional = true } # TODO: Can update to 1.7.0

framework_lib/Cargo.toml

@@ -0,0 +1,3 @@
+fn main() {
+    built::write_built_file().expect("Failed to acquire build-time information");
+}

framework_lib/build.rs

@@ -13,10 +13,14 @@ struct ClapCli {
     #[command(flatten)]
     verbosity: clap_verbosity_flag::Verbosity,
 
-    /// List current firmware versions version
+    /// List current firmware versions
     #[arg(long)]
     versions: bool,
 
+    /// Show tool version information (Add -vv for more details)
+    #[arg(long)]
+    version: bool,
+
     /// Display the UEFI ESRT table
     #[arg(long)]
     esrt: bool,
@@ -103,6 +107,7 @@ pub fn parse(args: &[String]) -> Cli {
     Cli {
         verbosity: args.verbosity.log_level_filter(),
         versions: args.versions,
+        version: args.version,
         esrt: args.esrt,
         power: args.power,
         pdports: args.pdports,

framework_lib/src/commandline/clap_std.rs

@@ -6,6 +6,7 @@
 use alloc::string::String;
 use alloc::string::ToString;
 use alloc::vec::Vec;
+use log::Level;
 
 #[cfg(not(feature = "uefi"))]
 pub mod clap_std;
@@ -17,6 +18,7 @@ use std::fs;
 
 #[cfg(not(feature = "uefi"))]
 use crate::audio_card::check_synaptics_fw_version;
+use crate::built_info;
 use crate::capsule;
 use crate::capsule_content::{
     find_bios_version, find_ec_in_bios_cap, find_pd_in_bios_cap, find_retimer_version,
@@ -61,6 +63,7 @@ pub enum ConsoleArg {
 pub struct Cli {
     pub verbosity: log::LevelFilter,
     pub versions: bool,
+    pub version: bool,
     pub esrt: bool,
     pub power: bool,
     pub pdports: bool,
@@ -171,6 +174,38 @@ fn print_dp_hdmi_details() {
     };
 }
 
+fn print_tool_version() {
+    let q = "?".to_string();
+    println!("Tool Version Information");
+    println!("  Version:     {}", built_info::PKG_VERSION);
+    println!("  Built At:    {}", built_info::BUILT_TIME_UTC);
+    println!(
+        "  Git Commit:  {}",
+        built_info::GIT_COMMIT_HASH.unwrap_or(&q)
+    );
+    println!(
+        "  Git Dirty:   {}",
+        built_info::GIT_DIRTY
+            .map(|x| x.to_string())
+            .unwrap_or(q.clone())
+    );
+
+    if log_enabled!(Level::Info) {
+        println!(
+            "  Built on CI: {:?}",
+            built_info::CI_PLATFORM.unwrap_or("None")
+        );
+        println!(
+            "  Git ref:     {:?}",
+            built_info::GIT_HEAD_REF.unwrap_or(&q)
+        );
+        println!("  rustc Ver:   {}", built_info::RUSTC_VERSION);
+        println!("  Features     {:?}", built_info::FEATURES);
+        println!("  DEBUG:       {}", built_info::DEBUG);
+        println!("  Target OS:   {}", built_info::CFG_OS);
+    }
+}
+
 fn print_versions(ec: &CrosEc) {
     println!("UEFI BIOS");
     if let Some(smbios) = get_smbios() {
@@ -326,6 +361,8 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
         return 2;
     } else if args.versions {
         print_versions(&ec);
+    } else if args.version {
+        print_tool_version();
     } else if args.esrt {
         print_esrt();
     } else if args.intrusion {
@@ -528,6 +565,8 @@ Options:
   -b                         Print output one screen at a time
   -v, --verbose...           More output per occurrence
   -q, --quiet...             Less output per occurrence
+      --versions             List current firmware versions
+      --version              Show tool version information (Add -vv for more detailed information)
       --esrt                 Display the UEFI ESRT table
       --power                Show current power status (battery and AC)
       --pdports              Show information about USB-C PD prots

framework_lib/src/commandline/mod.rs

@@ -56,6 +56,7 @@ pub fn parse(args: &[String]) -> Cli {
         verbosity: log::LevelFilter::Error,
         paginate: false,
         versions: false,
+        version: false,
         esrt: false,
         power: false,
         pdports: false,
@@ -101,6 +102,9 @@ pub fn parse(args: &[String]) -> Cli {
         } else if arg == "--versions" {
             cli.versions = true;
             found_an_option = true;
+        } else if arg == "--version" {
+            cli.version = true;
+            found_an_option = true;
         } else if arg == "-b" {
             cli.paginate = true;
             found_an_option = true;

framework_lib/src/commandline/uefi.rs

@@ -35,3 +35,8 @@ pub mod smbios;
 #[cfg(feature = "uefi")]
 pub mod uefi;
 mod util;
+
+pub mod built_info {
+    // The file has been placed there by the build script.
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}