1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
|
from __future__ import annotations
import logging
import pytest
import redis
import redis.client
from redis.exceptions import ResponseError
import fakeredis
from test import testtools
from test.testtools import raw_command
json_tests = pytest.importorskip("lupa")
@pytest.mark.min_server("7")
def test_script_exists_redis7(r: redis.Redis):
# test response for no arguments by bypassing the py-redis command
# as it requires at least one argument
with pytest.raises(redis.ResponseError):
raw_command(r, "SCRIPT EXISTS")
# use single character characters for non-existing scripts, as those
# will never be equal to an actual sha1 hash digest
assert r.script_exists("a") == [0]
assert r.script_exists("a", "b", "c", "d", "e", "f") == [0, 0, 0, 0, 0, 0]
sha1_one = r.script_load("return 'a'")
assert r.script_exists(sha1_one) == [1]
assert r.script_exists(sha1_one, "a") == [1, 0]
assert r.script_exists("a", "b", "c", sha1_one, "e") == [0, 0, 0, 1, 0]
sha1_two = r.script_load("return 'b'")
assert r.script_exists(sha1_one, sha1_two) == [1, 1]
assert r.script_exists("a", sha1_one, "c", sha1_two, "e", "f") == [0, 1, 0, 1, 0, 0]
@pytest.mark.max_server("6.2.7")
def test_script_exists_redis6(r: redis.Redis):
# test response for no arguments by bypassing the py-redis command
# as it requires at least one argument
assert raw_command(r, "SCRIPT EXISTS") == []
# use single character characters for non-existing scripts, as those
# will never be equal to an actual sha1 hash digest
assert r.script_exists("a") == [0]
assert r.script_exists("a", "b", "c", "d", "e", "f") == [0, 0, 0, 0, 0, 0]
sha1_one = r.script_load("return 'a'")
assert r.script_exists(sha1_one) == [1]
assert r.script_exists(sha1_one, "a") == [1, 0]
assert r.script_exists("a", "b", "c", sha1_one, "e") == [0, 0, 0, 1, 0]
sha1_two = r.script_load("return 'b'")
assert r.script_exists(sha1_one, sha1_two) == [1, 1]
assert r.script_exists("a", sha1_one, "c", sha1_two, "e", "f") == [0, 1, 0, 1, 0, 0]
@pytest.mark.parametrize("args", [("a",), tuple("abcdefghijklmn")])
def test_script_flush_errors_with_args(r, args):
with pytest.raises(redis.ResponseError):
raw_command(r, "SCRIPT FLUSH %s" % " ".join(args))
def test_script_flush(r: redis.Redis):
# generate/load six unique scripts and store their sha1 hash values
sha1_values = [r.script_load("return '%s'" % char) for char in "abcdef"]
# assert the scripts all exist prior to flushing
assert r.script_exists(*sha1_values) == [1] * len(sha1_values)
# flush and assert OK response
assert r.script_flush() is True
# assert none of the scripts exists after flushing
assert r.script_exists(*sha1_values) == [0] * len(sha1_values)
def test_script_no_subcommands(r: redis.Redis):
with pytest.raises(redis.ResponseError):
raw_command(r, "SCRIPT")
@pytest.mark.max_server("7")
def test_script_help(r: redis.Redis):
assert raw_command(r, "SCRIPT HELP") == [
b"SCRIPT <subcommand> [<arg> [value] [opt] ...]. Subcommands are:",
b"DEBUG (YES|SYNC|NO)",
b" Set the debug mode for subsequent scripts executed.",
b"EXISTS <sha1> [<sha1> ...]",
b" Return information about the existence of the scripts in the script cache.",
b"FLUSH [ASYNC|SYNC]",
b" Flush the Lua scripts cache. Very dangerous on replicas.",
b" When called without the optional mode argument, the behavior is determined by the",
b" lazyfree-lazy-user-flush configuration directive. Valid modes are:",
b" * ASYNC: Asynchronously flush the scripts cache.",
b" * SYNC: Synchronously flush the scripts cache.",
b"KILL",
b" Kill the currently executing Lua script.",
b"LOAD <script>",
b" Load a script into the scripts cache without executing it.",
b"HELP",
b" Prints this help.",
]
@pytest.mark.min_server("7.1")
@pytest.mark.unsupported_server_types("valkey")
def test_script_help73(r: redis.Redis):
assert raw_command(r, "SCRIPT HELP") == [
b"SCRIPT <subcommand> [<arg> [value] [opt] ...]. Subcommands are:",
b"DEBUG (YES|SYNC|NO)",
b" Set the debug mode for subsequent scripts executed.",
b"EXISTS <sha1> [<sha1> ...]",
b" Return information about the existence of the scripts in the script cache.",
b"FLUSH [ASYNC|SYNC]",
b" Flush the Lua scripts cache. Very dangerous on replicas.",
b" When called without the optional mode argument, the behavior is determined by the",
b" lazyfree-lazy-user-flush configuration directive. Valid modes are:",
b" * ASYNC: Asynchronously flush the scripts cache.",
b" * SYNC: Synchronously flush the scripts cache.",
b"KILL",
b" Kill the currently executing Lua script.",
b"LOAD <script>",
b" Load a script into the scripts cache without executing it.",
b"HELP",
b" Print this help.",
]
@pytest.mark.max_server("7.1")
def test_eval_blpop(r: redis.Redis):
r.rpush("foo", "bar")
with pytest.raises(redis.ResponseError, match="This Redis command is not allowed from script"):
r.eval('return redis.pcall("BLPOP", KEYS[1], 1)', 1, "foo")
def test_eval_set_value_to_arg(r: redis.Redis):
r.eval('redis.call("SET", KEYS[1], ARGV[1])', 1, "foo", "bar")
val = r.get("foo")
assert val == b"bar"
def test_eval_conditional(r: redis.Redis):
lua = """
local val = redis.call("GET", KEYS[1])
if val == ARGV[1] then
redis.call("SET", KEYS[1], ARGV[2])
else
redis.call("SET", KEYS[1], ARGV[1])
end
"""
r.eval(lua, 1, "foo", "bar", "baz")
val = r.get("foo")
assert val == b"bar"
r.eval(lua, 1, "foo", "bar", "baz")
val = r.get("foo")
assert val == b"baz"
def test_eval_table(r: redis.Redis):
lua = """
local a = {}
a[1] = "foo"
a[2] = "bar"
a[17] = "baz"
return a
"""
val = r.eval(lua, 0)
assert val == [b"foo", b"bar"]
def test_eval_table_with_nil(r: redis.Redis):
lua = """
local a = {}
a[1] = "foo"
a[2] = nil
a[3] = "bar"
return a
"""
val = r.eval(lua, 0)
assert val == [b"foo"]
def test_eval_table_with_numbers(r: redis.Redis):
lua = """
local a = {}
a[1] = 42
return a
"""
val = r.eval(lua, 0)
assert val == [42]
def test_eval_nested_table(r: redis.Redis):
lua = """
local a = {}
a[1] = {}
a[1][1] = "foo"
return a
"""
val = r.eval(lua, 0)
assert val == [[b"foo"]]
def test_eval_iterate_over_argv(r: redis.Redis):
lua = """
for i, v in ipairs(ARGV) do
end
return ARGV
"""
val = r.eval(lua, 0, "a", "b", "c")
assert val == [b"a", b"b", b"c"]
def test_eval_iterate_over_keys(r: redis.Redis):
lua = """
for i, v in ipairs(KEYS) do
end
return KEYS
"""
val = r.eval(lua, 2, "a", "b", "c")
assert val == [b"a", b"b"]
def test_eval_mget(r: redis.Redis):
r.set("foo1", "bar1")
r.set("foo2", "bar2")
val = r.eval('return redis.call("mget", "foo1", "foo2")', 2, "foo1", "foo2")
assert val == [b"bar1", b"bar2"]
def test_eval_mget_not_set(r: redis.Redis):
val = r.eval('return redis.call("mget", "foo1", "foo2")', 2, "foo1", "foo2")
assert val == [None, None]
def test_eval_hgetall(r: redis.Redis):
r.hset("foo", "k1", "bar")
r.hset("foo", "k2", "baz")
val = r.eval('return redis.call("hgetall", "foo")', 1, "foo")
sorted_val = sorted([val[:2], val[2:]])
assert sorted_val == [[b"k1", b"bar"], [b"k2", b"baz"]]
def test_eval_hgetall_iterate(r: redis.Redis):
r.hset("foo", "k1", "bar")
r.hset("foo", "k2", "baz")
lua = """
local result = redis.call("hgetall", "foo")
for i, v in ipairs(result) do
end
return result
"""
val = r.eval(lua, 1, "foo")
sorted_val = sorted([val[:2], val[2:]])
assert sorted_val == [[b"k1", b"bar"], [b"k2", b"baz"]]
def test_eval_invalid_command(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval('return redis.call("FOO")', 0)
def test_eval_syntax_error(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval('return "', 0)
def test_eval_runtime_error(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval('error("CRASH")', 0)
def test_eval_more_keys_than_args(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval("return 1", 42)
def test_eval_numkeys_float_string(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval("return KEYS[1]", "0.7", "foo")
def test_eval_numkeys_integer_string(r: redis.Redis):
val = r.eval("return KEYS[1]", "1", "foo")
assert val == b"foo"
def test_eval_numkeys_negative(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval("return KEYS[1]", -1, "foo")
def test_eval_numkeys_float(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval("return KEYS[1]", 0.7, "foo")
def test_eval_global_variable(r: redis.Redis):
# Redis doesn't allow script to define global variables
with pytest.raises(ResponseError):
r.eval("a=10", 0)
def test_eval_global_and_return_ok(r: redis.Redis):
# Redis doesn't allow script to define global variables
with pytest.raises(ResponseError):
r.eval(
"""
a=10
return redis.status_reply("Everything is awesome")
""",
0,
)
def test_eval_convert_number(r: redis.Redis):
# Redis forces all Lua numbers to integer
val = r.eval("return 3.2", 0)
assert val == 3
val = r.eval("return 3.8", 0)
assert val == 3
val = r.eval("return -3.8", 0)
assert val == -3
def test_eval_convert_bool(r: redis.Redis):
# Redis converts true to 1 and false to nil (which redis-py converts to None)
assert r.eval("return false", 0) is None
val = r.eval("return true", 0)
assert val == 1
assert not isinstance(val, bool)
@pytest.mark.max_server("6.2.7")
def test_eval_call_bool6(r: redis.Redis):
# Redis doesn't allow Lua bools to be passed to [p]call
with pytest.raises(redis.ResponseError, match=r"Lua redis\(\) command arguments must be strings or integers"):
r.eval('return redis.call("SET", KEYS[1], true)', 1, "testkey")
@pytest.mark.min_server("7")
@pytest.mark.unsupported_server_types("valkey")
def test_eval_call_bool7_redis(r: redis.Redis):
# Redis doesn't allow Lua bools to be passed to [p]call
with pytest.raises(redis.ResponseError) as exc_info:
r.eval('return redis.call("SET", KEYS[1], true)', 1, "testkey")
assert "Lua redis lib command arguments must be strings or integers" in str(exc_info.value)
@pytest.mark.min_server("7")
@pytest.mark.unsupported_server_types("redis")
def test_eval_call_bool7_valkey(r: redis.Redis):
# Redis doesn't allow Lua bools to be passed to [p]call
with pytest.raises(redis.ResponseError) as exc_info:
r.eval('return redis.call("SET", KEYS[1], true)', 1, "testkey")
assert "Command arguments must be strings or integers script" in str(exc_info.value)
def test_eval_return_error(r: redis.Redis):
with pytest.raises(redis.ResponseError, match="Testing") as exc_info:
r.eval('return {err="Testing"}', 0)
assert isinstance(exc_info.value.args[0], str)
with pytest.raises(redis.ResponseError, match="Testing") as exc_info:
r.eval('return redis.error_reply("Testing")', 0)
assert isinstance(exc_info.value.args[0], str)
def test_eval_return_redis_error(r: redis.Redis):
with pytest.raises(redis.ResponseError) as exc_info:
r.eval('return redis.pcall("BADCOMMAND")', 0)
assert isinstance(exc_info.value.args[0], str)
def test_eval_return_ok(r: redis.Redis):
val = r.eval('return {ok="Testing"}', 0)
assert val == b"Testing"
val = r.eval('return redis.status_reply("Testing")', 0)
assert val == b"Testing"
def test_eval_return_ok_nested(r: redis.Redis):
val = r.eval(
"""
local a = {}
a[1] = {ok="Testing"}
return a
""",
0,
)
assert val == [b"Testing"]
def test_eval_return_ok_wrong_type(r: redis.Redis):
with pytest.raises(redis.ResponseError):
r.eval("return redis.status_reply(123)", 0)
def test_eval_pcall(r: redis.Redis):
val = r.eval(
"""
local a = {}
a[1] = redis.pcall("foo")
return a
""",
0,
)
assert isinstance(val, list)
assert len(val) == 1
assert isinstance(val[0], ResponseError)
def test_eval_pcall_return_value(r: redis.Redis):
with pytest.raises(ResponseError):
r.eval('return redis.pcall("foo")', 0)
def test_eval_delete(r: redis.Redis):
r.set("foo", "bar")
val = r.get("foo")
assert val == b"bar"
val = r.eval('redis.call("DEL", KEYS[1])', 1, "foo")
assert val is None
def test_eval_exists(r: redis.Redis):
val = r.eval('return redis.call("exists", KEYS[1]) == 0', 1, "foo")
assert val == 1
def test_eval_flushdb(r: redis.Redis):
r.set("foo", "bar")
val = r.eval(
"""
local value = redis.call("FLUSHDB");
return type(value) == "table" and value.ok == "OK";
""",
0,
)
assert val == 1
def test_eval_flushall(r, create_connection):
r1 = create_connection(db=2)
r2 = create_connection(db=3)
r1["r1"] = "r1"
r2["r2"] = "r2"
val = r.eval(
"""
local value = redis.call("FLUSHALL");
return type(value) == "table" and value.ok == "OK";
""",
0,
)
assert val == 1
assert "r1" not in r1
assert "r2" not in r2
def test_eval_incrbyfloat(r: redis.Redis):
r.set("foo", 0.5)
val = r.eval(
"""
local value = redis.call("INCRBYFLOAT", KEYS[1], 2.0);
return type(value) == "string" and tonumber(value) == 2.5;
""",
1,
"foo",
)
assert val == 1
def test_eval_lrange(r: redis.Redis):
r.rpush("foo", "a", "b")
val = r.eval(
"""
local value = redis.call("LRANGE", KEYS[1], 0, -1);
return type(value) == "table" and value[1] == "a" and value[2] == "b";
""",
1,
"foo",
)
assert val == 1
def test_eval_ltrim(r: redis.Redis):
r.rpush("foo", "a", "b", "c", "d")
val = r.eval(
"""
local value = redis.call("LTRIM", KEYS[1], 1, 2);
return type(value) == "table" and value.ok == "OK";
""",
1,
"foo",
)
assert val == 1
assert r.lrange("foo", 0, -1) == [b"b", b"c"]
def test_eval_lset(r: redis.Redis):
r.rpush("foo", "a", "b")
val = r.eval(
"""
local value = redis.call("LSET", KEYS[1], 0, "z");
return type(value) == "table" and value.ok == "OK";
""",
1,
"foo",
)
assert val == 1
assert r.lrange("foo", 0, -1) == [b"z", b"b"]
def test_eval_sdiff(r: redis.Redis):
r.sadd("foo", "a", "b", "c", "f", "e", "d")
r.sadd("bar", "b")
val = r.eval(
"""
local value = redis.call("SDIFF", KEYS[1], KEYS[2]);
if type(value) ~= "table" then
return redis.error_reply(type(value) .. ", should be table");
else
return value;
end
""",
2,
"foo",
"bar",
)
# Note: while fakeredis sorts the result when using Lua, this isn't
# actually part of the redis contract (see
# https://github.com/antirez/redis/issues/5538), and for Redis 5 we
# need to sort val to pass the test.
assert sorted(val) == [b"a", b"c", b"d", b"e", b"f"]
def test_script(r: redis.Redis):
script = r.register_script("return ARGV[1]")
result = script(args=[42])
assert result == b"42"
@testtools.fake_only
def test_lua_log(r, caplog):
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 = r.register_script(script)
with caplog.at_level("DEBUG"):
script()
assert caplog.record_tuples == [
(logger.name, logging.DEBUG, "debug"),
(logger.name, logging.INFO, "verbose"),
(logger.name, logging.INFO, "notice"),
(logger.name, logging.WARNING, "warning"),
]
def test_lua_log_no_message(r: redis.Redis):
script = "redis.log(redis.LOG_DEBUG)"
script = r.register_script(script)
with pytest.raises(redis.ResponseError):
script()
@testtools.fake_only
def test_lua_log_different_types(r, caplog):
logger = logging.getLogger("fakeredis")
script = "redis.log(redis.LOG_DEBUG, 'string', 1, true, 3.14, 'string')"
script = r.register_script(script)
with caplog.at_level("DEBUG"):
script()
assert caplog.record_tuples == [(logger.name, logging.DEBUG, "string 1 3.14 string")]
def test_lua_log_wrong_level(r: redis.Redis):
script = "redis.log(10, 'string')"
script = r.register_script(script)
with pytest.raises(redis.ResponseError):
script()
@testtools.fake_only
def test_lua_log_defined_vars(r, caplog):
logger = fakeredis._server.LOGGER
script = """
local var='string'
redis.log(redis.LOG_DEBUG, var)
"""
script = r.register_script(script)
with caplog.at_level("DEBUG"):
script()
assert caplog.record_tuples == [(logger.name, logging.DEBUG, "string")]
def test_hscan_cursors_are_bytes(r: redis.Redis):
r.hset("hkey", "foo", 1)
result = r.eval(
"""
local results = redis.call("HSCAN", KEYS[1], "0")
return results[1]
""",
1,
"hkey",
)
assert result == b"0"
assert isinstance(result, bytes)
@pytest.mark.xfail # TODO
def test_deleting_while_scan(r: redis.Redis):
for i in range(100):
r.set(f"key-{i}", i)
assert len(r.keys()) == 100
script = """
local cursor = 0
local seen = {}
repeat
local result = redis.call('SCAN', cursor)
for _,key in ipairs(result[2]) do
seen[#seen+1] = key
redis.call('DEL', key)
end
cursor = tonumber(result[1])
until cursor == 0
return seen
"""
assert len(r.register_script(script)()) == 100
assert len(r.keys()) == 0
|