Merge pull request #1429 from input-output-hk/1417-txout-migration-tests

Test new tx-out feature flags

Author: Cmdv

cardano-chain-gen/cardano-chain-gen.cabal

@@ -165,8 +165,9 @@ test-suite cardano-chain-gen
                         Test.Cardano.Db.Mock.Unit.Alonzo.Stake
                         Test.Cardano.Db.Mock.Unit.Alonzo.Tx
                         Test.Cardano.Db.Mock.Unit.Babbage
-                        Test.Cardano.Db.Mock.Unit.Babbage.Other
+                        Test.Cardano.Db.Mock.Unit.Babbage.Flag.ConsumedTxOut
                         Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference
+                        Test.Cardano.Db.Mock.Unit.Babbage.Other
                         Test.Cardano.Db.Mock.Unit.Babbage.Plutus
                         Test.Cardano.Db.Mock.Unit.Babbage.Reward
                         Test.Cardano.Db.Mock.Unit.Babbage.Rollback

cardano-chain-gen/test/Test/Cardano/Db/Mock/Config.hs

@@ -5,6 +5,7 @@
 module Test.Cardano.Db.Mock.Config (
   Config (..),
   DBSyncEnv (..),
+  TxOutParam(..),
   babbageConfigDir,
   alonzoConfigDir,
   emptyMetricsSetters,
@@ -29,6 +30,7 @@ module Test.Cardano.Db.Mock.Config (
   startDBSync,
   withDBSyncEnv,
   withFullConfig,
+  withTxOutParamConfig,
   withFullConfig',
 ) where
 
@@ -89,6 +91,12 @@ data DBSyncEnv = DBSyncEnv
   , dbSyncThreadVar :: TMVar (Async ())
   }
 
+-- used for testing of tx out pruning feature
+data TxOutParam = TxOutParam
+  { paramMigrateConsumed :: Bool,
+    paramPruneTxOut :: Bool
+  }
+
 babbageConfigDir :: FilePath
 babbageConfigDir = "config"
 
@@ -195,14 +203,14 @@ setupTestsDir dir = do
           0
           Nothing
 
-mkConfig :: FilePath -> FilePath -> IO Config
-mkConfig staticDir mutableDir = do
+mkConfig :: FilePath -> FilePath -> Maybe TxOutParam -> IO Config
+mkConfig staticDir mutableDir mTxOutParam = do
   config <- readSyncNodeConfig $ ConfigFile (staticDir </> "test-db-sync-config.json")
   genCfg <- either (error . Text.unpack . renderSyncNodeError) id <$> runExceptT (readCardanoGenesisConfig config)
   let pInfoDbSync = mkProtocolInfoCardano genCfg []
   creds <- mkShelleyCredentials $ staticDir </> "pools" </> "bulk1.creds"
   let pInfoForger = mkProtocolInfoCardano genCfg creds
-  syncPars <- mkSyncNodeParams staticDir mutableDir
+  syncPars <- mkSyncNodeParams staticDir mutableDir mTxOutParam
   pure $ Config (Consensus.pInfoConfig pInfoDbSync) pInfoDbSync pInfoForger syncPars
 
 mkShelleyCredentials :: FilePath -> IO [ShelleyLeaderCredentials StandardCrypto]
@@ -220,8 +228,8 @@ mkShelleyCredentials bulkFile = do
         }
 
 -- | staticDir can be shared by tests running in parallel. mutableDir not.
-mkSyncNodeParams :: FilePath -> FilePath -> IO SyncNodeParams
-mkSyncNodeParams staticDir mutableDir = do
+mkSyncNodeParams :: FilePath -> FilePath -> Maybe TxOutParam -> IO SyncNodeParams
+mkSyncNodeParams staticDir mutableDir mTxOutParam = do
   pgconfig <- orDie Db.renderPGPassError $ newExceptT Db.readPGPassDefault
   pure $
     SyncNodeParams
@@ -242,8 +250,8 @@ mkSyncNodeParams staticDir mutableDir = do
       , enpHasOfflineData = True
       , enpTurboMode = False
       , enpFullMode = True
-      , enpMigrateConsumed = False
-      , enpPruneTxOut = False
+      , enpMigrateConsumed = maybe False paramMigrateConsumed mTxOutParam
+      , enpPruneTxOut = maybe False paramPruneTxOut mTxOutParam
       , enpSnEveryFollowing = 35
       , enpSnEveryLagging = 35
       , enpMaybeRollback = Nothing
@@ -265,19 +273,30 @@ withFullConfig ::
   IOManager ->
   [(Text, Text)] ->
   IO a
