Increased coverage of tool. General code improvement (#69)

Author: filipecosta90

redisbench_admin/run_local/run_local.py

@@ -24,7 +24,7 @@
     extract_git_vars,
     validateResultExpectations,
 )
-from redisbench_admin.utils.utils import decompress_file
+from redisbench_admin.utils.utils import decompress_file, get_decompressed_filename
 
 
 def run_local_command_logic(args):
@@ -214,7 +214,10 @@ def checkBenchmarkBinariesLocalRequirements(benchmark_config, allowed_tools, bin
                     logging.info(
                         "Decompressing {} into {}.".format(
                             full_path, binaries_localtemp_dir))
-                    full_path = decompress_file(full_path,binaries_localtemp_dir)
+                    if not os.path.exists(get_decompressed_filename(full_path)):
+                        full_path = decompress_file(full_path,binaries_localtemp_dir)
+                    else:
+                        full_path = get_decompressed_filename(full_path)
                     benchmark_tool_workdir = os.path.abspath(full_path)
                     executable = stat.S_IEXEC | stat.S_IXGRP | stat.S_IXOTH
                     which_benchmark_tool = whichLocal(benchmark_tool, executable, full_path, which_benchmark_tool)

redisbench_admin/utils/utils.py

@@ -51,6 +51,14 @@ def required_utilities(utility_list):
     return result
 
 
+def get_decompressed_filename(compressed_filename:str):
+    uncompressed_filename = None
+    for suffix in [".zip",".tar.gz","tar"]:
+        if compressed_filename.endswith(suffix):
+            uncompressed_filename = compressed_filename[:-len(suffix)]
+    return uncompressed_filename
+
+
 def decompress_file(compressed_filename:str, path=None):
     uncompressed_filename = compressed_filename
     logging.warning(

tests/test_common.py

@@ -8,7 +8,8 @@
     split_tags_string,
     get_or_None,
 )
-from redisbench_admin.run.common import get_start_time_vars, prepare_benchmark_parameters
+from redisbench_admin.run.common import get_start_time_vars, prepare_benchmark_parameters, \
+    extract_benchmark_tool_settings, common_exporter_logic, process_default_yaml_properties_file
 
 
 class Test(TestCase):
@@ -54,8 +55,34 @@ def test_get_start_time_vars():
 def test_prepare_benchmark_parameters():
     with open("./tests/test_data/ycsb-config.yml", "r") as yml_file:
         benchmark_config = yaml.safe_load(yml_file)
-        command_arr, command_str = prepare_benchmark_parameters(benchmark_config, "ycsb",  "6380", "localhost",
+        command_arr, command_str = prepare_benchmark_parameters(benchmark_config, "ycsb", "6380", "localhost",
                                                                 "out.txt", False)
         assert command_str == "ycsb load redisearch -P workloads/workload-ecommerce -p \"threadcount=64\"" \
                               " -p \"redis.host=localhost\" -p \"redis.port=6380\"" \
                               " -p \"recordcount=100000\" -p \"operationcount=100000\""
+
+
+def test_extract_benchmark_tool_settings():
+    config_files = ["./tests/test_data/ycsb-config.yml", "./tests/test_data/redis-benchmark.yml",
+                    "./tests/test_data/redisgraph-benchmark-go.yml"]
+    for file in config_files:
+        with open(file, "r") as yml_file:
+            benchmark_config = yaml.safe_load(yml_file)
+            benchmark_min_tool_version, benchmark_min_tool_version_major, benchmark_min_tool_version_minor, benchmark_min_tool_version_patch, benchmark_tool, benchmark_tool_source = extract_benchmark_tool_settings(
+                benchmark_config)
+            assert benchmark_tool is not None
+            prepare_benchmark_parameters(benchmark_config, benchmark_tool, "9999", "localhost", "out.txt", False)
+
+
+def test_common_exporter_logic():
+    # negative test
+    common_exporter_logic(None, None, None, None, None, None,
+                          None, None, None, None)
+
+
+def test_process_default_yaml_properties_file():
+    with open("./tests/test_data/common-properties-v0.1.yml", "r") as yml_file:
+        default_kpis, default_metrics, exporter_timemetric_path = process_default_yaml_properties_file({},{},"1.yml",None,yml_file)
+        assert exporter_timemetric_path == "$.StartTime"
+        assert default_kpis is None
+

tests/test_data/common-properties-v0.1.yml

@@ -0,0 +1,12 @@
+version: 0.1
+exporter:
+  redistimeseries:
+    timemetric: "$.StartTime"
+    metrics:
+      - "$.Tests.Overall.rps"
+      - "$.Tests.Overall.avg_latency_ms"
+      - "$.Tests.Overall.p50_latency_ms"
+      - "$.Tests.Overall.p95_latency_ms"
+      - "$.Tests.Overall.p99_latency_ms"
+      - "$.Tests.Overall.max_latency_ms"
+      - "$.Tests.Overall.min_latency_ms"

tests/test_data/redis-benchmark-6.2.0-csv.out

@@ -0,0 +1,3 @@
+"test","rps","avg_latency_ms","min_latency_ms","p50_latency_ms","p95_latency_ms","p99_latency_ms","max_latency_ms"
+"SET","139082.06","0.188","0.040","0.167","0.295","0.735","2.215"
+"GET","136986.30","0.187","0.048","0.183","0.247","0.391","0.887"

tests/test_data/redis-benchmark.yml

@@ -0,0 +1,15 @@
+name: "tsbs-scale100-single-groupby-1-8-1"
+remote:
+  - type: oss-standalone
+  - setup: redistimeseries-m5
+dbconfig:
+  - dataset: "https://s3.amazonaws.com/benchmarks.redislabs/redistimeseries/tsbs/datasets/devops/functional/scale-100-redistimeseries_data.rdb"
+clientconfig:
+  - tool: redis-benchmark
+  - min-tool-version: "6.2.0"
+  - parameters:
+    - clients: 50
+    - requests: 100000
+    - threads: 1
+    - pipeline: 1
+    - command: '"TS.MRANGE" "1609613705646" "1609617305646" "WITHLABELS" "AGGREGATION" "MAX" "60000" "FILTER" "measurement=cpu" "fieldname=usage_user" "hostname=(host_49,host_3,host_35,host_39,host_75,host_15,host_21,host_11)" "GROUPBY" "hostname" "REDUCE" "max"'

tests/test_redis_benchmark.py

@@ -0,0 +1,30 @@
+import shutil
+
+import yaml
+
+from redisbench_admin.run.redis_benchmark.redis_benchmark import prepareRedisBenchmarkCommand, \
+    redis_benchmark_ensure_min_version_local, redis_benchmark_from_stdout_csv_to_json
+
+
+def test_prepare_redis_benchmark_command():
+    with open("./tests/test_data/redisgraph-benchmark-go.yml", "r") as yml_file:
+        benchmark_config = yaml.safe_load(yml_file)
+        for k in benchmark_config["clientconfig"]:
+            if 'parameters' in k:
+                command_arr, command_str = prepareRedisBenchmarkCommand("redis-benchmark", "localhost",
+                                                                        "6380", k)
+                assert command_str == "redis-benchmark -h localhost -p 6380 --csv -e -c 32 --threads 4 -n 1000000"
+
+
+def test_redis_benchmark_ensure_min_version_local():
+    redis_benchmark_bin = shutil.which("redis-benchmark")
+    if redis_benchmark_bin:
+        redis_benchmark_ensure_min_version_local(redis_benchmark_bin, "6.2.0", "6", "2", "0")
+
+
+def test_redis_benchmark_from_stdout_csv_to_json():
+    with open("./tests/test_data/redis-benchmark-6.2.0-csv.out", "r") as csv_file:
+        csv_data = csv_file.read()
+        results_dict = redis_benchmark_from_stdout_csv_to_json(csv_data, 1, "1")
+        assert "SET" in results_dict["Tests"]
+        assert "GET" in results_dict["Tests"]

tests/test_redis_benchmark_csv_format.py

@@ -1,8 +1,9 @@
 from unittest import TestCase
 
 from redisbench_admin.export.redis_benchmark.redis_benchmark_csv_format import (
-    fill_tags_from_passed_array,
+    fill_tags_from_passed_array, redis_benchmark_export_logic,
 )
+from redisbench_admin.run.redis_benchmark.redis_benchmark import redis_benchmark_from_stdout_csv_to_json
 
 
 class Test(TestCase):
@@ -19,3 +20,10 @@ def test_fill_tags_from_passed_array(self):
         ) = fill_tags_from_passed_array(kv_array)
         assert git_sha == "a331"
         assert deployment_type == None
+
+
+def test_redis_benchmark_export_logic():
+    with open("./tests/test_data/redis-benchmark-6.2.0-csv.out", "r") as csv_file:
+        csv_data = csv_file.read()
+        results_dict = redis_benchmark_from_stdout_csv_to_json(csv_data, 1, "1")
+        redis_benchmark_export_logic(results_dict,[],None,{},False)