Added --required-module to local/remote runs to enable faster failures in case of missing module (#93)

* [add] Added --required-module to local/remote runs to enable faster failures in case of missing module

* Bumping version from 0.1.69 to 0.1.70

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.1.69"
+version = "0.1.70"
 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_local/args.py

@@ -12,5 +12,12 @@ def create_run_local_arguments(parser):
         default="",
         help="specify a test to run. By default will run all of them.",
     )
+    parser.add_argument(
+        "--required-module",
+        default=None,
+        action="append",
+        help="path to the module file. "
+        "You can use `--required-module` more than once",
+    )
     parser.add_argument("--port", type=int, default=6379)
     return parser

redisbench_admin/run_local/run_local.py

@@ -7,6 +7,7 @@
 import sys
 import tempfile
 
+import redis
 import wget
 import yaml
 
@@ -22,6 +23,9 @@
     redis_benchmark_ensure_min_version_local,
 )
 from redisbench_admin.run.ycsb.ycsb import post_process_ycsb_results
+from redisbench_admin.run_remote.run_remote import (
+    extract_module_semver_from_info_modules_cmd,
+)
 from redisbench_admin.utils.local import (
     spin_up_local_redis,
     get_local_run_full_filename,
@@ -47,6 +51,7 @@ def run_local_command_logic(args):
 
     local_module_file = args.module_path
     os.path.abspath(".")
+    required_modules = args.required_module
 
     logging.info("Retrieved the following local info:")
     logging.info("\tgithub_actor: {}".format(github_actor))
@@ -126,6 +131,29 @@ def run_local_command_logic(args):
                 )
                 if is_process_alive(redis_process) is False:
                     raise Exception("Redis process is not alive. Failing test.")
+
+                r = redis.StrictRedis(port=args.port)
+                stdout = r.execute_command("info modules")
+                print(stdout)
+                (
+                    module_names,
+                    _,
+                ) = extract_module_semver_from_info_modules_cmd(stdout)
+                if len(required_modules) > 0:
+                    logging.info(
+                        "Checking if the following required modules {} are present".format(
+                            required_modules
+                        )
+                    )
+                for required_module in required_modules:
+                    if required_module not in module_names:
+                        raise Exception(
+                            "Unable to detect required module {} in {}. Aborting...".format(
+                                required_module,
+                                module_names,
+                            )
+                        )
+
                 # setup the benchmark
                 start_time, start_time_ms, start_time_str = get_start_time_vars()
                 local_benchmark_output_filename = get_local_run_full_filename(

redisbench_admin/run_remote/args.py

@@ -26,6 +26,13 @@ def create_run_remote_arguments(parser):
     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, nargs="?", const="")
+    parser.add_argument(
+        "--required-module",
+        default=None,
+        action="append",
+        help="path to the module file. "
+        "You can use `--required-module` more than once",
+    )
     parser.add_argument("--github_branch", type=str, default=None, nargs="?", const="")
     parser.add_argument("--triggering_env", type=str, default=socket.gethostname())
     parser.add_argument("--terraform_bin_path", type=str, default=TERRAFORM_BIN_PATH)

redisbench_admin/run_remote/run_remote.py

@@ -95,12 +95,15 @@ def extract_artifact_version_remote(
     res = execute_remote_commands(server_public_ip, username, private_key, commands)
     recv_exit_status, stdout, stderr = res[0]
     print(stdout)
-    version = extract_module_semver_from_info_modules_cmd(stdout)
-    return version
+    module_name, version = extract_module_semver_from_info_modules_cmd(stdout)
+    return module_name, version
 
 
 def extract_module_semver_from_info_modules_cmd(stdout):
-    version = None
+    versions = []
+    module_names = []
+    if type(stdout) == bytes:
+        stdout = stdout.decode()
     if type(stdout) == str:
         info_modules_output = stdout.split("\n")[1:]
     else:
@@ -114,7 +117,9 @@ def extract_module_semver_from_info_modules_cmd(stdout):
             logging.info(
                 "Detected artifact={}, semver={}.".format(module_name, version)
             )
-    return version
+            module_names.append(module_name)
+            versions.append(version)
+    return module_names, versions
 
 
 def run_remote_command_logic(args):
@@ -124,6 +129,7 @@ def run_remote_command_logic(args):
     tf_github_repo = args.github_repo
     tf_github_sha = args.github_sha
     tf_github_branch = args.github_branch
+    required_modules = args.required_module
 
     if tf_github_org is None:
         (
@@ -389,9 +395,27 @@ def run_remote_command_logic(args):
                         remote_dataset_file,
                         dirname,
                     )
-                    artifact_version = extract_artifact_version_remote(
+                    module_names, artifact_versions = extract_artifact_version_remote(
                         server_public_ip, server_plaintext_port, username, private_key
                     )
+                    if len(required_modules) > 0:
+                        logging.info(
+                            "Checking if the following required modules {} are present".format(
+                                required_modules
+                            )
+                        )
+                    for required_module in required_modules:
+                        if required_module not in module_names:
+                            raise Exception(
+                                "Unable to detect required module {} in {}, using remote DB with IP {}, PORT {}. Aborting...".format(
+                                    required_module,
+                                    module_names,
+                                    server_public_ip,
+                                    server_plaintext_port,
+                                )
+                            )
+
+                    artifact_version = artifact_versions[0]
                     (
                         benchmark_min_tool_version,
                         benchmark_min_tool_version_major,

redisbench_admin/utils/local.py

@@ -94,7 +94,7 @@ def spin_up_local_redis(
         )
     )
     redis_process = subprocess.Popen(command)
-    result = wait_for_conn(redis.StrictRedis())
+    result = wait_for_conn(redis.StrictRedis(port=port))
     if result is True:
         logging.info("Redis available")
     return redis_process

tests/test_run_remote.py

@@ -5,5 +5,9 @@
 
 def test_extract_module_semver_from_info_modules_cmd():
     stdout = b"# Modules\r\nmodule:name=search,ver=999999,api=1,filters=0,usedby=[],using=[],options=[]\r\n".decode()
-    semver = extract_module_semver_from_info_modules_cmd(stdout)
-    assert semver == "999999"
+    module_name, semver = extract_module_semver_from_info_modules_cmd(stdout)
+    assert semver[0] == "999999"
+    assert module_name[0] == "search"
+    module_name, semver = extract_module_semver_from_info_modules_cmd(b"")
+    assert semver == []
+    assert module_name == []