feat(cli): gentest - generate test using debug_traceCall (#470)

* generate test using debug_traceCall

* address issues, refactor the code (WIP)

* fix(cli): use click for gentest

---------

Co-authored-by: Mario Vega <[email protected]>

setup.cfg

@@ -47,6 +47,7 @@ evm_transition_tool =
 console_scripts =
     fill = cli.pytest_commands:fill
     tf = cli.pytest_commands:tf
+    gentest = cli.gentest:make_test
     pyspelling_soft_fail = cli.tox_helpers:pyspelling
     markdownlintcli2_soft_fail = cli.tox_helpers:markdownlint
     order_fixtures = cli.order_fixtures:order_fixtures

src/cli/gentest.py

@@ -0,0 +1,385 @@
+"""
+Define an entry point wrapper for test generator.
+"""
+
+import json
+import os
+from dataclasses import asdict, dataclass
+from sys import stderr
+from typing import Dict, List, TextIO
+
+import click
+import requests
+
+from ethereum_test_tools import Account, Address, Transaction, common
+
+
+@click.command()
+@click.option(
+    "--config-file",
+    "-c",
+    envvar="GENTEST_CONFIG_FILE",
+    type=click.File("r"),
+    default=os.path.expanduser("~/.eest/gentest"),
+    help="Config file with remote node data.",
+)
+@click.argument("transaction_hash")
+@click.argument("output_file", type=click.File("w", lazy=True))
+def make_test(transaction_hash: str, output_file: TextIO, config_file: TextIO):
+    """
+    Extracts a transaction and required state from a network to make a blockchain test out of it.
+
+    TRANSACTION_HASH is the hash of the transaction to be used.
+
+    OUTPUT_FILE is the path to the output python script.
+    """
+    print("Load configs...", file=stderr)
+    config = Config(config_file)
+    request = RequestManager(config.remote_nodes[0])
+
+    print(
+        "Perform tx request: eth_get_transaction_by_hash(" + f"{transaction_hash}" + ")",
+        file=stderr,
+    )
+    tr = request.eth_get_transaction_by_hash(transaction_hash)
+
+    print("Perform debug_trace_call", file=stderr)
+    state = request.debug_trace_call(tr)
+
+    print("Perform eth_get_block_by_number", file=stderr)
+    block = request.eth_get_block_by_number(tr.block_number)
+
+    print("Generate py test", file=stderr)
+    constructor = TestConstructor(PYTEST_TEMPLATE)
+    test = constructor.make_test_template(block, tr, state)
+
+    output_file.write(test)
+
+    print("Finished", file=stderr)
+
+
+class TestConstructor:
+    """
+    Construct .py file from test template, by replacing keywords with test data
+    """
+
+    test_template: str
+
+    def __init__(self, test_template: str):
+        """
+        Initialize with template
+        """
+        self.test_template = test_template
+
+    def _make_test_comments(self, test: str, tr_hash: str) -> str:
+        test = test.replace(
+            "$HEADLINE_COMMENT",
+            "gentest autogenerated test with debug_traceCall of tx.hash " + tr_hash,
+        )
+        test = test.replace("$TEST_NAME", "test_transaction_" + tr_hash[2:])
+        test = test.replace(
+            "$TEST_COMMENT", "gentest autogenerated test for tx.hash " + tr_hash[2:]
+        )
+        return test
+
+    def _make_test_environment(self, test: str, bl: "RequestManager.RemoteBlock") -> str:
+        env_str = ""
+        pad = "        "
+        for field, value in asdict(bl).items():
+            env_str += (
+                f'{pad}{field}="{value}",\n' if field == "coinbase" else f"{pad}{field}={value},\n"
+            )
+        test = test.replace("$ENV", env_str)
+        return test
+
+    def _make_pre_state(
+        self, test: str, tr: "RequestManager.RemoteTransaction", state: Dict[Address, Account]
+    ) -> str:
+        # Print a nice .py storage pre
+        pad = "            "
+        state_str = ""
+        for address, account in state.items():
+            if isinstance(account, dict):
+                account_obj = Account(**account)
+                state_str += f'        "{address}": Account(\n'
+                state_str += f"{pad}balance={str(account_obj.balance)},\n"
+                if address == tr.transaction.sender:
+                    state_str += f"{pad}nonce={tr.transaction.nonce},\n"
+                else:
+                    state_str += f"{pad}nonce={str(account_obj.nonce)},\n"
+
+                if account_obj.code is None:
+                    state_str += f'{pad}code="0x",\n'
+                else:
+                    state_str += f'{pad}code="{str(account_obj.code)}",\n'
+                state_str += pad + "storage={\n"
+
+                if account_obj.storage is not None:
+                    for record, value in account_obj.storage.items():
+                        pad_record = common.ZeroPaddedHexNumber(record)
+                        pad_value = common.ZeroPaddedHexNumber(value)
+                        state_str += f'{pad}    "{pad_record}" : "{pad_value}",\n'
+
+                state_str += pad + "}\n"
+                state_str += "        ),\n"
+        return test.replace("$PRE", state_str)
+
+    def _make_transaction(self, test: str, tr: "RequestManager.RemoteTransaction") -> str:
+        """
+        Print legacy transaction in .py
+        """
+        pad = "            "
+        tr_str = ""
+        quoted_fields_array = ["data", "to"]
+        hex_fields_array = ["v", "r", "s"]
+        legacy_fields_array = [
+            "ty",
+            "chain_id",
+            "nonce",
+            "gas_price",
+            "protected",
+            "gas_limit",
+            "value",
+        ]
+        for field, value in asdict(tr.transaction).items():
+            if value is None:
+                continue
+
+            if field in legacy_fields_array:
+                tr_str += f"{pad}{field}={value},\n"
+
+            if field in quoted_fields_array:
+                tr_str += f'{pad}{field}="{value}",\n'
+
+            if field in hex_fields_array:
+                tr_str += f"{pad}{field}={hex(value)},\n"
+
+        return test.replace("$TR", tr_str)
+
+    def make_test_template(
+        self,
+        bl: "RequestManager.RemoteBlock",
+        tr: "RequestManager.RemoteTransaction",
+        state: Dict[Address, Account],
+    ) -> str:
+        """
+        Prepare the .py file template
+        """
+        test = self.test_template
+        test = self._make_test_comments(test, tr.tr_hash)
+        test = self._make_test_environment(test, bl)
+        test = self._make_pre_state(test, tr, state)
+        test = self._make_transaction(test, tr)
+        return test
+
+
+class Config:
+    """
+    Main class to manage Pyspec config
+    """
+
+    @dataclass
+    class RemoteNode:
+        """
+        Remote node structure
+        """
+
+        name: str
+        node_url: str
+        client_id: str
+        secret: str
+
+    remote_nodes: List["Config.RemoteNode"]
+
+    def __init__(self, file: TextIO):
+        """
+        Initialize pyspec config from file
+        """
+        data = json.load(file)
+        self.remote_nodes = [Config.RemoteNode(**node) for node in data["remote_nodes"]]
+
+
+class RequestManager:
+    """
+    Interface for the RPC interaction with remote node
+    """
+
+    @dataclass()
+    class RemoteTransaction:
+        """
+        Remote transaction structure
+        """
+
+        block_number: str
+        tr_hash: str
+        transaction: Transaction
+
+    @dataclass
+    class RemoteBlock:
+        """
+        Remote block header information structure
+        """
+
+        coinbase: str
+        difficulty: str
+        gas_limit: str
+        number: str
+        timestamp: str
+
+    node_url: str
+    headers: dict[str, str]
+
+    def __init__(self, node_config: Config.RemoteNode):
+        """
+        Initialize the RequestManager with specific client config.
+        """
+        self.node_url = node_config.node_url
+        self.headers = {
+            "CF-Access-Client-Id": node_config.client_id,
+            "CF-Access-Client-Secret": node_config.secret,
+            "Content-Type": "application/json",
+        }
+
+    def _make_request(self, data) -> requests.Response:
+        error_str = "An error occurred while making remote request: "
+        try:
+            response = requests.post(self.node_url, headers=self.headers, data=json.dumps(data))
+            if response.status_code >= 200 and response.status_code < 300:
+                return response
+            else:
+                print(error_str + response.text, file=stderr)
+                raise requests.exceptions.HTTPError
+        except requests.exceptions.RequestException as e:
+            print(error_str, e, file=stderr)
+            raise e
+
+    def eth_get_transaction_by_hash(self, transaction_hash: str) -> RemoteTransaction:
+        """
+        Get transaction data.
+        """
+        data = {
+            "jsonrpc": "2.0",
+            "method": "eth_getTransactionByHash",
+            "params": [f"{transaction_hash}"],
+            "id": 1,
+        }
+
+        response = self._make_request(data)
+        res = response.json().get("result", None)
+
+        return RequestManager.RemoteTransaction(
+            block_number=res["blockNumber"],
+            tr_hash=res["hash"],
+            transaction=Transaction(
+                ty=int(res["type"], 16),
+                gas_limit=int(res["gas"], 16),
+                gas_price=int(res["gasPrice"], 16),
+                data=res["input"],
+                nonce=int(res["nonce"], 16),
+                sender=res["from"],
+                to=res["to"],
+                value=int(res["value"], 16),
+                v=int(res["v"], 16),
+                r=int(res["r"], 16),
+                s=int(res["s"], 16),
+                protected=True if int(res["v"], 16) > 30 else False,
+            ),
+        )
+
+    def eth_get_block_by_number(self, block_number: str) -> RemoteBlock:
+        """
+        Get block by number
+        """
+        data = {
+            "jsonrpc": "2.0",
+            "method": "eth_getBlockByNumber",
+            "params": [f"{block_number}", False],
+            "id": 1,
+        }
+        response = self._make_request(data)
+        res = response.json().get("result", None)
+
+        return RequestManager.RemoteBlock(
+            coinbase=res["miner"],
+            number=res["number"],
+            difficulty=res["difficulty"],
+            gas_limit=res["gasLimit"],
+            timestamp=res["timestamp"],
+        )
+
+    def debug_trace_call(self, tr: RemoteTransaction) -> Dict[Address, Account]:
+        """
+        Get pre state required for transaction
+        """
+        data = {
+            "jsonrpc": "2.0",
+            "method": "debug_traceCall",
+            "params": [
+                {
+                    "from": f"{str(tr.transaction.sender)}",
+                    "to": f"{str(tr.transaction.to)}",
+                    "data": f"{str(tr.transaction.data)}",
+                },
+                f"{tr.block_number}",
+                {"tracer": "prestateTracer"},
+            ],
+            "id": 1,
+        }
+
+        response = self._make_request(data).json()
+        if "error" in response:
+            raise Exception(response["error"]["message"])
+        assert "result" in response, "No result in response on debug_traceCall"
+        return response["result"]
+
+
+PYTEST_TEMPLATE = """
+\"\"\"
+$HEADLINE_COMMENT
+\"\"\"
+
+import pytest
+
+from ethereum_test_tools import (
+    Account,
+    Address,
+    Block,
+    Environment,
+    BlockchainTestFiller,
+    Transaction,
+)
+
+REFERENCE_SPEC_GIT_PATH = "N/A"
+REFERENCE_SPEC_VERSION = "N/A"
+
+
+@pytest.fixture
+def env():  # noqa: D103
+    return Environment(
+$ENV
+    )
+
+
+@pytest.mark.valid_from("Paris")
+def $TEST_NAME(
+    env: Environment,
+    blockchain_test: BlockchainTestFiller,
+):
+    \"\"\"
+    $TEST_COMMENT
+    \"\"\"
+
+    pre = {
+$PRE
+    }
+
+    post = {
+    }
+
+    tx = Transaction(
+$TR
+    )
+
+    blockchain_test(genesis_environment=env, pre=pre, post=post, blocks=[Block(txs=[tx])])
+
+"""