Added --redis-7 flag to control if we include or not the redis 7 config directives (#362)

* Added --redis-7 flag to control if we include or not the redis 7 config directives

* Bumping version to 0.9.6

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.9.5"
+version = "0.9.6"
 description = "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... )."
 authors = ["filipecosta90 <filipecosta.90@gmail.com>","Redis Performance Group <performance@redis.com>"]
 readme = "README.md"

redisbench_admin/environments/oss_cluster.py

@@ -9,7 +9,11 @@
 
 import redis
 
-from redisbench_admin.utils.utils import wait_for_conn, redis_server_config_module_part
+from redisbench_admin.utils.utils import (
+    wait_for_conn,
+    redis_server_config_module_part,
+    generate_common_server_args,
+)
 
 
 def spin_up_local_redis_cluster(
@@ -22,6 +26,7 @@ def spin_up_local_redis_cluster(
     configuration_parameters=None,
     dataset_load_timeout_secs=60,
     modules_configuration_parameters_map={},
+    redis_7=True,
 ):
     redis_processes = []
     redis_conns = []
@@ -41,6 +46,9 @@ def spin_up_local_redis_cluster(
             configuration_parameters,
             "no",
             modules_configuration_parameters_map,
+            None,
+            "yes",
+            redis_7,
         )
 
         logging.info(
@@ -147,41 +155,25 @@ def generate_cluster_redis_server_args(
     daemonize="yes",
     modules_configuration_parameters_map={},
     logname_prefix=None,
+    enable_debug_command="yes",
+    enable_redis_7_config_directives=False,
 ):
     if logname_prefix is None:
         logname_prefix = ""
     logfile = "{}cluster-node-port-{}.log".format(logname_prefix, port)
-    if type(binary) == list:
-        command = binary
-    else:
-        command = [binary]
-    # start redis-server
+    dbfilename = get_cluster_dbfilename(port)
+
+    command = generate_common_server_args(
+        binary, daemonize, dbdir, dbfilename, enable_debug_command, ip, logfile, port
+    )
     command.extend(
         [
-            "--appendonly",
-            "no",
-            "--logfile",
-            logfile,
             "--cluster-enabled",
             "yes",
-            "--daemonize",
-            daemonize,
-            "--dbfilename",
-            get_cluster_dbfilename(port),
-            "--protected-mode",
-            "no",
-            "--bind",
-            "{}".format(ip),
             "--cluster-config-file",
             "cluster-node-port-{}.config".format(port),
-            "--save",
-            "",
             "--cluster-announce-ip",
             "{}".format(ip),
-            "--port",
-            "{}".format(port),
-            "--dir",
-            dbdir,
         ]
     )
     if configuration_parameters is not None:

redisbench_admin/environments/oss_standalone.py

@@ -8,7 +8,11 @@
 
 import redis
 
-from redisbench_admin.utils.utils import wait_for_conn, redis_server_config_module_part
+from redisbench_admin.utils.utils import (
+    wait_for_conn,
+    redis_server_config_module_part,
+    generate_common_server_args,
+)
 
 
 def spin_up_local_redis(
@@ -20,6 +24,7 @@ def spin_up_local_redis(
     dbdir_folder=None,
     dataset_load_timeout_secs=120,
     modules_configuration_parameters_map={},
+    redis_7=True,
 ):
     command = generate_standalone_redis_server_args(
         binary,
@@ -28,6 +33,9 @@ def spin_up_local_redis(
         port,
         configuration_parameters,
         modules_configuration_parameters_map,
+        "yes",
+        "yes",
+        redis_7,
     )
 
     logging.info(
@@ -49,22 +57,25 @@ def generate_standalone_redis_server_args(
     port,
     configuration_parameters=None,
     modules_configuration_parameters_map={},
+    enable_debug_command="yes",
+    daemonize="yes",
+    enable_redis_7_config_directives=False,
 ):
-    if type(binary) == list:
-        command = binary
-    else:
-        command = [binary]
-    # start redis-server
-    command.extend(
-        [
-            "--save",
-            "",
-            "--port",
-            "{}".format(port),
-            "--dir",
-            dbdir,
-        ]
+    logfile = "redis.log"
+    dbfilename = "dump.rdb"
+    ip = "127.0.0.1"
+    command = generate_common_server_args(
+        binary,
+        daemonize,
+        dbdir,
+        dbfilename,
+        enable_debug_command,
+        ip,
+        logfile,
+        port,
+        enable_redis_7_config_directives,
     )
+
     if configuration_parameters is not None:
         for parameter, parameter_value in configuration_parameters.items():
             command.extend(

redisbench_admin/run/ann/pkg

@@ -26,6 +26,7 @@
 BENCHMARK_GLOB = os.getenv("BENCHMARK_GLOB", "*.yml")
 S3_BUCKET_NAME = os.getenv("S3_BUCKET_NAME", "ci.benchmarks.redislabs")
 PUSH_S3 = bool(os.getenv("PUSH_S3", False))
+REDIS_7 = bool(os.getenv("REDIS_7", True))
 FAIL_FAST = bool(int(os.getenv("FAIL_FAST", 0)))
 PROFILERS_DSO = os.getenv("PROFILERS_DSO", None)
 GIT_ORG = os.getenv("GIT_ORG", None)
@@ -117,6 +118,13 @@ def common_run_args(parser):
         + "Full list of profilers: {}".format(ALLOWED_PROFILERS)
         + "Only available on x86 Linux platform and kernel version >= 4.9",
     )
+    parser.add_argument(
+        "--redis-7",
+        type=bool,
+        default=REDIS_7,
+        help="Include Redis 7 configuration directives.",
+    )
+
     parser.add_argument("--dso", type=str, required=False, default=PROFILERS_DSO)
     parser.add_argument(
         "--s3_bucket_name",

redisbench_admin/run/args.py

@@ -113,6 +113,7 @@ def spin_up_redis_cluster_remote_redis(
     ssh_port,
     modules_configuration_parameters_map,
     logname,
+    redis_7=True,
 ):
     logging.info("Generating the remote redis-server command arguments")
     redis_process_commands = []
@@ -131,6 +132,8 @@ def spin_up_redis_cluster_remote_redis(
             "yes",
             modules_configuration_parameters_map,
             logname_prefix,
+            "yes",
+            redis_7,
         )
         logging.error(
             "Remote primary shard {} command: {}".format(

redisbench_admin/run/cluster.py

@@ -50,6 +50,7 @@ def local_db_spin(
     # setup Redis
     # copy the rdb to DB machine
     temporary_dir = tempfile.mkdtemp()
+    redis_7 = args.redis_7
     logging.info(
         "Using local temporary dir to spin up Redis Instance. Path: {}".format(
             temporary_dir
@@ -89,6 +90,7 @@ def local_db_spin(
             redis_configuration_parameters,
             dataset_load_timeout_secs,
             modules_configuration_parameters_map,
+            redis_7,
         )
 
         status = setup_redis_cluster_from_conns(
@@ -116,6 +118,7 @@ def local_db_spin(
             dbdir_folder,
             dataset_load_timeout_secs,
             modules_configuration_parameters_map,
+            redis_7,
         )
 
         r = redis.Redis(port=args.port)

redisbench_admin/run_local/local_db.py

@@ -89,6 +89,7 @@ def remote_db_spin(
     private_key,
     s3_bucket_name,
     s3_bucket_path,
+    redis_7=True,
 ):
     (
         _,
@@ -137,6 +138,7 @@ def remote_db_spin(
             db_ssh_port,
             modules_configuration_parameters_map,
             logname,
+            redis_7,
         )
         try:
             for p in range(cluster_start_port, cluster_start_port + shard_count):
@@ -185,6 +187,7 @@ def remote_db_spin(
                 redis_configuration_parameters,
                 db_ssh_port,
                 modules_configuration_parameters_map,
+                redis_7,
             )
             full_logfiles.append(full_logfile)
             local_redis_conn, ssh_tunnel = ssh_tunnel_redisconn(

redisbench_admin/run_remote/remote_db.py

@@ -25,6 +25,7 @@ def spin_up_standalone_remote_redis(
     redis_configuration_parameters=None,
     port=22,
     modules_configuration_parameters_map={},
+    redis_7=True,
 ):
 
     full_logfile, initial_redis_cmd = generate_remote_standalone_redis_cmd(
@@ -33,6 +34,7 @@ def spin_up_standalone_remote_redis(
         remote_module_files,
         temporary_dir,
         modules_configuration_parameters_map,
+        redis_7,
     )
 
     # start redis-server
@@ -105,10 +107,14 @@ def generate_remote_standalone_redis_cmd(
     remote_module_files,
     temporary_dir,
     modules_configuration_parameters_map,
+    enable_redis_7_config_directives=True,
+    enable_debug_command="yes",
 ):
-    initial_redis_cmd = "redis-server --save '' --logfile {} --dir {} --daemonize yes --protected-mode no --enable-debug-command yes ".format(
+    initial_redis_cmd = "redis-server --save '' --logfile {} --dir {} --daemonize yes --protected-mode no ".format(
         logfile, temporary_dir
     )
+    if enable_redis_7_config_directives:
+        initial_redis_cmd = +" --enable-debug-command {} ".format(enable_debug_command)
     full_logfile = "{}/{}".format(temporary_dir, logfile)
     if redis_configuration_parameters is not None:
         for (

redisbench_admin/run_remote/standalone.py

@@ -55,6 +55,54 @@ def redis_server_config_module_part(
                 )
 
 
+def generate_common_server_args(
+    binary,
+    daemonize,
+    dbdir,
+    dbfilename,
+    enable_debug_command,
+    ip,
+    logfile,
+    port,
+    enable_redis_7_config_directives=False,
+):
+    if type(binary) == list:
+        command = binary
+    else:
+        command = [binary]
+    command.extend(
+        [
+            "--appendonly",
+            "no",
+            "--logfile",
+            logfile,
+            "--daemonize",
+            daemonize,
+            "--dbfilename",
+            dbfilename,
+            "--protected-mode",
+            "no",
+            "--bind",
+            "{}".format(ip),
+            "--save",
+            "",
+            "--port",
+            "{}".format(port),
+            "--dir",
+            dbdir,
+        ]
+    )
+    if enable_redis_7_config_directives:
+        command.extend(
+            [
+                "--enable-debug-command",
+                enable_debug_command,
+            ]
+        )
+
+    return command
+
+
 def upload_artifacts_to_s3(
     artifacts,
     s3_bucket_name,