feat: implement test runner (#589)

* feat: implement test runner

* chore: nit

* chore: forgot to add the launcher part

Author: leovct

.github/tests/additional-services.yml

@@ -10,4 +10,5 @@ args:
     - observability
     # - pless_zkevm_node # zkevm-node doesn't support fork12.
     - status_checker
+    - test_runner
     - tx_spammer

main.star

@@ -278,7 +278,10 @@ def run(plan, args={}):
         plan.print("Skipping the deployment of OP Succinct")
 
     # Deploy additional services.
-    additional_services.launch(plan, args, contract_setup_addresses, genesis_artifact)
+    deploy_optimism_rollup = deployment_stages.get("deploy_optimism_rollup", False)
+    additional_services.launch(
+        plan, args, contract_setup_addresses, genesis_artifact, deploy_optimism_rollup
+    )
 
 
 def deploy_helper_service(plan, args):

src/additional_services/launcher.star

@@ -10,10 +10,13 @@ panoptichain = import_module("./panoptichain.star")
 pless_zkevm_node = import_module("./pless_zkevm_node.star")
 prometheus = import_module("./prometheus.star")
 status_checker = import_module("./status_checker.star")
+test_runner = import_module("./test_runner.star")
 tx_spammer = import_module("./tx_spammer.star")
 
 
-def launch(plan, args, contract_setup_addresses, genesis_artifact):
+def launch(
+    plan, args, contract_setup_addresses, genesis_artifact, deploy_optimism_rollup=False
+):
     for svc in args.get("additional_services", []):
         if svc == constants.ADDITIONAL_SERVICES.arpeggio:
             arpeggio.run(plan, args)
@@ -41,6 +44,10 @@ def launch(plan, args, contract_setup_addresses, genesis_artifact):
             grafana.run(plan, args)
         elif svc == constants.ADDITIONAL_SERVICES.status_checker:
             status_checker.run(plan, args)
+        elif svc == constants.ADDITIONAL_SERVICES.test_runner:
+            test_runner.run(
+                plan, args, contract_setup_addresses, deploy_optimism_rollup
+            )
         elif svc == constants.ADDITIONAL_SERVICES.tx_spammer:
             tx_spammer.run(plan, args, contract_setup_addresses)
         else:

src/additional_services/test_runner.star

@@ -0,0 +1,94 @@
+hex = import_module("../hex/hex.star")
+service_package = import_module("../../lib/service.star")
+wallet_module = import_module("../wallet/wallet.star")
+
+TEST_RUNNER_IMAGE = "leovct/e2e:454aadc"  # https://github.com/agglayer/e2e/commit/454aadcc4008a2e95b0888521d770149d60ec6c1
+
+
+def run(plan, args, contract_setup_addresses, deploy_optimism_rollup):
+    l1_rpc_url = args.get("mitm_rpc_url").get("agglayer", args.get("l1_rpc_url"))
+
+    # Note: Getting values this way is not clean at all!!!
+    bridge_service_url = ""
+    l2_rpc_url = ""
+    l2_bridge_address = ""
+    if deploy_optimism_rollup:
+        # Bridge service url.
+        bridge_service_name = "sovereign-bridge-service{}".format(
+            args.get("deployment_suffix")
+        )
+        bridge_service = plan.get_service(bridge_service_name)
+        bridge_service_url = "http://{}:{}".format(
+            bridge_service.name,
+            bridge_service.ports.get("rpc").number,
+        )
+
+        # L2 rpc url.
+        op_el_rpc_name = "op-el-1-op-geth-op-node{}".format(
+            args.get("deployment_suffix")
+        )
+        op_el_rpc_service = plan.get_service(op_el_rpc_name)
+        l2_rpc_url = "http://{}:{}".format(
+            op_el_rpc_service.name,
+            op_el_rpc_service.ports.get("rpc").number,
+        )
+
+        # L2 bridge contract address.
+        l2_bridge_address = contract_setup_addresses.get("sovereign_bridge_proxy_addr")
+    else:
+        # Bridge service url.
+        bridge_service_name = "zkevm-bridge-service{}".format(
+            args.get("deployment_suffix")
+        )
+        bridge_service = plan.get_service(bridge_service_name)
+        bridge_service_url = "http://{}:{}".format(
+            bridge_service.name,
+            bridge_service.ports.get("rpc").number,
+        )
+
+        # L2 rpc url.
+        l2_rpc_url = service_package.get_l2_rpc_url(plan, args).http
+
+        # L2 bridge contract address.
+        l2_bridge_address = contract_setup_addresses.get("zkevm_bridge_l2_address")
+
+    # Generate a new wallet and fund it on L1 and L2.
+    funder_private_key = args.get("zkevm_l2_admin_private_key")
+    wallet = wallet_module.new(plan)
+    wallet_module.fund(
+        plan,
+        address=wallet.address,
+        rpc_url=l1_rpc_url,
+        funder_private_key=funder_private_key,
+    )
+    wallet_module.fund(
+        plan,
+        address=wallet.address,
+        rpc_url=l2_rpc_url,
+        funder_private_key=funder_private_key,
+    )
+
+    plan.add_service(
+        name="test-runner",
+        config=ServiceConfig(
+            image=TEST_RUNNER_IMAGE,
+            env_vars={
+                # For now, we've only defined variables used by `tests/agglayer/bridges.bats`.
+                # https://github.com/agglayer/e2e/blob/jhilliard/gas-token-test/tests/agglayer/bridges.bats
+                # Agglayer and bridge.
+                "AGGLAYER_RPC_URL": args.get("agglayer_readrpc_url"),
+                "BRIDGE_SERVICE_URL": bridge_service_url,
+                "CLAIMTXMANAGER_ADDR": args.get("zkevm_l2_claimtxmanager_address"),
+                # L1.
+                "L1_PRIVATE_KEY": wallet.private_key,
+                "L1_RPC_URL": l1_rpc_url,
+                "L1_BRIDGE_ADDR": contract_setup_addresses.get("zkevm_bridge_address"),
+                # L2.
+                "L2_PRIVATE_KEY": wallet.private_key,
+                "L2_RPC_URL": l2_rpc_url,
+                "L2_BRIDGE_ADDR": l2_bridge_address,
+            },
+            entrypoint=["bash", "-c"],
+            cmd=["sleep infinity"],
+        ),
+    )

src/hex/hex.star

@@ -0,0 +1,2 @@
+def normalize(s):
+    return "0x" + s.removeprefix("0x")

src/package_io/constants.star

@@ -8,6 +8,7 @@ ADDITIONAL_SERVICES = struct(
     observability="observability",
     pless_zkevm_node="pless_zkevm_node",
     status_checker="status_checker",
+    test_runner="test_runner",
     tx_spammer="tx_spammer",
 )
 

src/wallet/wallet.star

@@ -0,0 +1,42 @@
+constants = import_module("../../src/package_io/constants.star")
+
+
+def new(plan):
+    result = plan.run_sh(
+        name="private-key-generator",
+        description="Generating a new private key",
+        image=constants.TOOLBOX_IMAGE,
+        run="cast wallet new --json | jq --raw-output '.[0].private_key' | tr -d '\n'",
+    )
+    private_key = result.output
+
+    result = plan.run_sh(
+        name="address-deriver",
+        description="Deriving address from private key",
+        image=constants.TOOLBOX_IMAGE,
+        run="cast wallet address --private-key ${PRIVATE_KEY} | tr -d '\n'",
+        env_vars={
+            "PRIVATE_KEY": private_key,
+        },
+    )
+    address = result.output
+
+    return struct(
+        address=address,
+        private_key=private_key,
+    )
+
+
+def fund(plan, address, rpc_url, funder_private_key, value="50ether"):
+    plan.run_sh(
+        name="address-funder",
+        description="Funding address on network {}".format(rpc_url),
+        image=constants.TOOLBOX_IMAGE,
+        run="cast send --legacy --rpc-url ${RPC_URL} --private-key ${PRIVATE_KEY} --value ${VALUE} ${ADDRESS}",
+        env_vars={
+            "ADDRESS": address,
+            "PRIVATE_KEY": funder_private_key,
+            "RPC_URL": rpc_url,
+            "VALUE": value,
+        },
+    )