Merge pull request #2835 from IntersectMBO/common_get_payment_addr

feat: refactor get_payment_addr function

Author: mkoura

cardano_node_tests/tests/common.py

@@ -324,3 +324,40 @@ def get_conway_address_deposit(cluster_obj: clusterlib.ClusterLib) -> int:
         stake_deposit_amt = cluster_obj.g_query.get_address_deposit()
 
     return stake_deposit_amt
+
+
+def get_payment_addr(
+    name_template: str,
+    cluster_manager: cluster_management.ClusterManager,
+    cluster_obj: clusterlib.ClusterLib,
+    caching_key: str = "",
+    amount: int | None = None,
+) -> clusterlib.AddressRecord:
+    """Create new payment address."""
+
+    def _create_addr() -> clusterlib.AddressRecord:
+        addr = clusterlib_utils.create_payment_addr_records(
+            f"{name_template}_fund_addr",
+            cluster_obj=cluster_obj,
+        )[0]
+        return addr
+
+    if caching_key:
+        with cluster_manager.cache_fixture(key=caching_key) as fixture_cache:
+            if fixture_cache.value:
+                return fixture_cache.value  # type: ignore
+
+            addr = _create_addr()
+            fixture_cache.value = addr
+    else:
+        addr = _create_addr()
+
+    # Fund source address
+    clusterlib_utils.fund_from_faucet(
+        addr,
+        cluster_obj=cluster_obj,
+        all_faucets=cluster_manager.cache.addrs_data,
+        amount=amount,
+    )
+
+    return addr

cardano_node_tests/tests/test_chain_transactions.py

@@ -10,7 +10,6 @@
 
 from cardano_node_tests.cluster_management import cluster_management
 from cardano_node_tests.tests import common
-from cardano_node_tests.utils import clusterlib_utils
 from cardano_node_tests.utils import configuration
 from cardano_node_tests.utils import dbsync_utils
 from cardano_node_tests.utils import helpers
@@ -19,29 +18,6 @@
 LOGGER = logging.getLogger(__name__)
 
 
