[add] Enabled ftsb_redisearch support (#172)

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.3.11"
+version = "0.4.0"
 description = "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... )."
 authors = ["filipecosta90 <[email protected]>"]
 readme = "README.md"

redisbench_admin/run/common.py

@@ -14,6 +14,7 @@
 from redisbench_admin.run.aibench_run_inference_redisai_vision.aibench_run_inference_redisai_vision import (
     prepare_aibench_benchmark_command,
 )
+from redisbench_admin.run.ftsb.ftsb import prepare_ftsb_benchmark_command
 from redisbench_admin.run.redis_benchmark.redis_benchmark import (
     prepare_redis_benchmark_command,
 )
@@ -108,6 +109,22 @@ def prepare_benchmark_parameters(
                     isremote,
                     cluster_api_enabled,
                 )
+            if "ftsb_" in benchmark_tool:
+                input_data_file = None
+                if isremote is True:
+                    benchmark_tool = "/tmp/{}".format(benchmark_tool)
+                    input_data_file = "/tmp/input.data"
+                (command_arr, command_str,) = prepare_ftsb_benchmark_command(
+                    benchmark_tool,
+                    server_private_ip,
+                    server_plaintext_port,
+                    entry,
+                    current_workdir,
+                    remote_results_file,
+                    input_data_file,
+                    isremote,
+                    cluster_api_enabled,
+                )
             if "aibench_" in benchmark_tool:
                 input_data_file = None
                 if isremote is True:

redisbench_admin/run/ftsb/__init__.py

@@ -0,0 +1,5 @@
+#  Apache License Version 2.0
+#
+#  Copyright (c) 2021., Redis Labs Modules
+#  All rights reserved.
+#

redisbench_admin/run/ftsb/ftsb.py

@@ -0,0 +1,67 @@
+#  Apache License Version 2.0
+#
+#  Copyright (c) 2021., Redis Labs Modules
+#  All rights reserved.
+#
+
+from redisbench_admin.utils.local import check_if_needs_remote_fetch
+
+
+def prepare_ftsb_benchmark_command(
+    executable_path: str,
+    server_private_ip: object,
+    server_plaintext_port: object,
+    benchmark_config: object,
+    current_workdir,
+    result_file: str,
+    remote_queries_file,
+    is_remote: bool,
+    cluster_api_enabled: bool = False,
+):
+    """
+    Prepares prepare_ftsb_benchmark_command command parameters
+    :param executable_path:
+    :param server_private_ip:
+    :param server_plaintext_port:
+    :param benchmark_config:
+    :param current_workdir:
+    :return: [string] containing the required command to run the benchmark given the configurations
+    """
+    command_arr = [executable_path]
+
+    command_arr.extend(
+        ["--host", "{}:{}".format(server_private_ip, server_plaintext_port)]
+    )
+    if cluster_api_enabled is True:
+        command_arr.extend(["--cluster"])
+    if "parameters" in benchmark_config:
+        for k in benchmark_config["parameters"]:
+            if "input" in k:
+                input_file = k["input"]
+                input_file = check_if_needs_remote_fetch(
+                    input_file, "/tmp", None, remote_queries_file, is_remote
+                )
+                command_arr.extend(["--input", input_file])
+            else:
+                for kk in k.keys():
+                    command_arr.extend(["--{}".format(kk), str(k[kk])])
+
+    command_arr.extend(["--json-out-file", result_file])
+
+    command_str = " ".join(command_arr)
+    return command_arr, command_str
+
+
+def extract_ftsb_extra_links(benchmark_config, benchmark_tool):
+    remote_tool_link = "/tmp/{}".format(benchmark_tool)
+    tool_link = (
+        "https://s3.amazonaws.com/benchmarks.redislabs/"
+        + "redisearch/tools/ftsb/{}_linux_amd64".format(benchmark_tool)
+    )
+    queries_file_link = None
+    for entry in benchmark_config["clientconfig"]:
+        if "parameters" in entry:
+            for parameter in entry["parameters"]:
+                if "input" in parameter:
+                    queries_file_link = parameter["input"]
+    return queries_file_link, remote_tool_link, tool_link

redisbench_admin/run_local/args.py

@@ -40,6 +40,7 @@ def create_run_local_arguments(parser):
         type=str,
         default="redis-benchmark,redisgraph-benchmark-go,ycsb,"
         + "tsbs_run_queries_redistimeseries,tsbs_load_redistimeseries,"
+        + "ftsb_redisearch,"
         + "aibench_run_inference_redisai_vision",
         help="comma separated list of allowed tools for this module. By default all the supported are allowed.",
     )

redisbench_admin/run_remote/args.py

@@ -34,6 +34,7 @@ def create_run_remote_arguments(parser):
         type=str,
         default="redis-benchmark,redisgraph-benchmark-go,ycsb,"
         + "tsbs_run_queries_redistimeseries,tsbs_load_redistimeseries,"
+        + "ftsb_redisearch,"
         + "aibench_run_inference_redisai_vision",
         help="comma separated list of allowed tools for this module. By default all the supported are allowed.",
     )

redisbench_admin/run_remote/remote_helpers.py

@@ -10,6 +10,7 @@
 from redisbench_admin.run.aibench_run_inference_redisai_vision.aibench_run_inference_redisai_vision import (
     extract_aibench_extra_links,
 )
+from redisbench_admin.run.ftsb.ftsb import extract_ftsb_extra_links
 from redisbench_admin.run.redis_benchmark.redis_benchmark import (
     redis_benchmark_ensure_min_version_remote,
     redisbenchmark_go_link,
@@ -61,6 +62,7 @@ def remote_tool_pre_bench_step(
     client_public_ip,
     username,
 ):
+    logging.info("Settting up remote tool {} requirements".format(benchmark_tool))
     if benchmark_tool == "redisgraph-benchmark-go":
         setup_remote_benchmark_tool_redisgraph_benchmark_go(
             client_public_ip,
@@ -74,6 +76,28 @@ def remote_tool_pre_bench_step(
             username,
             private_key,
         )
+
+    if "ftsb_" in benchmark_tool:
+        (
+            queries_file_link,
+            remote_tool_link,
+            tool_link,
+        ) = extract_ftsb_extra_links(benchmark_config, benchmark_tool)
+        logging.info(
+            "FTSB Extracted:\nremote tool input: {}\nremote tool link: {}\ntool path: {}".format(
+                queries_file_link, remote_tool_link, tool_link
+            )
+        )
+
+        setup_remote_benchmark_tool_requirements_ftsb(
+            client_public_ip,
+            username,
+            private_key,
+            tool_link,
+            queries_file_link,
+            remote_tool_link,
+        )
+
     if "tsbs_" in benchmark_tool:
         (
             queries_file_link,
@@ -115,6 +139,24 @@ def remote_tool_pre_bench_step(
             username,
             private_key,
         )
+    logging.info("Finished up remote tool {} requirements".format(benchmark_tool))
+
+
+def setup_remote_benchmark_tool_requirements_ftsb(
+    client_public_ip,
+    username,
+    private_key,
+    tool_link,
+    queries_file_link,
+    remote_tool_link,
+    remote_input_file="/tmp/input.data",
+):
+    commands = [
+        "wget {} -q -O {}".format(tool_link, remote_tool_link),
+        "wget {} -q -O {}".format(queries_file_link, remote_input_file),
+        "chmod 755 {}".format(remote_tool_link),
+    ]
+    execute_remote_commands(client_public_ip, username, private_key, commands)
 
 
 def setup_remote_benchmark_tool_requirements_tsbs(