[add] Added support for redis-benchmark -x option (#256)

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.6.0"
+version = "0.6.1"
 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]>","Redis Performance Group <[email protected]>"]
 readme = "README.md"

redisbench_admin/run/common.py

@@ -123,6 +123,7 @@ def prepare_benchmark_parameters_specif_tooling(
             server_plaintext_port,
             entry,
             cluster_api_enabled,
+            current_workdir,
         )
         if isremote is True:
             redirect_file = "> {}".format(remote_results_file)

redisbench_admin/run/redis_benchmark/redis_benchmark.py

@@ -6,6 +6,7 @@
 
 import csv
 import logging
+import os
 import re
 import shlex
 import subprocess
@@ -50,6 +51,7 @@ def prepare_redis_benchmark_command(
     server_plaintext_port: object,
     benchmark_config: object,
     cluster_api_enabled: bool,
+    current_workdir,
 ):
     """
     Prepares redis-benchmark command parameters
@@ -63,13 +65,16 @@ def prepare_redis_benchmark_command(
     command_arr = [executable_path]
     command_arr.extend(["-h", "{}".format(server_private_ip)])
     command_arr.extend(["-p", "{}".format(server_plaintext_port)])
+    if current_workdir is None:
+        current_workdir = os.path.abspath(".")
 
     # we need the csv output
     command_arr.extend(["--csv", "-e"])
     last_append = None
     last_str = ""
     if cluster_api_enabled:
         command_arr.extend(["--cluster"])
+    minus_x = None
     for k in benchmark_config["parameters"]:
         if "clients" in k:
             command_arr.extend(["-c", "{}".format(k["clients"])])
@@ -81,12 +86,21 @@ def prepare_redis_benchmark_command(
             command_arr.extend(["-P", "{}".format(k["pipeline"])])
         if "keyspacelen" in k:
             command_arr.extend(["-r", "{}".format(k["keyspacelen"])])
+        if "r" in k:
+            command_arr.extend(["-r", "{}".format(k["r"])])
         if "size" in k:
             command_arr.extend(["-d", "{}".format(k["size"])])
+        if "x" in k:
+            with open("{}/{}".format(current_workdir, k["x"]), "r") as fd:
+                minus_x = fd.read()
         # if we have the command keywork then it needs to be at the end of args
         if "command" in k:
             last_str = k["command"]
             last_append = shlex.split(k["command"])
+
+    if minus_x is not None:
+        last_str += " '{}'".format(minus_x)
+        last_append.append(minus_x)
     command_str = " ".join(command_arr)
     if last_append is not None:
         command_arr.extend(last_append)

tests/test_data/pass-jsonsl-yahoo2.json

@@ -0,0 +1,16 @@
+version: 0.2
+name: "json_set_10k_docs_yahoo2"
+remote:
+ - type: oss-standalone
+ - setup: redisearch-m5d
+clientconfig:
+  - tool: redis-benchmark
+  - min-tool-version: "6.2.0"
+  - parameters:
+    - clients: 16
+    - requests: 50000
+    - threads: 2
+    - pipeline: 1
+    - command: 'SET __rand_int__'
+    - r: 1000
+    - x: "./tests/test_data/pass-jsonsl-yahoo2.json"

tests/test_data/redis-benchmark-json.yml

@@ -23,13 +23,31 @@ def test_prepare_redis_benchmark_command():
                 )
 
 
+def test_prepare_redis_benchmark_command_x():
+    with open("./tests/test_data/redis-benchmark-json.yml", "r") as yml_file:
+        benchmark_config = yaml.safe_load(yml_file)
+        for k in benchmark_config["clientconfig"]:
+            if "parameters" in k:
+                command_arr, command_str = prepare_redis_benchmark_command(
+                    "redis-benchmark",
+                    "localhost",
+                    "6380",
+                    k,
+                    False,
+                    "./tests/test_data/",
+                )
+                assert command_str.startswith(
+                    "redis-benchmark -h localhost -p 6380 --csv -e -c 16 -n 5000000 --threads 2 -P 1 -r 1000000 JSON.SET jsonsl-1 $ '"
+                )
+
+
 def test_prepare_redis_benchmark_command():
     with open("./tests/test_data/redis-benchmark2.yml", "r") as yml_file:
         benchmark_config = yaml.safe_load(yml_file)
         for k in benchmark_config["clientconfig"]:
             if "parameters" in k:
                 command_arr, command_str = prepare_redis_benchmark_command(
-                    "redis-benchmark", "localhost", "6380", k, False
+                    "redis-benchmark", "localhost", "6380", k, False, None
                 )
                 assert (
                     command_str

tests/test_redis_benchmark.py

@@ -102,6 +102,30 @@ def test_datasink_profile_tabular_data():
         pass
 
 
+def test_run_local_command_logic_redis_benchmark():
+    parser = argparse.ArgumentParser(
+        description="test",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser = create_run_local_arguments(parser)
+    args = parser.parse_args(
+        args=[
+            "--test",
+            "./tests/test_data/redis-benchmark-json.yml",
+            "--keep_env_and_topo",
+        ]
+    )
+    try:
+        run_local_command_logic(args, "tool", "v0")
+    except SystemExit as e:
+        assert e.code == 0
+
+    r = redis.StrictRedis()
+    total_keys = r.info("keyspace")["db0"]["keys"]
+    r.shutdown(nosave=True)
+    assert total_keys == 1000
+
+
 def test_run_local_command_logic():
     parser = argparse.ArgumentParser(
         description="test",