Merge pull request #266 from upcFrost/master

Lua redis.log implementation

Author: bmerry

fakeredis/_server.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import time
 import threading
@@ -19,6 +20,20 @@
 from ._zset import ZSet
 
 
+LOGGER = logging.getLogger('fakeredis')
+REDIS_LOG_LEVELS = {
+    b'LOG_DEBUG': 0,
+    b'LOG_VERBOSE': 1,
+    b'LOG_NOTICE': 2,
+    b'LOG_WARNING': 3
+}
+REDIS_LOG_LEVELS_TO_LOGGING = {
+    0: logging.DEBUG,
+    1: logging.INFO,
+    2: logging.INFO,
+    3: logging.WARNING
+}
+
 MAX_STRING_SIZE = 512 * 1024 * 1024
 
 INVALID_EXPIRE_MSG = "invalid expire time in {}"
@@ -59,6 +74,9 @@
 BAD_COMMAND_IN_PUBSUB_MSG = \
     "only (P)SUBSCRIBE / (P)UNSUBSCRIBE / PING / QUIT allowed in this context"
 CONNECTION_ERROR_MSG = "FakeRedis is emulating a connection error."
+REQUIRES_MORE_ARGS = "{} requires {} arguments or more."
+LOG_WRONG_FIRST_ARG = "First argument must be a number (log level)."
+LOG_INVALID_DEBUG_LEVEL = "Invalid debug level."
 
 FLAG_NO_SCRIPT = 's'      # Command not allowed in scripts
 
@@ -2312,9 +2330,20 @@ def _lua_redis_pcall(self, lua_runtime, expected_globals, op, *args):
         except Exception as ex:
             return lua_runtime.table_from({b"err": str(ex)})
 
+    def _lua_redis_log(self, lua_runtime, expected_globals, lvl, *args):
+        self._check_for_lua_globals(lua_runtime, expected_globals)
+        if len(args) < 1:
+            raise redis.ResponseError(REQUIRES_MORE_ARGS.format("redis.log()", "two"))
+        if lvl not in REDIS_LOG_LEVELS.values():
+            raise redis.ResponseError(LOG_INVALID_DEBUG_LEVEL)
+        msg = ' '.join([x.decode('utf-8')
+                        if isinstance(x, bytes) else str(x)
+                        for x in args if not isinstance(x, bool)])
+        LOGGER.log(REDIS_LOG_LEVELS_TO_LOGGING[lvl], msg)
+
     @command((bytes, Int), (bytes,), flags='s')
     def eval(self, script, numkeys, *keys_and_args):
-        from lupa import LuaRuntime, LuaError
+        from lupa import LuaRuntime, LuaError, as_attrgetter
 
         if numkeys > len(keys_and_args):
             raise redis.ResponseError(TOO_MANY_KEYS_MSG)
@@ -2326,10 +2355,14 @@ def eval(self, script, numkeys, *keys_and_args):
 
         set_globals = lua_runtime.eval(
             """
-            function(keys, argv, redis_call, redis_pcall)
+            function(keys, argv, redis_call, redis_pcall, redis_log, redis_log_levels)
                 redis = {}
                 redis.call = redis_call
                 redis.pcall = redis_pcall
+                redis.log = redis_log
+                for level, pylevel in python.iterex(redis_log_levels.items()) do
+                    redis[level] = pylevel
+                end
                 redis.error_reply = function(msg) return {err=msg} end
                 redis.status_reply = function(msg) return {ok=msg} end
                 KEYS = keys
@@ -2342,7 +2375,9 @@ def eval(self, script, numkeys, *keys_and_args):
             lua_runtime.table_from(keys_and_args[:numkeys]),
             lua_runtime.table_from(keys_and_args[numkeys:]),
             functools.partial(self._lua_redis_call, lua_runtime, expected_globals),
-            functools.partial(self._lua_redis_pcall, lua_runtime, expected_globals)
+            functools.partial(self._lua_redis_pcall, lua_runtime, expected_globals),
+            functools.partial(self._lua_redis_log, lua_runtime, expected_globals),
+            as_attrgetter(REDIS_LOG_LEVELS)
         )
         expected_globals.update(lua_runtime.globals().keys())
 

test_fakeredis.py

@@ -56,6 +56,16 @@ def skip_test(*args, **kwargs):
 redis3_only = pytest.mark.skipif(not REDIS3, reason="Test is only applicable to redis-py 3.x")
 
 
+def fake_only(reason):
+    def wrap(func):
+        def wrapper(self):
+            if not isinstance(self.redis, (fakeredis.FakeRedis, fakeredis.FakeStrictRedis)):
+                pytest.skip("Works only on fakeredis: %s" % reason)
+            func(self)
+        return wrapper
+    return wrap
+
+
 def key_val_dict(size=100):
     return {b'key:' + bytes([i]): b'val:' + bytes([i])
             for i in range(size)}
@@ -4160,6 +4170,56 @@ def test_script(self):
         result = script(args=[42])
         self.assertEqual(result, b'42')
 
+    @fake_only("requires access to redis log file")
+    def test_lua_log(self):
+        logger = fakeredis._server.LOGGER
+        script = """
+            redis.log(redis.LOG_DEBUG, "debug")
+            redis.log(redis.LOG_VERBOSE, "verbose")
+            redis.log(redis.LOG_NOTICE, "notice")
+            redis.log(redis.LOG_WARNING, "warning")
+        """
+        script = self.redis.register_script(script)
+        with self.assertLogs(logger, 'DEBUG') as cm:
+            script()
+            self.assertEqual(cm.output, ['DEBUG:%s:debug' % logger.name,
+                                         'INFO:%s:verbose' % logger.name,
+                                         'INFO:%s:notice' % logger.name,
+                                         'WARNING:%s:warning' % logger.name])
+
+    def test_lua_log_no_message(self):
+        script = "redis.log(redis.LOG_DEBUG)"
+        script = self.redis.register_script(script)
+        with self.assertRaises(redis.ResponseError):
+            script()
+
+    @fake_only("requires access to redis log file")
+    def test_lua_log_different_types(self):
+        logger = fakeredis._server.LOGGER
+        script = "redis.log(redis.LOG_DEBUG, 'string', 1, true, 3.14, 'string')"
+        script = self.redis.register_script(script)
+        with self.assertLogs(logger, 'DEBUG') as cm:
+            script()
+        self.assertEqual(cm.output, ['DEBUG:%s:string 1 3.14 string' % logger.name])
+
+    def test_lua_log_wrong_level(self):
+        script = "redis.log(10, 'string')"
+        script = self.redis.register_script(script)
+        with self.assertRaises(redis.ResponseError):
+            script()
+
+    @fake_only("requires access to redis log file")
+    def test_lua_log_defined_vars(self):
+        logger = fakeredis._server.LOGGER
+        script = """
+            local var='string'
+            redis.log(redis.LOG_DEBUG, var)
+        """
+        script = self.redis.register_script(script)
+        with self.assertLogs(logger, 'DEBUG') as cm:
+            script()
+        self.assertEqual(cm.output, ['DEBUG:%s:string' % logger.name])
+
     @redis3_only
     def test_unlink(self):
         self.redis.set('foo', 'bar')