Added run-remote runner (#44)

* [add] Added run-remote runner

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.1.43"
+version = "0.1.44"
 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

@@ -16,6 +16,8 @@
 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
+from redisbench_admin.run_remote.args import create_run_remote_arguments
+from redisbench_admin.run_remote.run_remote import run_remote_command_logic
 
 
 def populate_with_poetry_data():
@@ -60,8 +62,8 @@ def main():
         "--local-dir", type=str, default="./", help="local dir to use as storage"
     )
 
-    if requested_tool == "run":
-        parser = create_run_arguments(parser)
+    if requested_tool == "run-remote":
+        parser = create_run_remote_arguments(parser)
     elif requested_tool == "run-local":
         parser = create_run_local_arguments(parser)
     elif requested_tool == "extract":
@@ -77,17 +79,16 @@ def main():
         print_help(project_name, project_version)
         sys.exit(0)
     else:
-        valid_tool_options = ["run", "run-local", "export", "compare", "retrieve"]
+        valid_tool_options = ["run-local", "run-remote", "export", "compare", "retrieve"]
         print_invalid_tool_option(requested_tool, valid_tool_options)
         sys.exit(1)
 
     argv = sys.argv[2:]
     args = parser.parse_args(args=argv)
-
-    if requested_tool == "run":
-        run_command_logic(args)
     if requested_tool == "run-local":
         run_local_command_logic(args)
+    if requested_tool == "run-remote":
+        run_remote_command_logic(args)
     if requested_tool == "compare":
         compare_command_logic(args)
     if requested_tool == "export":
@@ -120,7 +121,7 @@ def print_help(project_name, project_version):
     )
     print("usage: {project_name} <tool> <args>...".format(project_name=project_name))
     print(
-        "\t-) To know more on how to run benchmarks: {project_name} run --help".format(
+        "\t-) To know more on how to run benchmarks: {project_name} run-remote/run-local --help".format(
             project_name=project_name
         )
     )

redisbench_admin/run/ftsb_redisearch/ftsb_redisearch.py

@@ -33,18 +33,18 @@ def get_run_options():
 
 
 def run_ftsb_redisearch(
-    redis_url,
-    ftsb_redisearch_path,
-    setup_run_json_output_fullpath,
-    options,
-    input_file,
-    workers=1,
-    pipeline=1,
-    oss_cluster_mode=False,
-    max_rps=0,
-    requests=0,
-    continue_on_error=False,
-    args=[],
+        redis_url,
+        ftsb_redisearch_path,
+        setup_run_json_output_fullpath,
+        options,
+        input_file,
+        workers=1,
+        pipeline=1,
+        oss_cluster_mode=False,
+        max_rps=0,
+        requests=0,
+        continue_on_error=False,
+        args=[],
 ):
     ##################
     # Setup commands #

redisbench_admin/run/redis_benchmark/redis_benchmark.py

@@ -55,4 +55,4 @@ def prepareRedisBenchmarkCommand(
             " ".join(queries_str)
         )
     )
-    return queries_str
+    return queries_str

redisbench_admin/run/run.py

@@ -1,11 +1,10 @@
 import logging
-import os
-import os.path
 import re
 import subprocess
 
 from cpuinfo import cpuinfo
 
+
 def run_command_logic(args):
     use_case_specific_arguments = dict(args.__dict__)
     # local_path = os.path.abspath(args.local_dir)
@@ -47,4 +46,4 @@ def redis_benchmark_ensure_min_version(benchmark_tool, benchmark_min_tool_versio
             major == benchmark_min_tool_version_major and minor == benchmark_min_tool_version_minor and patch < benchmark_min_tool_version_patch):
         raise Exception(
             "Detected benchmark version that is inferior than the minimum required. {} < {}".format(
-                version_output, benchmark_min_tool_version))
+                version_output, benchmark_min_tool_version))

redisbench_admin/run_local/run_local.py

@@ -131,17 +131,21 @@ def run_local_command_logic(args):
                                 entry
                             )
                         if benchmark_tool == 'redisgraph-benchmark-go':
+                            print(entry)
                             command = prepareRedisGraphBenchmarkGoCommand(
                                 "redisgraph-benchmark-go",
                                 "localhost",
-                                args.redisgraph_port,
-                                benchmark_config,
+                                args.port,
+                                entry,
                                 local_benchmark_output_filename,
                             )
 
                 # run the benchmark
-                benchmark_client_process = subprocess.Popen(args=command, stdout=subprocess.PIPE,
-                                                            stderr=subprocess.STDOUT)
+                if benchmark_tool == 'redis-benchmark':
+                    benchmark_client_process = subprocess.Popen(args=command, stdout=subprocess.PIPE,
+                                                                stderr=subprocess.STDOUT)
+                else:
+                    benchmark_client_process = subprocess.Popen(args=command)
                 (stdout, sterr) = benchmark_client_process.communicate()
                 logging.info("Extracting the benchmark results")
 

redisbench_admin/run_remote/__init__.py

@@ -0,0 +1,56 @@
+import os
+import socket
+
+# environment variables
+PERFORMANCE_RTS_AUTH = os.getenv("PERFORMANCE_RTS_AUTH", None)
+PERFORMANCE_RTS_HOST = os.getenv("PERFORMANCE_RTS_HOST", 6379)
+PERFORMANCE_RTS_PORT = os.getenv("PERFORMANCE_RTS_PORT", None)
+TERRAFORM_BIN_PATH = os.getenv("TERRAFORM_BIN_PATH", "terraform")
+
+
+def create_run_remote_arguments(parser):
+    parser.add_argument("--module_path", type=str, required=True)
+    parser.add_argument("--allowed-tools", type=str, default="redis-benchmark,redisgraph-benchmark-go",
+                        help="comma separated list of allowed tools for this module. By default all the supported are allowed.")
+    parser.add_argument(
+        "--test",
+        type=str,
+        default="",
+        help="specify a test to run. By default will run all of them.",
+    )
+    parser.add_argument("--github_actor", type=str, default=None)
+    parser.add_argument("--github_repo", type=str, default=None)
+    parser.add_argument("--github_org", type=str, default=None)
+    parser.add_argument("--github_sha", type=str, default=None)
+    parser.add_argument("--github_branch", type=str, default=None)
+    parser.add_argument("--triggering_env", type=str, default=socket.gethostname())
+    parser.add_argument("--terraform_bin_path", type=str, default=TERRAFORM_BIN_PATH)
+    parser.add_argument("--setup_name_sufix", type=str, default="")
+    parser.add_argument(
+        "--s3_bucket_name",
+        type=str,
+        default="ci.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 ci.benchmarks.redislabs bucket. Proper credentials are required",
+    )
+    parser.add_argument("--redistimesies_host", type=str, default=PERFORMANCE_RTS_HOST)
+    parser.add_argument("--redistimesies_port", type=int, default=PERFORMANCE_RTS_PORT)
+    parser.add_argument("--redistimesies_pass", type=str, default=PERFORMANCE_RTS_AUTH)
+    parser.add_argument(
+        "--push_results_redistimeseries",
+        default=False,
+        action="store_true",
+        help="uploads the results to RedisTimeSeries. Proper credentials are required",
+    )
+    parser.add_argument(
+        "--skip-env-vars-verify",
+        default=False,
+        action="store_true",
+        help="skip environment variables check",
+    )
+    return parser