feature audit

cargo/Cargo.toml

@@ -8,6 +8,8 @@ license.workspace = true
 
 [dependencies]
 clap = { workspace = true, features = ["derive"] }
+quick-xml = { workspace = true, features = ["serialize"] }
+serde = { workspace = true, features = ["derive"] }
 glob.workspace = true
 tracing-subscriber.workspace = true
 tracing.workspace = true

cargo/src/audit.rs

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: MPL-2.0
+
+// Copyright (C) 2023  Soc Virnyl Estela
+
+// 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 https://mozilla.org/MPL/2.0/.
+
+// use std::error::Error;
+// use std::fmt;
+use std::io;
+use std::path::PathBuf;
+// use std::process;
+
+use clap::Parser;
+
+#[derive(Parser, Debug)]
+#[command(
+    author,
+    name = "cargo_vendor",
+    version,
+    about = "OBS Source Service to vendor all crates.io and dependencies for Rust project locally",
+    after_long_help = "Set verbosity and tracing through `RUST_LOG` environmental variable e.g. `RUST_LOG=trace`
+
+Bugs can be reported on GitHub: https://github.com/uncomfyhalomacro/obs-service-cargo_vendor-rs/issues",
+    max_term_width = 120
+)]
+pub struct AuditOpts {
+    #[clap(flatten)]
+    src: AuditSrc,
+    #[arg(long, help = "Where to find other lockfiles for auditing.")]
+    lockfiles: Option<Vec<PathBuf>>,
+}
+
+#[derive(clap::Args, Debug, Clone)]
+pub struct AuditSrc {
+    #[arg(
+        long,
+        visible_aliases = ["srctar", "srcdir"],
+        help = "Where to find sources. Source is either a directory or a source tarball AND cannot be both."
+    )]
+    // NOTE If `None`, check `_service`
+    src: Option<PathBuf>,
+}
+
+// TODO: Replace some of the return types with a Custom Error
+pub trait Audit {
+    // RATIONALE: Running this command should be have two states
+    // 1. With src option
+    // 2. Without src option
+    // If 2, read the `_service` file.
+    fn run_audit(&self, opts: &AuditOpts) -> io::Result<()>;
+}

cargo/src/bin/cargo_audit.rs

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MPL-2.0
+
+// Copyright (C) 2023  Soc Virnyl Estela
+
+// 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 https://mozilla.org/MPL/2.0/.
+
+#![deny(warnings)]
+#![warn(unused_extern_crates)]
+// Enable some groups of clippy lints.
+#![deny(clippy::suspicious)]
+#![deny(clippy::perf)]
+// Specific lints to enforce.
+#![warn(clippy::todo)]
+#![deny(clippy::unimplemented)]
+#![deny(clippy::unwrap_used)]
+#![deny(clippy::expect_used)]
+#![deny(clippy::panic)]
+#![deny(clippy::await_holding_lock)]
+#![deny(clippy::needless_pass_by_value)]
+#![deny(clippy::trivially_copy_pass_by_ref)]
+#![deny(clippy::disallowed_types)]
+#![deny(clippy::manual_let_else)]
+#![allow(clippy::unreachable)]
+
+use clap::Parser;
+use obs_service_cargo::audit::AuditOpts;
+
+fn main() {
+    let _my_args = AuditOpts::parse();
+}

cargo/src/lib.rs

@@ -24,7 +24,9 @@
 #![deny(clippy::manual_let_else)]
 #![allow(clippy::unreachable)]
 
+pub mod audit;
 pub mod cli;
 pub mod consts;
+pub mod services;
 pub mod utils;
 pub mod vendor;

cargo/src/services.rs

@@ -0,0 +1,56 @@
+use std::path::Path;
+
+use quick_xml as xml;
+use serde::Deserialize;
+use serde::Serialize;
+#[allow(unused_imports)]
+use tracing::{debug, error, info, trace, warn, Level};
+use xml::de::from_str;
+
+#[derive(Serialize, Deserialize, Debug)]
+#[serde(rename_all = "kebab-case")]
+pub struct Services {
+    #[serde(rename = "service")]
+    service: Service,
+}
+
+#[derive(Serialize, Deserialize, Debug)]
+#[serde(rename_all = "kebab-case")]
+pub struct Service {
+    #[serde(rename = "@name")]
+    name: Option<String>,
+    #[serde(rename = "@mode")]
+    mode: Option<String>,
+    #[serde(rename = "param")]
+    param: Option<Vec<Param>>,
+}
+
+#[derive(Serialize, Deserialize, Debug)]
+#[serde(rename_all = "kebab-case")]
+pub struct Param {
+    #[serde(rename = "@name")]
+    name: String,
+    #[serde(rename = "$text")]
+    text: Option<String>,
+}
+
+impl Services {
+    pub fn from_file<P: AsRef<Path>>(p: P) -> std::io::Result<Self> {
+        match std::fs::read_to_string(p).map(|content| from_str::<Services>(&content)) {
+            Ok(c) => match c {
+                Ok(ay) => Ok(ay),
+                Err(err) => {
+                    error!(?err, "Failed to deserialize xml string");
+                    Err(std::io::Error::new(
+                        std::io::ErrorKind::InvalidData,
+                        "Failed to deserialize xml string",
+                    ))
+                }
+            },
+            Err(err) => {
+                error!(?err, "Failed to read file to string");
+                Err(err)
+            }
+        }
+    }
+}