Add redis-config-file argument (#223)

* Add redis-config-file argument * Fix default value * Simple assignment * Validate redis config file is not used with enterprise cluster * Add flow test --------- Co-authored-by: meiravgri <[email protected]>
RedisLabsModules · Nov 25, 2024 · bff4694 · bff4694
1 parent 151915c
commit bff4694
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -93,8 +93,10 @@ optional arguments:
   --oss-redis-path OSS_REDIS_PATH
                         path to the oss redis binary (default: redis-server)
   --enterprise-redis-path ENTERPRISE_REDIS_PATH
-                        path to the entrprise redis binary (default:
+                        path to the enterprise redis binary (default:
                         ~/.RLTest/opt/redislabs/bin/redis-server)
+  --redis-config-file REDIS_CONFIG_FILE
+                        path to the redis configuration file (default: None)
   --stop-on-failure     stop running on failure (default: False)
   -x, --exit-on-failure
                         Stop test execution and exit on first assertion

diff --git a/RLTest/__main__.py b/RLTest/__main__.py
@@ -162,7 +162,11 @@ def do_normal_conn(self, line):
 
 parser.add_argument(
     '--enterprise-redis-path', default=os.path.join(binaryrepo.REPO_ROOT, 'opt/redislabs/bin/redis-server'),
-    help='path to the entrprise redis binary')
+    help='path to the enterprise redis binary')
+
+parser.add_argument(
+    '--redis-config-file', default=None,
+    help='path to the redis configuration file')
 
 parser.add_argument(
     '--stop-on-failure', action='store_const', const=True, default=False,
@@ -537,10 +541,14 @@ def __init__(self):
         Defaults.enable_debug_command = True if self.args.allow_unsafe else self.args.enable_debug_command
         Defaults.enable_protected_configs = True if self.args.allow_unsafe else self.args.enable_protected_configs
         Defaults.enable_module_command = True if self.args.allow_unsafe else self.args.enable_module_command
+        Defaults.redis_config_file = self.args.redis_config_file
 
         if Defaults.use_unix and Defaults.use_slaves:
             raise Exception('Cannot use unix sockets with slaves')
 
+        if Defaults.env == 'enterprise-cluster' and Defaults.redis_config_file is not None:
+            raise Exception('Redis configuration file is not supported with enterprise-cluster env')
+
         self.tests = []
         self.testsFailed = {}
         self.currEnv = None

diff --git a/RLTest/env.py b/RLTest/env.py
@@ -151,6 +151,7 @@ class Defaults:
     terminate_retries = None
     terminate_retry_secs = None
     protocol = 2
+    redis_config_file = None
 
     def getKwargs(self):
         kwargs = {
@@ -174,6 +175,7 @@ def getKwargs(self):
             'password': self.oss_password,
             'terminateRetries': self.terminate_retries,
             'terminateRetrySecs': self.terminate_retry_secs,
+            'redisConfigFile': self.redis_config_file,
         }
         return kwargs
 
@@ -198,7 +200,7 @@ def __init__(self, testName=None, testDescription=None, module=None,
                  tlsCaCertFile=None, tlsPassphrase=None, logDir=None, redisBinaryPath=None, dmcBinaryPath=None,
                  redisEnterpriseBinaryPath=None, noDefaultModuleArgs=False, clusterNodeTimeout = None,
                  freshEnv=False, enableDebugCommand=None, enableModuleCommand=None, enableProtectedConfigs=None, protocol=None,
-                 terminateRetries=None, terminateRetrySecs=None):
+                 terminateRetries=None, terminateRetrySecs=None, redisConfigFile=None):
 
         self.testName = testName if testName else Defaults.curr_test_name
         if self.testName is None:
@@ -246,6 +248,8 @@ def __init__(self, testName=None, testDescription=None, module=None,
 
         self.protocol = protocol if protocol is not None else Defaults.protocol
 
+        self.redisConfigFile = redisConfigFile if redisConfigFile is not None else Defaults.redis_config_file
+
         self.assertionFailedSummary = []
 
         if not freshEnv and Env.RTestInstance and Env.RTestInstance.currEnv and self.compareEnvs(Env.RTestInstance.currEnv):
@@ -362,6 +366,7 @@ def getEnvKwargs(self):
             'protocol': self.protocol,
             'terminateRetries': self.terminateRetries,
             'terminateRetrySecs': self.terminateRetrySecs,
+            'redisConfigFile': self.redisConfigFile,
         }
         return kwargs
 

diff --git a/RLTest/redis_std.py b/RLTest/redis_std.py
@@ -22,7 +22,9 @@ def __init__(self, redisBinaryPath, port=6379, modulePath=None, moduleArgs=None,
                  dbDirPath=None, useSlaves=False, serverId=1, password=None, libPath=None, clusterEnabled=False, decodeResponses=False,
                  useAof=False, useRdbPreamble=True, debugger=None, sanitizer=None, noCatch=False, noLog=False, unix=False, verbose=False, useTLS=False,
                  tlsCertFile=None, tlsKeyFile=None, tlsCaCertFile=None, clusterNodeTimeout=None, tlsPassphrase=None, enableDebugCommand=False, protocol=2,
-                 terminateRetries=None, terminateRetrySecs=None, enableProtectedConfigs=False, enableModuleCommand=False, loglevel=None):
+                 terminateRetries=None, terminateRetrySecs=None, enableProtectedConfigs=False, enableModuleCommand=False, loglevel=None,
+                 redisConfigFile=None
+                 ):
         self.uuid = uuid.uuid4().hex
         self.redisBinaryPath = os.path.expanduser(redisBinaryPath) if redisBinaryPath.startswith(
             '~/') else redisBinaryPath
