Merge pull request #64 from Gioyik/gio/read_file

feat: add read from filesystem

Author: gcmurphy

Cargo.toml

@@ -24,19 +24,21 @@ thiserror = { version = "2.0", optional = true }
 url = { version = "2.3.1", optional = true }
 object_store = { version = "0.12.0", optional = true, features = ["gcp"] }
 futures = { version = "0.3.31", optional = true }
-
+walkdir = { version = "2.5.0", optional = true }
 
 [dev-dependencies]
 comfy-table = "7.1.1"
 cargo-release = "0.25.10"
 textwrap = { version = "0.16.1", features = ["default", "terminal_size"] }
 tokio-test = "0.4.3"
+tempfile = "3"
 
 [features]
 default = ["schema"]
 schema = []
 client = ["dep:tokio", "dep:reqwest", "dep:url", "dep:thiserror", "schema"]
 data = ["dep:object_store", "dep:thiserror", "dep:futures", "dep:tokio"]
+local = ["dep:thiserror", "dep:walkdir", "schema"]
 
 [[example]]
 name = "commit"
@@ -62,3 +64,13 @@ required-features = ["client"]
 name = "fetch"
 path = "examples/fetch.rs"
 required-features = ["data"]
+
+[[example]]
+name = "load_file"
+path = "examples/load_file.rs"
+required-features = ["local"]
+
+[[example]]
+name = "load_dir"
+path = "examples/load_dir.rs"
+required-features = ["local"]

examples/load_dir.rs

@@ -0,0 +1,66 @@
+//! Example: Loading multiple OSV vulnerabilities from a local directory.
+//!
+//! Requires the `local` feature to be enabled.
+//!
+//! Usage:
+//! 1. Create a directory (e.g., `test_vuln_dir`).
+//! 2. Create multiple dummy OSV JSON files inside it (e.g., `vuln1.json`, `vuln2.json`).
+//!    Use the format from the `load_file` example, changing the "id" for each.
+//! 3. Optionally create subdirectories with more `.json` files if testing recursion.
+//! 4. Run the example:
+//!    - Non-recursive: `cargo run --example load_dir --features local -- test_vuln_dir`
+//!    - Recursive: `cargo run --example load_dir --features local -- test_vuln_dir recursive`
+//! 5. Remember to delete `test_vuln_dir` afterwards.
+
+#[cfg(feature = "local")]
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    use osv::local::load_directory;
+    use std::env;
+    use std::path::Path;
+
+    let args: Vec<String> = env::args().collect();
+
+    if args.len() < 2 || args.len() > 3 {
+        eprintln!("Usage: cargo run --example load_dir --features local -- <path_to_directory> [recursive]");
+        std::process::exit(1);
+    }
+
+    let dir_path_str = &args[1];
+    let dir_path = Path::new(dir_path_str);
+    let recursive = args.len() == 3 && args[2] == "recursive";
+
+    println!(
+        "Attempting to load vulnerabilities from directory: {:?} (recursive: {})",
+        dir_path, recursive
+    );
+
+    match load_directory(dir_path, recursive) {
+        Ok(vulnerabilities) => {
+            println!(
+                "Successfully loaded {} vulnerabilities:",
+                vulnerabilities.len()
+            );
+            for (i, vulnerability) in vulnerabilities.iter().enumerate() {
+                println!(
+                    "  {}: ID = {}, Modified = {}",
+                    i + 1,
+                    vulnerability.id,
+                    vulnerability.modified
+                    // add more properties here to print
+                );
+            }
+        }
+        Err(e) => {
+            eprintln!("Error loading directory: {}", e);
+            std::process::exit(1);
+        }
+    }
+
+    Ok(())
+}
+
+#[cfg(not(feature = "local"))]
+fn main() {
+    println!("This example requires the 'local' feature to be enabled.");
+    println!("Run with: cargo run --example load_dir --features local -- <path> [recursive]");
+}

examples/load_file.rs

@@ -0,0 +1,80 @@
+//! Example: Loading a single OSV vulnerability from a local file.
+//!
+//! Requires the `local` feature to be enabled.
+//!
+//! Usage:
+//! 1. Create a dummy OSV JSON file (e.g., `test_vuln.json`):
+//!    ```json
+//!    {
+//!        "schema_version": "1.0.0",
+//!        "id": "TEST-VULN-001",
+//!        "modified": "2023-01-01T00:00:00Z",
+//!        "published": "2023-01-01T00:00:00Z",
+//!        "summary": "A test vulnerability",
+//!        "details": "Details about the test vulnerability.",
+//!        "affected": [
+//!            {
+//!                "package": {
+//!                    "name": "test-package",
+//!                    "ecosystem": "PyPI"
+//!                },
+//!                "ranges": [
+//!                    {
+//!                        "type": "SEMVER",
+//!                        "events": [
+//!                            { "introduced": "1.0.0" },
+//!                            { "fixed": "1.0.1" }
+//!                        ]
+//!                    }
+//!                ]
+//!            }
+//!        ]
+//!    }
+//!    ```
+//! 2. Run the example: `cargo run --example load_file --features local -- test_vuln.json`
+//! 3. Remember to delete `test_vuln.json` afterwards.
+
+#[cfg(feature = "local")]
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    use osv::local::load_vulnerability;
+    use std::env;
+    use std::path::Path;
+
+    let args: Vec<String> = env::args().collect();
+
+    if args.len() != 2 {
+        eprintln!("Usage: cargo run --example load_file --features local -- <path_to_osv_json_file>");
+        std::process::exit(1);
+    }
+
+    let file_path_str = &args[1];
+    let file_path = Path::new(file_path_str);
+
+    println!("Attempting to load vulnerability from: {:?}", file_path);
+
+    match load_vulnerability(file_path) {
+        Ok(vulnerability) => {
+            println!("Successfully loaded vulnerability:");
+            println!("ID: {}", vulnerability.id);
+            println!("Modified: {}", vulnerability.modified);
+            if let Some(summary) = &vulnerability.summary {
+                println!("Summary: {}", summary);
+            }
+            if let Some(details) = &vulnerability.details {
+                println!("Details: {}", details);
+            }
+        }
+        Err(e) => {
+            eprintln!("Error loading vulnerability: {}", e);
+            std::process::exit(1);
+        }
+    }
+
+    Ok(())
+}
+
+#[cfg(not(feature = "local"))]
+fn main() {
+    println!("This example requires the 'local' feature to be enabled.");
+    println!("Run with: cargo run --example load_file --features local -- <path>");
+}

src/lib.rs

@@ -6,3 +6,6 @@ pub mod client;
 
 #[cfg(feature = "data")]
 pub mod data;
+
+#[cfg(feature = "local")]
+pub mod local;