feat/ absorb full context (#907)

Author: TilakMaddy

Cargo.lock

@@ -44,7 +44,7 @@ petgraph = "0"
 
 # Uncomment in Production (just before merging to dev)
 # Cyfrin managed github repository
-solidity_ast = { git = "https://github.com/Cyfrin/solidity-ast-rs", tag = "v0.0.1-alpha.beta.3", package = "solidity-ast" }
+solidity_ast = { git = "https://github.com/Cyfrin/solidity-ast-rs", tag = "v0.0.1-alpha.beta.4", package = "solidity-ast" }
 
 # Uncomment when debugging in branch (PR)
 # solidity_ast = { git = "https://github.com/Cyfrin/solidity-ast-rs", branch = "main", package = "solidity-ast" }

Cargo.toml

@@ -1,7 +1,11 @@
 use solidity_ast::EvmVersion;
 
 use crate::{ast::*, fscloc::cloc::IgnoreLine};
-use std::{cmp::Ordering, collections::HashMap};
+use std::{
+    cmp::Ordering,
+    collections::{HashMap, HashSet},
+    path::PathBuf,
+};
 
 use super::{browser::GetImmediateParent, capturable::Capturable, graph::WorkspaceCallGraph};
 pub use crate::ast::ASTNode;
@@ -35,6 +39,9 @@ pub struct WorkspaceContext {
     // Source units
     pub source_units_context: Vec<SourceUnit>,
 
+    // In-scope files
+    pub included: HashSet<PathBuf>,
+
     // Hashmaps of all nodes => source_unit_id
     pub(crate) array_type_names_context: HashMap<ArrayTypeName, NodeContext>,
     pub(crate) assignments_context: HashMap<Assignment, NodeContext>,

aderyn_core/src/context/workspace_context.rs

@@ -2,7 +2,8 @@ use std::{
     collections::{btree_map::Entry, BTreeMap, HashMap},
     error::Error,
     ops::Add,
-    path::Path,
+    path::{Path, PathBuf},
+    str::FromStr,
 };
 
 use crate::{
@@ -139,10 +140,20 @@ pub fn get_report(
                         if found {
                             let instances = d.instances();
                             let hints = d.hints();
-                            return (instances, hints, context.src_filepaths.clone());
+                            return (
+                                instances,
+                                hints,
+                                context.src_filepaths.clone(),
+                                context.included.clone(),
+                            );
                         }
                     }
-                    (Default::default(), Default::default(), context.src_filepaths.clone())
+                    (
+                        Default::default(),
+                        Default::default(),
+                        context.src_filepaths.clone(),
+                        context.included.clone(),
+                    )
                 })
                 .collect::<Vec<_>>();
 
@@ -175,7 +186,7 @@ pub fn get_report(
                 Vec<BTreeMap<(String, usize, String), i64>>,
             > = Default::default();
 
-            for (instances, hints, src_filepaths) in collection_of_instances {
+            for (instances, hints, src_filepaths, included) in collection_of_instances {
                 let mut grouped_instances_context: BTreeMap<
                     String,
                     BTreeMap<(String, usize, String), i64>,
@@ -201,6 +212,9 @@ pub fn get_report(
                 }
 
                 for (key, value) in grouped_instances_context {
+                    if !included.contains(&PathBuf::from_str(&key).unwrap()) {
+                        continue;
+                    }
                     match grouped_instances.entry(key.clone()) {
                         Entry::Vacant(v) => {
                             v.insert(vec![value]);

aderyn_core/src/detect/report.rs

@@ -1,14 +1,19 @@
 use crate::fscloc::cloc;
 use ignore::{DirEntry, WalkBuilder, WalkState::Continue};
 use rayon::prelude::*;
-use std::{collections::HashMap, path::Path, sync::Mutex};
+use std::{
+    collections::{HashMap, HashSet},
+    path::{Path, PathBuf},
+    sync::Mutex,
+};
 
 use super::cloc::Stats;
 
 pub fn count_lines_of_code_and_collect_line_numbers_to_ignore(
     src: &Path,
     src_filepaths: &[String],
     skip_cloc: bool,
+    included: &HashSet<PathBuf>,
 ) -> Mutex<HashMap<String, Stats>> {
     let (tx, rx) = crossbeam_channel::unbounded();
 
@@ -29,7 +34,11 @@ pub fn count_lines_of_code_and_collect_line_numbers_to_ignore(
         }
     };
 
-    let src_filepaths_as_paths = src_filepaths.iter().map(form_path).collect::<Vec<_>>();
+    let src_filepaths_as_paths = src_filepaths
+        .iter()
+        .map(form_path)
+        .filter(|s| included.contains(s.strip_prefix(src).unwrap()))
+        .collect::<Vec<_>>();
 
     if !src_filepaths_as_paths.is_empty() {
         // Only add the paths to WalkBuilder that we want to do analysis on.

aderyn_core/src/fscloc/engine.rs

@@ -13,7 +13,7 @@ pub struct CodeLines {
 
 #[cfg(test)]
 mod cloc_tests {
-    use std::path::PathBuf;
+    use std::{collections::HashSet, path::PathBuf, str::FromStr};
 
     use crate::fscloc::engine;
 
@@ -23,10 +23,15 @@ mod cloc_tests {
             "HeavilyCommentedContract.sol".to_string(),
             "AnotherHeavilyCommentedContract.sol".to_string(),
         ];
+        let included = HashSet::from_iter(vec![
+            PathBuf::from_str("HeavilyCommentedContract.sol").unwrap(),
+            PathBuf::from_str("AnotherHeavilyCommentedContract.sol").unwrap(),
+        ]);
         let sol = engine::count_lines_of_code_and_collect_line_numbers_to_ignore(
             PathBuf::from("../tests/contract-playground/src/cloc").as_path(),
             &src_filepaths,
             false,
+            &included,
         );
         let result = sol.lock().unwrap();
         result.iter().for_each(|element| println!("{} - {}", element.0, element.1.code));
@@ -49,10 +54,13 @@ mod cloc_tests {
     #[test]
     fn test_print_loc_specific_file() {
         let src_filepaths = vec!["HeavilyCommentedContract.sol".to_string()];
+        let included =
+            HashSet::from_iter(vec![PathBuf::from_str("HeavilyCommentedContract.sol").unwrap()]);
         let sol = engine::count_lines_of_code_and_collect_line_numbers_to_ignore(
             PathBuf::from("../tests/contract-playground/src/cloc").as_path(),
             &src_filepaths,
             false,
+            &included,
         );
         let result = sol.lock().unwrap();
         assert_eq!(result.len(), 1);

aderyn_core/src/fscloc/mod.rs

@@ -65,14 +65,13 @@ pub fn project(
                 display_ingesting_message(&sources_ast, &included, &ast_info.version.to_string());
             }
             for (source_path, ast_source_file) in sources_ast {
-                if included.contains(&source_path) {
-                    let content = sources.get(&source_path).cloned().expect("content not found");
-                    absorb_ast_content_into_context(ast_source_file, &mut context, content);
-                    context.src_filepaths.push(source_path.display().to_string());
-                }
+                let content = sources.get(&source_path).expect("content not found");
+                absorb_ast_content_into_context(ast_source_file, &mut context, content.clone());
+                context.src_filepaths.push(source_path.display().to_string());
             }
 
             context.evm_version = derived_ast_evm_info.evm_version;
+            context.included = included;
 
             Some(context)
         })

aderyn_driver/src/compile.rs

@@ -59,6 +59,7 @@ pub fn make_context(
             absolute_root_path.as_path(),
             &context.src_filepaths,
             common.skip_cloc,
+            &context.included,
         );
         let sloc_stats: HashMap<String, usize> = stats
             .lock()