Fix Foundry test generation contract name collision (#1484)

* Fix Foundry test generation contract name collision

* Add actual forge compilation test in Foundry test generation suite

* Install foundry in CI

Author: BowTiedRadone

.github/workflows/ci.yml

@@ -249,14 +249,17 @@ jobs:
           HOST_OS: ${{ runner.os }}
           SOLC_VER: ${{ matrix.solc }}
 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
       - name: Download testsuite
         uses: actions/download-artifact@v7
         with:
          name: echidna-testsuite-${{ runner.os }}
 
       - name: Test
         run: |
-          export PATH="$PATH:$HOME/.local/bin"
+          export PATH="$PATH:$HOME/.local/bin:$HOME/.foundry/bin"
           solc-select use ${{ matrix.solc }}
           chmod +x echidna-testsuite*
           ./echidna-testsuite*

lib/Echidna/Output/Foundry.hs

@@ -44,7 +44,7 @@ createTestData mContractName test =
     cName = fromMaybe "YourContract" mContractName
   in
   object
-    [ "testName"     .= ("Test" :: Text)
+    [ "testName"     .= ("FoundryTest" :: Text)
     , "contractName" .= cName
     , "actors"       .= actors
     , "reproducer"   .= repro

src/test/Spec.hs

@@ -8,6 +8,7 @@ import Tests.Config (configTests)
 import Tests.Coverage (coverageTests)
 import Tests.Dapptest (dapptestTests)
 import Tests.Encoding (encodingJSONTests)
+import Tests.FoundryTestGen (foundryTestGenTests)
 import Tests.Integration (integrationTests)
 import Tests.Optimization (optimizationTests)
 import Tests.Overflow (overflowTests)
@@ -32,6 +33,7 @@ main = withCurrentDirectory "./tests/solidity" . defaultMain $
            , researchTests
            , dapptestTests
            , encodingJSONTests
+           , foundryTestGenTests
            , cheatTests
            , symbolicTests
            ]

src/test/Tests/FoundryTestGen.hs

@@ -0,0 +1,76 @@
+module Tests.FoundryTestGen (foundryTestGenTests) where
+
+import Test.Tasty (TestTree, testGroup)
+import Test.Tasty.HUnit (testCase, assertFailure)
+
+import Control.Exception (catch, SomeException)
+import Data.Text (pack, unpack, replace)
+import qualified Data.Text.Lazy as TL
+import System.Directory (getTemporaryDirectory, removePathForcibly, findExecutable, copyFile)
+import System.Exit (ExitCode(..))
+import System.Process (readProcessWithExitCode)
+
+import Echidna.Output.Foundry (foundryTest)
+import Echidna.Types.Test (EchidnaTest(..), TestType(..), TestValue(..), TestState(..))
+
+foundryTestGenTests :: TestTree
+foundryTestGenTests = testGroup "Foundry test generation"
+  [ testCase "compiles with forge" testForgeCompilation
+  ]
+
+-- | Verify generated test compiles with forge.
+-- We use temp directories because we need to test the full forge workflow:
+-- forge init (for dependencies) + our generated test + forge build.
+testForgeCompilation :: IO ()
+testForgeCompilation = do
+  forgeExe <- findExecutable "forge"
+  case forgeExe of
+    Nothing -> 
+      assertFailure "forge not found"
+    Just _ -> do
+      tmpBase <- getTemporaryDirectory
+      let tmpDir = tmpBase ++ "/echidna-forge-test"
+      
+      catch (removePathForcibly tmpDir) (\(_ :: SomeException) -> pure ())
+      
+      -- Initialize project with forge.
+      (code, _, err) <- readProcessWithExitCode "forge" ["init", tmpDir] ""
+      if code /= ExitSuccess
+        then assertFailure $ "forge init failed: " ++ err
+        else do
+          copyFile "foundry/FoundryTestTarget.sol" (tmpDir ++ "/src/FoundryTestTarget.sol")
+          
+          -- Simulate user action: Replace the target contract with the actual
+          -- contract instance and import it (add contract import after the
+          -- forge-std one).
+          let generated = TL.unpack $ foundryTest (Just "FoundryTestTarget") mkMinimalTest
+              forgeStdImport = pack "import \"forge-std/Test.sol\";"
+              contractImport = pack "import \"../src/FoundryTestTarget.sol\";"
+              testWithImport = unpack $ replace forgeStdImport 
+                                               (forgeStdImport <> "\n" <> contractImport) 
+                                               (pack generated)
+          
+          writeFile (tmpDir ++ "/test/Generated.t.sol") testWithImport
+          
+          (buildCode, _, buildErr) <- readProcessWithExitCode "forge" ["build", "--root", tmpDir] ""
+          
+          catch (removePathForcibly tmpDir) (\(_ :: SomeException) -> pure ())
+          
+          if buildCode == ExitSuccess
+            then pure ()
+            else assertFailure $ "forge build failed: " ++ buildErr
+
+mkMinimalTest :: EchidnaTest
+mkMinimalTest = EchidnaTest
+  -- Foundry tests are only generated for solved/large tests.
+  { state = Large 0
+  -- AssertionTest is required for Foundry test generation.
+  , testType = AssertionTest False ("test", []) 0
+  , value = BoolValue True
+  -- Empty reproducer is sufficient for testing contract name generation.
+  , reproducer = []
+  -- These fields are not read by the output generator.
+  , result = error "result not needed for Foundry output tests"
+  , vm = Nothing
+  , workerId = Nothing
+  }

tests/solidity/foundry/FoundryTestTarget.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+contract FoundryTestTarget {
+    function test() public pure returns (bool) {
+        return true;
+    }
+}