rename Extended to EpochDisabled & EpochAndCacheEnabled

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.CommandLineArg.MigrateConsumedPruneTxOut
                         Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile
+                        Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.EpochDisabled
+                        Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut
                         Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Babbage.Other
                         Test.Cardano.Db.Mock.Unit.Babbage.Plutus

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

@@ -103,7 +103,7 @@ data TxOutParam = TxOutParam
 
 data CommandLineArgs = CommandLineArgs
   { claHasConfigFile :: Bool
-  , claExtended :: Bool
+  , claEpochDisabled :: Bool
   , claHasCache :: Bool
   , claShouldUseLedger :: Bool
   , claSkipFix :: Bool
@@ -260,7 +260,7 @@ mkSyncNodeParams staticDir mutableDir CommandLineArgs{..} = do
       , enpMaybeLedgerStateDir = Just $ LedgerStateDir $ mutableDir </> "ledger-states"
       , enpMigrationDir = MigrationDir "../schema"
       , enpPGPassSource = Db.PGPassCached pgconfig
-      , enpExtended = claExtended
+      , enpEpochDisabled = claEpochDisabled
       , enpHasCache = claHasCache
       , enpShouldUseLedger = claShouldUseLedger
       , enpSkipFix = claSkipFix
@@ -283,7 +283,7 @@ initCommandLineArgs :: CommandLineArgs
 initCommandLineArgs =
   CommandLineArgs
   { claHasConfigFile = True
-  , claExtended = True
+  , claEpochDisabled = True
   , claHasCache = True
   , claShouldUseLedger = True
   , claSkipFix = True
@@ -327,6 +327,7 @@ withCustomConfig ::
   IO a
 withCustomConfig = withFullConfig' True False
 
+-- when wanting to check for a failure in a test for some reason logging has to be enabled
 withCustomConfigAndLogs ::
   CommandLineArgs ->
   FilePath ->

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

@@ -13,6 +13,7 @@ import Test.Tasty.HUnit (Assertion, testCase)
 import Test.Tasty.ExpectedFailure (expectFail)
 
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut as MigrateConsumedPruneTxOut
+import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.EpochDisabled as EpochDisabled
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile as ConfigFile
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference as BabInlineRef
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.Other as BabOther
@@ -52,7 +53,11 @@ unitTests iom knownMigrations =
                 ]
         , testGroup
             "ConfigFile"
-            [ expectFail $ test "fails if incorrect config file" ConfigFile.checkConfigFileArg
+            [ expectFail $ test "fails if incorrect or no config file given" ConfigFile.checkConfigFileArg ]
+        , testGroup
+            "EpochDisabled"
+            [ test "Epoch doesn't update when disabled" EpochDisabled.checkEpochDisabledArg
+            , test "Epoch updates when enabled" EpochDisabled.checkEpochEnabled
             ]
         ]
     , testGroup

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

@@ -12,7 +12,7 @@ mkCommandLineArgs :: Bool -> CommandLineArgs
 mkCommandLineArgs hasConfigFile =
   CommandLineArgs
     { claHasConfigFile = hasConfigFile
-    , claExtended = True
+    , claEpochDisabled = True
     , claHasCache = True
     , claShouldUseLedger = True
     , claSkipFix = True

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

@@ -0,0 +1,67 @@
+module Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.EpochDisabled (
+  checkEpochDisabledArg,
+  checkEpochEnabled,
+)
+where
+
+import qualified Cardano.Db as DB
+import Cardano.Mock.ChainSync.Server (IOManager)
+import qualified Cardano.Mock.Forging.Tx.Babbage as Babbage
+import Cardano.Mock.Forging.Types (UTxOIndex (..))
+import Control.Monad (void)
+import Data.Text (Text)
+import Test.Cardano.Db.Mock.Config (CommandLineArgs (..), babbageConfigDir, startDBSync, withCustomConfig)
+import Test.Cardano.Db.Mock.UnifiedApi (forgeAndSubmitBlocks, withBabbageFindLeaderAndSubmitTx)
+import Test.Cardano.Db.Mock.Validate (assertBlockNoBackoff, assertEqQuery)
+import Test.Tasty.HUnit (Assertion)
+
+mkCommandLineArgs :: Bool -> CommandLineArgs
+mkCommandLineArgs epochDisabled =
+  CommandLineArgs
+    { claHasConfigFile = True
+    , claEpochDisabled = epochDisabled
+    , claHasCache = True
+    , claShouldUseLedger = True
+    , claSkipFix = True
+    , claOnlyFix = False
+    , claForceIndexes = False
+    , claHasMultiAssets = True
+    , claHasMetadata = True
+    , claHasPlutusExtra = True
+    , claHasOfflineData = True
+    , claTurboMode = False
+    , claFullMode = True
+    , claMigrateConsumed = True
+    , claPruneTxOut = True
+    }
+
+-- this test fails as incorrect configuration file given
+checkEpochDisabledArg :: IOManager -> [(Text, Text)] -> Assertion
+checkEpochDisabledArg =
+  withCustomConfig (mkCommandLineArgs True) babbageConfigDir testLabel $ \interpreter mockServer dbSyncEnv -> do
+    startDBSync dbSyncEnv
+    b1 <- forgeAndSubmitBlocks interpreter mockServer 50
+    -- add 2 blocks with tx
+    void $ withBabbageFindLeaderAndSubmitTx interpreter mockServer $ Babbage.mkPaymentTx (UTxOIndex 0) (UTxOIndex 1) 10000 10000
+    void $ withBabbageFindLeaderAndSubmitTx interpreter mockServer $ Babbage.mkPaymentTx (UTxOIndex 1) (UTxOIndex 0) 10000 10000
+    b2 <- forgeAndSubmitBlocks interpreter mockServer 60
+
+    assertBlockNoBackoff dbSyncEnv (fromIntegral $ length (b1 <> b2) + 2)
+    assertEqQuery dbSyncEnv DB.queryEpochCount 0 "new epoch didn't prune tx_out column that are null"
+  where
+    testLabel = "CLAcheckEpochDisabledArg "
+
+checkEpochEnabled :: IOManager -> [(Text, Text)] -> Assertion
+checkEpochEnabled =
+  withCustomConfig (mkCommandLineArgs False) babbageConfigDir testLabel $ \interpreter mockServer dbSyncEnv -> do
+    startDBSync dbSyncEnv
+    b1 <- forgeAndSubmitBlocks interpreter mockServer 50
+    -- add 2 blocks with tx
+    void $ withBabbageFindLeaderAndSubmitTx interpreter mockServer $ Babbage.mkPaymentTx (UTxOIndex 0) (UTxOIndex 1) 10000 10000
+    void $ withBabbageFindLeaderAndSubmitTx interpreter mockServer $ Babbage.mkPaymentTx (UTxOIndex 1) (UTxOIndex 0) 10000 10000
+    b2 <- forgeAndSubmitBlocks interpreter mockServer 60
+
+    assertBlockNoBackoff dbSyncEnv (fromIntegral $ length (b1 <> b2) + 2)
+    assertEqQuery dbSyncEnv DB.queryEpochCount 1 "new epoch didn't prune tx_out column that are null"
+  where
+    testLabel = "CLAcheckEpochDisabledArg "

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

@@ -40,7 +40,7 @@ mkCommandLineArgs :: TxOutParam -> CommandLineArgs
 mkCommandLineArgs TxOutParam {..} =
   CommandLineArgs
     { claHasConfigFile = True
-    , claExtended = True
+    , claEpochDisabled = True
     , claHasCache = True
     , claShouldUseLedger = True
     , claSkipFix = True

cardano-chain-gen/test/testfiles/fingerprint/CLAcheckEpochDisabledArg

@@ -0,0 +1 @@
+[1,3,4,7,8,9,10,11,14,30,31,33,34,35,40,42,44,61,62,74,76,82,85,88,89,93,95,102,104,106,111,114,120,123,141,143,146,149,158,170,171,178,186,190,198,201,207,209,210,221,223,227,245,249,250,259,260,265,272,276,283,284,294,296,301,305,306,311,312,317,318,321,322,325,331,333,337,339,345,347,348,350,365,375,377,379,382,391,394,401,407,411,413,415,424,428,445,453,467,469,471,474,487,489,490,492,497,498,515,519,520,524]

cardano-db-sync/app/cardano-db-sync.hs

@@ -69,7 +69,7 @@ pRunDbSyncNode =
     <*> optional pLedgerStateDir
     <*> pMigrationDir
     <*> pPGPassSource
-    <*> pExtended
+    <*> pEpochDisabled
     <*> pHasCache
     <*> pUseLedger
     <*> pSkipFix
@@ -127,11 +127,11 @@ pPGPassSource =
         <> Opt.metavar "ENV"
     )
 
-pExtended :: Parser Bool
-pExtended =
+pEpochDisabled :: Parser Bool
+pEpochDisabled =
   Opt.flag
-    True
     False
+    True
     ( Opt.long "disable-epoch"
         <> Opt.help "Makes epoch table remain empty"
     )

cardano-db-sync/src/Cardano/DbSync.hs

@@ -228,7 +228,7 @@ logProtocolMagicId tracer pm =
 extractSyncOptions :: SyncNodeParams -> Bool -> SyncOptions
 extractSyncOptions snp aop =
   SyncOptions
-    { soptExtended = enpExtended snp && enpHasCache snp
+    { soptEpochAndCacheEnabled = not $ enpEpochDisabled snp && enpHasCache snp
     , soptAbortOnInvalid = aop
     , soptCache = enpHasCache snp
     , soptSkipFix = enpSkipFix snp
@@ -255,7 +255,7 @@ startupReport trce aop params = do
   logInfo trce $ mconcat ["Git hash: ", Db.gitRev]
   logInfo trce $ mconcat ["Option disable-ledger: ", textShow (not $ enpShouldUseLedger params)]
   logInfo trce $ mconcat ["Option disable-cache: ", textShow (not $ enpHasCache params)]
-  logInfo trce $ mconcat ["Option disable-epoch: ", textShow (not $ enpExtended params)]
+  logInfo trce $ mconcat ["Option disable-epoch: ", textShow (enpEpochDisabled params)]
   logInfo trce $ mconcat ["Option skip-fix: ", textShow (enpSkipFix params)]
   logInfo trce $ mconcat ["Option fix-only: ", textShow (enpOnlyFix params)]
   logInfo trce $ mconcat ["Option force-indexes: ", textShow (enpForceIndexes params)]

cardano-db-sync/src/Cardano/DbSync/Api/Types.hs

@@ -54,7 +54,7 @@ data SyncEnv = SyncEnv
   }
 
 data SyncOptions = SyncOptions
-  { soptExtended :: !Bool
+  { soptEpochAndCacheEnabled :: !Bool
   , soptAbortOnInvalid :: !Bool
   , soptCache :: !Bool
   , soptSkipFix :: !Bool