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
|
from contextlib import closing
from unittest import mock
import pytest
import redis
from .conftest import skip_if_server_version_lt, wait_for_command
class TestPipeline:
def test_pipeline_is_true(self, r):
"Ensure pipeline instances are not false-y"
with r.pipeline() as pipe:
assert pipe
def test_pipeline(self, r):
with r.pipeline() as pipe:
(
pipe.set("a", "a1")
.get("a")
.zadd("z", {"z1": 1})
.zadd("z", {"z2": 4})
.zincrby("z", 1, "z1")
)
assert pipe.execute() == [
True,
b"a1",
True,
True,
2.0,
]
def test_pipeline_memoryview(self, r):
with r.pipeline() as pipe:
(pipe.set("a", memoryview(b"a1")).get("a"))
assert pipe.execute() == [True, b"a1"]
def test_pipeline_length(self, r):
with r.pipeline() as pipe:
# Initially empty.
assert len(pipe) == 0
# Fill 'er up!
pipe.set("a", "a1").set("b", "b1").set("c", "c1")
assert len(pipe) == 3
# Execute calls reset(), so empty once again.
pipe.execute()
assert len(pipe) == 0
def test_pipeline_no_transaction(self, r):
with r.pipeline(transaction=False) as pipe:
pipe.set("a", "a1").set("b", "b1").set("c", "c1")
assert pipe.execute() == [True, True, True]
assert r["a"] == b"a1"
assert r["b"] == b"b1"
assert r["c"] == b"c1"
@pytest.mark.onlynoncluster
def test_pipeline_no_transaction_watch(self, r):
r["a"] = 0
with r.pipeline(transaction=False) as pipe:
pipe.watch("a")
a = pipe.get("a")
pipe.multi()
pipe.set("a", int(a) + 1)
assert pipe.execute() == [True]
@pytest.mark.onlynoncluster
def test_pipeline_no_transaction_watch_failure(self, r):
r["a"] = 0
with r.pipeline(transaction=False) as pipe:
pipe.watch("a")
a = pipe.get("a")
r["a"] = "bad"
pipe.multi()
pipe.set("a", int(a) + 1)
with pytest.raises(redis.WatchError):
pipe.execute()
assert r["a"] == b"bad"
def test_exec_error_in_response(self, r):
"""
an invalid pipeline command at exec time adds the exception instance
to the list of returned values
"""
r["c"] = "a"
with r.pipeline() as pipe:
pipe.set("a", 1).set("b", 2).lpush("c", 3).set("d", 4)
result = pipe.execute(raise_on_error=False)
assert result[0]
assert r["a"] == b"1"
assert result[1]
assert r["b"] == b"2"
# we can't lpush to a key that's a string value, so this should
# be a ResponseError exception
assert isinstance(result[2], redis.ResponseError)
assert r["c"] == b"a"
# since this isn't a transaction, the other commands after the
# error are still executed
assert result[3]
assert r["d"] == b"4"
# make sure the pipe was restored to a working state
assert pipe.set("z", "zzz").execute() == [True]
assert r["z"] == b"zzz"
def test_exec_error_raised(self, r):
r["c"] = "a"
with r.pipeline() as pipe:
pipe.set("a", 1).set("b", 2).lpush("c", 3).set("d", 4)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
assert str(ex.value).startswith(
"Command # 3 (LPUSH c 3) of pipeline caused error: "
)
# make sure the pipe was restored to a working state
assert pipe.set("z", "zzz").execute() == [True]
assert r["z"] == b"zzz"
@pytest.mark.onlynoncluster
def test_transaction_with_empty_error_command(self, r):
"""
Commands with custom EMPTY_ERROR functionality return their default
values in the pipeline no matter the raise_on_error preference
"""
for error_switch in (True, False):
with r.pipeline() as pipe:
pipe.set("a", 1).mget([]).set("c", 3)
result = pipe.execute(raise_on_error=error_switch)
assert result[0]
assert result[1] == []
assert result[2]
@pytest.mark.onlynoncluster
def test_pipeline_with_empty_error_command(self, r):
"""
Commands with custom EMPTY_ERROR functionality return their default
values in the pipeline no matter the raise_on_error preference
"""
for error_switch in (True, False):
with r.pipeline(transaction=False) as pipe:
pipe.set("a", 1).mget([]).set("c", 3)
result = pipe.execute(raise_on_error=error_switch)
assert result[0]
assert result[1] == []
assert result[2]
def test_parse_error_raised(self, r):
with r.pipeline() as pipe:
# the zrem is invalid because we don't pass any keys to it
pipe.set("a", 1).zrem("b").set("b", 2)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
assert str(ex.value).startswith(
"Command # 2 (ZREM b) of pipeline caused error: "
)
# make sure the pipe was restored to a working state
assert pipe.set("z", "zzz").execute() == [True]
assert r["z"] == b"zzz"
@pytest.mark.onlynoncluster
def test_parse_error_raised_transaction(self, r):
with r.pipeline() as pipe:
pipe.multi()
# the zrem is invalid because we don't pass any keys to it
pipe.set("a", 1).zrem("b").set("b", 2)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
assert str(ex.value).startswith(
"Command # 2 (ZREM b) of pipeline caused error: "
)
# make sure the pipe was restored to a working state
assert pipe.set("z", "zzz").execute() == [True]
assert r["z"] == b"zzz"
@pytest.mark.onlynoncluster
def test_watch_succeed(self, r):
r["a"] = 1
r["b"] = 2
with r.pipeline() as pipe:
pipe.watch("a", "b")
assert pipe.watching
a_value = pipe.get("a")
b_value = pipe.get("b")
assert a_value == b"1"
assert b_value == b"2"
pipe.multi()
pipe.set("c", 3)
assert pipe.execute() == [True]
assert not pipe.watching
@pytest.mark.onlynoncluster
def test_watch_failure(self, r):
r["a"] = 1
r["b"] = 2
with r.pipeline() as pipe:
pipe.watch("a", "b")
r["b"] = 3
pipe.multi()
pipe.get("a")
with pytest.raises(redis.WatchError):
pipe.execute()
assert not pipe.watching
@pytest.mark.onlynoncluster
def test_watch_failure_in_empty_transaction(self, r):
r["a"] = 1
r["b"] = 2
with r.pipeline() as pipe:
pipe.watch("a", "b")
r["b"] = 3
pipe.multi()
with pytest.raises(redis.WatchError):
pipe.execute()
assert not pipe.watching
@pytest.mark.onlynoncluster
def test_unwatch(self, r):
r["a"] = 1
r["b"] = 2
with r.pipeline() as pipe:
pipe.watch("a", "b")
r["b"] = 3
pipe.unwatch()
assert not pipe.watching
pipe.get("a")
assert pipe.execute() == [b"1"]
@pytest.mark.onlynoncluster
def test_watch_exec_no_unwatch(self, r):
r["a"] = 1
r["b"] = 2
with r.monitor() as m:
with r.pipeline() as pipe:
pipe.watch("a", "b")
assert pipe.watching
a_value = pipe.get("a")
b_value = pipe.get("b")
assert a_value == b"1"
assert b_value == b"2"
pipe.multi()
pipe.set("c", 3)
assert pipe.execute() == [True]
assert not pipe.watching
unwatch_command = wait_for_command(r, m, "UNWATCH")
assert unwatch_command is None, "should not send UNWATCH"
@pytest.mark.onlynoncluster
def test_watch_reset_unwatch(self, r):
r["a"] = 1
with r.monitor() as m:
with r.pipeline() as pipe:
pipe.watch("a")
assert pipe.watching
pipe.reset()
assert not pipe.watching
unwatch_command = wait_for_command(r, m, "UNWATCH")
assert unwatch_command is not None
assert unwatch_command["command"] == "UNWATCH"
@pytest.mark.onlynoncluster
def test_close_is_reset(self, r):
with r.pipeline() as pipe:
called = 0
def mock_reset():
nonlocal called
called += 1
with mock.patch.object(pipe, "reset", mock_reset):
pipe.close()
assert called == 1
@pytest.mark.onlynoncluster
def test_closing(self, r):
with closing(r.pipeline()):
pass
@pytest.mark.onlynoncluster
def test_transaction_callable(self, r):
r["a"] = 1
r["b"] = 2
has_run = []
def my_transaction(pipe):
a_value = pipe.get("a")
assert a_value in (b"1", b"2")
b_value = pipe.get("b")
assert b_value == b"2"
# silly run-once code... incr's "a" so WatchError should be raised
# forcing this all to run again. this should incr "a" once to "2"
if not has_run:
r.incr("a")
has_run.append("it has")
pipe.multi()
pipe.set("c", int(a_value) + int(b_value))
result = r.transaction(my_transaction, "a", "b")
assert result == [True]
assert r["c"] == b"4"
@pytest.mark.onlynoncluster
def test_transaction_callable_returns_value_from_callable(self, r):
def callback(pipe):
# No need to do anything here since we only want the return value
return "a"
res = r.transaction(callback, "my-key", value_from_callable=True)
assert res == "a"
def test_exec_error_in_no_transaction_pipeline(self, r):
r["a"] = 1
with r.pipeline(transaction=False) as pipe:
pipe.llen("a")
pipe.expire("a", 100)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
assert str(ex.value).startswith(
"Command # 1 (LLEN a) of pipeline caused error: "
)
assert r["a"] == b"1"
def test_exec_error_in_no_transaction_pipeline_unicode_command(self, r):
key = chr(3456) + "abcd" + chr(3421)
r[key] = 1
with r.pipeline(transaction=False) as pipe:
pipe.llen(key)
pipe.expire(key, 100)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
expected = f"Command # 1 (LLEN {key}) of pipeline caused error: "
assert str(ex.value).startswith(expected)
assert r[key] == b"1"
def test_exec_error_in_pipeline_truncated(self, r):
key = "a" * 50
a_value = "a" * 20
b_value = "b" * 20
r[key] = 1
with r.pipeline(transaction=False) as pipe:
pipe.hset(key, mapping={"field_a": a_value, "field_b": b_value})
pipe.expire(key, 100)
with pytest.raises(redis.ResponseError) as ex:
pipe.execute()
expected = f"Command # 1 (HSET {key} field_a {a_value} field_b...) of pipeline caused error: "
assert str(ex.value).startswith(expected)
def test_pipeline_with_bitfield(self, r):
with r.pipeline() as pipe:
pipe.set("a", "1")
bf = pipe.bitfield("b")
pipe2 = (
bf.set("u8", 8, 255)
.get("u8", 0)
.get("u4", 8) # 1111
.get("u4", 12) # 1111
.get("u4", 13) # 1110
.execute()
)
pipe.get("a")
response = pipe.execute()
assert pipe == pipe2
assert response == [True, [0, 0, 15, 15, 14], b"1"]
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.0.0")
def test_pipeline_discard(self, r):
# empty pipeline should raise an error
with r.pipeline() as pipe:
pipe.set("key", "someval")
pipe.discard()
with pytest.raises(redis.exceptions.ResponseError):
pipe.execute()
# setting a pipeline and discarding should do the same
with r.pipeline() as pipe:
pipe.set("key", "someval")
pipe.set("someotherkey", "val")
response = pipe.execute()
pipe.set("key", "another value!")
pipe.discard()
pipe.set("key", "another vae!")
with pytest.raises(redis.exceptions.ResponseError):
pipe.execute()
pipe.set("foo", "bar")
response = pipe.execute()
assert response[0]
assert r.get("foo") == b"bar"
@pytest.mark.onlynoncluster
def test_send_set_commands_over_pipeline(self, r: redis.Redis):
pipe = r.pipeline()
pipe.hset("hash:1", "foo", "bar")
pipe.hset("hash:1", "bar", "foo")
pipe.hset("hash:1", "baz", "bar")
pipe.hgetall("hash:1")
resp = pipe.execute()
assert resp == [1, 1, 1, {b"bar": b"foo", b"baz": b"bar", b"foo": b"bar"}]
|