Merge pull request #3107 from IntersectMBO/use_enum_for_action_types

refactor: use enum for epoch state action type

Author: mkoura

cardano_node_tests/tests/tests_conway/test_committee.py

@@ -1317,10 +1317,12 @@ def _check_resign_dbsync(res_member: clusterlib.CCMember) -> None:
         # Check epoch state in dbsync
         reqc.db025_01.start(url=helpers.get_vcs_link())
         dbsync_utils.check_epoch_state(
-            epoch_no=enact_epoch, txid=action_add_txid, change_type="committee"
+            epoch_no=enact_epoch,
+            txid=action_add_txid,
+            action_type=dbsync_utils.ActionTypes.COMMITTEE,
         )
         dbsync_utils.check_epoch_state(
-            epoch_no=rem_epoch, txid=action_rem_txid, change_type="committee"
+            epoch_no=rem_epoch, txid=action_rem_txid, action_type=dbsync_utils.ActionTypes.COMMITTEE
         )
         reqc.db025_01.success()
 

cardano_node_tests/tests/tests_conway/test_constitution.py

@@ -589,9 +589,11 @@ def _check_cli_query():
             assert constitution_db[0].gov_action_type == "NewConstitution"
             reqc.db012.success()
 
-        # Check epoch state in dbsync
-        reqc.db025_02.start(url=helpers.get_vcs_link())
-        dbsync_utils.check_epoch_state(
-            epoch_no=cluster.g_query.get_epoch(), txid=action_txid, change_type="constitution"
-        )
-        reqc.db025_02.success()
+            # Check epoch state in dbsync
+            reqc.db025_02.start(url=helpers.get_vcs_link())
+            dbsync_utils.check_epoch_state(
+                epoch_no=cluster.g_query.get_epoch(),
+                txid=action_txid,
+                action_type=dbsync_utils.ActionTypes.CONSTITUTION,
+            )
+            reqc.db025_02.success()

cardano_node_tests/utils/dbsync_utils.py

@@ -1,5 +1,6 @@
 """Functionality for interacting with db-sync."""
 
+import enum
 import functools
 import itertools
 import logging
@@ -20,6 +21,11 @@
 NO_RESPONSE_STR = "No response returned from db-sync:"
 
 
+class ActionTypes(enum.StrEnum):
+    COMMITTEE = "committee"
+    CONSTITUTION = "constitution"
+
+
 def get_address_reward(
     address: str, epoch_from: int = 0, epoch_to: int = 99999999
 ) -> dbsync_types.RewardRecord:
@@ -1593,7 +1599,7 @@ def table_exists(table: str) -> bool:
     return table in table_names
 
 
-def check_epoch_state(epoch_no: int, txid: str, change_type: str = "") -> None:
+def check_epoch_state(epoch_no: int, txid: str, action_type: ActionTypes) -> None:
     """Check governance stats per epoch in dbsync."""
     if not configuration.HAS_DBSYNC:
         return
@@ -1604,20 +1610,22 @@ def check_epoch_state(epoch_no: int, txid: str, change_type: str = "") -> None:
         msg = f"No information about epoch state in dbsync for epoch: {epoch_no}"
         raise ValueError(msg)
 
-    if change_type == "committee":
+    if action_type == ActionTypes.COMMITTEE:
         dbsync_committee_info = list(dbsync_queries.query_new_committee_info(txhash=txid))[-1]
         es_committee_id = epoch_state_data[0].committee_id
         tx_committee_id = dbsync_committee_info.id
         assert es_committee_id == tx_committee_id, (
             f"Committee id mismatch between epoch_state {es_committee_id} "
             f"and committee table {tx_committee_id}."
         )
-
-    if change_type == "constitution":
+    elif action_type == ActionTypes.CONSTITUTION:
         dbsync_constitution_info = list(dbsync_queries.query_new_constitution(txhash=txid))[-1]
         es_constitution_id = epoch_state_data[0].constitution_id
         tx_constitution_id = dbsync_constitution_info.id
         assert es_constitution_id == tx_constitution_id, (
             f"Committee id mismatch between epoch_state {es_constitution_id} "
             f"and committee table {tx_constitution_id}."
         )
+    else:
+        msg = f"Unsupported action type for epoch state check: {action_type.value}"
+        raise ValueError(msg)