config.rs

//! Contains various tests for checking forge commands related to config values
use crate::forge_utils;
use ethers::{
    prelude::artifacts::YulDetails,
    solc::artifacts::RevertStrings,
    types::{Address, H256, U256},
};
use forge::executor::opts::EvmOpts;
use foundry_cli_test_utils::{
    ethers_solc::{remappings::Remapping, EvmVersion},
    forgetest, forgetest_init, pretty_eq,
    util::{pretty_err, OutputExt, TestCommand, TestProject},
};
use foundry_config::{
    cache::{CachedChains, CachedEndpoints, StorageCachingConfig},
    Config, FuzzConfig, InvariantConfig, OptimizerDetails, SolcReq,
};
use path_slash::PathBufExt;
use std::{fs, path::PathBuf, str::FromStr};

// tests all config values that are in use
forgetest!(can_extract_config_values, |prj: TestProject, mut cmd: TestCommand| {
    // explicitly set all values
    let input = Config {
        profile: Config::DEFAULT_PROFILE,
        __root: Default::default(),
        src: "test-src".into(),
        test: "test-test".into(),
        script: "test-script".into(),
        out: "out-test".into(),
        libs: vec!["lib-test".into()],
        cache: true,
        cache_path: "test-cache".into(),
        broadcast: "broadcast".into(),
        force: true,
        evm_version: EvmVersion::Byzantium,
        gas_reports: vec!["Contract".to_string()],
        gas_reports_ignore: vec![],
        solc: Some(SolcReq::Local(PathBuf::from("custom-solc"))),
        auto_detect_solc: false,
        auto_detect_remappings: true,
        offline: true,
        optimizer: false,
        optimizer_runs: 1000,
        optimizer_details: Some(OptimizerDetails {
            yul: Some(false),
            yul_details: Some(YulDetails { stack_allocation: Some(true), ..Default::default() }),
            ..Default::default()
        }),
        model_checker: None,
        extra_output: Default::default(),
        extra_output_files: Default::default(),
        names: true,
        sizes: true,
        test_pattern: None,
        test_pattern_inverse: None,
        contract_pattern: None,
        contract_pattern_inverse: None,
        path_pattern: None,
        path_pattern_inverse: None,
        fuzz: FuzzConfig {
            runs: 1000,
            max_test_rejects: 100203,
            seed: Some(1000.into()),
            ..Default::default()
        },
        invariant: InvariantConfig { runs: 256, ..Default::default() },
        ffi: true,
        sender: "00a329c0648769A73afAc7F9381D08FB43dBEA72".parse().unwrap(),
        tx_origin: "00a329c0648769A73afAc7F9F81E08FB43dBEA72".parse().unwrap(),
        initial_balance: U256::from(0xffffffffffffffffffffffffu128),
        block_number: 10,
        fork_block_number: Some(200),
        chain_id: Some(9999.into()),
        gas_limit: 99_000_000u64.into(),
        code_size_limit: Some(100000),
        gas_price: Some(999),
        block_base_fee_per_gas: 10,
        block_coinbase: Address::random(),
        block_timestamp: 10,
        block_difficulty: 10,
        block_prevrandao: H256::random(),
        block_gas_limit: Some(100u64.into()),
        memory_limit: 2u64.pow(25),
        eth_rpc_url: Some("localhost".to_string()),
        etherscan_api_key: None,
        etherscan: Default::default(),
        verbosity: 4,
        remappings: vec![Remapping::from_str("forge-std=lib/forge-std/").unwrap().into()],
        libraries: vec![
            "src/DssSpell.sol:DssExecLib:0x8De6DDbCd5053d32292AAA0D2105A32d108484a6".to_string()
        ],
        ignored_error_codes: vec![],
        deny_warnings: false,
        via_ir: true,
        rpc_storage_caching: StorageCachingConfig {
            chains: CachedChains::None,
            endpoints: CachedEndpoints::Remote,
        },
        no_storage_caching: true,
        no_rpc_rate_limit: true,
        use_literal_content: false,
        bytecode_hash: Default::default(),
        cbor_metadata: true,
        revert_strings: Some(RevertStrings::Strip),
        sparse_mode: true,
        allow_paths: vec![],
        include_paths: vec![],
        rpc_endpoints: Default::default(),
        build_info: false,
        build_info_path: None,
        fmt: Default::default(),
        doc: Default::default(),
        fs_permissions: Default::default(),
        __non_exhaustive: (),
        __warnings: vec![],
    };
    prj.write_config(input.clone());
    let config = cmd.config();
    pretty_assertions::assert_eq!(input, config);
});

