add --profile-path flag (#109)

* add --profile-path flag

Author: erwin-wee

README.md

@@ -110,19 +110,20 @@ This will run a load test with a general BSC profile.
 
 
 ### Parameters and Flags
-- `-p, --profile`: Specifies the profile to use for the benchmark. Available profiles can be found in the profile directory. Sample usage `-p bsc.general`
-- `-d` or `--profile-dir`: Specifies the base directory to use which contain profiles, supporting up to one-level of subdirectories.
-- `-s, --shape`: Specifies the shape of the load pattern. List available shapes with `chainbench list shapes`.
-- `-u, --users`: Sets the number of simulated users to use for the benchmark.
-- `-r, --spawn-rate`: Sets the spawn rate of users per second.
-- `-w, --workers`: Sets the number of worker threads to use for the benchmark.
-- `-t, --test-time`: Sets the duration of the test to run.
+- `-p`, `--profile`: Specifies the profile to use for the benchmark. Available profiles can be found in the profile directory. Sample usage `-p bsc.general`
+- `-d`, `--profile-dir`: Specifies the base directory to use which contain profiles, supporting up to one-level of subdirectories.
+- `--profile-path`: Specifies the full path to the profile file to use for the benchmark. Overrides `--profile` and `--profile-dir` options.
+- `-s`, `--shape`: Specifies the shape of the load pattern. List available shapes with `chainbench list shapes`.
+- `-u`, `--users`: Sets the number of simulated users to use for the benchmark.
+- `-r`, `--spawn-rate`: Sets the spawn rate of users per second.
+- `-w`, `--workers`: Sets the number of worker threads to use for the benchmark.
+- `-t`, `--test-time`: Sets the duration of the test to run.
 - `--target`: Specifies the target blockchain node URL that the benchmark will connect to.
 - `--headless`: Runs the benchmark in headless mode, meaning that no graphical user interface (GUI) will be displayed during the test. This is useful for running the test on a remote server or when the GUI is not needed.
 - `--autoquit`: Tells the Chainbench tool to automatically quit after the test has finished. This is useful for running the benchmark in an automated environment where manual intervention is not desired.
 - `--help`: Displays the help message.
 - `--debug-trace-methods`: Enables tasks tagged with debug or trace to be executed
-- `-E, --exclude-tags`: Exclude tasks tagged with custom tags from the test. You may specify this option multiple times.
+- `-E`, `--exclude-tags`: Exclude tasks tagged with custom tags from the test. You may specify this option multiple times.
 - `--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.

chainbench/main.py

@@ -84,6 +84,20 @@ def validate_profile(ctx: Context, param: Parameter, value: str) -> str:
     return value
 
 
+def validate_profile_path(ctx: Context, param: Parameter, value: str) -> str:
+    if value is not None:
+        if "profile_dir" or "profile" in ctx.params:
+            click.echo("WARNING: Profile and Profile Directory options are ignored when --profile-path flag is used.")
+        if "method" in ctx.params:
+            click.echo("WARNING: Profile and Profile Directory options are ignored when method argument is used.")
+        """Validate profile path."""
+        abs_profile_path = Path(value).resolve()
+        if not abs_profile_path.exists():
+            raise FileNotFoundError(f"Profile path not found: {abs_profile_path}")
+        profile_exists(abs_profile_path.name.removesuffix(".py"), abs_profile_path.parent)
+    return value
+
+
 @cli.command(
     help="Start a load test on the specified method. "
     "Alternatively, you can specify a profile to run using the --profile option instead. "
@@ -107,6 +121,14 @@ def validate_profile(ctx: Context, param: Parameter, value: str) -> str:
     help="Profile to run",
     show_default=True,
 )
+@click.option(
+    "--profile-path",
+    default=None,
+    callback=validate_profile_path,
+    type=click.Path(exists=True, dir_okay=False, file_okay=True, path_type=Path),
+    help="Path to profile locustfile to be run. Overrides --profile and --profile-dir options.",
+    show_default=True,
+)
 @click.option(
     "-s",
     "--shape",
@@ -193,6 +215,7 @@ def start(
     ctx: Context,
     profile: str,
     profile_dir: Path | None,
+    profile_path: Path | None,
     shape: str | None,
     host: str,
     port: int,
@@ -243,18 +266,20 @@ def start(
         profile_dir = get_base_path(__file__) / "profile"
 
     if method:
-        profile_path = Path(all_methods[method])
+        final_profile_path = Path(all_methods[method])
+    elif profile_path:
+        final_profile_path = profile_path
     elif profile:
-        profile_path = get_profile_path(profile_dir, profile)
+        final_profile_path = get_profile_path(profile_dir, profile)
     else:
-        profile_path = profile_dir
+        final_profile_path = profile_dir
 
-    if not profile_path.exists():
-        click.echo(f"Profile path {profile_path} does not exist.")
+    if not final_profile_path.exists():
+        click.echo(f"Profile path {final_profile_path} does not exist.")
         sys.exit(1)
 
     user_classes = {}
-    for locustfile in parse_locustfile_paths([profile_path.__str__()]):
+    for locustfile in parse_locustfile_paths([final_profile_path.__str__()]):
         _, _user_classes, _ = load_locustfile(locustfile)
         for key, value in _user_classes.items():
             user_classes[key] = value
@@ -273,7 +298,7 @@ def start(
             for test_data_type in test_data_types:
                 click.echo(test_data_type)
             sys.exit(1)
-        profile = profile_path.name
+        profile = final_profile_path.name
         if not headless:
             enable_class_picker = True
 
@@ -329,7 +354,7 @@ def start(
         custom_exclude_tags.extend(["batch", "batch_single"])
 
     locust_options = LocustOptions(
-        profile_path=profile_path,
+        profile_path=final_profile_path,
         host=host,
         port=port,
         test_time=test_time,

chainbench/util/cli.py

@@ -42,6 +42,16 @@ def get_profiles(profile_dir: Path) -> list[str]:
     return result
 
 
+def validate_profile_path(profile_path: Path) -> None:
+    """Validate profile path."""
+    abs_profile_path = profile_path.resolve()
+    if not profile_path.resolve().exists():
+        raise FileNotFoundError(f"Profile file not found: {profile_path}")
+    profiles = get_profiles(abs_profile_path.parent)
+    if profile_path.stem.removesuffix(".py") not in profiles:
+        raise ValueError(f"Profile file not found: {profile_path}")
+
+
 def generate_unique_dir_name() -> str:
     return datetime.now().strftime("%Y-%m-%d_%H-%M-%S")