Add ref-url for fetching test data (#113)

* add ref_url

* Update README.md

* update dependencies

Author: erwin-wee

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: mypy
         language_version: python3.10
   - repo: https://github.com/python-poetry/poetry
-    rev: 2.0.1
+    rev: 2.1.3
     hooks:
       - id: poetry-check
   - repo: https://github.com/pycqa/flake8

Dockerfile

@@ -1,5 +1,5 @@
 # build stage
-FROM python:3.10-buster AS venv
+FROM python:3.10-bookworm AS venv
 
 # copy files
 COPY pyproject.toml poetry.lock ./
@@ -14,7 +14,7 @@ RUN python -m venv --copies /app/venv
 RUN . /app/venv/bin/activate && $HOME/.local/bin/poetry install --no-directory --without dev --no-root --compile
 
 # runtime stage
-FROM python:3.10-slim-buster as prod
+FROM python:3.10-slim-bookworm as prod
 
 COPY --from=venv /app/venv /app/venv/
 ENV PATH /app/venv/bin:$PATH

README.md

@@ -127,6 +127,7 @@ This will run a load test with a general BSC profile.
 - `--use-latest-blocks`: Use latest blocks for test data generation and runs a background process to update the test data with latest blocks.
 - `--size`: Specifies the test data size. Available values are XS, S, M, L, XL. Default is S.
 - `--batch`: Runs the test using batch requests. This will send multiple requests in a single batch request. The number of requests in a batch can be specified using the `--batch-size` flag. Default batch size is 10.
+- `--ref-url`: Specifies the reference blockchain node URL that will be used to fetch test data from before the benchmark starts.
 
 You may also run `chainbench start --help` for the full list of parameters and flags.
 

chainbench/main.py

@@ -210,6 +210,11 @@ def validate_profile_path(ctx: Context, param: Parameter, value: str) -> str:
 @click.option("--pg-password", default=None, help="PG password")
 @click.option("--use-latest-blocks", is_flag=True, help="Uses latest blocks for test data")
 @click.option("--size", default=None, help="Set the size of the test data. e.g. --size S")
+@click.option(
+    "--ref-url",
+    default=None,
+    help="Reference Node URL for retrieving test data before test starts. If not specified, target url is used.",
+)
 @click.pass_context
 def start(
     ctx: Context,
@@ -243,6 +248,7 @@ def start(
     use_latest_blocks: bool,
     size: str | None,
     method: str | None = None,
+    ref_url: str | None = None,
 ) -> None:
     if notify:
         click.echo(f"Notify when test is finished using topic: {notify}")
@@ -280,7 +286,7 @@ def start(
 
     user_classes = {}
     for locustfile in parse_locustfile_paths([final_profile_path.__str__()]):
-        _, _user_classes, _ = load_locustfile(locustfile)
+        _user_classes, _ = load_locustfile(locustfile)
         for key, value in _user_classes.items():
             user_classes[key] = value
     test_data_types = set()
@@ -379,6 +385,7 @@ def start(
         method=method,
         enable_class_picker=enable_class_picker,
         batch_size=batch_size,
+        ref_url=ref_url,
     )
     # Start the Locust master
     master_command = locust_options.get_master_command()

chainbench/util/cli.py

@@ -144,6 +144,7 @@ class LocustOptions:
     method: str | None = None
     enable_class_picker: bool = False
     batch_size: int | None = None
+    ref_url: str | None = None
 
     def get_master_command(self) -> str:
         """Generate master command."""
@@ -203,6 +204,9 @@ def get_extra_options(self, command: str):
 
         if self.batch_size is not None:
             command += f" --batch-size {self.batch_size}"
+
+        if self.ref_url is not None:
+            command += f" --ref-url {self.ref_url}"
         return command
 
 

chainbench/util/event.py

@@ -31,7 +31,7 @@ def cli_custom_arguments(parser: LocustArgumentParser):
         "--size",
         type=str,
         default=None,
-        help="Set the size of the test data. e.g. --size S",
+        help="Set the size of the test data. e.g. --size S.",
         include_in_web_ui=False,
     )
     parser.add_argument(
@@ -48,7 +48,14 @@ def cli_custom_arguments(parser: LocustArgumentParser):
         type=str,
         default="eth_blockNumber",
         choices=list(all_methods.keys()),
-        help="Test a specific method",
+        help="Test a specific method.",
+        include_in_web_ui=True,
+    )
+    parser.add_argument(
+        "--ref-url",
+        type=str,
+        default=None,
+        help="Reference node url used for fetching test data before test starts. If empty, defaults to target url.",
         include_in_web_ui=True,
     )
 
@@ -187,15 +194,20 @@ def on_init(environment: Environment, **_kwargs):
                         continue
                     logger.info(f"Initializing test data for {test_data_class_name}")
                     print(f"Initializing test data for {test_data_class_name}")
-                    if environment.host:
-                        user_test_data.init_http_client(environment.host)
-                    if isinstance(user_test_data, EvmTestData):
-                        chain_id: ChainId = user_test_data.fetch_chain_id()
-                        user_test_data.init_network(chain_id)
-                        logger.info(f"Target endpoint network is {user_test_data.network.name}")
-                        print(f"Target endpoint network is {user_test_data.network.name}")
-                        test_data["chain_id"] = {test_data_class_name: chain_id}
                     if environment.parsed_options:
+                        ref_node_url = (
+                            environment.parsed_options.ref_url
+                            if environment.parsed_options.ref_url is not None
+                            else environment.host
+                        )
+                        if ref_node_url is not None:
+                            user_test_data.init_http_client(ref_node_url)
+                        if isinstance(user_test_data, EvmTestData):
+                            chain_id: ChainId = user_test_data.fetch_chain_id()
+                            user_test_data.init_network(chain_id)
+                            logger.info(f"Target endpoint network is {user_test_data.network.name}")
+                            print(f"Target endpoint network is {user_test_data.network.name}")
+                            test_data["chain_id"] = {test_data_class_name: chain_id}
                         user_test_data.init_data(environment.parsed_options)
                         test_data[test_data_class_name] = user_test_data.data.to_json()
                         send_msg_to_workers(environment.runner, "test_data", test_data)