test(cardano-chain-gen): Allow tests to override config file name

Author: sgillespie

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

@@ -141,8 +141,8 @@ test-suite cardano-chain-gen
                         Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile
                         Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.EpochDisabled
                         Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ForceIndex
-                        Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut
-                        Test.Cardano.Db.Mock.Unit.Babbage.Config
+                        Test.Cardano.Db.Mock.Unit.Babbage.Config.MigrateConsumedPruneTxOut
+                        Test.Cardano.Db.Mock.Unit.Babbage.Config.Parse
                         Test.Cardano.Db.Mock.Unit.Babbage.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Babbage.Other
                         Test.Cardano.Db.Mock.Unit.Babbage.Plutus
@@ -155,8 +155,8 @@ test-suite cardano-chain-gen
                         Test.Cardano.Db.Mock.Unit.Conway.CommandLineArg.ConfigFile
                         Test.Cardano.Db.Mock.Unit.Conway.CommandLineArg.EpochDisabled
                         Test.Cardano.Db.Mock.Unit.Conway.CommandLineArg.ForceIndex
-                        Test.Cardano.Db.Mock.Unit.Conway.CommandLineArg.MigrateConsumedPruneTxOut
-                        Test.Cardano.Db.Mock.Unit.Conway.Config
+                        Test.Cardano.Db.Mock.Unit.Conway.Config.Parse
+                        Test.Cardano.Db.Mock.Unit.Conway.Config.MigrateConsumedPruneTxOut
                         Test.Cardano.Db.Mock.Unit.Conway.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Conway.Other
                         Test.Cardano.Db.Mock.Unit.Conway.Plutus

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

@@ -41,6 +41,7 @@ module Test.Cardano.Db.Mock.Config (
   withCustomConfigAndDropDB,
   withCustomConfigAndLogs,
   withFullConfig',
+  replaceConfigFile,
 ) where
 
 import Cardano.Api (NetworkMagic (..))
@@ -81,7 +82,7 @@ import qualified Ouroboros.Consensus.Node.ProtocolInfo as Consensus
 import Ouroboros.Consensus.Shelley.Eras (StandardCrypto)
 import Ouroboros.Consensus.Shelley.Node (ShelleyLeaderCredentials)
 import System.Directory (createDirectoryIfMissing, removePathForcibly)
-import System.FilePath.Posix ((</>))
+import System.FilePath.Posix (takeDirectory, (</>))
 import System.IO.Silently (hSilence)
 
 data Config = Config
@@ -94,12 +95,13 @@ data Config = Config
 
 data DBSyncEnv = DBSyncEnv
   { dbSyncParams :: SyncNodeParams
-  , partialRunDbSync :: SyncNodeParams -> IO ()
+  , dbSyncConfig :: SyncNodeConfig
+  , partialRunDbSync :: SyncNodeParams -> SyncNodeConfig -> IO ()
   , dbSyncThreadVar :: TMVar (Async ())
   }
 
 data CommandLineArgs = CommandLineArgs