@@ -68,6 +70,7 @@ def __init__(self, redisBinaryPath, port=6379, modulePath=None, moduleArgs=None,
         self.protocol = protocol
         self.terminateRetries = terminateRetries
         self.terminateRetrySecs = terminateRetrySecs
+        self.redisConfigFile = redisConfigFile
 
         if port > 0:
             self.port = port
@@ -179,6 +182,9 @@ def createCmdArgs(self, role):
 
         cmdArgs += [self.redisBinaryPath]
 
+        if self.redisConfigFile:
+            cmdArgs += [self.redisConfigFile]
+
         if self.port > -1:
             if self.useTLS:
                 cmdArgs += ['--port', str(0), '--tls-port', str(self.getPort(role))]

diff --git a/tests/flow/test_simple_flow.py b/tests/flow/test_simple_flow.py
@@ -1,4 +1,5 @@
 import redis
+import os
 
 from RLTest import Env
 
@@ -60,3 +61,27 @@ def test_resp3(env):
     env = Env(protocol=3)
     res = env.cmd('client', 'list')
     env.assertTrue("resp=3" in res.decode('ascii'))
+
+def test_redisConfigFile():
+    # create redis.conf file in /tmp
+    redisConfigFile = '/tmp/redis.conf'
+    if os.path.isfile(redisConfigFile):
+        os.unlink(redisConfigFile)
+    with open(redisConfigFile, 'w') as f:
+        f.write('loglevel verbose\n')
+
+    # create env with the config file
+    env = Env(redisConfigFile=redisConfigFile)
+    res = env.cmd('config', 'get', 'loglevel')
+    env.assertEqual(res[1].decode('ascii'), 'verbose')
+    env.stop()
+
+    # update config file and create new env
+    if os.path.isfile(redisConfigFile):
+        os.unlink(redisConfigFile)
+    with open(redisConfigFile, 'w') as f:
+        f.write('loglevel debug\n')
+    env = Env(redisConfigFile=redisConfigFile)
+    env.start()
+    res = env.cmd('config', 'get', 'loglevel')
+    env.assertEqual(res[1].decode('ascii'), 'debug')
diff --git a/tests/unit/test_redis_std.py b/tests/unit/test_redis_std.py
@@ -89,6 +89,14 @@ def test_create_cmd_args_default(self):
         cmd_args = std_env.createCmdArgs(role)
         assert [REDIS_BINARY, '--port', '6379', '--logfile', std_env._getFileName(role, '.log'), '--dbfilename',
                 std_env._getFileName(role, '.rdb')] == cmd_args
+
+    def test_create_cmd_args_config_file(self):
+        std_env = StandardEnv(redisBinaryPath=REDIS_BINARY, outputFilesFormat='%s-test',
+                              redisConfigFile='redis.conf')
+        role = 'master'
+        cmd_args = std_env.createCmdArgs(role)
+        assert [REDIS_BINARY, 'redis.conf','--port', '6379', '--logfile', std_env._getFileName(role, '.log'), '--dbfilename',
+                std_env._getFileName(role, '.rdb')] == cmd_args
 
     def test_create_cmd_args_tls(self):
         port = 8000