[add] Added run-local runner (#42)

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.1.41"
+version = "0.1.42"
 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/cli.py

@@ -1,4 +1,5 @@
 import argparse
+import logging
 import sys
 
 # import toml
@@ -13,6 +14,8 @@
 from redisbench_admin.extract.extract import extract_command_logic
 from redisbench_admin.run.args import create_run_arguments
 from redisbench_admin.run.run import run_command_logic
+from redisbench_admin.run_local.args import create_run_local_arguments
+from redisbench_admin.run_local.run_local import run_local_command_logic
 
 
 def populate_with_poetry_data():
@@ -29,6 +32,12 @@ def populate_with_poetry_data():
 
     return project_name, project_description, project_version
 
+# logging settings
+logging.basicConfig(
+    format="%(asctime)s %(levelname)-4s %(message)s",
+    level=logging.INFO,
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
 
 def main():
     tool = None
@@ -53,6 +62,8 @@ def main():
 
     if requested_tool == "run":
         parser = create_run_arguments(parser)
+    elif requested_tool == "run-local":
+        parser = create_run_local_arguments(parser)
     elif requested_tool == "extract":
         parser = create_extract_arguments(parser)
     elif requested_tool == "compare":
@@ -66,7 +77,7 @@ def main():
         print_help(project_name, project_version)
         sys.exit(0)
     else:
-        valid_tool_options = ["run", "export", "compare", "retrieve"]
+        valid_tool_options = ["run", "run-local", "export", "compare", "retrieve"]
         print_invalid_tool_option(requested_tool, valid_tool_options)
         sys.exit(1)
 
@@ -75,6 +86,8 @@ def main():
 
     if requested_tool == "run":
         run_command_logic(args)
+    if requested_tool == "run-local":
+        run_local_command_logic(args)
     if requested_tool == "compare":
         compare_command_logic(args)
     if requested_tool == "export":

redisbench_admin/run/args.py

@@ -1,105 +1,20 @@
 def create_run_arguments(parser):
     parser.add_argument(
-        "--benchmark-config-file",
+        "--tool",
         type=str,
         required=True,
-        help="benchmark config file to read instructions from. can be a local file or a remote link",
+        help="benchmark tool to use",
     )
     parser.add_argument(
-        "--workers",
-        type=str,
-        default=0,
-        help="number of workers to use during the benchark. If set to 0 it will auto adjust based on the machine number of VCPUs",
-    )
-    parser.add_argument(
-        "--run-only-steps",
-        type=str,
-        default="",
-        help="Comma separated list of use-case steps to run. By default it will run all specified steps.",
-    )
-    parser.add_argument(
-        "--repetitions", type=int, default=1, help="number of repetitions to run"
-    )
-    parser.add_argument(
-        "--benchmark-requests",
-        type=int,
-        default=0,
-        help="Number of total requests to issue (0 = all of the present in input file)",
-    )
-    parser.add_argument(
-        "--s3-bucket-name",
-        type=str,
-        default="benchmarks.redislabs",
-        help="S3 bucket name.",
-    )
-    parser.add_argument(
-        "--upload-results-s3",
-        default=False,
-        action="store_true",
-        help="uploads the result files and configuration file to public benchmarks.redislabs bucket. Proper credentials are required",
-    )
-    parser.add_argument(
-        "--redis-url",
-        type=str,
-        default="redis://localhost:6379",
-        help="The url for Redis connection",
-    )
-    parser.add_argument(
-        "--deployment-type",
-        type=str,
-        default="docker-oss",
-        help="one of docker-oss,docker-oss-cluster,docker-enterprise,oss,oss-cluster,enterprise",
-    )
-    parser.add_argument(
-        "--deployment-shards",
-        type=int,
-        default=1,
-        help="number of database shards used in the deployment",
-    )
-    parser.add_argument(
-        "--pipeline", type=int, default=1, help="pipeline requests to Redis"
-    )
-    parser.add_argument(
-        "--skip-teardown-commands",
-        default=False,
-        action="store_true",
-        help="If enabled will skip any teardown commands.",
-    )
-    parser.add_argument(
-        "--skip-setup-commands",
-        default=False,
-        action="store_true",
-        help="If enabled will skip any setup commands.",
-    )
-    parser.add_argument(
-        "--continue-on-error",
+        "--remote",
         default=False,
         action="store_true",
-        help="If enabled will continue on Redis ERR replies and only print the message.",
-    )
-    parser.add_argument(
-        "--cluster-mode",
-        default=False,
-        action="store_true",
-        help="Run client in cluster mode",
-    )
-    parser.add_argument(
-        "--max-rps",
-        type=int,
-        default=0,
-        help="enable limiting the rate of queries per second, 0 = no limit. "
-        + "By default no limit is specified and the binaries will stress the DB up to the maximum.",
+        help="run the benchmark in remote mode",
     )
     parser.add_argument(
         "--output-file-prefix",
         type=str,
         default="",
         help="prefix to quickly tag some files",
     )
-    parser.add_argument(
-        "--requests",
-        type=int,
-        default=0,
-        help="Number of total requests to issue (0 = all of the present in input file).",
-    )
     return parser

redisbench_admin/run/redis_benchmark/redis_benchmark.py

@@ -0,0 +1,58 @@
+import csv
+import logging
+import shlex
+
+
+def redis_benchmark_from_stdout_csv_to_json(stdout, start_time, start_time_str):
+    results_dict = {"Tests": {}, "StartTime": int(start_time.strftime("%s")),
+                    "StartTimeHuman": start_time_str}
+    csv_data = list(csv.reader(stdout.decode('ascii').splitlines(), delimiter=","))
+    header = csv_data[0]
+    for row in csv_data[1:]:
+        test_name = row[0]
+        results_dict["Tests"][test_name] = {}
+        for pos, value in enumerate(row[1:]):
+            results_dict["Tests"][test_name][header[pos + 1]] = value
+    return results_dict
+
+
+def prepareRedisBenchmarkCommand(
+        executable_path: str,
+        server_private_ip: object,
+        server_plaintext_port: object,
+        benchmark_config: object,
+) -> str:
+    """
+    Prepares redis-benchmark command parameters
+    :param server_private_ip:
+    :param server_plaintext_port:
+    :param benchmark_config:
+    :return: string containing the required command to run the benchmark given the configurations
+    """
+    queries_str = [executable_path]
+    queries_str.extend(["-h", "{}".format(server_private_ip)])
+    queries_str.extend(["-p", "{}".format(server_plaintext_port)])
+
+    # we need the csv output
+    queries_str.extend(["--csv", "-e"])
+    last_append = None
+    for k in benchmark_config["parameters"]:
+        if "clients" in k:
+            queries_str.extend(["-c", "{}".format(k["clients"])])
+        if "requests" in k:
+            queries_str.extend(["-n", "{}".format(k["requests"])])
+        if "threads" in k:
+            queries_str.extend(["--threads", "{}".format(k["threads"])])
+        if "pipeline" in k:
+            queries_str.extend(["-P", "{}".format(k["pipeline"])])
+        # if we have the command keywork then it needs to be at the end of args
+        if "command" in k:
+            last_append = shlex.split(k["command"])
+    if last_append is not None:
+        queries_str.extend(last_append)
+    logging.info(
+        "Running the benchmark with the following parameters: {}".format(
+            " ".join(queries_str)
+        )
+    )
+    return queries_str