-  { claHasConfigFile :: Bool
+  { claConfigFilename :: FilePath
   , claEpochDisabled :: Bool
   , claHasCache :: Bool
   , claHasLedger :: Bool
@@ -151,12 +153,17 @@ fingerprintRoot = rootTestDir </> "fingerprint"
 mkFingerPrint :: FilePath -> FilePath
 mkFingerPrint testLabel = fingerprintRoot </> testLabel
 
-mkDBSyncEnv :: SyncNodeParams -> (SyncNodeParams -> IO ()) -> IO DBSyncEnv
-mkDBSyncEnv params pRunDbSync = do
+mkDBSyncEnv ::
+  SyncNodeParams ->
+  SyncNodeConfig ->
+  (SyncNodeParams -> SyncNodeConfig -> IO ()) ->
+  IO DBSyncEnv
+mkDBSyncEnv params cfg pRunDbSync = do
   runningVar <- newEmptyTMVarIO
   pure $
     DBSyncEnv
       { dbSyncParams = params
+      , dbSyncConfig = cfg
       , partialRunDbSync = pRunDbSync
       , dbSyncThreadVar = runningVar
       }
@@ -188,7 +195,7 @@ startDBSync env = do
   case thr of
     Just _a -> error "db-sync already running"
     Nothing -> do
-      let appliedRunDbSync = partialRunDbSync env $ dbSyncParams env
+      let appliedRunDbSync = partialRunDbSync env (dbSyncParams env) (dbSyncConfig env)
       -- we async the fully applied runDbSync here ad put it into the thread
       asyncApplied <- async appliedRunDbSync
       void . atomically $ tryPutTMVar (dbSyncThreadVar env) asyncApplied
@@ -220,17 +227,21 @@ getPoolLayer env = do
 
 mkConfig :: FilePath -> FilePath -> CommandLineArgs -> SyncNodeConfig -> IO Config
 mkConfig staticDir mutableDir cmdLineArgs config = do
+  let cfgDir = mkConfigDir staticDir
   genCfg <- runOrThrowIO $ runExceptT (readCardanoGenesisConfig config)
   let (pInfoDbSync, _) = mkProtocolInfoCardano genCfg []
-  creds <- mkShelleyCredentials $ staticDir </> "pools" </> "bulk1.creds"
+  creds <- mkShelleyCredentials $ cfgDir </> "pools" </> "bulk1.creds"
   let (pInfoForger, forging) = mkProtocolInfoCardano genCfg creds
   forging' <- forging
   syncPars <- mkSyncNodeParams staticDir mutableDir cmdLineArgs
   pure $ Config (Consensus.pInfoConfig pInfoDbSync) pInfoDbSync pInfoForger forging' syncPars
 
-mkSyncNodeConfig :: FilePath -> IO SyncNodeConfig
-mkSyncNodeConfig configFilePath =
-  readSyncNodeConfig $ ConfigFile (mkConfigDir configFilePath </> "test-db-sync-config.json")
+mkSyncNodeConfig :: FilePath -> CommandLineArgs -> IO SyncNodeConfig
+mkSyncNodeConfig configFilePath cmdLineArgs =
+  readSyncNodeConfig $ mkConfigFile configDir configFilename
+  where
+    configFilename = claConfigFilename cmdLineArgs
+    configDir = mkConfigDir configFilePath
 
 mkShelleyCredentials :: FilePath -> IO [ShelleyLeaderCredentials StandardCrypto]
 mkShelleyCredentials bulkFile = do
@@ -250,9 +261,10 @@ mkShelleyCredentials bulkFile = do
 mkSyncNodeParams :: FilePath -> FilePath -> CommandLineArgs -> IO SyncNodeParams
 mkSyncNodeParams staticDir mutableDir CommandLineArgs {..} = do
   pgconfig <- runOrThrowIO Db.readPGPassDefault
+
   pure $
     SyncNodeParams
-      { enpConfigFile = ConfigFile $ staticDir </> (if claHasConfigFile then "test-db-sync-config.json" else "")
+      { enpConfigFile = mkConfigFile staticDir claConfigFilename
       , enpSocketPath = SocketPath $ mutableDir </> ".socket"
       , enpMaybeLedgerStateDir = Just $ LedgerStateDir $ mutableDir </> "ledger-states"
       , enpMigrationDir = MigrationDir "../schema"
@@ -285,10 +297,14 @@ mkSyncNodeParams staticDir mutableDir CommandLineArgs {..} = do
       , enpMaybeRollback = Nothing
       }
 
+mkConfigFile :: FilePath -> FilePath -> ConfigFile
+mkConfigFile staticDir cliConfigFilename =
+  ConfigFile $ staticDir </> cliConfigFilename
+
 initCommandLineArgs :: CommandLineArgs
 initCommandLineArgs =
   CommandLineArgs
-    { claHasConfigFile = True
+    { claConfigFilename = "test-db-sync-config.json"
     , claEpochDisabled = True
     , claHasCache = True
     , claHasLedger = True
@@ -460,17 +476,17 @@ withFullConfig' WithConfigArgs {..} cmdLineArgs mSyncNodeConfig configFilePath t
   syncNodeConfig <-
     case mSyncNodeConfig of
       Just snc -> pure snc
-      Nothing -> mkSyncNodeConfig configFilePath
+      Nothing -> mkSyncNodeConfig configFilePath cmdLineArgs
 
-  cfg <- mkConfig (mkConfigDir configFilePath) mutableDir cmdLineArgs syncNodeConfig
+  cfg <- mkConfig configFilePath mutableDir cmdLineArgs syncNodeConfig
   fingerFile <- if hasFingerprint then Just <$> prepareFingerprintFile testLabelFilePath else pure Nothing
   let dbsyncParams = syncNodeParams cfg
   trce <-
     if shouldLog
       then configureLogging syncNodeConfig "db-sync-node"
       else pure nullTracer
   -- runDbSync is partially applied so we can pass in syncNodeParams at call site / within tests
-  let partialDbSyncRun params = runDbSync emptyMetricsSetters migr iom trce params syncNodeConfig True
+  let partialDbSyncRun params cfg' = runDbSync emptyMetricsSetters migr iom trce params cfg' True
       initSt = Consensus.pInfoInitLedger $ protocolInfo cfg
 
   withInterpreter (protocolInfoForging cfg) (protocolInfoForger cfg) nullTracer fingerFile $ \interpreter -> do
@@ -483,7 +499,7 @@ withFullConfig' WithConfigArgs {..} cmdLineArgs mSyncNodeConfig configFilePath t
       (unSocketPath (enpSocketPath $ syncNodeParams cfg))
       $ \mockServer ->
         -- we dont fork dbsync here. Just prepare it as an action
-        withDBSyncEnv (mkDBSyncEnv dbsyncParams partialDbSyncRun) $ \dbSyncEnv -> do
+        withDBSyncEnv (mkDBSyncEnv dbsyncParams syncNodeConfig partialDbSyncRun) $ \dbSyncEnv -> do
           let pgPass = getDBSyncPGPass dbSyncEnv
           tableNames <- Db.getAllTablleNames pgPass
           -- We only want to create the table schema once for the tests so here we check
@@ -509,3 +525,13 @@ recreateDir path = do
 
 textShow :: (Show a) => a -> Text
 textShow = Text.pack . show
+
+replaceConfigFile :: FilePath -> DBSyncEnv -> IO DBSyncEnv
+replaceConfigFile newFilename dbSync@DBSyncEnv {..} = do
+  cfg <- readSyncNodeConfig $ mkConfigFile configDir newFilename
+
+  pure $ dbSync {dbSyncParams = newParams, dbSyncConfig = cfg}
+  where
+    configDir = mkConfigDir . takeDirectory . unConfigFile . enpConfigFile $ dbSyncParams
+    newParams =
+      dbSyncParams {enpConfigFile = ConfigFile $ configDir </> newFilename}

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

@@ -13,12 +13,12 @@ import Prelude ()
 
 defaultInsertConfig :: Assertion
 defaultInsertConfig = do
-  cfg <- mkSyncNodeConfig alonzoConfigDir
+  cfg <- mkSyncNodeConfig alonzoConfigDir initCommandLineArgs
   dncInsertConfig cfg @?= def
 
 insertConfig :: Assertion
 insertConfig = do
-  cfg <- mkSyncNodeConfig configDir
+  cfg <- mkSyncNodeConfig configDir initCommandLineArgs
   let expected =
         SyncInsertConfig
           { spcTxOut = TxOutDisable

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

@@ -15,8 +15,8 @@ import Test.Tasty.HUnit (Assertion, testCase)
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ConfigFile as ConfigFile
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.EpochDisabled as EpochDisabled
 import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ForceIndex as ForceIndex
-import qualified Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.MigrateConsumedPruneTxOut as MigrateConsumedPruneTxOut
-import qualified Test.Cardano.Db.Mock.Unit.Babbage.Config as BabConfig
+import qualified Test.Cardano.Db.Mock.Unit.Babbage.Config.MigrateConsumedPruneTxOut as MigrateConsumedPruneTxOut
+import qualified Test.Cardano.Db.Mock.Unit.Babbage.Config.Parse as Config
 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
@@ -32,23 +32,11 @@ unitTests iom knownMigrations =
     "Babbage unit tests"
     [ testGroup
         "config"
-        [ testCase "default insert config" BabConfig.defaultInsertConfig
-        , testCase "insert config" BabConfig.insertConfig
-        ]
-    , testGroup
-        "simple"
-        [ test "simple forge blocks" BabSimple.forgeBlocks
-        , test "sync one block" BabSimple.addSimple
-        , test "sync small chain" BabSimple.addSimpleChain
-        , test "restart db-sync" BabSimple.restartDBSync
-        , test "node restart" BabSimple.nodeRestart
-        , test "node restart boundary" BabSimple.nodeRestartBoundary
-        ]
-    , testGroup
-        "Command Line Arguments"
-        [ testGroup
+        [ testCase "default insert config" Config.defaultInsertConfig
+        , testCase "insert config" Config.insertConfig
+        , testGroup
             "consumed-tx-out and prune-tx-out"
-            [ test "flag check" MigrateConsumedPruneTxOut.commandLineArgCheck
+            [ test "flag check" MigrateConsumedPruneTxOut.txConsumedColumnCheck
             , test "basic prune" MigrateConsumedPruneTxOut.basicPrune
             , test "prune with simple rollback" MigrateConsumedPruneTxOut.pruneWithSimpleRollback
             , test "prune with full tx rollback" MigrateConsumedPruneTxOut.pruneWithFullTxRollback
@@ -61,9 +49,21 @@ unitTests iom knownMigrations =
             , expectFail $ test "set prune flag, restart missing prune flag" MigrateConsumedPruneTxOut.pruneRestartMissingFlag
             , expectFail $ test "set bootstrap flag, restart missing bootstrap flag" MigrateConsumedPruneTxOut.bootstrapRestartMissingFlag
             ]
-        , testGroup
+        ]
+    , testGroup
+        "simple"
+        [ test "simple forge blocks" BabSimple.forgeBlocks
+        , test "sync one block" BabSimple.addSimple
+        , test "sync small chain" BabSimple.addSimpleChain
+        , test "restart db-sync" BabSimple.restartDBSync
+        , test "node restart" BabSimple.nodeRestart
+        , test "node restart boundary" BabSimple.nodeRestartBoundary
+        ]
+    , testGroup
+        "Command Line Arguments"
+        [ testGroup
             "config"
-            [ expectFail $ test "fails if incorrect or no config file given" ConfigFile.checkConfigFileArg
+            [ expectFail $ test "fails if incorrect config file given" ConfigFile.checkConfigFileArg
             ]
         , testGroup
             "disable-epoch"

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

@@ -17,4 +17,4 @@ checkConfigFileArg =
     checkStillRuns dbSyncEnv
   where
     testLabel = "CLAcheckConfigFileArg"
-    commandLineConfigArgs = initCommandLineArgs {claHasConfigFile = False}
+    commandLineConfigArgs = initCommandLineArgs {claConfigFilename = "does-not-exist"}