Test for command line arguments

Author: Cmdv

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

@@ -165,7 +165,8 @@ 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.Flag.ConsumedTxOut
+                        Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut
+                        Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile
                         Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Babbage.Other
                         Test.Cardano.Db.Mock.Unit.Babbage.Plutus
@@ -209,6 +210,7 @@ test-suite cardano-chain-gen
                       , stm
                       , strict-stm
                       , tasty
+                      , tasty-expected-failure
                       , tasty-quickcheck
                       , text
                       , transformers

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

@@ -1,11 +1,14 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
+{-# LANGUAGE RecordWildCards #-}
 
 module Test.Cardano.Db.Mock.Config (
   Config (..),
   DBSyncEnv (..),
-  TxOutParam(..),
+  CommandLineArgs(..),
+  TxOutParam (..),
+  initCommandLineArgs,
   babbageConfigDir,
   alonzoConfigDir,
   emptyMetricsSetters,
@@ -30,7 +33,8 @@ module Test.Cardano.Db.Mock.Config (
   startDBSync,
   withDBSyncEnv,
   withFullConfig,
-  withTxOutParamConfig,
+  withCustomConfig,
+  withCustomConfigAndLogs,
   withFullConfig',
 ) where
 
@@ -48,7 +52,7 @@ import Cardano.Mock.ChainSync.Server
 import Cardano.Mock.Forging.Interpreter
 import Cardano.Node.Protocol.Shelley (readLeaderCredentials)
 import Cardano.Node.Types (ProtocolFilepaths (..))
-import Cardano.Prelude (ReaderT, panic, stderr)
+import Cardano.Prelude (ReaderT, panic, stderr, fromMaybe)
 import Cardano.SMASH.Server.PoolDataLayer
 import Control.Concurrent.Async (Async, async, cancel, poll)
 import Control.Concurrent.STM (atomically)
@@ -93,8 +97,26 @@ data DBSyncEnv = DBSyncEnv
 
 -- used for testing of tx out pruning feature
 data TxOutParam = TxOutParam
-  { paramMigrateConsumed :: Bool,
-    paramPruneTxOut :: Bool
+  { paramMigrateConsumed :: Bool
+  , paramPruneTxOut :: Bool
+  }
+
+data CommandLineArgs = CommandLineArgs
+  { claHasConfigFile :: Bool
+  , claExtended :: Bool
+  , claHasCache :: Bool
+  , claShouldUseLedger :: Bool
+  , claSkipFix :: Bool
+  , claOnlyFix :: Bool
+  , claForceIndexes :: Bool
+  , claHasMultiAssets :: Bool
+  , claHasMetadata :: Bool
+  , claHasPlutusExtra :: Bool
+  , claHasOfflineData :: Bool
+  , claTurboMode :: Bool
+  , claFullMode :: Bool
+  , claMigrateConsumed :: Bool
+  , claPruneTxOut :: Bool
   }
 
 babbageConfigDir :: FilePath
@@ -203,14 +225,14 @@ setupTestsDir dir = do
           0
           Nothing
 
-mkConfig :: FilePath -> FilePath -> Maybe TxOutParam -> IO Config
-mkConfig staticDir mutableDir mTxOutParam = do
+mkConfig :: FilePath -> FilePath -> CommandLineArgs -> IO Config
+mkConfig staticDir mutableDir cmdLineArgs = 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 mTxOutParam
+  syncPars <- mkSyncNodeParams staticDir mutableDir cmdLineArgs
   pure $ Config (Consensus.pInfoConfig pInfoDbSync) pInfoDbSync pInfoForger syncPars
 
 mkShelleyCredentials :: FilePath -> IO [ShelleyLeaderCredentials StandardCrypto]
@@ -228,35 +250,55 @@ mkShelleyCredentials bulkFile = do
         }
 
 -- | staticDir can be shared by tests running in parallel. mutableDir not.
-mkSyncNodeParams :: FilePath -> FilePath -> Maybe TxOutParam -> IO SyncNodeParams
-mkSyncNodeParams staticDir mutableDir mTxOutParam = do
+mkSyncNodeParams :: FilePath -> FilePath -> CommandLineArgs -> IO SyncNodeParams
+mkSyncNodeParams staticDir mutableDir CommandLineArgs{..} = do
   pgconfig <- orDie Db.renderPGPassError $ newExceptT Db.readPGPassDefault
   pure $
     SyncNodeParams
-      { enpConfigFile = ConfigFile $ staticDir </> "test-db-sync-config.json"
+      { enpConfigFile = ConfigFile $ staticDir </> (if claHasConfigFile then "test-db-sync-config.json" else "")
       , enpSocketPath = SocketPath $ mutableDir </> ".socket"
       , enpMaybeLedgerStateDir = Just $ LedgerStateDir $ mutableDir </> "ledger-states"
       , enpMigrationDir = MigrationDir "../schema"
       , enpPGPassSource = Db.PGPassCached pgconfig
-      , enpExtended = True
-      , enpHasCache = True
-      , enpShouldUseLedger = True
-      , enpSkipFix = True
-      , enpOnlyFix = False
-      , enpForceIndexes = False
-      , enpHasMultiAssets = True
-      , enpHasMetadata = True
+      , enpExtended = claExtended
+      , enpHasCache = claHasCache
+      , enpShouldUseLedger = claShouldUseLedger
+      , enpSkipFix = claSkipFix
+      , enpOnlyFix = claOnlyFix
+      , enpForceIndexes = claForceIndexes
+      , enpHasMultiAssets = claHasMultiAssets
+      , enpHasMetadata = claHasMetadata
       , enpHasPlutusExtra = True
       , enpHasOfflineData = True
       , enpTurboMode = False
       , enpFullMode = True
-      , enpMigrateConsumed = maybe False paramMigrateConsumed mTxOutParam
-      , enpPruneTxOut = maybe False paramPruneTxOut mTxOutParam
+      , enpMigrateConsumed = claMigrateConsumed
+      , enpPruneTxOut = claPruneTxOut
       , enpSnEveryFollowing = 35
       , enpSnEveryLagging = 35
       , enpMaybeRollback = Nothing
       }
 
+initCommandLineArgs :: CommandLineArgs
+initCommandLineArgs =
+  CommandLineArgs
+  { claHasConfigFile = True
+  , claExtended = True
+  , 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
+  }
+
 emptyMetricsSetters :: MetricSetters
 emptyMetricsSetters =
   MetricSetters
@@ -273,37 +315,48 @@ withFullConfig ::
   IOManager ->
   [(Text, Text)] ->
   IO a
-withFullConfig = withFullConfig' True Nothing
+withFullConfig = withFullConfig' True False initCommandLineArgs
+
+withCustomConfig ::
+  CommandLineArgs ->
+  FilePath ->
+  FilePath ->
+  (Interpreter -> ServerHandle IO CardanoBlock -> DBSyncEnv -> IO a) ->
+  IOManager ->
+  [(Text, Text)] ->
+  IO a
+withCustomConfig = withFullConfig' True False
 
-withTxOutParamConfig ::
-  TxOutParam ->
+withCustomConfigAndLogs ::
+  CommandLineArgs ->
   FilePath ->
   FilePath ->
   (Interpreter -> ServerHandle IO CardanoBlock -> DBSyncEnv -> IO a) ->
   IOManager ->
   [(Text, Text)] ->
   IO a
-withTxOutParamConfig txOutParam = withFullConfig' True (Just txOutParam)
+withCustomConfigAndLogs = withFullConfig' True True
 
 withFullConfig' ::
   Bool ->
-  Maybe TxOutParam ->
+  Bool ->
+  CommandLineArgs ->
   FilePath ->
   FilePath ->
   (Interpreter -> ServerHandle IO CardanoBlock -> DBSyncEnv -> IO a) ->
   IOManager ->
   [(Text, Text)] ->
   IO a
-withFullConfig' hasFingerprint mTxOutParam config testLabel action iom migr = do
+withFullConfig' hasFingerprint shouldLog cmdLineArgs config testLabel action iom migr = do
   recreateDir mutableDir
-  cfg <- mkConfig configDir mutableDir mTxOutParam
+  cfg <- mkConfig configDir mutableDir cmdLineArgs
   fingerFile <- if hasFingerprint then Just <$> prepareFingerprintFile testLabel else pure Nothing
   let dbsyncParams = syncNodeParams cfg
   -- Set to True to disable logging, False to enable it.
   trce <-
-    if True
-      then pure nullTracer
-      else configureLogging dbsyncParams "db-sync-node"
+    if shouldLog
+      then configureLogging dbsyncParams "db-sync-node"
+      else pure nullTracer
   let dbsyncRun = runDbSync emptyMetricsSetters migr iom trce dbsyncParams True
   let initSt = Consensus.pInfoInitLedger $ protocolInfo cfg
   withInterpreter (protocolInfoForging cfg) nullTracer fingerFile $ \interpreter -> do

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 Nothing "config" "qsm" action iom knownMigrations
+    runAction action = withFullConfig' False False initCommandLineArgs "config" "qsm" action iom knownMigrations

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

@@ -10,8 +10,10 @@ import Cardano.Mock.ChainSync.Server (IOManager)
 import Data.Text (Text)
 import Test.Tasty (TestTree, testGroup)
 import Test.Tasty.HUnit (Assertion, testCase)
+import Test.Tasty.ExpectedFailure (expectFail)
 
-import qualified Test.Cardano.Db.Mock.Unit.Babbage.Flag.ConsumedTxOut as FlagConsumedTxOut
+import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut as MigrateConsumedPruneTxOut
+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
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.Plutus as BabPlutus
@@ -35,19 +37,23 @@ unitTests iom knownMigrations =
         , test "node restart boundary" BabSimple.nodeRestartBoundary
         ]
     , testGroup
-        "flags"
+        "Command Line Arguements"
         [ 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
+            "MigrateConsumed - PruneTxOut"
+                [ test "flag check" MigrateConsumedPruneTxOut.commandLineArgCheck
+                , test "basic prune" MigrateConsumedPruneTxOut.basicPrune
+                , test "prune with simple rollback" MigrateConsumedPruneTxOut.pruneWithSimpleRollback
+                , test "prune with full tx rollback" MigrateConsumedPruneTxOut.pruneWithFullTxRollback
+                , test "pruning should keep some tx" MigrateConsumedPruneTxOut.pruningShouldKeepSomeTx
+                , test "prune and rollback one block" MigrateConsumedPruneTxOut.pruneAndRollBackOneBlock
+                , test "no pruning and rollback" MigrateConsumedPruneTxOut.noPruneAndRollBack
+                , test "prune same block" MigrateConsumedPruneTxOut.pruneSameBlock
+                , test "no pruning same block" MigrateConsumedPruneTxOut.noPruneSameBlock
                 ]
+        , testGroup
+            "ConfigFile"
+            [ expectFail $ test "fails if incorrect config file" ConfigFile.checkConfigFileArg
+            ]
         ]
     , testGroup
         "rollbacks"

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

@@ -0,0 +1,37 @@
+module Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile (
+  checkConfigFileArg,
+)
+where
+
+import Cardano.Mock.ChainSync.Server (IOManager)
+import Data.Text (Text)
+import Test.Cardano.Db.Mock.Config (CommandLineArgs (..), babbageConfigDir, withCustomConfigAndLogs)
+import Test.Tasty.HUnit (Assertion)
+
+mkCommandLineArgs :: Bool -> CommandLineArgs
+mkCommandLineArgs hasConfigFile =
+  CommandLineArgs
+    { claHasConfigFile = hasConfigFile
+    , claExtended = True
+    , 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
+checkConfigFileArg :: IOManager -> [(Text, Text)] -> Assertion
+checkConfigFileArg =
+  withCustomConfigAndLogs (mkCommandLineArgs False) babbageConfigDir testLabel $ \_ _ _ -> do
+    pure ()
+  where
+    testLabel = "CLAcheckConfigFileArg"