test: Add tx_out.consumed_by_tx tests

Author: sgillespie

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

@@ -157,6 +157,7 @@ test-suite cardano-chain-gen
                         Test.Cardano.Db.Mock.Unit.Conway.Config.JsonbInSchema
                         Test.Cardano.Db.Mock.Unit.Conway.Config.Parse
                         Test.Cardano.Db.Mock.Unit.Conway.Config.MigrateConsumedPruneTxOut
+                        Test.Cardano.Db.Mock.Unit.Conway.Config.TxOutConsumed
                         Test.Cardano.Db.Mock.Unit.Conway.Governance
                         Test.Cardano.Db.Mock.Unit.Conway.InlineAndReference
                         Test.Cardano.Db.Mock.Unit.Conway.Other

cardano-chain-gen/src/Cardano/Mock/Query.hs

@@ -1,4 +1,8 @@
+{-# LANGUAGE AllowAmbiguousTypes #-}
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE KindSignatures #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
 module Cardano.Mock.Query (
@@ -17,6 +21,7 @@ module Cardano.Mock.Query (
   queryEpochStateCount,
   queryCommitteeByTxHash,
   queryCommitteeMemberCountByTxHash,
+  queryConsumedTxOutCount,
 ) where
 
 import qualified Cardano.Db as Db
@@ -270,3 +275,15 @@ queryCommitteeMemberCountByTxHash txHash = do
     pure countRows
 
   pure (maybe 0 unValue res)
+
+queryConsumedTxOutCount ::
+  forall (a :: Db.TxOutTableType) io.
+  (MonadIO io, Db.TxOutFields a) =>
+  ReaderT SqlBackend io Word64
+queryConsumedTxOutCount = do
+  res <- selectOne $ do
+    txOut <- from $ table @(Db.TxOutTable a)
+    where_ (not_ $ isNothing_ $ txOut ^. Db.txOutConsumedByTxIdField @a)
+    pure countRows
+
+  pure $ maybe 0 unValue res

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

@@ -7,6 +7,7 @@ import qualified Test.Cardano.Db.Mock.Unit.Conway.CommandLineArg.EpochDisabled a
 import qualified Test.Cardano.Db.Mock.Unit.Conway.Config.JsonbInSchema as Config
 import qualified Test.Cardano.Db.Mock.Unit.Conway.Config.MigrateConsumedPruneTxOut as MigrateConsumedPruneTxOut
 import qualified Test.Cardano.Db.Mock.Unit.Conway.Config.Parse as Config
+import qualified Test.Cardano.Db.Mock.Unit.Conway.Config.TxOutConsumed as TxOutConsumed
 import qualified Test.Cardano.Db.Mock.Unit.Conway.Governance as Governance
 import qualified Test.Cardano.Db.Mock.Unit.Conway.InlineAndReference as InlineRef
 import qualified Test.Cardano.Db.Mock.Unit.Conway.Other as Other
@@ -85,6 +86,11 @@ unitTests iom knownMigrations =
                 "populate db then reset with use_address_table config config active"
                 $ MigrateConsumedPruneTxOut.populateDbRestartWithAddressConfig iom knownMigrations
             ]
+        , testGroup
+            "tx-out consumed by tx id"
+            [ test "without txout-consumed" TxOutConsumed.consumeTx
+            , test "with txout-consumed" TxOutConsumed.consumeTxConsumed
+            ]
         ]
     , testGroup
         "simple"

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

@@ -0,0 +1,82 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE NumericUnderscores #-}
+{-# LANGUAGE TypeApplications #-}
+
+module Test.Cardano.Db.Mock.Unit.Conway.Config.TxOutConsumed (
+  consumeTx,
+  consumeTxConsumed,
+) where
+
+import qualified Cardano.Db as Db
+import Cardano.Mock.ChainSync.Server (IOManager ())
+import Cardano.Mock.Forging.Interpreter (withConwayLedgerState)
+import qualified Cardano.Mock.Forging.Tx.Conway as Conway
+import Cardano.Mock.Forging.Types (ForgingError (..), UTxOIndex (..))
+import qualified Cardano.Mock.Query as Query
+import Cardano.Prelude
+import Test.Cardano.Db.Mock.Config
+import qualified Test.Cardano.Db.Mock.UnifiedApi as Api
+import Test.Cardano.Db.Mock.Validate
+import Test.Tasty.HUnit (Assertion ())
+import Prelude ()
+
+consumeTx :: IOManager -> [(Text, Text)] -> Assertion
+consumeTx =
+  withFullConfigAndDropDB conwayConfigDir testLabel $ \interpreter mockServer dbSync -> do
+    startDBSync dbSync
+
+    -- Forge a payment transaction
+    tx0 <-
+      withConwayLedgerState interpreter $
+        Conway.mkPaymentTx (UTxOIndex 0) (UTxOIndex 1) 20_000 20_000 0
+
+    -- Forge a block with a transaction
+    void $ Api.withConwayFindLeaderAndSubmitTx interpreter mockServer $ \_ -> Right tx0
+    void $ Api.withConwayFindLeaderAndSubmitTx interpreter mockServer $ \state' -> do
+      utxo' <- maybeToEither CantFindUTxO (head $ Conway.mkUTxOConway tx0)
+      Conway.mkPaymentTx (UTxOPair utxo') (UTxOIndex 2) 10_000 500 0 state'
+
+    -- Verify the new transaction count
+    assertBlockNoBackoff dbSync 2
+
+    -- Should not have consumed_by_tx
+    assertEqBackoff
+      dbSync
+      (Query.queryConsumedTxOutCount @'Db.TxOutCore)
+      0
+      []
+      "Unexpected consumed_by_tx count"
+  where
+    testLabel = "conwayConsumeTx"
+
+consumeTxConsumed :: IOManager -> [(Text, Text)] -> Assertion
+consumeTxConsumed =
+  withCustomConfig cmdLineArgs cfg conwayConfigDir testLabel $ \interpreter mockServer dbSync -> do
+    startDBSync dbSync
+
+    -- Forge a payment transaction
+    tx0 <-
+      withConwayLedgerState interpreter $
+        Conway.mkPaymentTx (UTxOIndex 0) (UTxOIndex 1) 20_000 20_000 0
+
+    -- Forge a block with a transaction
+    void $ Api.withConwayFindLeaderAndSubmitTx interpreter mockServer $ \_ -> Right tx0
+    void $ Api.withConwayFindLeaderAndSubmitTx interpreter mockServer $ \state' -> do
+      utxo' <- maybeToEither CantFindUTxO (head $ Conway.mkUTxOConway tx0)
+      Conway.mkPaymentTx (UTxOPair utxo') (UTxOIndex 2) 10_000 500 0 state'
+
+    -- Wait for it to sync
+    assertBlockNoBackoff dbSync 2
+    assertTxCount dbSync 13
+
+    -- Should have consumed_by_tx
+    assertEqBackoff
+      dbSync
+      (Query.queryConsumedTxOutCount @'Db.TxOutCore)
+      2
+      []
+      "Unexpected consumed_by_tx count"
+  where
+    cmdLineArgs = initCommandLineArgs
+    cfg = Just (configConsume False)
+    testLabel = "conwayConsumeTxConsumed"

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

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

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

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