feat: add get_pool_users and get_pool_user functions

- Added `get_pool_users` function to create and fund multiple pool users.
- Added `get_pool_user` function to create and fund a single pool user.
- Updated tests to use the new `get_pool_users` and `get_pool_user` functions.
- Removed redundant code for creating and funding pool users in tests.
- Improved consistency and reusability of pool user creation and funding.

Author: mkoura

cardano_node_tests/tests/common.py

@@ -357,7 +357,7 @@ def _create_addrs() -> list[clusterlib.AddressRecord]:
     else:
         addrs = _create_addrs()
 
-    # Fund source address
+    # Fund source addresses
     fund_addresses = addrs if fund_idx is None else [addrs[i] for i in fund_idx]
     if fund_addresses:
         clusterlib_utils.fund_from_faucet(
@@ -386,3 +386,66 @@ def get_payment_addr(
         caching_key=caching_key,
         amount=amount,
     )[0]
+
+
+def get_pool_users(
+    name_template: str,
+    cluster_manager: cluster_management.ClusterManager,
+    cluster_obj: clusterlib.ClusterLib,
+    num: int,
+    fund_idx: list[int] | None = None,
+    caching_key: str = "",
+    amount: int | None = None,
+) -> list[clusterlib.PoolUser]:
+    """Create new pool users."""
+    if num < 1:
+        err = f"Number of pool users must be at least 1, got: {num}"
+        raise ValueError(err)
+
+    def _create_pool_users() -> list[clusterlib.PoolUser]:
+        users = clusterlib_utils.create_pool_users(
+            cluster_obj=cluster_obj,
+            name_template=f"{name_template}_pool_user",
+            no_of_addr=num,
+        )
+        return users
+
+    if caching_key:
+        with cluster_manager.cache_fixture() as fixture_cache:
+            if fixture_cache.value:
+                return fixture_cache.value  # type: ignore
+
+            users = _create_pool_users()
+            fixture_cache.value = users
+    else:
+        users = _create_pool_users()
+
+    # Fund source addresses
+    fund_users = users if fund_idx is None else [users[i] for i in fund_idx]
+    if fund_users:
+        clusterlib_utils.fund_from_faucet(
+            *fund_users,
+            cluster_obj=cluster_obj,
+            all_faucets=cluster_manager.cache.addrs_data,
+            amount=amount,
+        )
+
+    return users
+
+
+def get_pool_user(
+    name_template: str,
+    cluster_manager: cluster_management.ClusterManager,
+    cluster_obj: clusterlib.ClusterLib,
+    caching_key: str = "",
+    amount: int | None = None,
+) -> clusterlib.PoolUser:
+    """Create a single new pool user."""
+    return get_pool_users(
+        name_template=name_template,
+        cluster_manager=cluster_manager,
+        cluster_obj=cluster_obj,
+        num=1,
+        caching_key=caching_key,
+        amount=amount,
+    )[0]

cardano_node_tests/tests/test_addr_registration.py

@@ -26,24 +26,14 @@ def pool_users(
     cluster: clusterlib.ClusterLib,
 ) -> list[clusterlib.PoolUser]:
     """Create pool users."""
-    with cluster_manager.cache_fixture() as fixture_cache:
-        if fixture_cache.value:
-            return fixture_cache.value  # type: ignore
-
-        created_users = clusterlib_utils.create_pool_users(
-            cluster_obj=cluster,
-            name_template=f"test_delegation_pool_user_ci{cluster_manager.cluster_instance_num}",
-            no_of_addr=2,
-        )
-        fixture_cache.value = created_users
-
-    # Fund source addresses
-    clusterlib_utils.fund_from_faucet(
-        created_users[0],
+    created_users = common.get_pool_users(
+        name_template=common.get_test_id(cluster),
+        cluster_manager=cluster_manager,
         cluster_obj=cluster,
-        all_faucets=cluster_manager.cache.addrs_data,
+        num=2,
+        fund_idx=[0],
+        caching_key=helpers.get_current_line_str(),
     )
-
     return created_users
 
 

cardano_node_tests/tests/test_delegation.py

@@ -65,24 +65,14 @@ def pool_users(
     cluster: clusterlib.ClusterLib,
 ) -> list[clusterlib.PoolUser]:
     """Create pool users."""
-    with cluster_manager.cache_fixture() as fixture_cache:
-        if fixture_cache.value:
-            return fixture_cache.value  # type: ignore
-
-        created_users = clusterlib_utils.create_pool_users(
-            cluster_obj=cluster,
-            name_template=f"test_delegation_pool_user_ci{cluster_manager.cluster_instance_num}",
-            no_of_addr=2,
-        )
-        fixture_cache.value = created_users
-
-    # Fund source addresses
-    clusterlib_utils.fund_from_faucet(
-        created_users[0],
+    created_users = common.get_pool_users(
+        name_template=common.get_test_id(cluster),
+        cluster_manager=cluster_manager,
         cluster_obj=cluster,
-        all_faucets=cluster_manager.cache.addrs_data,
+        num=2,
+        fund_idx=[0],
+        caching_key=helpers.get_current_line_str(),
     )
-
     return created_users
 
 
@@ -94,7 +84,7 @@ def pool_users_disposable(
     test_id = common.get_test_id(cluster)
     pool_users = clusterlib_utils.create_pool_users(
         cluster_obj=cluster,
-        name_template=f"{test_id}_pool_user",
+        name_template=f"{test_id}_disposable",
         no_of_addr=2,
     )
     return pool_users
@@ -112,24 +102,14 @@ def pool_users_cluster_and_pool(
        The pool can be different every time the fixture is called.
     """
     cluster, *__ = cluster_and_pool
-    with cluster_manager.cache_fixture() as fixture_cache:
-        if fixture_cache.value:
-            return fixture_cache.value  # type: ignore
-
-        created_users = clusterlib_utils.create_pool_users(
-            cluster_obj=cluster,
-            name_template=f"test_delegation_pool_user_cap_ci{cluster_manager.cluster_instance_num}",
-            no_of_addr=2,
-        )
-        fixture_cache.value = created_users
-
-    # Fund source addresses
-    clusterlib_utils.fund_from_faucet(
-        created_users[0],
+    created_users = common.get_pool_users(
+        name_template=common.get_test_id(cluster),
+        cluster_manager=cluster_manager,
         cluster_obj=cluster,
-        all_faucets=cluster_manager.cache.addrs_data,
+        num=2,
+        fund_idx=[0],
+        caching_key=helpers.get_current_line_str(),
     )
-
     return created_users
 
 
@@ -142,7 +122,7 @@ def pool_users_disposable_cluster_and_pool(
     test_id = common.get_test_id(cluster)
     pool_users = clusterlib_utils.create_pool_users(
         cluster_obj=cluster,
-        name_template=f"{test_id}_pool_user_cap",
+        name_template=f"{test_id}_disposable_cap",
         no_of_addr=2,
     )
     return pool_users

cardano_node_tests/tests/test_mir_certs.py

@@ -62,24 +62,14 @@ def pool_users(
     cluster_pots: clusterlib.ClusterLib,
 ) -> list[clusterlib.PoolUser]:
     """Create pool user."""
-    with cluster_manager.cache_fixture() as fixture_cache:
-        if fixture_cache.value:
-            return fixture_cache.value  # type: ignore
-
-        created_users = clusterlib_utils.create_pool_users(
-            cluster_obj=cluster_pots,
-            name_template=f"test_mir_certs_ci{cluster_manager.cluster_instance_num}",
-            no_of_addr=5,
-        )
-        fixture_cache.value = created_users
-
-    # Fund source addresses
-    clusterlib_utils.fund_from_faucet(
-        *created_users,
-        cluster_obj=cluster_pots,
-        all_faucets=cluster_manager.cache.addrs_data,
+    cluster = cluster_pots
+    created_users = common.get_pool_users(
+        name_template=common.get_test_id(cluster),
+        cluster_manager=cluster_manager,
+        cluster_obj=cluster,
+        num=5,
+        caching_key=helpers.get_current_line_str(),
     )
-
     return created_users