Merge pull request #32 from CoinFabrik/develop

version with better output

apps/cargo-scout-audit/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-scout-audit"
-version = "0.2.9"
+version = "0.2.10"
 edition = "2021"
 authors = [
     "Agustin Aon <agustin.aon@coinfabrik.com>",

apps/cargo-scout-audit/src/output/markdown/generator.rs

@@ -4,14 +4,9 @@ use crate::output::report::{Category, Finding};
 
 use super::utils;
 
-const BANNER_URL: &str = "https://www.example.com/banner.png";
-
 // Generate the header for the report
 pub fn generate_header(date: String) -> String {
-    format!(
-        "![Banner Scout report]({})\n# Scout Report - {}\n\n",
-        BANNER_URL, date
-    )
+    format!("# Scout Report - {}\n\n", date)
 }
 
 // Generate the summary for the report
@@ -116,7 +111,7 @@ fn generate_finding(finding: &Finding) -> String {
                           <li>- [ ] Resolved</li></ul>";
 
     format!(
-        "<tr><td>{}</td><td><a href=\"{}\">{}</a></td><td>{}</td></tr>\n",
-        finding.id, "link-to-github", finding.span, status_options
+        "<tr><td>{}</td><td><a>{}</a></td><td>{}</td></tr>\n",
+        finding.id, finding.span, status_options
     )
 }

apps/cargo-scout-audit/src/output/markdown/lib.rs

@@ -1,15 +1,11 @@
-use std::path::PathBuf;
+use anyhow::Result;
 
-use anyhow::{Context, Result};
-
-use crate::output::{report::Report, utils::write_to_file};
+use crate::output::report::Report;
 
 use super::generator::{generate_body, generate_header, generate_summary};
 
-const REPORT_MD_PATH: &str = "build/report.md";
-
 // Generates a markdown report from a given `Report` object.
-pub fn generate_markdown(report: &Report) -> Result<&'static str> {
+pub fn generate_markdown(report: &Report) -> Result<String> {
     let mut report_markdown = String::new();
 
     // Header
@@ -21,8 +17,5 @@ pub fn generate_markdown(report: &Report) -> Result<&'static str> {
     // Body
     report_markdown.push_str(&generate_body(&report.categories, &report.findings));
 
-    write_to_file(&PathBuf::from(REPORT_MD_PATH), report_markdown.as_bytes())
-        .with_context(|| format!("Failed to write markdown to '{}'", REPORT_MD_PATH))?;
-
-    Ok(REPORT_MD_PATH)
+    Ok(report_markdown)
 }

apps/cargo-scout-audit/src/output/pdf/generator.rs

@@ -128,7 +128,7 @@ fn generate_finding(finding: &Finding) -> String {
                           <li>- [ ] Resolved</li></ul>";
 
     format!(
-        "<tr><td>{}</td><td><a href=\"{}\">{}</a></td><td>{}</td></tr>\n",
-        finding.id, "link-to-github", finding.span, status_options
+        "<tr><td>{}</td><td><a >{}</a></td><td>{}</td></tr>\n",
+        finding.id, finding.span, status_options
     )
 }

apps/cargo-scout-audit/src/output/pdf/lib.rs

@@ -6,7 +6,7 @@ use crate::output::{report::Report, utils::write_to_file};
 
 use super::generator::{generate_body, generate_header, generate_summary};
 
-const REPORT_MD_PATH: &str = "build/report.html";
+const REPORT_MD_PATH: &str = "temp_report.html";
 
 // Generates a markdown report from a given `Report` object.
 pub fn generate_pdf(report: &Report) -> Result<&'static str> {

apps/cargo-scout-audit/src/output/report.rs

@@ -2,8 +2,8 @@ use anyhow::Result;
 use chrono::offset::Local;
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
+use std::collections::HashMap;
 use std::path::Path;
-use std::{collections::HashMap, os::unix::process::CommandExt};
 
 use super::{html, markdown, pdf};
 
@@ -78,17 +78,25 @@ impl Report {
         html::generate_html(self)
     }
 
-    pub fn generate_markdown(&self) -> Result<&'static str> {
+    pub fn generate_markdown(&self) -> Result<String> {
         markdown::generate_markdown(self)
     }
 
     pub fn generate_pdf(&self, path: &Path) -> Result<()> {
         let temp_html = pdf::generate_pdf(self)?;
 
-        std::process::Command::new("wkhtmltopdf")
+        //probe if wkhtmltopdf is installed
+        std::process::Command::new("which")
+            .arg("wkhtmltopdf")
+            .output()
+            .expect("Please, install wkhtmltopdf to generate pdf reports.");
+
+        let mut child = std::process::Command::new("wkhtmltopdf")
             .arg(temp_html)
             .arg(path.to_str().unwrap())
-            .exec();
+            .spawn()?;
+
+        child.wait()?;
 
         std::fs::remove_file(temp_html)?;
 

apps/cargo-scout-audit/src/startup.rs

@@ -389,14 +389,14 @@ fn run_dylint(
             let report = generate_report(content, info, detectors_info);
 
             // Generate Markdown
-            let markdown_path = report.generate_markdown()?;
+            let md_text = report.generate_markdown()?;
 
             let mut md_file = match &opts.output_path {
                 Some(path) => fs::File::create(path)?,
-                None => fs::File::create("report.html")?,
+                None => fs::File::create("report.md")?,
             };
 
-            std::io::Write::write_all(&mut md_file, markdown_path.as_bytes())?;
+            std::io::Write::write_all(&mut md_file, md_text.as_bytes())?;
         }
         OutputFormat::Sarif => {
             let path = if let Some(path) = opts.output_path {