add tests for force-index command line arg

Author: Cmdv

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

@@ -167,6 +167,7 @@ test-suite cardano-chain-gen
                         Test.Cardano.Db.Mock.Unit.Babbage
                         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.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Babbage.Other

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

@@ -9,12 +9,13 @@ module Test.Cardano.Db.Mock.Unit.Babbage (
 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 Test.Tasty.HUnit (Assertion, testCase)
 
-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.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.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
@@ -40,25 +41,31 @@ unitTests iom knownMigrations =
     , testGroup
         "Command Line Arguments"
         [ testGroup
-            "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
-                ]
+            "consumed-tx-out + prune-tx-out"
+            [ 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 or no config file given" ConfigFile.checkConfigFileArg ]
+            "config"
+            [ expectFail $ test "fails if incorrect or no config file given" ConfigFile.checkConfigFileArg
+            ]
         , testGroup
-            "EpochDisabled"
+            "disable-epoch"
             [ test "Epoch doesn't update when disabled" EpochDisabled.checkEpochDisabledArg
             , test "Epoch updates when enabled" EpochDisabled.checkEpochEnabled
             ]
+        , testGroup
+            "force-indexes"
+            [ test "check force-index adds indexes" ForceIndex.checkForceIndexesArg
+            , test "check no force-index doesn't add indexes" ForceIndex.checkNoForceIndexesArg
+            ]
         ]
     , testGroup
         "rollbacks"

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

@@ -8,13 +8,11 @@ import Data.Text (Text)
 import Test.Cardano.Db.Mock.Config (CommandLineArgs (..), babbageConfigDir, initCommandLineArgs, withCustomConfigAndLogs)
 import Test.Tasty.HUnit (Assertion)
 
-commandLineArgs :: CommandLineArgs
-commandLineArgs = initCommandLineArgs {claHasConfigFile = False}
-
 -- this test fails as incorrect configuration file given
 checkConfigFileArg :: IOManager -> [(Text, Text)] -> Assertion
 checkConfigFileArg =
-  withCustomConfigAndLogs commandLineArgs babbageConfigDir testLabel $ \_ _ _ -> do
+  withCustomConfigAndLogs commandLineConfigArgs babbageConfigDir testLabel $ \_ _ _ -> do
     pure ()
   where
     testLabel = "CLAcheckConfigFileArg"
+    commandLineConfigArgs = initCommandLineArgs {claHasConfigFile = False}

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

@@ -0,0 +1,37 @@
+{-# LANGUAGE NumericUnderscores #-}
+
+module Test.Cardano.Db.Mock.Unit.Babbage.CommandLineArg.ForceIndex (
+  checkForceIndexesArg,
+  checkNoForceIndexesArg
+)
+where
+
+import Cardano.Mock.ChainSync.Server (IOManager)
+import Data.Text (Text)
+import Test.Cardano.Db.Mock.Config (CommandLineArgs (..), babbageConfigDir, initCommandLineArgs, withCustomConfig, startDBSync)
+import Test.Tasty.HUnit (Assertion)
+import qualified Cardano.Db as DB
+import Test.Cardano.Db.Mock.Validate (assertEqQuery)
+import GHC.Conc.IO (threadDelay)
+
+checkForceIndexesArg :: IOManager -> [(Text, Text)] -> Assertion
+checkForceIndexesArg =
+  withCustomConfig commandLineForceIndexArgs babbageConfigDir testLabel $ \_ _ dbSyncEnv -> do
+    startDBSync dbSyncEnv
+    -- assertBlockNoBackoff dbSyncEnv 0
+    threadDelay 3_000_000
+    assertEqQuery dbSyncEnv DB.queryPgIndexesCount 143 "there wasn't the correct number of indexes"
+  where
+    testLabel = "CLAcheckForceIndexesArg"
+    commandLineForceIndexArgs = initCommandLineArgs {claForceIndexes = True}
+
+checkNoForceIndexesArg :: IOManager -> [(Text, Text)] -> Assertion
+checkNoForceIndexesArg =
+  withCustomConfig commandLineNoForceIndexArgs babbageConfigDir testLabel $ \_ _ dbSyncEnv -> do
+    startDBSync dbSyncEnv
+    -- assertBlockNoBackoff dbSyncEnv 0
+    threadDelay 3_000_000
+    assertEqQuery dbSyncEnv DB.queryPgIndexesCount 78 "there wasn't the correct number of indexes"
+  where
+    testLabel = "CLAcheckNoForceIndexesArg"
+    commandLineNoForceIndexArgs = initCommandLineArgs {claForceIndexes = False}

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

@@ -103,7 +103,7 @@ pruneWithSimpleRollback = do
     assertEqQuery dbSyncEnv DB.queryTxOutCount 14 ""
     b1 <- forgeAndSubmitBlocks interpreter mockServer 96
     assertBlockNoBackoff dbSyncEnv (fullBlockSize b1)
-    assertEqQuery dbSyncEnv DB.queryTxOutCount 12 "there wasn't the correct "
+    assertEqQuery dbSyncEnv DB.queryTxOutCount 12 "the txOut count is incorrect"
     assertEqQuery dbSyncEnv DB.queryTxOutConsumedCount 0 "Unexpected TxOutConsumedByTxInId count after prune"
     assertUnspentTx dbSyncEnv
 

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

@@ -0,0 +1 @@
+[]

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

@@ -0,0 +1 @@
+[]

cardano-db/src/Cardano/Db/Migration.hs

@@ -1,5 +1,6 @@
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 
 module Cardano.Db.Migration (
   MigrationDir (..),
@@ -18,6 +19,7 @@ module Cardano.Db.Migration (
   hashMigrations,
   renderMigrationValidateError,
   noLedgerMigrations,
+  queryPgIndexesCount,
 ) where
 
 import Cardano.BM.Trace (Trace)
@@ -31,7 +33,7 @@ import Cardano.Db.Schema
 import Cardano.Db.Text
 import Control.Exception (SomeException, handle)
 import Control.Monad.Extra
-import Control.Monad.IO.Class (liftIO)
+import Control.Monad.IO.Class (MonadIO, liftIO)
 import Control.Monad.Logger (NoLoggingT)
 import Control.Monad.Trans.Reader (ReaderT)
 import Control.Monad.Trans.Resource (runResourceT)
@@ -58,6 +60,7 @@ import Database.Persist.Sql (
   rawSql,
   selectFirst,
  )
+import GHC.Word (Word64)
 import System.Directory (listDirectory)
 import System.Exit (ExitCode (..), exitFailure)
 import System.FilePath (takeExtension, takeFileName, (</>))
@@ -378,3 +381,15 @@ noLedgerMigrations backend trce = do
     rawExecute "delete from epoch_stake" []
     rawExecute "delete from ada_pots" []
     rawExecute "delete from epoch_param" []
+
+queryPgIndexesCount :: MonadIO m => ReaderT SqlBackend m Word64
+queryPgIndexesCount = do
+  indexesExists :: [Text] <-
+    fmap unSingle
+      <$> rawSql
+        ( mconcat
+            [ "SELECT indexname FROM pg_indexes WHERE schemaname = 'public'"
+            ]
+        )
+        []
+  pure $ fromIntegral (length indexesExists)