-withFullConfig = withFullConfig' True
+withFullConfig = withFullConfig' True Nothing
+
+withTxOutParamConfig ::
+  TxOutParam ->
+  FilePath ->
+  FilePath ->
+  (Interpreter -> ServerHandle IO CardanoBlock -> DBSyncEnv -> IO a) ->
+  IOManager ->
+  [(Text, Text)] ->
+  IO a
+withTxOutParamConfig txOutParam = withFullConfig' True (Just txOutParam)
 
 withFullConfig' ::
   Bool ->
+  Maybe TxOutParam ->
   FilePath ->
   FilePath ->
   (Interpreter -> ServerHandle IO CardanoBlock -> DBSyncEnv -> IO a) ->
   IOManager ->
   [(Text, Text)] ->
   IO a
-withFullConfig' hasFingerprint config testLabel action iom migr = do
+withFullConfig' hasFingerprint mTxOutParam config testLabel action iom migr = do
   recreateDir mutableDir
-  cfg <- mkConfig configDir mutableDir
+  cfg <- mkConfig configDir mutableDir mTxOutParam
   fingerFile <- if hasFingerprint then Just <$> prepareFingerprintFile testLabel else pure Nothing
   let dbsyncParams = syncNodeParams cfg
   -- Set to True to disable logging, False to enable it.

cardano-chain-gen/test/Test/Cardano/Db/Mock/Property/Property.hs

@@ -273,4 +273,4 @@ prop_empty_blocks iom knownMigrations = withMaxSuccess 20 $ noShrinking $ forAll
   prettyCommands smSymbolic hist (checkCommandNames cmds (res === Ok))
   where
     smSymbolic = sm (error "inter") (error "mockServer") (error "dbSync")
-    runAction action = withFullConfig' False "config" "qsm" action iom knownMigrations
+    runAction action = withFullConfig' False Nothing "config" "qsm" action iom knownMigrations

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Alonzo/Tx.hs

@@ -5,11 +5,18 @@ module Test.Cardano.Db.Mock.Unit.Alonzo.Tx (
 
 import Cardano.Mock.ChainSync.Server (IOManager)
 import qualified Cardano.Mock.Forging.Tx.Alonzo as Alonzo
-import Cardano.Mock.Forging.Types (UTxOIndex (UTxOIndex, UTxOPair))
+import Cardano.Mock.Forging.Types (UTxOIndex (..))
 import Control.Monad (void)
 import Data.Text (Text)
-import Test.Cardano.Db.Mock.Config (alonzoConfigDir, startDBSync, withFullConfig)
-import Test.Cardano.Db.Mock.UnifiedApi (withAlonzoFindLeaderAndSubmit, withAlonzoFindLeaderAndSubmitTx)
+import Test.Cardano.Db.Mock.Config (
+  alonzoConfigDir,
+  startDBSync,
+  withFullConfig,
+ )
+import Test.Cardano.Db.Mock.UnifiedApi (
+  withAlonzoFindLeaderAndSubmit,
+  withAlonzoFindLeaderAndSubmitTx,
+ )
 import Test.Cardano.Db.Mock.Validate (assertBlockNoBackoff)
 import Test.Tasty.HUnit (Assertion)
 

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Babbage.hs

@@ -11,6 +11,7 @@ import Data.Text (Text)
 import Test.Tasty (TestTree, testGroup)
 import Test.Tasty.HUnit (Assertion, testCase)
 
+import qualified Test.Cardano.Db.Mock.Unit.Babbage.Flag.ConsumedTxOut as FlagConsumedTxOut
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference as BabInlineRef
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.Other as BabOther
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.Plutus as BabPlutus
@@ -33,6 +34,21 @@ unitTests iom knownMigrations =
         , test "node restart" BabSimple.nodeRestart
         , test "node restart boundary" BabSimple.nodeRestartBoundary
         ]
+    , testGroup
+        "flags"
+        [ testGroup
+            "consumed-tx-out"
+                [ test "flag check" FlagConsumedTxOut.flagCheck
+                , test "basic prune" FlagConsumedTxOut.basicPrune
+                , test "prune with simple rollback" FlagConsumedTxOut.pruneWithSimpleRollback
+                , test "prune with full tx rollback" FlagConsumedTxOut.pruneWithFullTxRollback
+                , test "pruning should keep some tx" FlagConsumedTxOut.pruningShouldKeepSomeTx
+                , test "prune and rollback one block" FlagConsumedTxOut.pruneAndRollBackOneBlock
+                , test "no pruning and rollback" FlagConsumedTxOut.noPruneAndRollBack
+                , test "prune same block" FlagConsumedTxOut.pruneSameBlock
+                , test "no pruning same block" FlagConsumedTxOut.noPruneSameBlock
+                ]
+        ]
     , testGroup
         "rollbacks"
         [ test "simple rollback" BabRollback.simpleRollback