// tests config gets printed to std out
forgetest!(
    #[serial_test::serial]
    can_show_config,
    |prj: TestProject, mut cmd: TestCommand| {
        cmd.arg("config");
        let expected =
            Config::load_with_root(prj.root()).to_string_pretty().unwrap().trim().to_string();
        assert_eq!(expected, cmd.stdout().trim().to_string());
    }
);

// checks that config works
// - foundry.toml is properly generated
// - paths are resolved properly
// - config supports overrides from env, and cli
forgetest_init!(
    #[serial_test::serial]
    can_override_config,
    |prj: TestProject, mut cmd: TestCommand| {
        cmd.set_current_dir(prj.root());
        let foundry_toml = prj.root().join(Config::FILE_NAME);
        assert!(foundry_toml.exists());

        let mut profile = Config::load_with_root(prj.root());
        // ensure that the auto-generated internal remapping for forge-std's ds-test exists
        assert_eq!(profile.remappings.len(), 3);
        pretty_eq!(
            "lib/forge-std:ds-test/=lib/forge-std/lib/ds-test/src/",
            profile.remappings[2].to_string()
        );

        // remove the auto-generated remapping to compare with `forge config` since `forge config`
        // does not include the auto-generated remappings
        profile.remappings.remove(2);
        assert_eq!(profile.remappings.len(), 2);

        // ensure remappings contain test
        pretty_eq!("ds-test/=lib/forge-std/lib/ds-test/src/", profile.remappings[0].to_string());
        // the loaded config has resolved, absolute paths
        pretty_eq!(
            "ds-test/=lib/forge-std/lib/ds-test/src/",
            Remapping::from(profile.remappings[0].clone()).to_string()
        );

        cmd.arg("config");
        let expected = profile.to_string_pretty().unwrap();
        pretty_eq!(expected.trim().to_string(), cmd.stdout().trim().to_string());

        // remappings work
        let remappings_txt =
            prj.create_file("remappings.txt", "ds-test/=lib/forge-std/lib/ds-test/from-file/");
        let config = forge_utils::load_config_with_root(Some(prj.root().into()));
        pretty_eq!(
            format!(
                "ds-test/={}/",
                prj.root().join("lib/forge-std/lib/ds-test/from-file").to_slash_lossy()
            ),
            Remapping::from(config.remappings[0].clone()).to_string()
        );

        // env vars work
        std::env::set_var("DAPP_REMAPPINGS", "ds-test/=lib/forge-std/lib/ds-test/from-env/");
        let config = forge_utils::load_config_with_root(Some(prj.root().into()));
        pretty_eq!(
            format!(
                "ds-test/={}/",
                prj.root().join("lib/forge-std/lib/ds-test/from-env").to_slash_lossy()
            ),
            Remapping::from(config.remappings[0].clone()).to_string()
        );

        let config =
            prj.config_from_output(["--remappings", "ds-test/=lib/forge-std/lib/ds-test/from-cli"]);
        pretty_eq!(
            format!(
                "ds-test/={}/",
                prj.root().join("lib/forge-std/lib/ds-test/from-cli").to_slash_lossy()
            ),
            Remapping::from(config.remappings[0].clone()).to_string()
        );

        let config = prj.config_from_output(["--remappings", "other-key/=lib/other/"]);
        assert_eq!(config.remappings.len(), 3);
        pretty_eq!(
            format!("other-key/={}/", prj.root().join("lib/other").to_slash_lossy()),
            Remapping::from(config.remappings[2].clone()).to_string()
        );

        std::env::remove_var("DAPP_REMAPPINGS");
        pretty_err(&remappings_txt, fs::remove_file(&remappings_txt));

        cmd.set_cmd(prj.forge_bin()).args(["config", "--basic"]);
        let expected = profile.into_basic().to_string_pretty().unwrap();
        pretty_eq!(expected.trim().to_string(), cmd.stdout().trim().to_string());
    }
);

