Configure structopt to report the right versionv0.7.2_ci-test-2bug/reported-version

By default, structopt reports the value provided by
the env var CARGO_PKG_VERSION, feeded by Cargo when reading
Cargo.toml. However for Garage we use a versioning based on git,
so we often report a version that is behind the real version.
In this commit, we create garage_util::version::garage() that
reports the right version and configure all structopt subcommands
to call this function instead of using the env var.

7 files changed, 65 insertions, 57 deletions

diff --git a/src/garage/cli/structs.rs b/src/garage/cli/structs.rs
index bc44b5ef..9274f80f 100644
--- a/src/garage/cli/structs.rs
+++ b/src/garage/cli/structs.rs
@@ -1,64 +1,65 @@
 use serde::{Deserialize, Serialize};
 
+use garage_util::version;
 use structopt::StructOpt;
 
 #[derive(StructOpt, Debug)]
 pub enum Command {
 	/// Run Garage server
-	#[structopt(name = "server")]
+	#[structopt(name = "server", version = version::garage())]
 	Server,
 
 	/// Get network status
-	#[structopt(name = "status")]
+	#[structopt(name = "status", version = version::garage())]
 	Status,
 
 	/// Operations on individual Garage nodes
-	#[structopt(name = "node")]
+	#[structopt(name = "node", version = version::garage())]
 	Node(NodeOperation),
 
 	/// Operations on the assignation of node roles in the cluster layout
-	#[structopt(name = "layout")]
+	#[structopt(name = "layout", version = version::garage())]
 	Layout(LayoutOperation),
 
 	/// Operations on buckets
-	#[structopt(name = "bucket")]
+	#[structopt(name = "bucket", version = version::garage())]
 	Bucket(BucketOperation),
 
 	/// Operations on S3 access keys
-	#[structopt(name = "key")]
+	#[structopt(name = "key", version = version::garage())]
 	Key(KeyOperation),
 
 	/// Run migrations from previous Garage version
 	/// (DO NOT USE WITHOUT READING FULL DOCUMENTATION)
-	#[structopt(name = "migrate")]
+	#[structopt(name = "migrate", version = version::garage())]
 	Migrate(MigrateOpt),
 
 	/// Start repair of node data on remote node
-	#[structopt(name = "repair")]
+	#[structopt(name = "repair", version = version::garage())]
 	Repair(RepairOpt),
 
 	/// Offline reparation of node data (these repairs must be run offline
 	/// directly on the server node)
-	#[structopt(name = "offline-repair")]
+	#[structopt(name = "offline-repair", version = version::garage())]
 	OfflineRepair(OfflineRepairOpt),
 
 	/// Gather node statistics
-	#[structopt(name = "stats")]
+	#[structopt(name = "stats", version = version::garage())]
 	Stats(StatsOpt),
 
 	/// Manage background workers
-	#[structopt(name = "worker")]
+	#[structopt(name = "worker", version = version::garage())]
 	Worker(WorkerOpt),
 }
 
 #[derive(StructOpt, Debug)]
 pub enum NodeOperation {
 	/// Print identifier (public key) of this Garage node
-	#[structopt(name = "id")]
+	#[structopt(name = "id", version = version::garage())]
 	NodeId(NodeIdOpt),
 
 	/// Connect to Garage node that is currently isolated from the system
-	#[structopt(name = "connect")]
+	#[structopt(name = "connect", version = version::garage())]
 	Connect(ConnectNodeOpt),
 }
 
