[add] Enabled specifying dbconfig configuration-parameters (#110)

filipecosta90 · web-flow · commit 0c3d58aa7cff · 2021-05-17T12:42:57.000+01:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.1.77"
+version = "0.1.78"
 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>"]
 readme = "README.md"
diff --git a/redisbench_admin/run_local/run_local.py b/redisbench_admin/run_local/run_local.py
@@ -18,6 +18,7 @@
     extract_benchmark_tool_settings,
     check_required_modules,
     results_dict_kpi_check,
+    extract_redis_configuration_parameters,
 )
 from redisbench_admin.run.redis_benchmark.redis_benchmark import (
     redis_benchmark_ensure_min_version_local,
@@ -79,8 +80,15 @@ def run_local_command_logic(args):
             )
             check_dataset_local_requirements(benchmark_config, temporary_dir, dirname)
 
+            redis_configuration_parameters = extract_redis_configuration_parameters(
+                benchmark_config, "dbconfig"
+            )
+
             redis_process = spin_up_local_redis(
-                temporary_dir, args.port, local_module_file
+                temporary_dir,
+                args.port,
+                local_module_file,
+                redis_configuration_parameters,
             )
             if is_process_alive(redis_process) is False:
                 raise Exception("Redis process is not alive. Failing test.")
diff --git a/redisbench_admin/run_remote/run_remote.py b/redisbench_admin/run_remote/run_remote.py
@@ -25,6 +25,7 @@
     prepare_benchmark_definitions,
     check_required_modules,
     results_dict_kpi_check,
