merge with master

Author: gustavo-grieco

.github/scripts/install-libff.sh

@@ -18,6 +18,23 @@ cd libff
 git checkout v0.2.1
 git submodule init && git submodule update
 
+# Fix libff header installation with CMake >= 4.3
+# CMake 4.3 commit 4e7e6928cb ("install: Fix bugs around empty
+#  directories") changed the behavior of install(DIRECTORY "" ...).
+# Previously, an empty string was silently expanded to the current source
+# directory. CMake 4.3 now treats it as a no-op that creates the
+# destination directory but installs nothing into it.
+# Replace the empty string with "./" to explicitly reference the current
+# source directory, restoring header installation. The trailing slash
+# ensures the directory *contents* are installed rather than the directory
+# itself.
+# See: https://gitlab.kitware.com/cmake/cmake/-/issues/27568
+if [ "$HOST_OS" = "macOS" ]; then
+  sed -i '' 's#DIRECTORY "" DESTINATION "include/libff"#DIRECTORY "./" DESTINATION "include/libff"#' libff/CMakeLists.txt
+else
+  sed -i 's#DIRECTORY "" DESTINATION "include/libff"#DIRECTORY "./" DESTINATION "include/libff"#' libff/CMakeLists.txt
+fi
+
 ARGS=("-DCMAKE_INSTALL_PREFIX=$PREFIX" "-DWITH_PROCPS=OFF" "-DCMAKE_POLICY_VERSION_MINIMUM=3.5" "-DCMAKE_CXX_STANDARD=11")
 CXXFLAGS=""
 if [ "$HOST_OS" = "macOS" ]; then

.github/workflows/ci.yml

@@ -258,7 +258,7 @@ jobs:
           SOLC_VER: ${{ matrix.solc }}
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@8789b3e21e6c11b2697f5eb56eddae542f746c10 # v1
+        uses: foundry-rs/foundry-toolchain@c7450ba673e133f5ee30098b3b54f444d3a2ca2d # v1
 
       - name: Download testsuite
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8

.github/workflows/docker.yml

@@ -32,14 +32,14 @@ jobs:
           PLATFORM: "${{ matrix.platform }}"
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4
+        uses: docker/setup-buildx-action@d7f5e7f509e45cec5c76c4d5afdd7de93d0b3df5 # v4
         id: buildx
         with:
           install: true
 
       - name: Set Docker metadata (Ubuntu & NVM variant)
         id: meta-ubuntu
-        uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6
+        uses: docker/metadata-action@80c7e94dd9b9319bd5eb7a0e0fe9291e23a2a2e9 # v6
         with:
           images: |
             ghcr.io/${{ github.repository }}/echidna
@@ -58,21 +58,21 @@ jobs:
           } >> "$GITHUB_OUTPUT"
 
       - name: GitHub Container Registry Login
-        uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4
+        uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Docker Hub Login
-        uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4
+        uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4
         if: github.repository == 'crytic/echidna'
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
 
       - name: Docker Build and Push (Ubuntu & NVM variant)
-        uses: docker/build-push-action@bcafcacb16a39f128d818304e6c9c0c18556b85f # v7
+        uses: docker/build-push-action@f9f3042f7e2789586610d6e8b85c8f03e5195baf # v7
         id: build-ubuntu
         with:
           platforms: ${{ matrix.platform }}
@@ -116,25 +116,25 @@ jobs:
           merge-multiple: true
 
       - name: GitHub Container Registry Login
-        uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4
+        uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Docker Hub Login
-        uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 # v4
+        uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4
         if: github.repository == 'crytic/echidna'
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4
+        uses: docker/setup-buildx-action@d7f5e7f509e45cec5c76c4d5afdd7de93d0b3df5 # v4
 
       - name: Set Docker metadata (Ubuntu & NVM variant)
         id: meta-ubuntu
-        uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6
+        uses: docker/metadata-action@80c7e94dd9b9319bd5eb7a0e0fe9291e23a2a2e9 # v6
         with:
           images: |
             ghcr.io/${{ github.repository }}/echidna

.github/workflows/hlint.yml

@@ -21,7 +21,7 @@ jobs:
           persist-credentials: false
 
       - name: Install Nix
-        uses: cachix/install-nix-action@ab739621df7a23f52766f9ccc97f38da6b7af14f # v31
+        uses: cachix/install-nix-action@8aa03977d8d733052d78f4e008a241fd1dbf36b3 # v31
         with:
           nix_path: nixpkgs=channel:nixos-unstable
 

.github/workflows/release.yml

@@ -51,7 +51,7 @@ jobs:
         uses: DeterminateSystems/nix-installer-action@ef8a148080ab6020fd15196c2084a2eea5ff2d25 # v22
 
       - name: Configure Cachix