@@ -79,23 +80,23 @@ pub struct ConnectNodeOpt {
 #[derive(StructOpt, Debug)]
 pub enum LayoutOperation {
 	/// Assign role to Garage node
-	#[structopt(name = "assign")]
+	#[structopt(name = "assign", version = version::garage())]
 	Assign(AssignRoleOpt),
 
 	/// Remove role from Garage cluster node
-	#[structopt(name = "remove")]
+	#[structopt(name = "remove", version = version::garage())]
 	Remove(RemoveRoleOpt),
 
 	/// Show roles currently assigned to nodes and changes staged for commit
-	#[structopt(name = "show")]
+	#[structopt(name = "show", version = version::garage())]
 	Show,
 
 	/// Apply staged changes to cluster layout
-	#[structopt(name = "apply")]
+	#[structopt(name = "apply", version = version::garage())]
 	Apply(ApplyLayoutOpt),
 
 	/// Revert staged changes to cluster layout
-	#[structopt(name = "revert")]
+	#[structopt(name = "revert", version = version::garage())]
 	Revert(RevertLayoutOpt),
 }
 
@@ -150,43 +151,43 @@ pub struct RevertLayoutOpt {
 #[derive(Serialize, Deserialize, StructOpt, Debug)]
 pub enum BucketOperation {
 	/// List buckets
-	#[structopt(name = "list")]
+	#[structopt(name = "list", version = version::garage())]
 	List,
 
 	/// Get bucket info
-	#[structopt(name = "info")]
+	#[structopt(name = "info", version = version::garage())]
 	Info(BucketOpt),
 
 	/// Create bucket
-	#[structopt(name = "create")]
+	#[structopt(name = "create", version = version::garage())]
 	Create(BucketOpt),
 
 	/// Delete bucket
-	#[structopt(name = "delete")]
+	#[structopt(name = "delete", version = version::garage())]
 	Delete(DeleteBucketOpt),
 
 	/// Alias bucket under new name
-	#[structopt(name = "alias")]
+	#[structopt(name = "alias", version = version::garage())]
 	Alias(AliasBucketOpt),
 
 	/// Remove bucket alias
-	#[structopt(name = "unalias")]
+	#[structopt(name = "unalias", version = version::garage())]
 	Unalias(UnaliasBucketOpt),
 
 	/// Allow key to read or write to bucket
-	#[structopt(name = "allow")]
+	#[structopt(name = "allow", version = version::garage())]
 	Allow(PermBucketOpt),
 
 	/// Deny key from reading or writing to bucket
-	#[structopt(name = "deny")]
+	#[structopt(name = "deny", version = version::garage())]
 	Deny(PermBucketOpt),
 
 	/// Expose as website or not
-	#[structopt(name = "website")]
+	#[structopt(name = "website", version = version::garage())]
 	Website(WebsiteOpt),
 
 	/// Set the quotas for this bucket
-	#[structopt(name = "set-quotas")]
+	#[structopt(name = "set-quotas", version = version::garage())]
 	SetQuotas(SetQuotasOpt),
 }
 
@@ -292,35 +293,35 @@ pub struct SetQuotasOpt {
 #[derive(Serialize, Deserialize, StructOpt, Debug)]
 pub enum KeyOperation {
 	/// List keys
-	#[structopt(name = "list")]
+	#[structopt(name = "list", version = version::garage())]
 	List,
 
 	/// Get key info
-	#[structopt(name = "info")]
+	#[structopt(name = "info", version = version::garage())]
 	Info(KeyOpt),
 
 	/// Create new key
-	#[structopt(name = "new")]
+	#[structopt(name = "new", version = version::garage())]
 	New(KeyNewOpt),
 
 	/// Rename key
-	#[structopt(name = "rename")]
+	#[structopt(name = "rename", version = version::garage())]
 	Rename(KeyRenameOpt),
 
 	/// Delete key
-	#[structopt(name = "delete")]
+	#[structopt(name = "delete", version = version::garage())]
 	Delete(KeyDeleteOpt),
 
 	/// Set permission flags for key
-	#[structopt(name = "allow")]
+	#[structopt(name = "allow", version = version::garage())]
 	Allow(KeyPermOpt),
 
 	/// Unset permission flags for key
-	#[structopt(name = "deny")]
+	#[structopt(name = "deny", version = version::garage())]
 	Deny(KeyPermOpt),
 
 	/// Import key
-	#[structopt(name = "import")]
+	#[structopt(name = "import", version = version::garage())]
 	Import(KeyImportOpt),
 }
 
@@ -392,7 +393,7 @@ pub struct MigrateOpt {
 #[derive(Serialize, Deserialize, StructOpt, Debug, Eq, PartialEq, Clone)]
 pub enum MigrateWhat {
 	/// Migrate buckets and permissions from v0.5.0
-	#[structopt(name = "buckets050")]
+	#[structopt(name = "buckets050", version = version::garage())]
 	Buckets050,
 }
 
@@ -413,19 +414,19 @@ pub struct RepairOpt {
 #[derive(Serialize, Deserialize, StructOpt, Debug, Eq, PartialEq, Clone)]
 pub enum RepairWhat {
 	/// Only do a full sync of metadata tables
-	#[structopt(name = "tables")]
+	#[structopt(name = "tables", version = version::garage())]
 	Tables,
 	/// Only repair (resync/rebalance) the set of stored blocks
-	#[structopt(name = "blocks")]
+	#[structopt(name = "blocks", version = version::garage())]
 	Blocks,
 	/// Only redo the propagation of object deletions to the version table (slow)
-	#[structopt(name = "versions")]
+	#[structopt(name = "versions", version = version::garage())]
 	Versions,
 	/// Only redo the propagation of version deletions to the block ref table (extremely slow)
-	#[structopt(name = "block_refs")]
+	#[structopt(name = "block_refs", version = version::garage())]
 	BlockRefs,
 	/// Verify integrity of all blocks on disc (extremely slow, i/o intensive)
-	#[structopt(name = "scrub")]
+	#[structopt(name = "scrub", version = version::garage())]
 	Scrub {
 		#[structopt(subcommand)]
 		cmd: ScrubCmd,
@@ -435,19 +436,19 @@ pub enum RepairWhat {
 #[derive(Serialize, Deserialize, StructOpt, Debug, Eq, PartialEq, Clone)]
 pub enum ScrubCmd {
 	/// Start scrub
-	#[structopt(name = "start")]
+	#[structopt(name = "start", version = version::garage())]
 	Start,
 	/// Pause scrub (it will resume automatically after 24 hours)
-	#[structopt(name = "pause")]
+	#[structopt(name = "pause", version = version::garage())]
 	Pause,
 	/// Resume paused scrub
-	#[structopt(name = "resume")]
+	#[structopt(name = "resume", version = version::garage())]
 	Resume,
 	/// Cancel scrub in progress
-	#[structopt(name = "cancel")]
+	#[structopt(name = "cancel", version = version::garage())]
 	Cancel,
 	/// Set tranquility level for in-progress and future scrubs
-	#[structopt(name = "set-tranquility")]
+	#[structopt(name = "set-tranquility", version = version::garage())]
 	SetTranquility {
 		#[structopt()]
 		tranquility: u32,
@@ -468,10 +469,10 @@ pub struct OfflineRepairOpt {
 pub enum OfflineRepairWhat {
 	/// Repair K2V item counters
 	#[cfg(feature = "k2v")]
-	#[structopt(name = "k2v_item_counters")]
+	#[structopt(name = "k2v_item_counters", version = version::garage())]
 	K2VItemCounters,
 	/// Repair object counters
-	#[structopt(name = "object_counters")]
+	#[structopt(name = "object_counters", version = version::garage())]
 	ObjectCounters,
 }
 
@@ -495,7 +496,7 @@ pub struct WorkerOpt {
 #[derive(Serialize, Deserialize, StructOpt, Debug, Eq, PartialEq, Clone)]
 pub enum WorkerCmd {
 	/// List all workers on Garage node
-	#[structopt(name = "list")]
+	#[structopt(name = "list", version = version::garage())]
 	List {
 		#[structopt(flatten)]
 		opt: WorkerListOpt,
diff --git a/src/garage/main.rs b/src/garage/main.rs
index 3fa5c3c0..89888884 100644
--- a/src/garage/main.rs
+++ b/src/garage/main.rs
@@ -22,6 +22,7 @@ use garage_util::error::*;
 
 use garage_rpc::system::*;
 use garage_rpc::*;
+use garage_util::version;
 
 use garage_model::helper::error::Error as HelperError;
 
@@ -29,7 +30,7 @@ use admin::*;
 use cli::*;
 
 #[derive(StructOpt, Debug)]
-#[structopt(name = "garage")]
+#[structopt(name = "garage", version = version::garage(), about = "S3-compatible object store for self-hosted geo-distributed deployments")]
 struct Opt {
 	/// Host to connect to for admin operations, in the format:
 	/// <public-key>@<ip>:<port>
diff --git a/src/rpc/Cargo.toml b/src/rpc/Cargo.toml
index 73328993..80a1975c 100644
--- a/src/rpc/Cargo.toml
+++ b/src/rpc/Cargo.toml
@@ -19,7 +19,6 @@ garage_util = { version = "0.7.0", path = "../util" }
 arc-swap = "1.0"
 bytes = "1.0"
 gethostname = "0.2"
-git-version = "0.3.4"
 hex = "0.4"
 tracing = "0.1.30"
 rand = "0.8"
diff --git a/src/rpc/system.rs b/src/rpc/system.rs
index f9f2970b..fbfbbf56 100644
--- a/src/rpc/system.rs
+++ b/src/rpc/system.rs
@@ -27,6 +27,7 @@ use garage_util::data::*;
 use garage_util::error::*;
 use garage_util::persister::Persister;
 use garage_util::time::*;
+use garage_util::version;
 
 use crate::consul::*;
 #[cfg(feature = "kubernetes-discovery")]
@@ -320,11 +321,7 @@ impl System {
 	//      also available through RPC) ----
 
 	pub fn garage_version(&self) -> &'static str {
-		option_env!("GIT_VERSION").unwrap_or(git_version::git_version!(
-			prefix = "git:",
-			cargo_prefix = "cargo:",
-			fallback = "unknown"
-		))
+		version::garage()
 	}
 
 	pub fn get_known_nodes(&self) -> Vec<KnownNodeInfo> {
diff --git a/src/util/Cargo.toml b/src/util/Cargo.toml
index 57c70ffb..783fb3fc 100644
--- a/src/util/Cargo.toml
+++ b/src/util/Cargo.toml
@@ -24,6 +24,7 @@ hex = "0.4"
 tracing = "0.1.30"
 rand = "0.8"
 sha2 = "0.9"
+git-version = "0.3.4"
 
 chrono = "0.4"
 rmp-serde = "0.15"
@@ -43,5 +44,6 @@ hyper = "0.14"
 
 opentelemetry = { version = "0.17", features = [ "rt-tokio", "metrics", "trace" ] }
 
+
 [features]
 k2v = []
diff --git a/src/util/lib.rs b/src/util/lib.rs
index fce151af..47c85c3a 100644
--- a/src/util/lib.rs
+++ b/src/util/lib.rs
@@ -14,3 +14,4 @@ pub mod persister;
 pub mod time;
 pub mod token_bucket;
 pub mod tranquilizer;
+pub mod version;
diff --git a/src/util/version.rs b/src/util/version.rs
new file mode 100644
index 00000000..8882d035
--- /dev/null
+++ b/src/util/version.rs
@@ -0,0 +1,7 @@
+pub fn garage() -> &'static str {
+	option_env!("GIT_VERSION").unwrap_or(git_version::git_version!(
+		prefix = "git:",
+		cargo_prefix = "cargo:",
+		fallback = "unknown"
+	))
+}