forgetest_init!(
    #[serial_test::serial]
    can_detect_config_vals,
    |prj: TestProject, _cmd: TestCommand| {
        let url = "http://127.0.0.1:8545";
        let config = prj.config_from_output(["--no-auto-detect", "--rpc-url", url]);
        assert!(!config.auto_detect_solc);
        assert_eq!(config.eth_rpc_url, Some(url.to_string()));

        let mut config = Config::load_with_root(prj.root());
        config.eth_rpc_url = Some("http://127.0.0.1:8545".to_string());
        config.auto_detect_solc = false;
        // write to `foundry.toml`
        prj.create_file(
            Config::FILE_NAME,
            &config.to_string_pretty().unwrap().replace("eth_rpc_url", "eth-rpc-url"),
        );
        let config = prj.config_from_output(["--force"]);
        assert!(!config.auto_detect_solc);
        assert_eq!(config.eth_rpc_url, Some(url.to_string()));
    }
);

// checks that `clean` removes dapptools style paths
forgetest_init!(
    #[serial_test::serial]
    can_get_evm_opts,
    |prj: TestProject, _cmd: TestCommand| {
        let url = "http://127.0.0.1:8545";
        let config = prj.config_from_output(["--rpc-url", url, "--ffi"]);
        assert_eq!(config.eth_rpc_url, Some(url.to_string()));
        assert!(config.ffi);

        std::env::set_var("FOUNDRY_ETH_RPC_URL", url);
        let figment = Config::figment_with_root(prj.root()).merge(("debug", false));
        let evm_opts: EvmOpts = figment.extract().unwrap();
        assert_eq!(evm_opts.fork_url, Some(url.to_string()));
        std::env::remove_var("FOUNDRY_ETH_RPC_URL");
    }
);

// checks that we can set various config values
forgetest_init!(can_set_config_values, |prj: TestProject, _cmd: TestCommand| {
    let config = prj.config_from_output(["--via-ir"]);
    assert!(config.via_ir);
});

// tests that solc can be explicitly set
forgetest!(can_set_solc_explicitly, |prj: TestProject, mut cmd: TestCommand| {
    prj.inner()
        .add_source(
            "Foo",
            r#"
// SPDX-License-Identifier: UNLICENSED
pragma solidity >0.8.9;
contract Greeter {}
   "#,
        )
        .unwrap();

    // explicitly set to run with 0.8.10
    let config = Config { solc: Some("0.8.10".into()), ..Default::default() };
    prj.write_config(config);

    cmd.arg("build");

    assert!(cmd.stdout_lossy().ends_with(
        "
Compiler run successful!
",
    ));
});

// tests that `--use <solc>` works
forgetest!(can_use_solc, |prj: TestProject, mut cmd: TestCommand| {
    prj.inner()
        .add_source(
            "Foo",
            r#"
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.7.0;
contract Foo {}
   "#,
        )
        .unwrap();

    cmd.args(["build", "--use", "0.7.1"]);

    let stdout = cmd.stdout_lossy();
    assert!(stdout.contains("Compiler run successful"));

    cmd.forge_fuse().args(["build", "--force", "--use", "solc:0.7.1"]).root_arg();

    assert!(stdout.contains("Compiler run successful"));

    // fails to use solc that does not exist
    cmd.forge_fuse().args(["build", "--use", "this/solc/does/not/exist"]);
    assert!(cmd.stderr_lossy().contains("this/solc/does/not/exist does not exist"));

    // 0.7.1 was installed in previous step, so we can use the path to this directly
    let local_solc = ethers::solc::Solc::find_svm_installed_version("0.7.1")
        .unwrap()
        .expect("solc 0.7.1 is installed");
    cmd.forge_fuse().args(["build", "--force", "--use"]).arg(local_solc.solc).root_arg();
    assert!(stdout.contains("Compiler run successful"));
});

// test to ensure yul optimizer can be set as intended
forgetest!(can_set_yul_optimizer, |prj: TestProject, mut cmd: TestCommand| {
    prj.inner()
        .add_source(
            "Foo",
            r#"
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.10;
contract Foo {
    function bar() public pure {
       assembly {
            let result_start := msize()
       }
    }
}
   "#,
        )
        .unwrap();

    cmd.arg("build");
    cmd.unchecked_output().stderr_matches_path(
        PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/can_set_yul_optimizer.stderr"),
    );

    // disable yul optimizer explicitly
    let config = Config {
        optimizer_details: Some(OptimizerDetails { yul: Some(false), ..Default::default() }),
        ..Default::default()
    };
    prj.write_config(config);

    assert!(cmd.stdout_lossy().ends_with(
        "
Compiler run successful!
",
    ));
});