-        uses: cachix/cachix-action@1eb2ef646ac0255473d23a5907ad7b04ce94065c # v17
+        uses: cachix/cachix-action@5f2d7c5294214f71b873db4b969586b980625e71 # v17
         with:
           name: trailofbits
           authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased
 
+* The reason a test failed (e.g. revert, returned false) is now shown consistently in the text, JSON and UI outputs, including when no transactions are required to reproduce the failure (#1476)
+
 ## 2.3.2
 
 * Improved support for Foundry tests (#1499)

lib/Echidna.hs

@@ -12,8 +12,9 @@ import Data.Map.Strict qualified as Map
 import Data.Maybe (mapMaybe)
 import Data.Set qualified as Set
 import Data.Text qualified as T
+import System.Console.ANSI (hNowSupportsANSI)
 import System.FilePath ((</>))
-import System.IO (stderr, hPutStrLn)
+import System.IO (stderr, stdout, hPutStrLn)
 
 import EVM (cheatCode)
 import EVM.ABI (AbiValue(AbiAddress))
@@ -132,10 +133,11 @@ mkEnv cfg buildOutput tests world slitherInfo = do
   testRefs <- traverse newIORef tests
   fetchSession <- EVM.Fetch.mkSession cfg.campaignConf.corpusDir (fromIntegral <$> cfg.rpcBlock)
   contractNameCache <- newIORef mempty
+  useColor <- hNowSupportsANSI stdout
   -- TODO put in real path
   let dapp = dappInfo "/" buildOutput
       sourceCache = buildOutput.sources
   pure $ Env { cfg, dapp, sourceCache, codehashMap, fetchSession, contractNameCache
              , chainId, eventQueue, bus, coverageRefInit, coverageRefRuntime, corpusRef, testRefs, world
-             , slitherInfo
+             , slitherInfo, useColor
              }

lib/Echidna/Exec.hs

@@ -40,7 +40,7 @@ import Echidna.Types (ExecException(..), fromEVM, emptyAccount)
 import Echidna.Types.Config (Env(..), EConfig(..), UIConf(..), OperationMode(..), OutputFormat(Text))
 import Echidna.Types.Coverage (CoverageInfo)
 import Echidna.Types.Solidity (SolConf(..))
-import Echidna.Types.Tx (TxCall(..), Tx(call, dst), TxResult(..), initialTimestamp, initialBlockNumber, getResult)
+import Echidna.Types.Tx (TxCall(..), Tx(call, dst, delay), TxResult(..), initialTimestamp, initialBlockNumber, getResult)
 import Echidna.Utility (getTimestamp, timePrefix)
 
 -- | Broad categories of execution failures: reversions, illegal operations, and ???.
@@ -184,6 +184,9 @@ execTxWith executeTx tx = do
       burnedGas <- gets (.burned)
       -- If a transaction reverts reset VM to state before the transaction.
       put vmBeforeTx
+      -- Re-apply the time/block advancement from the transaction's delay.
+      -- Time doesn't go backwards on revert, only EVM state does.
+      #block %= \b -> advanceBlock b tx.delay
       -- Undo reset of some of the VM state.
       -- Otherwise we'd lose all information about the reverted transaction like
       -- contract address, calldata, result and traces.

lib/Echidna/Output/Foundry.hs

@@ -5,8 +5,7 @@
 module Echidna.Output.Foundry (foundryTest) where
 
 import Data.Aeson (Value(..), object, (.=))
-import Data.Functor ((<&>))
-import Data.List (elemIndex, nub)
+import Data.List (elemIndex, isPrefixOf, nub)
 import Data.Maybe (fromMaybe, mapMaybe)
 import Data.Text (Text, unpack)
 import Data.Text.Lazy (fromStrict)
@@ -33,33 +32,67 @@ foundryTest :: Maybe Text -> Addr -> EchidnaTest -> TL.Text
 foundryTest mContractName psender test =
   case test.testType of
     AssertionTest{} ->
-      let testData = createTestData mContractName Nothing test
+      let testData = createTestData mContractName Nothing Nothing test
       in fromStrict $ substituteValue template (toMustache testData)
     PropertyTest name _ ->
-      let testData = createTestData mContractName (Just (name, psender)) test
+      let testData = createTestData mContractName (Just (name, psender)) Nothing test
+      in fromStrict $ substituteValue template (toMustache testData)
+    CallTest name _ | "AssertionFailed" `isPrefixOf` unpack name ->
+      -- Echidna detects assertion failures via events named AssertionFailed
+      -- with any argument types (see checkAssertionEvent in Echidna.Test).
+      -- We check all overloads defined in crytic's fuzzlib (LibLog.sol):
+      --   AssertionFailed()
+      --   AssertionFailed(string)
+      --   AssertionFailed(string,string)
+      --   AssertionFailed(string,bytes)
+      --   AssertionFailed(string,uint256)
+      --   AssertionFailed(string,int256)
+      --   AssertionFailed(string,address)
+      --   AssertionFailed(string,bool)
+      --   AssertionFailed(string,bytes32)
+      let eventAssert = Just $
+            "        // Check that an AssertionFailed event was emitted\n"
+            ++ "        Vm.Log[] memory entries = vm.getRecordedLogs();\n"
+            ++ "        bool found = false;\n"
+            ++ "        for (uint i = 0; i < entries.length; i++) {\n"
+            ++ "            if (entries[i].topics.length > 0 && _isAssertionFailed(entries[i].topics[0])) {\n"
+            ++ "                found = true;\n"
+            ++ "                break;\n"
+            ++ "            }\n"
+            ++ "        }\n"
+            ++ "        assertTrue(found, \"Expected AssertionFailed event\");"
+          testData = createTestData mContractName Nothing eventAssert test
       in fromStrict $ substituteValue template (toMustache testData)
     _ -> ""
 
 -- | Create an Aeson Value from test data for the Mustache template.
 -- When a property name and psender are provided, a final assertion is added
 -- to call the property from psender and check it returns false.
-createTestData :: Maybe Text -> Maybe (Text, Addr) -> EchidnaTest -> Value
-createTestData mContractName mProperty test =
+-- When an event assertion is provided, vm.recordLogs() is added at the start
+-- and the event check is added at the end.
+createTestData :: Maybe Text -> Maybe (Text, Addr) -> Maybe String -> EchidnaTest -> Value
+createTestData mContractName mProperty mEventAssert test =
   let
     senders = nub $ map (.src) test.reproducer
     actors = zipWith actorObject senders [1..]
     repro = mapMaybe (foundryTx senders) test.reproducer
     cName = fromMaybe "YourContract" mContractName
-    propAssertion = mProperty <&> \(name, addr) ->
-      "        vm.stopPrank();\n        vm.prank(" ++ formatAddr addr ++ ");\n"
-      ++ "        assertFalse(Target." ++ unpack name ++ "());"
+    propAssertion = case mProperty of
+      Just (name, addr) -> Just $
+        "        vm.stopPrank();\n        vm.prank(" ++ formatAddr addr ++ ");\n"
+        ++ "        assertFalse(Target." ++ unpack name ++ "());"
+      Nothing -> mEventAssert
+    preamble = case mEventAssert of
+      Just _ -> Just ("        vm.recordLogs();" :: String)
+      Nothing -> Nothing
   in
   object
     [ "testName"     .= ("FoundryTest" :: Text)
     , "contractName" .= cName
     , "actors"       .= actors
     , "reproducer"   .= repro
     , "propertyAssertion" .= propAssertion
+    , "preamble"     .= preamble
     ]
 
 -- | Create a JSON object for an actor.

lib/Echidna/Output/JSON.hs

@@ -22,7 +22,7 @@ import Echidna.Types.Config (Env(..))
 import Echidna.Types.Coverage (CoverageInfo, mergeCoverageMaps)
 import Echidna.Types.Test (EchidnaTest(..))
 import Echidna.Types.Test qualified as T
-import Echidna.Types.Tx (Tx(..), TxCall(..))
+import Echidna.Types.Tx (Tx(..), TxCall(..), TxResult)
 
 data Campaign = Campaign
   { _success :: Bool
@@ -46,6 +46,7 @@ data Test = Test
   , name :: Text
   , status :: TestStatus
   , _error :: Maybe String
+  , reason :: Maybe TxResult
   , events :: Events
   , testType :: TestType
   , transactions :: Maybe [Transaction]
@@ -57,6 +58,7 @@ instance ToJSON Test where
     , "name" .= name
     , "status" .= status
     , "error" .= _error
+    , "reason" .= reason
     , "events" .= events
     , "type" .= testType
     , "transactions" .= transactions
@@ -122,6 +124,7 @@ mapTest dappInfo test =
     , name = "name" -- TODO add a proper name here
     , status = status
     , _error = err
+    , reason = mapReason test.state
     , events = maybe [] (extractEvents False dappInfo) test.vm
     , testType = Property
     , transactions = transactions
@@ -134,6 +137,11 @@ mapTest dappInfo test =
   mapTestState (T.Large _) txs = (Shrinking, Just $ mapTx <$> txs, Nothing)
   mapTestState (T.Failed e) _ = (Error, Nothing, Just $ Prelude.show e) -- TODO add (show e)
 
+  -- The reason a test failed is only meaningful for falsified tests.
+  mapReason T.Solved    = Just test.result
+  mapReason (T.Large _) = Just test.result
+  mapReason _           = Nothing
+
   mapTx tx =
     let (function, args) = mapCall tx.call
     in Transaction