Show all events from all the transactions when a property or assertion fails (#1475)

* show all events from all the transaction when a property or assertion fails

* fixed tests and removed ECHIDNA_SAVE_TRACES

Author: gustavo-grieco

lib/Echidna/Config.hs

@@ -55,6 +55,7 @@ instance FromJSON EConfigWithUsage where
               <*> testConfParser
               <*> txConfParser
               <*> (UIConf <$> v ..:? "timeout" <*> formatParser)
+              <*> v ..:? "allEvents" ..!= False
               <*> v ..:? "rpcUrl"
               <*> v ..:? "rpcBlock"
               <*> v ..:? "etherscanApiKey"

lib/Echidna/Exec.hs

@@ -90,7 +90,8 @@ execTxWith executeTx tx = do
   if hasSelfdestructed vm tx.dst then
     pure $ VMFailure (Revert (ConcreteBuf ""))
   else do
-    #traces .= emptyEvents
+    config <- asks (.cfg)
+    when (not config.allEvents) $ #traces .= emptyEvents
     vmBeforeTx <- get
     setupTx tx
     case tx.call of

lib/Echidna/Types/Config.hs

@@ -44,6 +44,7 @@ data EConfig = EConfig
   , txConf :: TxConf
   , uiConf :: UIConf
 
+  , allEvents :: Bool
   , rpcUrl :: Maybe Text
   , rpcBlock :: Maybe Word64
   , etherscanApiKey :: Maybe Text

src/Main.hs

@@ -2,7 +2,7 @@
 
 module Main where
 
-import Control.Monad (unless, forM_, when)
+import Control.Monad (unless, forM_)
 import Control.Monad.Reader (runReaderT, liftIO)
 import Control.Monad.Random (getRandomR)
 import Data.Aeson.Key qualified as Aeson.Key
@@ -12,7 +12,7 @@ import Data.Hashable (hash)
 import Data.IORef (readIORef)
 import Data.List.NonEmpty qualified as NE
 import Data.Map qualified as Map
-import Data.Maybe (fromMaybe, isJust)
+import Data.Maybe (fromMaybe)
 import Data.Set qualified as Set
 import Data.Text (Text)
 import Data.Text qualified as T
@@ -24,7 +24,6 @@ import Main.Utf8 (withUtf8)
 import Options.Applicative
 import Paths_echidna (version)
 import System.Directory (createDirectoryIfMissing)
-import System.Environment (lookupEnv)
 import System.Exit (exitWith, exitSuccess, ExitCode(..))
 import System.FilePath ((</>), (<.>))
 import System.IO (hPutStrLn, stderr)
@@ -42,13 +41,12 @@ import Echidna.Output.Corpus
 import Echidna.Output.Foundry
 import Echidna.Output.Source
 import Echidna.Solidity (compileContracts)
-import Echidna.Test (reproduceTest, validateTestMode)
+import Echidna.Test (validateTestMode)
 import Echidna.Types.Campaign
 import Echidna.Types.Config
 import Echidna.Types.Solidity
 import Echidna.Types.Test (TestMode, EchidnaTest(..), TestType(..), TestState(..))
 import Echidna.UI
-import Echidna.UI.Report (ppFailWithTraces, ppTestName)
 import Echidna.Utility (measureIO)
 
 main :: IO ()
@@ -86,19 +84,6 @@ main = withUtf8 $ withCP65001 $ do
       measureIO cfg.solConf.quiet "Saving test reproducers" $
         saveTxs env (dir </> "reproducers") (filter (not . null) $ (.reproducer) <$> tests)
 
-      saveTracesEnabled <- lookupEnv "ECHIDNA_SAVE_TRACES"
-      when (isJust saveTracesEnabled) $ do
-        measureIO cfg.solConf.quiet "Saving test reproducers-traces" $ do
-          flip runReaderT env $ do
-            forM_ tests $ \test ->
-              unless (null test.reproducer) $ do
-                (results, finalVM) <- reproduceTest vm test
-                let subdir = dir </> "reproducers-traces"
-                liftIO $ createDirectoryIfMissing True subdir
-                let file = subdir </> (show . abs . hash) test.reproducer <.> "txt"
-                txsPrinted <- ppFailWithTraces Nothing finalVM results
-                liftIO $ writeFile file (ppTestName test <> ": " <> txsPrinted)
-
       measureIO cfg.solConf.quiet "Saving corpus" $ do
         corpus <- readIORef env.corpusRef
         saveTxs env (dir </> "coverage") (snd <$> Set.toList corpus)

tests/solidity/basic/default.yaml

@@ -98,6 +98,8 @@ rpcBlock: null
 etherscanApiKey: null
 # number of workers. By default (unset) its value is the clamp of the number cores between 1 and 4
 workers: null
+# show all events from all the transactions, not just the last one
+allEvents: false
 # events server port
 server: null
 # whether to add an additional symbolic execution worker