-def get_payment_addr(
-    cluster_manager: cluster_management.ClusterManager,
-    cluster_obj: clusterlib.ClusterLib,
-) -> clusterlib.AddressRecord:
-    """Create new payment address."""
-    amount = 205_000_000
-
-    addr = clusterlib_utils.create_payment_addr_records(
-        f"chain_tx_addr_{clusterlib.get_rand_str(4)}_ci{cluster_manager.cluster_instance_num}",
-        cluster_obj=cluster_obj,
-    )[0]
-
-    # Fund source address
-    clusterlib_utils.fund_from_faucet(
-        addr,
-        cluster_obj=cluster_obj,
-        all_faucets=cluster_manager.cache.addrs_data,
-        amount=amount,
-    )
-
-    return addr
-
-
 def _gen_signed_tx(
     cluster_obj: clusterlib.ClusterLib,
     payment_addr: clusterlib.AddressRecord,
@@ -151,7 +127,12 @@ def test_tx_chaining(
             next_try = False
             tx_raw_outputs.clear()
 
-            payment_addr = get_payment_addr(cluster_manager=cluster_manager, cluster_obj=cluster)
+            payment_addr = common.get_payment_addr(
+                name_template=temp_template,
+                cluster_manager=cluster_manager,
+                cluster_obj=cluster,
+                amount=205_000_000,
+            )
             init_utxo = cluster.g_query.get_utxo(address=payment_addr.address)[0]
             assert (
                 init_utxo.amount - (fee * iterations) >= min_utxo_value

cardano_node_tests/tests/test_governance.py

@@ -47,21 +47,12 @@ def payment_addr(
         cluster: clusterlib.ClusterLib,
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
-        amount = 200_000_000
-
-        addr = clusterlib_utils.create_payment_addr_records(
-            f"chain_tx_addr_ci{cluster_manager.cluster_instance_num}",
-            cluster_obj=cluster,
-        )[0]
-
-        # Fund source address
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
-            amount=amount,
+            amount=200_000_000,
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())

cardano_node_tests/tests/test_tx_metadata.py

@@ -37,23 +37,12 @@ def payment_addr(
         cluster: clusterlib.ClusterLib,
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
-        with cluster_manager.cache_fixture() as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = clusterlib_utils.create_payment_addr_records(
-                f"addr_test_metadata_ci{cluster_manager.cluster_instance_num}_0",
-                cluster_obj=cluster,
-            )[0]
-            fixture_cache.value = addr
-
-        # Fund source addresses
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
+            caching_key=helpers.get_current_line_str(),
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())

cardano_node_tests/tests/test_update_proposals.py

@@ -49,24 +49,12 @@ def payment_addr(
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
         cluster = cluster_update_proposal
-
-        with cluster_manager.cache_fixture() as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = clusterlib_utils.create_payment_addr_records(
-                f"addr_test_update_proposal_ci{cluster_manager.cluster_instance_num}_0",
-                cluster_obj=cluster,
-            )[0]
-            fixture_cache.value = addr
-
-        # Fund source addresses
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
+            caching_key=helpers.get_current_line_str(),
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())
@@ -376,23 +364,12 @@ def payment_addr(
         cluster: clusterlib.ClusterLib,
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
-        with cluster_manager.cache_fixture() as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = clusterlib_utils.create_payment_addr_records(
-                f"addr_test_neg_update_proposal_ci{cluster_manager.cluster_instance_num}_0",
-                cluster_obj=cluster,
-            )[0]
-            fixture_cache.value = addr
-
-        # Fund source addresses
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
+            caching_key=helpers.get_current_line_str(),
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())

cardano_node_tests/tests/tests_conway/test_drep.py

@@ -58,43 +58,6 @@ class DRepRatRecord:
     ratified: bool
 
 
-def get_payment_addr(
-    name_template: str,
-    cluster_manager: cluster_management.ClusterManager,
-    cluster_obj: clusterlib.ClusterLib,
-    caching_key: str = "",
-    amount: int | None = None,
-) -> clusterlib.AddressRecord:
-    """Create new payment address."""
-
-    def _create_addr() -> clusterlib.AddressRecord:
-        addr = clusterlib_utils.create_payment_addr_records(
-            f"{name_template}_fund_addr",
-            cluster_obj=cluster_obj,
-        )[0]
-        return addr
-
-    if caching_key:
-        with cluster_manager.cache_fixture(key=caching_key) as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = _create_addr()
-            fixture_cache.value = addr
-    else:
-        addr = _create_addr()
-
-    # Fund source address
-    clusterlib_utils.fund_from_faucet(
-        addr,
-        cluster_obj=cluster_obj,
-        all_faucets=cluster_manager.cache.addrs_data,
-        amount=amount,
-    )
-
-    return addr
-
-
 def get_pool_user(
     name_template: str,
     cluster_manager: cluster_management.ClusterManager,
@@ -208,7 +171,7 @@ def payment_addr(
         key = ""
 
     test_id = common.get_test_id(cluster)
-    return get_payment_addr(
+    return common.get_payment_addr(
         name_template=test_id,
         cluster_manager=cluster_manager,
         cluster_obj=cluster,
@@ -254,7 +217,7 @@ def payment_addr_wpr(
     cluster, __ = cluster_and_pool_and_rewards
     test_id = common.get_test_id(cluster)
     key = helpers.get_current_line_str()
-    return get_payment_addr(
+    return common.get_payment_addr(
         name_template=test_id, cluster_manager=cluster_manager, cluster_obj=cluster, caching_key=key
     )
 
@@ -297,7 +260,7 @@ def payment_addr_rewards(
 ) -> clusterlib.AddressRecord:
     test_id = common.get_test_id(cluster_rewards)
     key = helpers.get_current_line_str()
-    return get_payment_addr(
+    return common.get_payment_addr(
         name_template=test_id,
         cluster_manager=cluster_manager,
         cluster_obj=cluster_rewards,
@@ -997,7 +960,7 @@ def test_drep_no_multiple_registration(
         )
         drep_metadata_url = web.publish(file_path=drep_metadata_file)
 
-        payment_addr = get_payment_addr(
+        payment_addr = common.get_payment_addr(
             name_template=temp_template,
             cluster_manager=cluster_manager,
             cluster_obj=cluster,

cardano_node_tests/tests/tests_conway/test_guardrails.py

@@ -85,19 +85,12 @@ def payment_addr(
 ) -> clusterlib.AddressRecord:
     """Create new payment address."""
     cluster, __ = cluster_guardrails
-    addr = clusterlib_utils.create_payment_addr_records(
-        f"payment_addr_{cluster_manager.cluster_instance_num}",
-        cluster_obj=cluster,
-    )[0]
-
-    # Fund source address
-    clusterlib_utils.fund_from_faucet(
-        addr,
+    addr = common.get_payment_addr(
+        name_template=common.get_test_id(cluster),
+        cluster_manager=cluster_manager,
         cluster_obj=cluster,
-        all_faucets=cluster_manager.cache.addrs_data,
         amount=10_000_000_000,
     )
-
     return addr
 
 

cardano_node_tests/tests/tests_conway/test_pparam_update.py

@@ -1388,23 +1388,12 @@ def payment_addr(
         cluster: clusterlib.ClusterLib,
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
-        with cluster_manager.cache_fixture() as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = clusterlib_utils.create_payment_addr_records(
-                f"addr_test_conway_update_proposal_ci{cluster_manager.cluster_instance_num}_0",
-                cluster_obj=cluster,
-            )[0]
-            fixture_cache.value = addr
-
-        # Fund source addresses
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
+            caching_key=helpers.get_current_line_str(),
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())

cardano_node_tests/tests/tests_conway/test_treasury_withdrawals.py

@@ -726,25 +726,13 @@ def payment_addr(
         cluster: clusterlib.ClusterLib,
     ) -> clusterlib.AddressRecord:
         """Create new payment address."""
-        test_id = common.get_test_id(cluster)
-        with cluster_manager.cache_fixture() as fixture_cache:
-            if fixture_cache.value:
-                return fixture_cache.value  # type: ignore
-
-            addr = clusterlib_utils.create_payment_addr_records(
-                f"{test_id}_payment_addr_0",
-                cluster_obj=cluster,
-            )[0]
-            fixture_cache.value = addr
-
-        # Fund source addresses
-        clusterlib_utils.fund_from_faucet(
-            addr,
+        addr = common.get_payment_addr(
+            name_template=common.get_test_id(cluster),
+            cluster_manager=cluster_manager,
             cluster_obj=cluster,
-            all_faucets=cluster_manager.cache.addrs_data,
+            caching_key=helpers.get_current_line_str(),
             amount=4_000_000,
         )
-
         return addr
 
     @allure.link(helpers.get_vcs_link())