parsing file paths from foundry.toml (#7063)

* parsing file paths from foundry.toml

* e2e test

* fix

* review: renaming

* Update crates/forge/tests/cli/cmd.rs

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

* review: improved test readability

---------

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

Cargo.toml

@@ -127,7 +127,7 @@ foundry-test-utils = { path = "crates/test-utils" }
 
 # solc & compilation utilities
 foundry-block-explorers = { version = "0.2.3", default-features = false }
-foundry-compilers = { version = "0.3.2", default-features = false }
+foundry-compilers = { version = "0.3.4", default-features = false }
 
 ## revm
 # no default features to avoid c-kzg
@@ -162,7 +162,7 @@ alloy-transport = { git = "https://github.com/alloy-rs/alloy" }
 alloy-transport-http = { git = "https://github.com/alloy-rs/alloy" }
 alloy-transport-ipc = { git = "https://github.com/alloy-rs/alloy" }
 alloy-transport-ws = { git = "https://github.com/alloy-rs/alloy" }
-alloy-primitives = "0.6.2"
+alloy-primitives = { version ="0.6.2", features = ["getrandom"] }
 alloy-dyn-abi = "0.6.2"
 alloy-json-abi = "0.6.2"
 alloy-sol-types = "0.6.2"

crates/config/README.md

@@ -106,6 +106,7 @@ etherscan_api_key = "YOURETHERSCANAPIKEY"
 # known error codes are: ["unreachable", "unused-return", "unused-param", "unused-var", "code-size", "shadowing", "func-mutability", "license", "pragma-solidity", "virtual-interfaces", "same-varname"]
 # additional warnings can be added using their numeric error code: ["license", 1337]
 ignored_error_codes = ["license", "code-size"]
+ignored_warnings_from = ["path_to_ignore"]
 deny_warnings = false
 match_test = "Foo"
 no_match_test = "Bar"

crates/config/src/lib.rs

@@ -214,6 +214,9 @@ pub struct Config {
     pub etherscan: EtherscanConfigs,
     /// list of solidity error codes to always silence in the compiler output
     pub ignored_error_codes: Vec<SolidityErrorCode>,
+    /// list of file paths to ignore
+    #[serde(rename = "ignored_warnings_from")]
+    pub ignored_file_paths: Vec<PathBuf>,
     /// When true, compiler warnings are treated as errors
     pub deny_warnings: bool,
     /// Only run test functions matching the specified regex pattern.
@@ -657,6 +660,7 @@ impl Config {
             .include_paths(&self.include_paths)
             .solc_config(SolcConfig::builder().settings(self.solc_settings()?).build())
             .ignore_error_codes(self.ignored_error_codes.iter().copied().map(Into::into))
+            .ignore_paths(self.ignored_file_paths.clone())
             .set_compiler_severity_filter(if self.deny_warnings {
                 Severity::Warning
             } else {
@@ -1868,6 +1872,7 @@ impl Default for Config {
                 SolidityErrorCode::ContractExceeds24576Bytes,
                 SolidityErrorCode::ContractInitCodeSizeExceeds49152Bytes,
             ],
+            ignored_file_paths: vec![],
             deny_warnings: false,
             via_ir: false,
             rpc_storage_caching: Default::default(),
@@ -3514,6 +3519,7 @@ mod tests {
                 gas_price = 0
                 gas_reports = ['*']
                 ignored_error_codes = [1878]
+                ignored_warnings_from = ["something"]
                 deny_warnings = false
                 initial_balance = '0xffffffffffffffffffffffff'
                 libraries = []
@@ -3561,6 +3567,7 @@ mod tests {
 
             let config = Config::load_with_root(jail.directory());
 
+            assert_eq!(config.ignored_file_paths, vec![PathBuf::from("something")]);
             assert_eq!(config.fuzz.seed, Some(U256::from(1000)));
             assert_eq!(
                 config.remappings,
@@ -4590,6 +4597,24 @@ mod tests {
         });
     }
 
+    #[test]
+    fn test_parse_file_paths() {
+        figment::Jail::expect_with(|jail| {
+            jail.create_file(
+                "foundry.toml",
+                r#"
+                [default]
+                ignored_warnings_from = ["something"]
+            "#,
+            )?;
+
+            let config = Config::load();
+            assert_eq!(config.ignored_file_paths, vec![Path::new("something").to_path_buf()]);
+
+            Ok(())
+        });
+    }
+
     #[test]
     fn test_parse_optimizer_settings() {
         figment::Jail::expect_with(|jail| {

crates/forge/bin/cmd/verify/etherscan/flatten.rs

@@ -80,7 +80,7 @@ impl EtherscanFlattenedSource {
         if out.has_error() {
             let mut o = AggregatedCompilerOutput::default();
             o.extend(version, out);
-            let diags = o.diagnostics(&[], Default::default());
+            let diags = o.diagnostics(&[], &[], Default::default());
 
             eyre::bail!(
                 "\

crates/forge/tests/cli/cmd.rs

@@ -10,7 +10,7 @@ use foundry_test_utils::{
 use semver::Version;
 use std::{
     env, fs,
-    path::PathBuf,
+    path::{Path, PathBuf},
     process::{Command, Stdio},
     str::FromStr,
 };
@@ -666,6 +666,42 @@ contract ATest is DSTest {
     }
 );
 
+// test that `forge build` does not print `(with warnings)` if file path is ignored
+forgetest!(can_compile_without_warnings_ignored_file_paths, |prj, cmd| {
+    // Ignoring path and setting empty error_codes as default would set would set some error codes
+    prj.write_config(Config {
+        ignored_file_paths: vec![Path::new("src").to_path_buf()],
+        ignored_error_codes: vec![],
+        ..Default::default()
+    });
+
+    prj.add_raw_source(
+        "src/example.sol",
+        r"
+pragma solidity *;
+contract A {
+    function testExample() public {}
+}
+",
+    )
+    .unwrap();
+
+    cmd.args(["build", "--force"]);
+    let out = cmd.stdout_lossy();
+    // expect no warning as path is ignored
+    assert!(out.contains("Compiler run successful!"));
+    assert!(!out.contains("Compiler run successful with warnings:"));
+
+    // Reconfigure without ignored paths or error codes and check for warnings
+    // need to reset empty error codes as default would set some error codes
+    prj.write_config(Config { ignored_error_codes: vec![], ..Default::default() });
+
+    let out = cmd.stdout_lossy();
+    // expect warnings as path is not ignored
+    assert!(out.contains("Compiler run successful with warnings:"), "{out}");
+    assert!(out.contains("Warning") && out.contains("SPDX-License-Identifier"), "{out}");
+});
+
 // test that `forge build` does not print `(with warnings)` if there arent any
 forgetest!(can_compile_without_warnings, |prj, cmd| {
     let config = Config {

crates/forge/tests/cli/config.rs

@@ -95,6 +95,7 @@ forgetest!(can_extract_config_values, |prj, cmd| {
             "src/DssSpell.sol:DssExecLib:0x8De6DDbCd5053d32292AAA0D2105A32d108484a6".to_string()
         ],
         ignored_error_codes: vec![],
+        ignored_file_paths: vec![],
         deny_warnings: false,
         via_ir: true,
         rpc_storage_caching: StorageCachingConfig {