Extended README.md

Author: oxisto

README.md

@@ -2,4 +2,47 @@
 
 This repository is a proof-of-concept for a CSAF library in Rust that relies on automatically generating CSAF document structs from the JSON schema.
 
-This is work-in-progress.
+This is work-in-progress.
+
+## Build
+
+If you want to build `csaf-validator` on your own, please install Rust (see https://rustup.rs) and then run
+
+```bash
+cargo build --release
+```
+
+The final binary will be in `target/release` and can then installed for example in a system-wide folder.
+
+## Usage
+
+After building or downloading `csaf-validator`, the usage is quite simple and additional help can be display using `--help`.
+
+```
+A validator for CSAF documents
+
+Usage: csaf-validator [OPTIONS] <PATH>
+
+Arguments:
+  <PATH>  
+
+Options:
+  -c, --csaf-version <CSAF_VERSION>  Version of CSAF to use [default: 2.0]
+  -p, --profile <PROFILE>            The profile to use [default: basic]
+  -o, --only-test <ONLY_TEST>        Run only the selected test
+  -h, --help                         Print help
+  -V, --version                      Print version
+```
+
+Some examples to use are included below. Please note that the validation is not yet fully implemented!
+
+```
+# validate a CSAF 2.0 document with profile basic (the default)
+csaf-validator --csaf-version 2.0 my-csaf-2-0-document.json
+
+# validate a CSAF 2.0 document with profile full
+csaf-validator --csaf-version 2.0 --profile full my-csaf-2-0-document.json
+
+# validate a CSAF 2.1 document with a specific test
+csaf-validator --csaf-version 2.1 --only-test 6.1.34 my-csaf-2-1-document.json
+```

csaf-lib/src/csaf/validation.rs

@@ -52,7 +52,7 @@ pub trait Validatable<VersionedDocument> {
 /// Executes all tests of the specified [profile] against the [target]
 /// (which is of type [VersionedDocument], e.g. a CSAF 2.0 document).
 pub fn validate_by_profile<VersionedDocument>(
-    target: impl Validatable<VersionedDocument>,
+    target: &impl Validatable<VersionedDocument>,
     profile: ValidationProfile,
 ) {
     println!("Validating document with {:?} profile... \n", profile);
@@ -61,15 +61,7 @@ pub fn validate_by_profile<VersionedDocument>(
     if let Some(tests) = target.profiles().get(&profile) {
         for test_id in tests {
             println!("Executing Test {}... ", test_id);
-
-            if let Some(test_fn) = target.tests().get(test_id) {
-                let _ = match test_fn(target.doc()) {
-                    Ok(()) => println!("> Test Success"),
-                    Err(e) => println!("> Error: {}", e),
-                };
-            } else {
-                println!("Test with ID {} is missing implementation", test_id);
-            }
+            validate_by_test(target, test_id);
 
             println!()
         }
@@ -79,8 +71,15 @@ pub fn validate_by_profile<VersionedDocument>(
 }
 
 pub fn validate_by_test<VersionedDocument>(
-    target: impl Validatable<VersionedDocument>,
+    target: &impl Validatable<VersionedDocument>,
     test_id: &str,
 ) {
-    todo!()
+    if let Some(test_fn) = target.tests().get(test_id) {
+        let _ = match test_fn(target.doc()) {
+            Ok(()) => println!("> Test Success"),
+            Err(e) => println!("> Error: {}", e),
+        };
+    } else {
+        println!("Test with ID {} is missing implementation", test_id);
+    }
 }

csaf-validator/src/main.rs

@@ -1,8 +1,7 @@
-use anyhow::{anyhow, bail, Result};
+use 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, validate_by_test, Validatable, ValidationProfile};
-use std::env;
+use csaf_lib::csaf::validation::{validate_by_profile, validate_by_test, ValidationProfile};
 use clap::Parser;
 
 /// A validator for CSAF documents
@@ -34,10 +33,10 @@ fn main() -> 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())
+                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())
+                validate_by_test(&load_document_2_1(args.path.as_str())?, test_id.as_str())
             }
             _ => bail!("invalid version"),
         };
@@ -46,10 +45,10 @@ fn main() -> Result<()> {
     } else {
         let result = match args.csaf_version.as_str() {
             "2.0" => {
-                validate_by_profile(load_document_2_0(args.path.as_str())?, profile)
+                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)
+                validate_by_profile(&load_document_2_1(args.path.as_str())?, profile)
             }
             _ => bail!("invalid version"),
         };