chore: set seed for flaky tests, use etherscan api key (#12255)

* chore: set seed for flaky tests

* env var

* fix

Author: grandizzy

.github/workflows/test.yml

@@ -112,4 +112,5 @@ jobs:
           SVM_TARGET_PLATFORM: ${{ matrix.svm_target_platform }}
           HTTP_ARCHIVE_URLS: ${{ secrets.HTTP_ARCHIVE_URLS }}
           WS_ARCHIVE_URLS: ${{ secrets.WS_ARCHIVE_URLS }}
+          ETHERSCAN_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
         run: cargo nextest run ${{ matrix.flags }}

crates/cast/tests/cli/main.rs

@@ -2887,9 +2887,9 @@ contract CounterInExternalLibScript is Script {
         .unwrap()
         .tx_hash();
 
-    // Cache project selectors.
+    // Build and cache project selectors.
+    cmd.forge_fuse().args(["build"]).assert_success();
     cmd.forge_fuse().args(["selectors", "cache"]).assert_success();
-
     // Assert cast with local artifacts can decode external lib signature.
     cmd.cast_fuse()
         .args(["run", format!("{tx_hash}").as_str(), "--rpc-url", &handle.http_endpoint()])

crates/cast/tests/cli/selectors.rs

@@ -186,7 +186,8 @@ contract ContractWithCustomError {
 }
    "#,
     );
-    // Store selectors in local cache.
+    // Build and cache project selectors.
+    cmd.forge_fuse().args(["build"]).assert_success();
     cmd.forge_fuse().args(["selectors", "cache"]).assert_success();
 
     // Assert cast can decode custom error with local cache.

crates/forge/tests/cli/failure_assertions.rs

@@ -199,6 +199,7 @@ forgetest!(expect_emit_tests_should_fail, |prj, cmd| {
     prj.add_source("ExpectEmitFailures.sol", expect_emit_failure_tests);
 
     cmd.forge_fuse().arg("build").assert_success();
+    cmd.forge_fuse().args(["selectors", "cache"]).assert_success();
 
     cmd.forge_fuse().args(["test", "--mc", "ExpectEmitFailureTest"]).assert_failure().stdout_eq(str![[r#"No files changed, compilation skipped
 ...

crates/forge/tests/cli/test_cmd/fuzz.rs

@@ -117,7 +117,10 @@ Ran 1 test suite [ELAPSED]: 1 tests passed, 0 failed, 0 skipped (1 total tests)
 
 forgetest_init!(test_fuzz_fail_on_revert, |prj, cmd| {
     prj.wipe_contracts();
-    prj.update_config(|config| config.fuzz.fail_on_revert = false);
+    prj.update_config(|config| {
+        config.fuzz.fail_on_revert = false;
+        config.fuzz.seed = Some(U256::from(100u32));
+    });
     prj.add_source(
         "Counter.sol",
         r#"
@@ -672,6 +675,9 @@ Ran 1 test suite [ELAPSED]: 3 tests passed, 0 failed, 0 skipped (3 total tests)
 // random values (instead edge cases) are generated if no fixtures defined
 forgetest_init!(fuzz_uint, |prj, cmd| {
     prj.wipe_contracts();
+    prj.update_config(|config| {
+        config.fuzz.seed = Some(U256::from(100u32));
+    });
     prj.add_test(
         "FuzzUint.t.sol",
         r#"

crates/forge/tests/cli/test_cmd/invariant/common.rs

@@ -188,6 +188,7 @@ forgetest!(invariant_calldata_dictionary, |prj, cmd| {
     prj.wipe_contracts();
     prj.insert_utils();
     prj.update_config(|config| {
+        config.fuzz.seed = Some(U256::from(1));
         config.invariant.depth = 10;
     });
 
@@ -293,7 +294,7 @@ Ran 1 test for test/InvariantCalldataDictionary.t.sol:InvariantCalldataDictionar
 	[SEQUENCE]
  invariant_owner_never_changes() ([RUNS])
 
-[STATS]
+...
 
 Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
 
@@ -1056,35 +1057,17 @@ contract InvariantRollForkStateTest is Test {
 
     assert_invariant(cmd.args(["test", "-j1"])).failure().stdout_eq(str![[r#"
 ...
-Ran 1 test for test/InvariantRollFork.t.sol:InvariantRollForkStateTest
-[FAIL: wrong supply]
-	[SEQUENCE]
- invariant_fork_handler_state() ([RUNS])
-
-[STATS]
-
-Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
-
-Ran 1 test for test/InvariantRollFork.t.sol:InvariantRollForkBlockTest
-[FAIL: too many blocks mined]
-	[SEQUENCE]
- invariant_fork_handler_block() ([RUNS])
-
-[STATS]
-
-Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
-
 Ran 2 test suites [ELAPSED]: 0 tests passed, 2 failed, 0 skipped (2 total tests)
 
 Failing tests:
 Encountered 1 failing test in test/InvariantRollFork.t.sol:InvariantRollForkBlockTest
 [FAIL: too many blocks mined]
-	[SEQUENCE]
+...
  invariant_fork_handler_block() ([RUNS])
 
 Encountered 1 failing test in test/InvariantRollFork.t.sol:InvariantRollForkStateTest
 [FAIL: wrong supply]
-	[SEQUENCE]
+...
  invariant_fork_handler_state() ([RUNS])
 
 Encountered a total of 2 failing tests, 0 tests succeeded
@@ -1098,6 +1081,7 @@ forgetest_init!(invariant_scrape_values, |prj, cmd| {
     prj.wipe_contracts();
     prj.update_config(|config| {
         config.invariant.depth = 10;
+        config.fuzz.seed = Some(U256::from(100u32));
     });
 
     prj.add_test(
@@ -1173,24 +1157,6 @@ contract FindFromLogValueTest is Test {
 
     assert_invariant(cmd.args(["test", "-j1"])).failure().stdout_eq(str![[r#"
 ...
-Ran 1 test for test/InvariantScrapeValues.t.sol:FindFromReturnValueTest
-[FAIL: value from return found]
-	[SEQUENCE]
- invariant_value_not_found() ([RUNS])
-
-[STATS]
-
-Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
-
-Ran 1 test for test/InvariantScrapeValues.t.sol:FindFromLogValueTest
-[FAIL: value from logs found]
-	[SEQUENCE]
- invariant_value_not_found() ([RUNS])
-
-[STATS]
-
-Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
-
 Ran 2 test suites [ELAPSED]: 0 tests passed, 2 failed, 0 skipped (2 total tests)
 
 Failing tests:

crates/forge/tests/cli/test_cmd/invariant/target.rs

@@ -842,33 +842,12 @@ contract DynamicTargetContract is Test {
 
     assert_invariant(cmd.args(["test", "-j1"])).failure().stdout_eq(str![[r#"
 ...
-Ran 1 test for test/FuzzedTargetContracts.t.sol:ExplicitTargetContract
 [PASS] invariant_explicit_target() ([RUNS])
-
-[STATS]
-
-Suite result: ok. 1 passed; 0 failed; 0 skipped; [ELAPSED]
-
-Ran 1 test for test/FuzzedTargetContracts.t.sol:DynamicTargetContract
-[FAIL: wrong target selector called]
-	[SEQUENCE]
- invariant_dynamic_targets() ([RUNS])
-
-[STATS]
-
-Suite result: FAILED. 0 passed; 1 failed; 0 skipped; [ELAPSED]
-
-Ran 2 test suites [ELAPSED]: 1 tests passed, 1 failed, 0 skipped (2 total tests)
-
-Failing tests:
-Encountered 1 failing test in test/FuzzedTargetContracts.t.sol:DynamicTargetContract
+...
 [FAIL: wrong target selector called]
 	[SEQUENCE]
  invariant_dynamic_targets() ([RUNS])
-
-Encountered a total of 1 failing tests, 1 tests succeeded
-
-Tip: Run `forge test --rerun` to retry only the 1 failed test
+...
 
 "#]]);
 });

crates/forge/tests/cli/test_cmd/mod.rs

@@ -4055,7 +4055,7 @@ contract ContractWithCustomError {
    "#,
     );
     // Build and cache project selectors.
-    cmd.forge_fuse().args(["build"]).assert_success();
+    cmd.forge_fuse().args(["build", "--force"]).assert_success();
 
     // Assert cast can decode custom error with local cache.
     cmd.cast_fuse()

crates/test-utils/src/rpc.rs

@@ -7,9 +7,12 @@ use foundry_config::{
     RpcEndpointUrl, RpcEndpoints,
 };
 use rand::seq::SliceRandom;
-use std::sync::{
-    LazyLock,
-    atomic::{AtomicUsize, Ordering},
+use std::{
+    env,
+    sync::{
+        LazyLock,
+        atomic::{AtomicUsize, Ordering},
+    },
 };
 
 macro_rules! shuffled_list {
@@ -153,7 +156,10 @@ fn next_archive_url(is_ws: bool) -> String {
 
 /// Returns the next etherscan api key.
 pub fn next_etherscan_api_key() -> String {
-    let key = ETHERSCAN_KEYS.next().to_string();
+    let mut key = env::var("ETHERSCAN_KEY").unwrap_or_default();
+    if key.is_empty() {
+        key = ETHERSCAN_KEYS.next().to_string();
+    }
     test_debug!("next_etherscan_api_key() = {}...", &key[..6]);
     key
 }