tests: add DefaultDevFramework to speedup integration tests

Author: darwintree

integration_tests/readme.md

@@ -158,6 +158,8 @@ def network(framework_class: Type[ConfluxTestFramework], port_min: int, request:
 
 In the tests, you can start by directly using the `network` fixture for the test framework setup.
 
+You can check available pre-defined framework classes in [test_framework/framework_templates.py](./test_framework/framework_templates.py). It is recommended to directly use `DefaultDevFramework` or inherit your `framework_class` fixture from `DefaultDevFramework` if you don't care about block generation or p2p network setup. This template will setup a dev node, resulting in txs being packed and executed immediately.
+
 You can overwrite the `framework_class` fixture in the test file to customize the test framework setup. Check [cip137_test.py](./tests/cip137_test.py) for an example.
 
 #### Common Fixtures

integration_tests/test_framework/framework_templates.py

@@ -14,6 +14,25 @@ def setup_network(self):
         self.setup_nodes()
         self.rpc = RpcClient(self.nodes[0])
 
+
+# dev framework runs a single node in dev mode
+# when recieveing a tx, it will pack and execute it(generate 5 blocks) immediately
+class DefaultDevFramework(ConfluxTestFramework):
+    def set_test_params(self):
+        self.num_nodes = 1
+        self.conf_parameters["mode"] = "'dev'"
+        self.conf_parameters["min_native_base_price"] = 10000
+        self.conf_parameters["base_fee_burn_transition_height"] = 1
+        self.conf_parameters["base_fee_burn_transition_number"] = 1
+
+    def setup_network(self):
+        self.setup_nodes()
+        self.rpc = RpcClient(self.nodes[0])
+        
+    # do nothing because in dev mode
+    def _setup_w3_block_control_middleware(self):
+        pass
+
 class DefaultPoSFramework(ConfluxTestFramework):
     def set_test_params(self):
         self.num_nodes = 4        

integration_tests/test_framework/test_framework.py

@@ -375,8 +375,8 @@ def setup_w3(self):
 
         self.ew3.middleware_onion.add(SignAndSendRawMiddlewareBuilder.build(self.evm_secrets)) # type: ignore
         self.eth.default_account = self.evm_accounts[0].address
-        
-        class TestNodeMiddleware(ConfluxWeb3Middleware):
+
+        class MaxFeePerGasMiddleware(ConfluxWeb3Middleware):
             def request_processor(self, method: RPCEndpoint, params: Any) -> Any:
                 if method == RPC.cfx_sendRawTransaction or method == RPC.cfx_sendTransaction or method == "eth_sendRawTransaction" or method == "eth_sendTransaction":
                     client.node.wait_for_phase(["NormalSyncPhase"])
@@ -388,21 +388,31 @@ def request_processor(self, method: RPCEndpoint, params: Any) -> Any:
                         client.generate_blocks_to_state(num_txs=1)
                 return super().request_processor(method, params)
 
+        self.cw3.middleware_onion.add(MaxFeePerGasMiddleware)
+        self.ew3.middleware_onion.add(MaxFeePerGasMiddleware)
+
+        if self.options.trace_tx:
+            self.cw3.middleware_onion.add(AutoTraceMiddleware)
+            self.ew3.middleware_onion.add(AutoTraceMiddleware)
+            
+        self._setup_w3_block_control_middleware()
+
+    # setup middleware to control the block generation to wait for tx receipt
+    def _setup_w3_block_control_middleware(self):
+        client = RpcClient(self.nodes[0])
+        log = self.log
+
+        class BlockControlMiddleware(ConfluxWeb3Middleware):
+
             def response_processor(self, method: RPCEndpoint, response: Any):
                 if method == RPC.cfx_getTransactionReceipt or method == "eth_getTransactionReceipt":
                     if "result" in response and response["result"] is None:
                         log.debug("Auto generate 5 blocks because did not get tx receipt")
                         client.generate_blocks_to_state(num_txs=1)  # why num_txs=1?
                 return response
-            
-            
-        self.cw3.middleware_onion.add(TestNodeMiddleware)
-        self.ew3.middleware_onion.add(TestNodeMiddleware)
-
-        if self.options.trace_tx:
-            self.cw3.middleware_onion.add(AutoTraceMiddleware)
-            self.ew3.middleware_onion.add(AutoTraceMiddleware)
 
+        self.cw3.middleware_onion.add(BlockControlMiddleware)
+        self.ew3.middleware_onion.add(BlockControlMiddleware)
 
     def add_nodes(self, num_nodes, genesis_nodes=None, rpchost=None, binary=None, auto_recovery=False,
                   recovery_timeout=30, is_consortium=True):

integration_tests/tests/cross_space/conftest.py

@@ -3,13 +3,14 @@
 import pytest
 
 from integration_tests.test_framework.test_framework import ConfluxTestFramework
+from integration_tests.test_framework.framework_templates import DefaultDevFramework
 
 
 @pytest.fixture(scope="module")
 def framework_class() -> Type[ConfluxTestFramework]:
-    class DefaultFramework(ConfluxTestFramework):
+    class DefaultFramework(DefaultDevFramework):
         def set_test_params(self):
-            self.num_nodes = 1
+            super().set_test_params()
             # self.conf_parameters["min_native_base_price"] = 10000
             self.conf_parameters["next_hardfork_transition_height"] = 1
             self.conf_parameters["next_hardfork_transition_number"] = 1

integration_tests/tests/execution_spec_tests/conftest.py

@@ -13,6 +13,7 @@
 from ethereum_test_tools.code import Yul
 
 from integration_tests.test_framework.test_framework import ConfluxTestFramework, AutoTraceMiddleware
+from integration_tests.test_framework.framework_templates import DefaultDevFramework
 from integration_tests.test_framework.util.adapter import AllocMock, conflux_state_test
 
 def pytest_configure(config):
@@ -112,9 +113,9 @@ def _parameterize_opcodes(metafunc, marker_name: str, opcodes: list, fixture_nam
 
 @pytest.fixture(scope="module")
 def framework_class():
-    class EIP7702TestEnv(ConfluxTestFramework):
+    class EIP7702TestEnv(DefaultDevFramework):
         def set_test_params(self):
-            self.num_nodes = 1
+            super().set_test_params()
             self.conf_parameters["evm_chain_id"] = str(EVM_CHAIN_ID)
             self.conf_parameters["eoa_code_transition_height"] = 1
             self.conf_parameters["evm_transaction_block_ratio"] = str(1)

integration_tests/tests/internal_contracts/conftest.py

@@ -1,7 +1,12 @@
 import pytest
 from integration_tests.test_framework.test_framework import ConfluxTestFramework
 from integration_tests.conflux.rpc import RpcClient
+from integration_tests.test_framework.framework_templates import DefaultDevFramework
 
 @pytest.fixture(scope="module")
 def client(network: ConfluxTestFramework) -> RpcClient:
     return network.client
+
+@pytest.fixture(scope="module")
+def framework_class():
+    return DefaultDevFramework

integration_tests/tests/rpc/conftest.py

@@ -1,7 +1,13 @@
 import pytest
 from integration_tests.test_framework.test_framework import ConfluxTestFramework
 from integration_tests.conflux.rpc import RpcClient
+from integration_tests.test_framework.framework_templates import DefaultDevFramework
+from typing import Type
 
 @pytest.fixture(scope="module")
 def client(network: ConfluxTestFramework) -> RpcClient:
     return network.client
+
+@pytest.fixture(scope="module")
+def framework_class():
+    return DefaultDevFramework