Merge pull request #3728 from mulkieran/metadata-check

Add a command-line tool and module for pool inspection

src/bin/tools/check_metadata.rs

@@ -0,0 +1,20 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+use std::{fs, path::Path};
+
+use stratisd::engine::pool_inspection::inspectors;
+
+pub fn run(infile: &Path, print: bool) -> Result<(), String> {
+    let metadata_str = fs::read_to_string(infile)
+        .map_err(|the_io_error| format!("Error opening file: {}", the_io_error))?;
+    let metadata = serde_json::from_str(&metadata_str)
+        .map_err(|the_json_error| format!("Error parsing json into structs: {}", the_json_error))?;
+
+    if print {
+        inspectors::print(&metadata).map_err(|the_error| format!("Error: {}", the_error))
+    } else {
+        inspectors::check(&metadata).map_err(|the_error| format!("Error: {}", the_error))
+    }
+}

src/bin/tools/cmds.rs

@@ -6,7 +6,7 @@ use std::path::PathBuf;
 
 use clap::{Arg, ArgAction, Command};
 
-use crate::tools::dump_metadata;
+use crate::tools::{check_metadata, dump_metadata};
 
 use stratisd::stratis::VERSION;
 
@@ -70,17 +70,87 @@ impl<'a> ToolCommand<'a> for StratisDumpMetadata {
     }
 }
 
+struct StratisCheckMetadata;
+
+impl StratisCheckMetadata {
+    fn cmd() -> Command {
+        Command::new("stratis-checkmetadata")
+            .version(VERSION)
+            .about("Check validity of Stratis metadata")
+            .next_line_help(true)
+            .arg(
+                Arg::new("file")
+                    .value_parser(clap::value_parser!(PathBuf))
+                    .required(true)
+                    .help("File containing pool-level metadata as JSON"),
+            )
+    }
+}
+
+impl<'a> ToolCommand<'a> for StratisCheckMetadata {
+    fn name(&self) -> &'a str {
+        "stratis-checkmetadata"
+    }
+
+    fn run(&self, command_line_args: Vec<String>) -> Result<(), String> {
+        let matches = StratisCheckMetadata::cmd().get_matches_from(command_line_args);
+        let infile = matches
+            .get_one::<PathBuf>("file")
+            .expect("'file' is a mandatory argument");
+
+        check_metadata::run(infile, false)
+    }
+}
+
+struct StratisPrintMetadata;
+
+impl StratisPrintMetadata {
+    fn cmd() -> Command {
+        Command::new("stratis-printmetadata")
+            .version(VERSION)
+            .about("Print a human-suitable representation of Stratis metadata")
+            .next_line_help(true)
+            .arg(
+                Arg::new("file")
+                    .value_parser(clap::value_parser!(PathBuf))
+                    .required(true)
+                    .help("File containing pool-level metadata as JSON"),
+            )
+    }
+}
+
+impl<'a> ToolCommand<'a> for StratisPrintMetadata {
+    fn name(&self) -> &'a str {
+        "stratis-printmetadata"
+    }
+
+    fn run(&self, command_line_args: Vec<String>) -> Result<(), String> {
+        let matches = StratisPrintMetadata::cmd().get_matches_from(command_line_args);
+        let infile = matches
+            .get_one::<PathBuf>("file")
+            .expect("'file' is a mandatory argument");
+
+        check_metadata::run(infile, true)
+    }
+}
+
 pub fn cmds<'a>() -> Vec<Box<dyn ToolCommand<'a>>> {
-    vec![Box::new(StratisDumpMetadata)]
+    vec![
+        Box::new(StratisCheckMetadata),
+        Box::new(StratisDumpMetadata),
+        Box::new(StratisPrintMetadata),
+    ]
 }
 
 #[cfg(test)]
 mod tests {
 
-    use super::StratisDumpMetadata;
+    use super::{StratisCheckMetadata, StratisDumpMetadata, StratisPrintMetadata};
 
     #[test]
     fn test_dumpmetadata_parse_args() {
+        StratisCheckMetadata::cmd().debug_assert();
         StratisDumpMetadata::cmd().debug_assert();
+        StratisPrintMetadata::cmd().debug_assert();
     }
 }

src/bin/tools/mod.rs

@@ -2,6 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
+mod check_metadata;
 mod cmds;
 mod dump_metadata;
 

src/engine/mod.rs

@@ -5,6 +5,9 @@
 #[cfg(feature = "test_extras")]
 pub use self::strat_engine::{ProcessedPathInfos, StratPool};
 
+#[cfg(feature = "extras")]
+pub use self::strat_engine::pool_inspection;
+
 pub use self::{
     engine::{BlockDev, Engine, Filesystem, KeyActions, Pool, Report},
     shared::{total_allocated, total_used},

src/engine/strat_engine/mod.rs

@@ -25,6 +25,9 @@ mod writing;
 #[cfg(feature = "test_extras")]
 pub use self::{backstore::ProcessedPathInfos, pool::v1::StratPool};
 
+#[cfg(feature = "extras")]
+pub use self::pool::inspection as pool_inspection;
+
 pub use self::{
     backstore::integrity_meta_space,
     crypt::{