Added CLI with clap

Author: oxisto

Cargo.lock

@@ -3,7 +3,7 @@ use std::str::FromStr;
 
 pub enum ValidationError {}
 
-#[derive(Debug, PartialEq, Eq, Hash)]
+#[derive(Debug, PartialEq, Eq, Hash, Clone)]
 pub enum ValidationProfile {
     Basic,
     Extended,
@@ -78,8 +78,8 @@ pub fn validate_by_profile<VersionedDocument>(
     }
 }
 
-fn validate_by_test<VersionedDocument>(
-    target: Box<dyn Validatable<VersionedDocument>>,
+pub fn validate_by_test<VersionedDocument>(
+    target: impl Validatable<VersionedDocument>,
     test_id: &str,
 ) {
     todo!()

csaf-lib/src/csaf/validation.rs

@@ -6,3 +6,4 @@ edition = "2021"
 [dependencies]
 csaf-lib = { path = "../csaf-lib" }
 anyhow = "1.0.93"
+clap = { version = "4.5.23", features = ["derive"] }

csaf-validator/Cargo.toml

@@ -1,31 +1,59 @@
 use anyhow::{anyhow, bail, Result};
 use csaf_lib::csaf::csaf2_0::loader::load_document as load_document_2_0;
 use csaf_lib::csaf::csaf2_1::loader::load_document as load_document_2_1;
-use csaf_lib::csaf::validation::{validate_by_profile, Validatable, ValidationProfile};
+use csaf_lib::csaf::validation::{validate_by_profile, validate_by_test, Validatable, ValidationProfile};
 use std::env;
+use clap::Parser;
 
-fn main() -> Result<()> {
-    let args: Vec<String> = env::args().collect();
+/// A validator for CSAF documents
+#[derive(Parser, Debug)]
+#[command(version, about, long_about = None)]
+struct Args {
+    #[arg()]
+    path: String,
+
+    /// Version of CSAF to use
+    #[arg(short, long, default_value = "2.0")]
+    csaf_version: String,
 
-    let path = match args.get(1) {
-        None => return Err(anyhow!("Please specify a file to validate")),
-        Some(v) => v,
-    };
+    /// The profile to use
+    #[arg(short, long, default_value = "basic")]
+    profile: String,
+
+    /// Run only the selected test
+    #[arg(short, long)]
+    only_test: Option<String>,
+}
 
+fn main() -> Result<()> {
+    let args = Args::parse();
     let profile = ValidationProfile::Basic;
 
     // TODO: it would be nice to return the validatable from this match, but this is beyond my
     //  rust generics knowledge, so a little bit of duplicate code here
-    let version = args.get(2).cloned().unwrap_or("2.0".to_string());
-    let result = match version.as_str() {
-        "2.0" => {
-            validate_by_profile(load_document_2_0(path)?, profile)
-        }
-        "2.1" => {
-            validate_by_profile(load_document_2_1(path)?, profile)
-        }
-        _ => bail!("invalid version"),
-    };
-
-    Ok(result)
+    if let Some(test_id) = args.only_test {
+        let result = match args.csaf_version.as_str() {
+            "2.0" => {
+                validate_by_test(load_document_2_0(args.path.as_str())?, test_id.as_str())
+            }
+            "2.1" => {
+                validate_by_test(load_document_2_1(args.path.as_str())?, test_id.as_str())
+            }
+            _ => bail!("invalid version"),
+        };
+
+        Ok(result)
+    } else {
+        let result = match args.csaf_version.as_str() {
+            "2.0" => {
+                validate_by_profile(load_document_2_0(args.path.as_str())?, profile)
+            }
+            "2.1" => {
+                validate_by_profile(load_document_2_1(args.path.as_str())?, profile)
+            }
+            _ => bail!("invalid version"),
+        };
+
+        Ok(result)
+    }
 }