+    extract_redis_configuration_parameters,
 )
 from redisbench_admin.utils.redisgraph_benchmark_go import (
     spin_up_standalone_remote_redis,
@@ -354,6 +355,11 @@ def run_remote_command_logic(args):
             # after we've created the env, even on error we should always teardown
             # in case of some unexpected error we fail the test
             try:
+
+                redis_configuration_parameters = extract_redis_configuration_parameters(
+                    benchmark_config, "dbconfig"
+                )
+
                 # setup Redis
                 spin_up_standalone_remote_redis(
                     benchmark_config,
@@ -364,6 +370,7 @@ def run_remote_command_logic(args):
                     remote_module_file,
                     remote_dataset_file,
                     dirname,
+                    redis_configuration_parameters,
                 )
                 module_names, artifact_versions = extract_artifact_version_remote(
                     server_public_ip, server_plaintext_port, username, private_key
@@ -390,20 +397,11 @@ def run_remote_command_logic(args):
                         redisbenchmark_go_link,
                     )
                 if "tsbs_" in benchmark_tool:
-                    remote_tool_link = "/tmp/{}".format(benchmark_tool)
-                    tool_link = (
-                        "https://s3.amazonaws.com/benchmarks.redislabs/"
-                        + "redistimeseries/tools/tsbs/{}_linux_amd64".format(
-                            benchmark_tool
-                        )
-                    )
-
-                    queries_file_link = None
-                    for entry in benchmark_config["clientconfig"]:
-                        if "parameters" in entry:
-                            for parameter in entry["parameters"]:
-                                if "file" in parameter:
-                                    queries_file_link = parameter["file"]
+                    (
+                        queries_file_link,
+                        remote_tool_link,
+                        tool_link,
+                    ) = extract_tsbs_extra_links(benchmark_config, benchmark_tool)
 
                     setup_remote_benchmark_tool_requirements_tsbs(
                         client_public_ip,
@@ -586,6 +584,21 @@ def run_remote_command_logic(args):
     exit(return_code)
 
 
+def extract_tsbs_extra_links(benchmark_config, benchmark_tool):
+    remote_tool_link = "/tmp/{}".format(benchmark_tool)
+    tool_link = (
+        "https://s3.amazonaws.com/benchmarks.redislabs/"
+        + "redistimeseries/tools/tsbs/{}_linux_amd64".format(benchmark_tool)
+    )
+    queries_file_link = None
+    for entry in benchmark_config["clientconfig"]:
+        if "parameters" in entry:
+            for parameter in entry["parameters"]:
+                if "file" in parameter:
+                    queries_file_link = parameter["file"]
+    return queries_file_link, remote_tool_link, tool_link
+
+
 def get_test_s3_bucket_path(s3_bucket_name, test_name, tf_github_org, tf_github_repo):
     s3_bucket_path = "{github_org}/{github_repo}/results/{test_name}/".format(
         github_org=tf_github_org,
diff --git a/redisbench_admin/utils/benchmark_config.py b/redisbench_admin/utils/benchmark_config.py
@@ -117,6 +117,19 @@ def merge_default_and_specific_properties_dict_type(
                 )
 
 
+def extract_redis_configuration_parameters(benchmark_config, dbconfig_keyname):
+    redis_configuration_parameters = {}
+    if dbconfig_keyname in benchmark_config:
+        for k in benchmark_config[dbconfig_keyname]:
+            if "configuration-parameters" in k:
+                cp = k["configuration-parameters"]
+                for item in cp:
+                    for k, v in item.items():
+                        redis_configuration_parameters[k] = v
+
+    return redis_configuration_parameters
+
+
 def process_default_yaml_properties_file(
     default_kpis, default_metrics, defaults_filename, exporter_timemetric_path, stream
 ):
diff --git a/redisbench_admin/utils/local.py b/redisbench_admin/utils/local.py
@@ -87,8 +87,11 @@ def spin_up_local_redis(
     dbdir,
     port,
     local_module_file,
+    configuration_parameters=None,
 ):
-    command = generate_standalone_redis_server_args(dbdir, local_module_file, port)
+    command = generate_standalone_redis_server_args(
+        dbdir, local_module_file, port, configuration_parameters
+    )
 
     logging.info(
         "Running local redis-server with the following args: {}".format(
@@ -102,7 +105,9 @@ def spin_up_local_redis(
     return redis_process
 
 
-def generate_standalone_redis_server_args(dbdir, local_module_file, port):
+def generate_standalone_redis_server_args(
+    dbdir, local_module_file, port, configuration_parameters=None
+):
     # start redis-server
     command = [
         "redis-server",
@@ -113,6 +118,14 @@ def generate_standalone_redis_server_args(dbdir, local_module_file, port):
         "--dir",
         dbdir,
     ]
+    if configuration_parameters is not None:
+        for parameter, parameter_value in configuration_parameters.items():
+            command.extend(
+                [
+                    "--{}".format(parameter),
+                    parameter_value,
+                ]
+            )
     if local_module_file is not None:
         command.extend(
             [
diff --git a/redisbench_admin/utils/redisgraph_benchmark_go.py b/redisbench_admin/utils/redisgraph_benchmark_go.py
@@ -14,6 +14,7 @@ def spin_up_standalone_remote_redis(
     remote_module_file,
     remote_dataset_file,
     dirname=".",
+    redis_configuration_parameters=None,
 ):
     # copy the rdb to DB machine
     check_dataset_remote_requirements(
@@ -24,23 +25,36 @@ def spin_up_standalone_remote_redis(
         remote_dataset_file,
         dirname,
     )
+    initial_redis_cmd = (
+        'redis-server --save "" --dir /tmp/ --daemonize yes --protected-mode no'
+    )
+    if redis_configuration_parameters is not None:
+        for (
+            configuration_parameter,
+            configuration_value,
+        ) in redis_configuration_parameters.items():
+            initial_redis_cmd += " --{} {}".format(
+                configuration_parameter, configuration_value
+            )
 
     # copy the module to the DB machine
-    copy_file_to_remote_setup(
-        server_public_ip, username, private_key, local_module_file, remote_module_file
-    )
-    execute_remote_commands(
-        server_public_ip,
-        username,
-        private_key,
-        ["chmod 755 {}".format(remote_module_file)],
-    )
-    # start redis-server
-    commands = [
-        "redis-server --dir /tmp/ --daemonize yes --protected-mode no --loadmodule {}".format(
-            remote_module_file
+    if remote_module_file is not None:
+        copy_file_to_remote_setup(
+            server_public_ip,
+            username,
+            private_key,
+            local_module_file,
+            remote_module_file,
         )
-    ]
+        execute_remote_commands(
+            server_public_ip,
+            username,
+            private_key,
+            ["chmod 755 {}".format(remote_module_file)],
+        )
+        initial_redis_cmd += " --loadmodule {}".format(remote_module_file)
+    # start redis-server
+    commands = [initial_redis_cmd]
     execute_remote_commands(server_public_ip, username, private_key, commands)
 
 
diff --git a/tests/test_benchmark_config.py b/tests/test_benchmark_config.py
@@ -5,6 +5,7 @@
 from redisbench_admin.utils.benchmark_config import (
     results_dict_kpi_check,
     check_required_modules,
+    extract_redis_configuration_parameters,
 )
 
 
@@ -43,3 +44,26 @@ def test_check_required_modules():
         assert "Unable to detect required module" in e.__str__()
     check_required_modules(["search", "ReJSON", "TimeSeries"], ["search"])
     check_required_modules(["search", "ReJSON", "TimeSeries"], ["search", "TimeSeries"])
+
+
+def test_extract_redis_configuration_parameters():
+    with open(
+        "./tests/test_data/redisgraph-benchmark-go-defaults.yml", "r"
+    ) as config_fd:
+        benchmark_config = yaml.safe_load(config_fd)
+        redis_configuration_parameters = extract_redis_configuration_parameters(
+            benchmark_config, "dbconfig"
+        )
+        assert redis_configuration_parameters == {}
+
+        with open(
+            "./tests/test_data/tsbs-devops-ingestion-scale100-4days-keyspace.yml", "r"
+        ) as config_fd:
+            benchmark_config = yaml.safe_load(config_fd)
+            redis_configuration_parameters = extract_redis_configuration_parameters(
+                benchmark_config, "dbconfig"
+            )
+            assert redis_configuration_parameters == {
+                "notify-keyspace-events": "KEA",
+                "timeout": 0,
+            }
diff --git a/tests/test_data/tsbs-devops-ingestion-scale100-4days-keyspace.yml b/tests/test_data/tsbs-devops-ingestion-scale100-4days-keyspace.yml
@@ -0,0 +1,20 @@
+name: "tsbs-devops-ingestion-scale100-4days-keyspace"
+remote:
+  - type: oss-standalone
+  - setup: redistimeseries-m5
+dbconfig:
+  - configuration-parameters:
+    - notify-keyspace-events: KEA
+    - timeout: 0
+clientconfig:
+  - tool: tsbs_load_redistimeseries
+  - parameters:
+    - workers: 64
+    - reporting-period: 1s
+    - file: "https://s3.amazonaws.com/benchmarks.redislabs/redistimeseries/tsbs/datasets/devops/scale100/data_redistimeseries_cpu-only_100.dat"
+exporter:
+  redistimeseries:
+    timemetric: "$.StartTime"
+    metrics:
+      - "$.Totals.metricRate"
+      - "$.Totals.rowRate"
diff --git a/tests/test_local.py b/tests/test_local.py
@@ -62,6 +62,20 @@ def test_generate_standalone_redis_server_args():
         "--loadmodule",
         os.path.abspath(local_module_file),
     ]
+    cmd = generate_standalone_redis_server_args(
+        ".", None, "9999", {"notify-keyspace-events": "KEA"}
+    )
+    assert cmd == [
+        "redis-server",
+        "--save",
+        '""',
+        "--port",
+        "9999",
+        "--dir",
+        ".",
+        "--notify-keyspace-events",
+        "KEA",
+    ]
 
 
 def test_spin_up_local_redis():
diff --git a/tests/test_run_remote.py b/tests/test_run_remote.py
@@ -5,6 +5,7 @@
     redistimeseries_results_logic,
     merge_default_and_config_metrics,
     get_test_s3_bucket_path,
+    extract_tsbs_extra_links,
 )
 from redisbench_admin.utils.benchmark_config import process_default_yaml_properties_file
 from redisbench_admin.utils.remote import get_overall_dashboard_keynames
@@ -94,3 +95,21 @@ def test_get_overall_dashboard_keynames():
         "ci.benchmarks.redislabs/env/org/repo:total_failures"
         == tsname_project_total_failures
     )
+
+
+def test_extract_tsbs_extra_links():
+    with open(
+        "./tests/test_data/tsbs-devops-ingestion-scale100-4days-keyspace.yml", "r"
+    ) as yml_file:
+        benchmark_config = yaml.safe_load(yml_file)
+        queries_file_link, remote_tool_link, tool_link = extract_tsbs_extra_links(
+            benchmark_config, "tsbs_load_redistimeseries"
+        )
+        assert (
+            queries_file_link
+            == "https://s3.amazonaws.com/benchmarks.redislabs/redistimeseries/tsbs/datasets/devops/scale100/data_redistimeseries_cpu-only_100.dat"
+        )
+        assert remote_tool_link == "/tmp/tsbs_load_redistimeseries"
+        assert tool_link == (
+            "https://s3.amazonaws.com/benchmarks.redislabs/redistimeseries/tools/tsbs/tsbs_load_redistimeseries_linux_amd64"
+        )
