Merge pull request #3114 from IntersectMBO/build_method_in_test_addr_reg

refactor(tests): Refactor tests to replace `PARAM_USE_BUILD_CMD` with `PARAM_BUILD_METHOD`

Author: mkoura

cardano_node_tests/tests/common.py

@@ -39,6 +39,11 @@
     ),
 )
 
+SKIPIF_BUILD_EST_1199 = pytest.mark.skipif(
+    issues.cli_1199.is_blocked(),
+    reason="`build-estimate` fails to balance tx with no txouts",
+)
+
 SKIPIF_MISMATCHED_ERAS = pytest.mark.skipif(
     VERSIONS.transaction_era != VERSIONS.cluster_era,
     reason="transaction era must be the same as node era",
@@ -101,6 +106,21 @@
     ),
 )
 
+PARAM_BUILD_METHOD_NO_EST = pytest.mark.parametrize(
+    "build_method",
+    (
+        clusterlib_utils.BuildMethods.BUILD_RAW,
+        pytest.param(
+            clusterlib_utils.BuildMethods.BUILD,
+            marks=SKIPIF_BUILD_UNUSABLE,
+        ),
+        pytest.param(
+            clusterlib_utils.BuildMethods.BUILD_EST,
+            marks=SKIPIF_BUILD_EST_1199,
+        ),
+    ),
+)
+
 PARAM_OFFLINE_BUILD_METHOD = pytest.mark.parametrize(
     "offline_build_method",
     (

cardano_node_tests/tests/test_addr_registration.py

@@ -55,7 +55,7 @@ class TestRegisterAddr:
     """Tests for stake address registration and deregistration."""
 
     @allure.link(helpers.get_vcs_link())
-    @common.PARAM_USE_BUILD_CMD
+    @common.PARAM_BUILD_METHOD_NO_EST
     @pytest.mark.smoke
     @pytest.mark.testnets
     @pytest.mark.dbsync
@@ -64,7 +64,7 @@ def test_deregister_registered(
         cluster: clusterlib.ClusterLib,
         pool_users: list[clusterlib.PoolUser],
         pool_users_disposable: list[clusterlib.PoolUser],
-        use_build_cmd: bool,
+        build_method: str,
     ):
         """Deregister a registered stake address.
 
@@ -96,26 +96,14 @@ def test_deregister_registered(
             signing_key_files=[user_payment.skey_file, user_registered.stake.skey_file],
         )
 
-        if use_build_cmd:
-            tx_raw_output_reg = cluster.g_transaction.build_tx(
-                src_address=user_payment.address,
-                tx_name=f"{temp_template}_reg",
-                tx_files=tx_files_reg,
-                fee_buffer=2_000_000,
-                witness_override=len(tx_files_reg.signing_key_files),
-            )
-            tx_signed = cluster.g_transaction.sign_tx(
-                tx_body_file=tx_raw_output_reg.out_file,
-                signing_key_files=tx_files_reg.signing_key_files,
-                tx_name=f"{temp_template}_reg",
-            )
-            cluster.g_transaction.submit_tx(tx_file=tx_signed, txins=tx_raw_output_reg.txins)
-        else:
-            tx_raw_output_reg = cluster.g_transaction.send_tx(
-                src_address=user_payment.address,
-                tx_name=f"{temp_template}_reg",
-                tx_files=tx_files_reg,
-            )
+        tx_output_reg = clusterlib_utils.build_and_submit_tx(
+            cluster_obj=cluster,
+            name_template=f"{temp_template}_reg",
+            src_address=user_payment.address,
+            tx_files=tx_files_reg,
+            build_method=build_method,
+            witness_override=len(tx_files_reg.signing_key_files),
+        )
 
         assert cluster.g_query.get_stake_addr_info(user_registered.stake.address).address, (
             f"Stake address is NOT registered: {user_registered.stake.address}"
@@ -134,35 +122,19 @@ def test_deregister_registered(
             signing_key_files=[user_payment.skey_file, user_registered.stake.skey_file],
         )
 
-        if use_build_cmd:
-
-            def _build_dereg() -> clusterlib.TxRawOutput:
-                return cluster.g_transaction.build_tx(
-                    src_address=user_payment.address,
-                    tx_name=f"{temp_template}_dereg",
-                    tx_files=tx_files_dereg,
-                    fee_buffer=2_000_000,
-                    witness_override=len(tx_files_dereg.signing_key_files),
-                )
-
-            tx_raw_output_dereg: clusterlib.TxRawOutput = common.match_blocker(func=_build_dereg)
-            tx_signed = cluster.g_transaction.sign_tx(
-                tx_body_file=tx_raw_output_dereg.out_file,
-                signing_key_files=tx_files_dereg.signing_key_files,
-                tx_name=f"{temp_template}_dereg",
-            )
-            try:
-                cluster.g_transaction.submit_tx(tx_file=tx_signed, txins=tx_raw_output_dereg.txins)
-            except clusterlib.CLIError as exc:
-                if "ValueNotConservedUTxO" in str(exc):
-                    issues.cli_942.finish_test()
-                raise
-        else:
-            tx_raw_output_dereg = cluster.g_transaction.send_tx(
+        try:
+            tx_output_dereg = clusterlib_utils.build_and_submit_tx(
+                cluster_obj=cluster,
+                name_template=f"{temp_template}_dereg",
                 src_address=user_payment.address,
-                tx_name=f"{temp_template}_dereg",
                 tx_files=tx_files_dereg,
+                build_method=build_method,
+                witness_override=len(tx_files_dereg.signing_key_files),
             )
+        except clusterlib.CLIError as exc:
+            if "ValueNotConservedUTxO" in str(exc):
+                issues.cli_942.finish_test()
+            raise
 
         assert not cluster.g_query.get_stake_addr_info(user_registered.stake.address).address, (
             f"Stake address is registered: {user_registered.stake.address}"
@@ -171,24 +143,22 @@ def _build_dereg() -> clusterlib.TxRawOutput:
         # Check that the balance for source address was correctly updated
         assert (
             cluster.g_query.get_address_balance(user_payment.address)
-            == src_init_balance - tx_raw_output_reg.fee - tx_raw_output_dereg.fee
+            == src_init_balance - tx_output_reg.fee - tx_output_dereg.fee
         ), f"Incorrect balance for source address `{user_payment.address}`"
 
         # Check records in db-sync
-        tx_db_record_reg = dbsync_utils.check_tx(
-            cluster_obj=cluster, tx_raw_output=tx_raw_output_reg
-        )
+        tx_db_record_reg = dbsync_utils.check_tx(cluster_obj=cluster, tx_raw_output=tx_output_reg)
         if tx_db_record_reg:
             assert user_registered.stake.address in tx_db_record_reg.stake_registration
 
         tx_db_record_dereg = dbsync_utils.check_tx(
-            cluster_obj=cluster, tx_raw_output=tx_raw_output_dereg
+            cluster_obj=cluster, tx_raw_output=tx_output_dereg
         )
         if tx_db_record_dereg:
             assert user_registered.stake.address in tx_db_record_dereg.stake_deregistration
 
     @allure.link(helpers.get_vcs_link())
-    @common.PARAM_USE_BUILD_CMD
+    @common.PARAM_BUILD_METHOD_NO_EST
     @pytest.mark.smoke
     @pytest.mark.testnets
     @pytest.mark.dbsync
@@ -197,7 +167,7 @@ def test_addr_registration_deregistration(
         cluster: clusterlib.ClusterLib,
         pool_users: list[clusterlib.PoolUser],
         pool_users_disposable: list[clusterlib.PoolUser],
-        use_build_cmd: bool,
+        build_method: str,
     ):
         """Submit registration and deregistration certificates in single TX.
 
@@ -240,28 +210,15 @@ def test_addr_registration_deregistration(
             signing_key_files=[user_payment.skey_file, user_registered.stake.skey_file],
         )
 
-        if use_build_cmd:
-            tx_raw_output = cluster.g_transaction.build_tx(
-                src_address=user_payment.address,
-                tx_name=f"{temp_template}_reg_dereg",
-                tx_files=tx_files,
-                fee_buffer=2_000_000,
-                deposit=0,
-                witness_override=len(tx_files.signing_key_files),
-            )
-            tx_signed = cluster.g_transaction.sign_tx(
-                tx_body_file=tx_raw_output.out_file,
-                signing_key_files=tx_files.signing_key_files,
-                tx_name=f"{temp_template}_reg_dereg",
-            )
-            cluster.g_transaction.submit_tx(tx_file=tx_signed, txins=tx_raw_output.txins)
-        else:
-            tx_raw_output = cluster.g_transaction.send_tx(
-                src_address=user_payment.address,
-                tx_name=f"{temp_template}_reg_dereg",
-                tx_files=tx_files,
-                deposit=0,
-            )
+        tx_output = clusterlib_utils.build_and_submit_tx(
+            cluster_obj=cluster,
+            name_template=f"{temp_template}_reg_dereg",
+            src_address=user_payment.address,
+            tx_files=tx_files,
+            build_method=build_method,
+            deposit=0,
+            witness_override=len(tx_files.signing_key_files),
+        )
 
         # Check that the stake address is not registered
         assert not cluster.g_query.get_stake_addr_info(user_registered.stake.address).address, (
@@ -272,10 +229,10 @@ def test_addr_registration_deregistration(
         # was not needed
         assert (
             cluster.g_query.get_address_balance(user_payment.address)
-            == src_init_balance - tx_raw_output.fee
+            == src_init_balance - tx_output.fee
         ), f"Incorrect balance for source address `{user_payment.address}`"
 
-        tx_db_record = dbsync_utils.check_tx(cluster_obj=cluster, tx_raw_output=tx_raw_output)
+        tx_db_record = dbsync_utils.check_tx(cluster_obj=cluster, tx_raw_output=tx_output)
         if tx_db_record:
             assert user_registered.stake.address in tx_db_record.stake_registration
             assert user_registered.stake.address in tx_db_record.stake_deregistration
@@ -380,7 +337,7 @@ def test_addr_registration_certificate_order(
             assert user_registered.stake.address in tx_db_record.stake_deregistration
 
     @allure.link(helpers.get_vcs_link())
-    @common.PARAM_USE_BUILD_CMD
+    @common.PARAM_BUILD_METHOD_NO_EST
     @pytest.mark.parametrize("key_type", ("stake", "payment"))
     @pytest.mark.smoke
     @pytest.mark.testnets
@@ -389,7 +346,7 @@ def test_multisig_deregister_registered(
         self,
         cluster: clusterlib.ClusterLib,
         pool_users: list[clusterlib.PoolUser],
-        use_build_cmd: bool,
+        build_method: str,
         key_type: str,
     ):
         """Deregister a registered multisig stake address.
@@ -454,15 +411,16 @@ def test_multisig_deregister_registered(
         def _submit_tx(
             name_template: str, complex_certs: list[clusterlib.ComplexCert]
         ) -> clusterlib.TxRawOutput:
-            if use_build_cmd:
+            if build_method == clusterlib_utils.BuildMethods.BUILD:
                 tx_output = cluster.g_transaction.build_tx(
                     src_address=payment_addr.address,
                     tx_name=name_template,
                     complex_certs=complex_certs,
                     fee_buffer=2_000_000,
                     witness_override=witness_len,
                 )
-            else:
+
+            elif build_method == clusterlib_utils.BuildMethods.BUILD_RAW:
                 fee = cluster.g_transaction.calculate_tx_fee(
                     src_address=payment_addr.address,
                     tx_name=name_template,
@@ -475,6 +433,13 @@ def _submit_tx(
                     complex_certs=complex_certs,
                     fee=fee,
                 )
+            elif build_method == clusterlib_utils.BuildMethods.BUILD_EST:
+                tx_output = cluster.g_transaction.build_estimate_tx(
+                    src_address=payment_addr.address,
+                    tx_name=name_template,
+                    complex_certs=complex_certs,
+                    witness_count_add=witness_len,
+                )
 
             # Create witness file for each key
             witness_files = [
@@ -610,15 +575,15 @@ def test_register_addr_with_wrong_key(
         assert "MissingVKeyWitnessesUTXOW" in err_msg, err_msg
 
     @allure.link(helpers.get_vcs_link())
-    @common.PARAM_USE_BUILD_CMD
+    @common.PARAM_BUILD_METHOD_NO_EST
     @pytest.mark.smoke
     @pytest.mark.testnets
     def test_deregister_not_registered_addr(
         self,
         cluster: clusterlib.ClusterLib,
         pool_users: list[clusterlib.PoolUser],
         pool_users_disposable: list[clusterlib.PoolUser],
-        use_build_cmd: bool,
+        build_method: str,
     ):
         """Deregister not registered stake address."""
         temp_template = common.get_test_id(cluster)
@@ -638,7 +603,7 @@ def test_deregister_not_registered_addr(
         )
 
         with pytest.raises(clusterlib.CLIError) as excinfo:
-            if use_build_cmd:
+            if build_method == clusterlib_utils.BuildMethods.BUILD_RAW:
 
                 def _build_dereg() -> clusterlib.TxRawOutput:
                     return cluster.g_transaction.build_tx(
@@ -656,25 +621,33 @@ def _build_dereg() -> clusterlib.TxRawOutput:
                     tx_name=f"{temp_template}_dereg_fail",
                 )
                 cluster.g_transaction.submit_tx(tx_file=tx_signed, txins=tx_raw_output.txins)
-            else:
+            elif build_method == clusterlib_utils.BuildMethods.BUILD:
                 cluster.g_transaction.send_tx(
                     src_address=user_payment.address,
                     tx_name=f"{temp_template}_dereg_fail",
                     tx_files=tx_files,
                 )
+            elif build_method == clusterlib_utils.BuildMethods.BUILD_EST:
+                cluster.g_transaction.build_estimate_tx(
+                    src_address=user_payment.address,
+                    tx_name=f"{temp_template}_dereg_fail",
+                    tx_files=tx_files,
+                    witness_count_add=len(tx_files.signing_key_files),
+                )
+
         err_msg = str(excinfo.value)
         assert "StakeKeyNotRegisteredDELEG" in err_msg, err_msg
 
     @allure.link(helpers.get_vcs_link())
-    @common.PARAM_USE_BUILD_CMD
+    @common.PARAM_BUILD_METHOD_NO_EST
     @pytest.mark.parametrize("issue", ("missing_script", "missing_skey"))
     @pytest.mark.smoke
     @pytest.mark.testnets
     def test_incomplete_multisig(
         self,
         cluster: clusterlib.ClusterLib,
         pool_users: list[clusterlib.PoolUser],
-        use_build_cmd: bool,
+        build_method: str,
         issue: str,
     ):
         """Try to register a multisig stake address while missing either a script or an skey.
@@ -724,7 +697,7 @@ def _submit_tx(
         ) -> clusterlib.TxRawOutput:
             witness_len = len(signing_key_files)
 
-            if use_build_cmd:
+            if build_method == clusterlib_utils.BuildMethods.BUILD:
                 tx_output = cluster.g_transaction.build_tx(
                     src_address=payment_addr.address,
                     tx_name=name_template,
@@ -733,7 +706,7 @@ def _submit_tx(
                     fee_buffer=2_000_000,
                     witness_override=witness_len,
                 )
-            else:
+            elif build_method == clusterlib_utils.BuildMethods.BUILD_RAW:
                 fee = cluster.g_transaction.calculate_tx_fee(
                     src_address=payment_addr.address,
                     tx_name=name_template,
@@ -748,6 +721,14 @@ def _submit_tx(
                     complex_certs=complex_certs,
                     fee=fee,
                 )
+            elif build_method == clusterlib_utils.BuildMethods.BUILD_EST:
+                tx_output = cluster.g_transaction.build_estimate_tx(
+                    src_address=payment_addr.address,
+                    tx_name=name_template,
+                    tx_files=tx_files,
+                    complex_certs=complex_certs,
+                    witness_count_add=witness_len,
+                )
 
             # Create witness file for each key
             witness_files = [