// tests that the lib triple can be parsed
forgetest_init!(can_parse_dapp_libraries, |_prj: TestProject, mut cmd: TestCommand| {
    cmd.set_env(
        "DAPP_LIBRARIES",
        "src/DssSpell.sol:DssExecLib:0x8De6DDbCd5053d32292AAA0D2105A32d108484a6",
    );
    let config = cmd.config();
    assert_eq!(
        config.libraries,
        vec!["src/DssSpell.sol:DssExecLib:0x8De6DDbCd5053d32292AAA0D2105A32d108484a6".to_string(),]
    );
});

// test that optimizer runs works
forgetest!(can_set_optimizer_runs, |prj: TestProject, mut cmd: TestCommand| {
    // explicitly set optimizer runs
    let config = Config { optimizer_runs: 1337, ..Default::default() };
    prj.write_config(config);

    let config = cmd.config();
    assert_eq!(config.optimizer_runs, 1337);

    let config = prj.config_from_output(["--optimizer-runs", "300"]);
    assert_eq!(config.optimizer_runs, 300);
});

// test that gas_price can be set
forgetest!(can_set_gas_price, |prj: TestProject, mut cmd: TestCommand| {
    // explicitly set gas_price
    let config = Config { gas_price: Some(1337), ..Default::default() };
    prj.write_config(config);

    let config = cmd.config();
    assert_eq!(config.gas_price, Some(1337));

    let config = prj.config_from_output(["--gas-price", "300"]);
    assert_eq!(config.gas_price, Some(300));
});

// test that optimizer runs works
forgetest_init!(can_detect_lib_foundry_toml, |prj: TestProject, mut cmd: TestCommand| {
    let config = cmd.config();
    let remappings = config.remappings.iter().cloned().map(Remapping::from).collect::<Vec<_>>();
    pretty_assertions::assert_eq!(
        remappings,
        vec![
            // global
            "ds-test/=lib/forge-std/lib/ds-test/src/".parse().unwrap(),
            "forge-std/=lib/forge-std/src/".parse().unwrap(),
        ]
    );
    // create a new lib directly in the `lib` folder with a remapping
    let mut config = config;
    config.remappings = vec![Remapping::from_str("nested/=lib/nested").unwrap().into()];
    let nested = prj.paths().libraries[0].join("nested-lib");
    pretty_err(&nested, fs::create_dir_all(&nested));
    let toml_file = nested.join("foundry.toml");
    pretty_err(&toml_file, fs::write(&toml_file, config.to_string_pretty().unwrap()));

    let config = cmd.config();
    let remappings = config.remappings.iter().cloned().map(Remapping::from).collect::<Vec<_>>();
    pretty_assertions::assert_eq!(
        remappings,
        vec![
            // global
            "ds-test/=lib/forge-std/lib/ds-test/src/".parse().unwrap(),
            "forge-std/=lib/forge-std/src/".parse().unwrap(),
            "nested-lib/=lib/nested-lib/src/".parse().unwrap(),
            // remapping is local to the lib
            "lib/nested-lib:nested/=lib/nested-lib/lib/nested/".parse().unwrap(),
        ]
    );

    // nest another lib under the already nested lib
    let mut config = config;
    config.remappings = vec![Remapping::from_str("nested-twice/=lib/nested-twice").unwrap().into()];
    let nested = nested.join("lib/another-lib");
    pretty_err(&nested, fs::create_dir_all(&nested));
    let toml_file = nested.join("foundry.toml");
    pretty_err(&toml_file, fs::write(&toml_file, config.to_string_pretty().unwrap()));

    let another_config = cmd.config();
    let remappings =
        another_config.remappings.iter().cloned().map(Remapping::from).collect::<Vec<_>>();
    pretty_assertions::assert_eq!(
        remappings,
        vec![
            // local to the lib
            "lib/nested-lib:another-lib/=lib/nested-lib/lib/another-lib/src/".parse().unwrap(),
            // global
            "ds-test/=lib/forge-std/lib/ds-test/src/".parse().unwrap(),
            "forge-std/=lib/forge-std/src/".parse().unwrap(),
            "nested-lib/=lib/nested-lib/src/".parse().unwrap(),
            // remappings local to the lib
            "lib/nested-lib:nested-twice/=lib/nested-lib/lib/another-lib/lib/nested-twice/"
                .parse()
                .unwrap(),
            "lib/nested-lib:nested/=lib/nested-lib/lib/nested/".parse().unwrap(),
        ]
    );

    config.src = "custom-source-dir".into();
    pretty_err(&toml_file, fs::write(&toml_file, config.to_string_pretty().unwrap()));
    let config = cmd.config();
    let remappings = config.remappings.iter().cloned().map(Remapping::from).collect::<Vec<_>>();
    pretty_assertions::assert_eq!(
        remappings,
        vec![
            // local to the lib
            "lib/nested-lib:another-lib/=lib/nested-lib/lib/another-lib/custom-source-dir/"
                .parse()
                .unwrap(),
            // global
            "ds-test/=lib/forge-std/lib/ds-test/src/".parse().unwrap(),
            "forge-std/=lib/forge-std/src/".parse().unwrap(),
            "nested-lib/=lib/nested-lib/src/".parse().unwrap(),
            // remappings local to the lib
            "lib/nested-lib:nested-twice/=lib/nested-lib/lib/another-lib/lib/nested-twice/"
                .parse()
                .unwrap(),
            "lib/nested-lib:nested/=lib/nested-lib/lib/nested/".parse().unwrap(),
        ]
    );
});

