Ignore build.rs since that code doesn't end up in the target binary (#193)

* Ignore build.rs since that code doesn't end up in the target binary

* remove stats in doc-comment coming from build.rs

Author: qrilka

cargo-geiger/src/scan.rs

@@ -53,6 +53,7 @@ pub struct ScanResult {
 #[derive(Default)]
 pub struct GeigerContext {
     pub package_id_to_metrics: HashMap<PackageId, PackageMetrics>,
+    pub ignored_paths: HashSet<PathBuf>,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -184,7 +185,10 @@ fn list_files_used_but_not_scanned(
     rs_files_used
         .iter()
         .cloned()
-        .filter(|p| !scanned_files.contains(p))
+        .filter(|p| {
+            !scanned_files.contains(p)
+                && !geiger_context.ignored_paths.contains(p)
+        })
         .collect()
 }
 
@@ -449,6 +453,7 @@ mod scan_tests {
             .iter()
             .cloned()
             .collect(),
+            ignored_paths: HashSet::new(),
         };
 
         let rs_files_used = input_rs_files_used_vec.iter().cloned().collect();

cargo-geiger/src/scan/find.rs

@@ -13,7 +13,7 @@ use cargo::{CliError, Config};
 use cargo_metadata::PackageId;
 use geiger::find::find_unsafe_in_file;
 use geiger::{IncludeTests, RsFileMetrics, ScanFileError};
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 use std::path::Path;
 use std::path::PathBuf;
 use walkdir::WalkDir;
@@ -48,13 +48,18 @@ where
     F: FnMut(usize, usize) -> CargoResult<()>,
 {
     let mut package_id_to_metrics = HashMap::new();
+    let mut ignored = HashSet::new();
     let packages = cargo_metadata_parameters.metadata.packages.to_vec();
     let package_code_files: Vec<_> =
         find_rs_files_in_packages(&packages).collect();
     let package_code_file_count = package_code_files.len();
     for (i, (package_id, rs_code_file)) in
         package_code_files.into_iter().enumerate()
     {
+        if let RsFile::CustomBuildRoot(path_buf) = rs_code_file {
+            ignored.insert(path_buf);
+            continue;
+        }
         let (is_entry_point, path_buf) =
             into_is_entry_point_and_path_buf(rs_code_file);
         if let (false, ScanMode::EntryPointsOnly) = (is_entry_point, &mode) {
@@ -90,6 +95,7 @@ where
 
     GeigerContext {
         package_id_to_metrics: cargo_core_package_metrics,
+        ignored_paths: ignored,
     }
 }
 

cargo-geiger/tests/external_package_reports/mod.rs

@@ -96,11 +96,11 @@ pub fn doc_comment_safety_report() -> SafetyReport {
         unsafety: UnsafeInfo {
             used: CounterBlock {
                 functions: Count {
-                    safe: 1,
+                    safe: 0,
                     unsafe_: 0,
                 },
                 exprs: Count {
-                    safe: 37,
+                    safe: 0,
                     unsafe_: 0,
                 },
                 ..Default::default()

cargo-geiger/tests/integration_tests.rs

@@ -19,7 +19,8 @@ use std::process::Output;
     case("test4_workspace_with_top_level_package"),
     case("test5_workspace_with_virtual_manifest"),
     case("test6_cargo_lock_out_of_date"),
-    case("test7_package_with_patched_dep")
+    case("test7_package_with_patched_dep"),
+    case("test8_package_with_build_rs_no_deps")
 )]
 fn test_package(name: &str) {
     better_panic::install();

cargo-geiger/tests/snapshots/integration_tests__test8_package_with_build_rs_no_deps.stdout.snap

@@ -0,0 +1,21 @@
+---
+source: cargo-geiger/tests/integration_tests.rs
+expression: stdout
+---
+
+Metric output format: x/y
+    x = unsafe code used by the build
+    y = total unsafe code found in the crate
+
+Symbols: 
+    :) = No `unsafe` usage found, declares #![forbid(unsafe_code)]
+    ?  = No `unsafe` usage found, missing #![forbid(unsafe_code)]
+    !  = `unsafe` usage found
+
+Functions  Expressions  Impls  Traits  Methods  Dependency
+
+0/0        0/0          0/0    0/0     0/0      ?  test8_package_with_build_rs_no_deps 0.1.0
+
+0/0        0/0          0/0    0/0     0/0    
+
+

test_crates/test8_package_with_build_rs_no_deps/Cargo.lock

@@ -0,0 +1,7 @@
+[package]
+name = "test8_package_with_build_rs_no_deps"
+version = "0.1.0"
+edition = "2018"
+
+[dependencies]
+[workspace]

test_crates/test8_package_with_build_rs_no_deps/Cargo.toml

@@ -0,0 +1,5 @@
+pub unsafe fn f() {
+    unimplemented!()
+}
+
+fn main() {}

test_crates/test8_package_with_build_rs_no_deps/README.md

@@ -0,0 +1,4 @@
+pub fn g() {
+    println!("Hello");
+}
+