test(db-sync config): Add db-sync test for governance option

Author: ArturWieczorek

cardano_node_tests/tests/test_dbsync_config.py

@@ -13,6 +13,7 @@
 from cardano_node_tests.tests import common
 from cardano_node_tests.utils import cluster_nodes
 from cardano_node_tests.utils import configuration
+from cardano_node_tests.utils import dbsync_queries
 from cardano_node_tests.utils import dbsync_service_manager as db_sync
 from cardano_node_tests.utils import dbsync_utils
 from cardano_node_tests.utils import helpers
@@ -143,7 +144,6 @@ def basic_tx_out(
             """Test `tx_out` option."""
             db_config = db_sync_manager.get_config_builder()
 
-            # Test tx_out : enable
             db_sync_manager.restart_with_config(
                 custom_config=db_config.with_tx_out(
                     value=db_sync.TxOutMode.ENABLE, force_tx_in=False, use_address_table=False
@@ -158,7 +158,6 @@ def basic_tx_out(
                 }
             )
 
-            # Test tx_out : disable
             db_sync_manager.restart_with_config(
                 custom_config=db_config.with_tx_out(
                     value=db_sync.TxOutMode.DISABLE, force_tx_in=True, use_address_table=True
@@ -177,6 +176,106 @@ def basic_tx_out(
 
         yield basic_tx_out
 
+        def governance(
+            db_sync_manager: db_sync.DBSyncManager,
+        ):
+            """Test `governance` option."""
+            db_config = db_sync_manager.get_config_builder()
+
+            db_sync_manager.restart_with_config(
+                custom_config=db_config.with_governance(value=db_sync.SettingState.ENABLE)
+            )
+
+            # Off-chain data is inserted into the DB a few minutes after the restart of db-sync
+            def _query_func():
+                tables_to_check = [
+                    db_sync.Table.COMMITTEE_DE_REGISTRATION,
+                    db_sync.Table.COMMITTEE_MEMBER,
+                    db_sync.Table.COMMITTEE_REGISTRATION,
+                    db_sync.Table.COMMITTEE,
+                    db_sync.Table.CONSTITUTION,
+                    db_sync.Table.DELEGATION_VOTE,
+                    db_sync.Table.DREP_DISTR,
+                    db_sync.Table.DREP_REGISTRATION,
+                    db_sync.Table.EPOCH_STATE,
+                    db_sync.Table.GOV_ACTION_PROPOSAL,
+                    db_sync.Table.OFF_CHAIN_VOTE_DATA,
+                    db_sync.Table.OFF_CHAIN_VOTE_DREP_DATA,
+                    db_sync.Table.OFF_CHAIN_VOTE_EXTERNAL_UPDATE,
+                    db_sync.Table.OFF_CHAIN_VOTE_FETCH_ERROR,
+                    db_sync.Table.OFF_CHAIN_VOTE_GOV_ACTION_DATA,
+                    db_sync.Table.OFF_CHAIN_VOTE_REFERENCE,
+                    db_sync.Table.VOTING_ANCHOR,
+                    db_sync.Table.VOTING_PROCEDURE,
+                    db_sync.Table.TREASURY_WITHDRAWAL,
+                ]
+
+                empty_tables = [
+                    table for table in tables_to_check
+                    if dbsync_utils.table_empty(table)
+                ]
+
+                if empty_tables:
+                    msg = f"Following tables are still empty: {empty_tables}"
+                    raise dbsync_utils.DbSyncNoResponseError(msg)
+
+                return True
+
+            dbsync_utils.retry_query(query_func=_query_func, timeout=600)
+
+            check_dbsync_state(
+                expected_state={
+                    db_sync.Table.COMMITTEE_DE_REGISTRATION: TableCondition.NOT_EMPTY,
+                    db_sync.Table.COMMITTEE_MEMBER: TableCondition.NOT_EMPTY,
+                    db_sync.Table.COMMITTEE_REGISTRATION: TableCondition.NOT_EMPTY,
+                    db_sync.Table.COMMITTEE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.CONSTITUTION: TableCondition.NOT_EMPTY,
+                    db_sync.Table.DELEGATION_VOTE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.DREP_DISTR: TableCondition.NOT_EMPTY,
+                    db_sync.Table.DREP_REGISTRATION: TableCondition.NOT_EMPTY,
+                    db_sync.Table.EPOCH_STATE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.GOV_ACTION_PROPOSAL: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_DATA: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_DREP_DATA: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_EXTERNAL_UPDATE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_FETCH_ERROR: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_GOV_ACTION_DATA: TableCondition.NOT_EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_REFERENCE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.VOTING_ANCHOR: TableCondition.NOT_EMPTY,
+                    db_sync.Table.VOTING_PROCEDURE: TableCondition.NOT_EMPTY,
+                    db_sync.Table.TREASURY_WITHDRAWAL: TableCondition.NOT_EMPTY,
+                }
+            )
+
+            db_sync_manager.restart_with_config(
+                custom_config=db_config.with_governance(value=db_sync.SettingState.DISABLE)
+            )
+            check_dbsync_state(
+                expected_state={
+                    db_sync.Table.COMMITTEE_DE_REGISTRATION: TableCondition.EMPTY,
+                    db_sync.Table.COMMITTEE_MEMBER: TableCondition.EMPTY,
+                    db_sync.Table.COMMITTEE_REGISTRATION: TableCondition.EMPTY,
+                    db_sync.Table.COMMITTEE: TableCondition.EMPTY,
+                    db_sync.Table.CONSTITUTION: TableCondition.EMPTY,
+                    db_sync.Table.DELEGATION_VOTE: TableCondition.EMPTY,
+                    db_sync.Table.DREP_DISTR: TableCondition.EMPTY,
+                    db_sync.Table.DREP_REGISTRATION: TableCondition.EMPTY,
+                    db_sync.Table.EPOCH_STATE: TableCondition.EMPTY,
+                    db_sync.Table.GOV_ACTION_PROPOSAL: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_DATA: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_DREP_DATA: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_EXTERNAL_UPDATE: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_FETCH_ERROR: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_GOV_ACTION_DATA: TableCondition.EMPTY,
+                    db_sync.Table.OFF_CHAIN_VOTE_REFERENCE: TableCondition.EMPTY,
+                    db_sync.Table.VOTING_ANCHOR: TableCondition.EMPTY,
+                    db_sync.Table.VOTING_PROCEDURE: TableCondition.EMPTY,
+                    db_sync.Table.TREASURY_WITHDRAWAL: TableCondition.EMPTY,
+                }
+            )
+
+        yield governance
+
         def tx_cbor_value_enable(
             db_sync_manager: db_sync.DBSyncManager,
         ):

cardano_node_tests/tests/tests_conway/test_committee.py

@@ -550,6 +550,7 @@ def test_update_committee_action(
     @allure.link(helpers.get_vcs_link())
     @pytest.mark.long
     @pytest.mark.dbsync
+    @pytest.mark.dbsync_config
     def test_add_rm_committee_members(  # noqa: C901
         self,
         cluster_lock_governance: governance_utils.GovClusterT,

cardano_node_tests/tests/tests_conway/test_drep.py

@@ -318,6 +318,7 @@ def test_drep_id_is_blake2b_224_of_drep_vkey(
     @submit_utils.PARAM_SUBMIT_METHOD
     @common.PARAM_USE_BUILD_CMD
     @pytest.mark.dbsync
+    @pytest.mark.dbsync_config
     @pytest.mark.testnets
     @pytest.mark.smoke
     @pytest.mark.parametrize(

cardano_node_tests/tests/tests_conway/test_info.py

@@ -22,10 +22,13 @@
 LOGGER = logging.getLogger(__name__)
 DATA_DIR = pl.Path(__file__).parent.parent / "data"
 
-pytestmark = pytest.mark.skipif(
-    VERSIONS.transaction_era < VERSIONS.CONWAY,
-    reason="runs only with Tx era >= Conway",
-)
+pytestmark = [
+    pytest.mark.skipif(
+        VERSIONS.transaction_era < VERSIONS.CONWAY,
+        reason="runs only with Tx era >= Conway",
+    ),
+    pytest.mark.dbsync_config,
+]
 
 
 @pytest.fixture

cardano_node_tests/tests/tests_conway/test_treasury_withdrawals.py

@@ -93,6 +93,7 @@ class TestTreasuryWithdrawals:
 
     @allure.link(helpers.get_vcs_link())
     @pytest.mark.dbsync
+    @pytest.mark.dbsync_config
     @pytest.mark.long
     @pytest.mark.upgrade_step3
     def test_enact_treasury_withdrawals(

cardano_node_tests/utils/dbsync_queries.py

@@ -602,7 +602,7 @@ class DrepDistributionDBRow:
 class EpochStateDBRow:
     id: int
     committee_id: int
-    no_confidence_id: tp.Optional[int]
+    no_confidence_id: int | None
     constitution_id: int
     epoch_no: int
 
@@ -1465,7 +1465,9 @@ def query_treasury_withdrawal(txhash: str) -> tp.Generator[TreasuryWithdrawalDBR
             yield TreasuryWithdrawalDBRow(*result)
 
 
-def query_off_chain_vote_data(data_hash: str) -> tp.Generator[OffChainVoteDataDBRow, None, None]:
+def query_off_chain_vote_data(
+    data_hash: str | None = None,
+) -> tp.Generator[OffChainVoteDataDBRow, None, None]:
     """Query the off chain vote data in db-sync."""
     query = (
         "SELECT"
@@ -1482,11 +1484,16 @@ def query_off_chain_vote_data(data_hash: str) -> tp.Generator[OffChainVoteDataDB
         "LEFT JOIN off_chain_vote_gov_action_data gov ON data.id = gov.off_chain_vote_data_id "
         "LEFT JOIN off_chain_vote_reference ref ON data.id = ref.off_chain_vote_data_id "
         "LEFT JOIN voting_anchor va ON data.voting_anchor_id = va.id "
-        "WHERE data.hash = %s "
-        "ORDER BY va.id, ref.id, auth.id, updt.id;"
     )
 
-    with execute(query=query, vars=(rf"\x{data_hash}",)) as cur:
+    query_params: tuple[str, ...] = ()
+    if data_hash is not None:
+        query += "WHERE data.hash = %s "
+        query_params = (rf"\x{data_hash}",)
+
+    query += "ORDER BY va.id, ref.id, auth.id, updt.id;"
+
+    with execute(query=query, vars=query_params) as cur:
         while (result := cur.fetchone()) is not None:
             yield OffChainVoteDataDBRow(*result)
 

cardano_node_tests/utils/dbsync_service_manager.py

@@ -358,14 +358,12 @@ def recreate_database(self) -> None:
         This is a DESTRUCTIVE operation!
         It will delete existing data and recreate the database from scratch.
         """
-        scripts_dir = cluster_scripts.get_testnet_variant_scriptdir(
-            testnet_variant=configuration.TESTNET_VARIANT
-        )
-        if not scripts_dir:
-            err = f"Testnet variant '{configuration.TESTNET_VARIANT}' scripts directory not found."
+        common_scripts_dir = cluster_scripts.COMMON_DIR
+        if not common_scripts_dir:
+            err = f"Common scripts directory '{common_scripts_dir}' not found."
             raise RuntimeError(err)
 
-        db_script_template = scripts_dir / "postgres-setup.sh"
+        db_script_template = common_scripts_dir / "postgres-setup.sh"
         if not db_script_template.exists() and configuration.BOOTSTRAP_DIR:
             db_script_template = pl.Path(configuration.BOOTSTRAP_DIR) / "postgres-setup.sh"
 

cardano_node_tests/utils/logfiles.py

@@ -47,6 +47,8 @@
     "OffChainPoolFetchError",
     # DB-Sync table name
     "OffChainVoteFetchError",
+    # DB-Sync table name (lowercase)
+    "off_chain_vote_fetch_error",
     # TODO: p2p failures on testnet
     "PeerStatusChangeFailure",
     # TODO: p2p failures on testnet - PeerMonitoringError