// test remappings with closer paths are prioritised
// so that `dep/=lib/a/src` will take precedent over  `dep/=lib/a/lib/b/src`
forgetest_init!(
    #[serial_test::serial]
    can_prioritise_closer_lib_remappings,
    |prj: TestProject, mut cmd: TestCommand| {
        let config = cmd.config();

        // create a new lib directly in the `lib` folder with conflicting remapping `forge-std/`
        let mut config = config;
        config.remappings =
            vec![Remapping::from_str("forge-std/=lib/forge-std/src/").unwrap().into()];
        let nested = prj.paths().libraries[0].join("dep1");
        pretty_err(&nested, fs::create_dir_all(&nested));
        let toml_file = nested.join("foundry.toml");
        pretty_err(&toml_file, fs::write(&toml_file, config.to_string_pretty().unwrap()));

        let config = cmd.config();
        let remappings = config.get_all_remappings();
        pretty_assertions::assert_eq!(
            remappings,
            vec![
                "dep1/=lib/dep1/src/".parse().unwrap(),
                "ds-test/=lib/forge-std/lib/ds-test/src/".parse().unwrap(),
                "forge-std/=lib/forge-std/src/".parse().unwrap()
            ]
        );
    }
);

// test to check that foundry.toml libs section updates on install
forgetest!(can_update_libs_section, |prj: TestProject, mut cmd: TestCommand| {
    cmd.git_init();

    // explicitly set gas_price
    let init = Config { libs: vec!["node_modules".into()], ..Default::default() };
    prj.write_config(init);

    cmd.args(["install", "foundry-rs/forge-std", "--no-commit"]);
    cmd.assert_non_empty_stdout();

    let config = cmd.forge_fuse().config();
    // `lib` was added automatically
    let expected = vec![PathBuf::from("node_modules"), PathBuf::from("lib")];
    assert_eq!(config.libs, expected);

    // additional install don't edit `libs`
    cmd.forge_fuse().args(["install", "dapphub/ds-test", "--no-commit"]);
    cmd.assert_non_empty_stdout();

    let config = cmd.forge_fuse().config();
    assert_eq!(config.libs, expected);
});

// test to check that loading the config emits warnings on the root foundry.toml and
// is silent for any libs
forgetest!(config_emit_warnings, |prj: TestProject, mut cmd: TestCommand| {
    cmd.git_init();

    cmd.args(["install", "foundry-rs/forge-std", "--no-commit"]);
    cmd.assert_non_empty_stdout();

    let faulty_toml = r#"[default]
    src = 'src'
    out = 'out'
    libs = ['lib']"#;

    fs::write(prj.root().join("foundry.toml"), faulty_toml).unwrap();
    fs::write(prj.root().join("lib").join("forge-std").join("foundry.toml"), faulty_toml).unwrap();

    cmd.forge_fuse().args(["config"]);
    let output = cmd.execute();
    assert!(output.status.success());
    assert_eq!(
        String::from_utf8_lossy(&output.stderr)
            .lines()
            .filter(|line| { line.contains("Unknown section [default]") })
            .count(),
        1
    )
});

forgetest_init!(can_skip_remappings_auto_detection, |prj: TestProject, mut cmd: TestCommand| {
    // explicitly set remapping and libraries
    let config = Config {
        remappings: vec![Remapping::from_str("remapping/=lib/remapping/").unwrap().into()],
        auto_detect_remappings: false,
        ..Default::default()
    };
    prj.write_config(config);

    let config = cmd.config();

    // only loads remappings from foundry.toml
    assert_eq!(config.remappings.len(), 1);
    assert_eq!("remapping/=lib/remapping/", config.remappings[0].to_string());
});