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
|
"""test building messages with Session"""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import hmac
import math
import os
import platform
import uuid
import warnings
from datetime import datetime
from unittest import mock
import pytest
import zmq
from dateutil.tz import tzlocal
from tornado import ioloop
from zmq.eventloop.zmqstream import ZMQStream
from jupyter_client import jsonutil
from jupyter_client import session as ss
def _bad_packer(obj):
raise TypeError("I don't work")
def _bad_unpacker(bytes):
raise TypeError("I don't work either")
@pytest.fixture
def no_copy_threshold():
"""Disable zero-copy optimizations in pyzmq >= 17"""
with mock.patch.object(zmq, "COPY_THRESHOLD", 1, create=True):
yield
@pytest.fixture()
def session():
return ss.Session()
@pytest.mark.usefixtures("no_copy_threshold")
class TestSession:
def assertEqual(self, a, b):
assert a == b, (a, b)
def assertTrue(self, a):
assert a, a
def test_msg(self, session):
"""message format"""
msg = session.msg("execute")
thekeys = set("header parent_header metadata content msg_type msg_id".split())
s = set(msg.keys())
self.assertEqual(s, thekeys)
self.assertTrue(isinstance(msg["content"], dict))
self.assertTrue(isinstance(msg["metadata"], dict))
self.assertTrue(isinstance(msg["header"], dict))
self.assertTrue(isinstance(msg["parent_header"], dict))
self.assertTrue(isinstance(msg["msg_id"], str))
self.assertTrue(isinstance(msg["msg_type"], str))
self.assertEqual(msg["header"]["msg_type"], "execute")
self.assertEqual(msg["msg_type"], "execute")
def test_serialize(self, session):
msg = session.msg("execute", content=dict(a=10, b=1.1))
msg_list = session.serialize(msg, ident=b"foo")
ident, msg_list = session.feed_identities(msg_list)
new_msg = session.deserialize(msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], msg["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
# ensure floats don't come out as Decimal:
self.assertEqual(type(new_msg["content"]["b"]), type(msg["content"]["b"]))
def test_default_secure(self, session):
assert isinstance(session.key, bytes)
assert isinstance(session.auth, hmac.HMAC)
def test_send_sync(self, session):
ctx = zmq.Context()
A = ctx.socket(zmq.PAIR)
B = ctx.socket(zmq.PAIR)
A.bind("inproc://test")
B.connect("inproc://test")
msg = session.msg("execute", content=dict(a=10))
session.send(A, msg, ident=b"foo", buffers=[b"bar"])
ident, msg_list = session.feed_identities(B.recv_multipart())
new_msg = session.deserialize(msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], msg["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["buffers"], [b"bar"])
content = msg["content"]
header = msg["header"]
header["msg_id"] = session.msg_id
parent = msg["parent_header"]
metadata = msg["metadata"]
header["msg_type"]
session.send(
A,
None,
content=content,
parent=parent,
header=header,
metadata=metadata,
ident=b"foo",
buffers=[b"bar"],
)
ident, msg_list = session.feed_identities(B.recv_multipart())
new_msg = session.deserialize(msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], header["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["buffers"], [b"bar"])
header["msg_id"] = session.msg_id
session.send(A, msg, ident=b"foo", buffers=[b"bar"])
ident, new_msg = session.recv(B)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], header["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["buffers"], [b"bar"])
# buffers must support the buffer protocol
with pytest.raises(TypeError):
session.send(A, msg, ident=b"foo", buffers=[1])
# buffers must be contiguous
buf = memoryview(os.urandom(16))
with pytest.raises(ValueError):
session.send(A, msg, ident=b"foo", buffers=[buf[::2]])
A.close()
B.close()
ctx.term()
async def test_send(self, session):
ctx = zmq.asyncio.Context()
A = ctx.socket(zmq.PAIR)
B = ctx.socket(zmq.PAIR)
A.bind("inproc://test")
B.connect("inproc://test")
msg = session.msg("execute", content=dict(a=10))
session.send(A, msg, ident=b"foo", buffers=[b"bar"])
ident, msg_list = session.feed_identities(await B.recv_multipart())
new_msg = session.deserialize(msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], msg["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["buffers"], [b"bar"])
content = msg["content"]
header = msg["header"]
header["msg_id"] = session.msg_id
parent = msg["parent_header"]
metadata = msg["metadata"]
header["msg_type"]
session.send(
A,
None,
content=content,
parent=parent,
header=header,
metadata=metadata,
ident=b"foo",
buffers=[b"bar"],
)
ident, msg_list = session.feed_identities(await B.recv_multipart())
new_msg = session.deserialize(msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], header["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["buffers"], [b"bar"])
header["msg_id"] = session.msg_id
session.send(A, msg, ident=b"foo", buffers=[b"bar"])
ident, new_msg = session.recv(B)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_id"], header["msg_id"])
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["buffers"], [b"bar"])
# buffers must support the buffer protocol
with pytest.raises(TypeError):
session.send(A, msg, ident=b"foo", buffers=[1])
# buffers must be contiguous
buf = memoryview(os.urandom(16))
with pytest.raises(ValueError):
session.send(A, msg, ident=b"foo", buffers=[buf[::2]])
A.close()
B.close()
ctx.term()
def test_args(self, session):
"""initialization arguments for Session"""
s = session
self.assertTrue(s.pack is ss.default_packer)
self.assertTrue(s.unpack is ss.default_unpacker)
self.assertEqual(s.username, os.environ.get("USER", "username"))
s = ss.Session()
self.assertEqual(s.username, os.environ.get("USER", "username"))
with pytest.raises(TypeError):
ss.Session(pack="hi")
with pytest.raises(TypeError):
ss.Session(unpack="hi")
u = str(uuid.uuid4())
s = ss.Session(username="carrot", session=u)
self.assertEqual(s.session, u)
self.assertEqual(s.username, "carrot")
@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="Test fails on PyPy")
def test_tracking_sync(self, session):
"""test tracking messages"""
ctx = zmq.Context()
a = ctx.socket(zmq.PAIR)
b = ctx.socket(zmq.PAIR)
a.bind("inproc://test")
b.connect("inproc://test")
s = session
s.copy_threshold = 1
loop = ioloop.IOLoop(make_current=False)
ZMQStream(a, io_loop=loop)
msg = s.send(a, "hello", track=False)
self.assertTrue(msg["tracker"] is ss.DONE)
msg = s.send(a, "hello", track=True)
self.assertTrue(isinstance(msg["tracker"], zmq.MessageTracker))
M = zmq.Message(b"hi there", track=True)
msg = s.send(a, "hello", buffers=[M], track=True)
t = msg["tracker"]
self.assertTrue(isinstance(t, zmq.MessageTracker))
with pytest.raises(zmq.NotDone):
t.wait(0.1)
del M
with pytest.raises(zmq.NotDone):
t.wait(1) # this will raise
a.close()
b.close()
ctx.term()
@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="Test fails on PyPy")
async def test_tracking(self, session):
"""test tracking messages"""
ctx = zmq.asyncio.Context()
a = ctx.socket(zmq.PAIR)
b = ctx.socket(zmq.PAIR)
a.bind("inproc://test")
b.connect("inproc://test")
s = session
s.copy_threshold = 1
loop = ioloop.IOLoop(make_current=False)
msg = s.send(a, "hello", track=False)
self.assertTrue(msg["tracker"] is ss.DONE)
msg = s.send(a, "hello", track=True)
self.assertTrue(isinstance(msg["tracker"], zmq.MessageTracker))
M = zmq.Message(b"hi there", track=True)
msg = s.send(a, "hello", buffers=[M], track=True)
t = msg["tracker"]
self.assertTrue(isinstance(t, zmq.MessageTracker))
with pytest.raises(zmq.NotDone):
t.wait(0.1)
del M
with pytest.raises(zmq.NotDone):
t.wait(1) # this will raise
a.close()
b.close()
ctx.term()
def test_unique_msg_ids(self, session):
"""test that messages receive unique ids"""
ids = set()
for i in range(2**12):
h = session.msg_header("test")
msg_id = h["msg_id"]
self.assertTrue(msg_id not in ids)
ids.add(msg_id)
def test_feed_identities(self, session):
"""scrub the front for zmq IDENTITIES"""
content = dict(code="whoda", stuff=object())
session.msg("execute", content=content)
def test_session_id(self):
session = ss.Session()
# get bs before us
bs = session.bsession
us = session.session
self.assertEqual(us.encode("ascii"), bs)
session = ss.Session()
# get us before bs
us = session.session
bs = session.bsession
self.assertEqual(us.encode("ascii"), bs)
# change propagates:
session.session = "something else"
bs = session.bsession
us = session.session
self.assertEqual(us.encode("ascii"), bs)
session = ss.Session(session="stuff")
# get us before bs
self.assertEqual(session.bsession, session.session.encode("ascii"))
self.assertEqual(b"stuff", session.bsession)
def test_zero_digest_history(self):
session = ss.Session(digest_history_size=0)
for i in range(11):
session._add_digest(uuid.uuid4().bytes)
self.assertEqual(len(session.digest_history), 0)
def test_cull_digest_history(self):
session = ss.Session(digest_history_size=100)
for i in range(100):
session._add_digest(uuid.uuid4().bytes)
self.assertTrue(len(session.digest_history) == 100)
session._add_digest(uuid.uuid4().bytes)
self.assertTrue(len(session.digest_history) == 91)
for i in range(9):
session._add_digest(uuid.uuid4().bytes)
self.assertTrue(len(session.digest_history) == 100)
session._add_digest(uuid.uuid4().bytes)
self.assertTrue(len(session.digest_history) == 91)
def assertIn(self, a, b):
assert a in b
def test_bad_pack(self):
try:
ss.Session(pack=_bad_packer)
except ValueError as e:
self.assertIn("could not serialize", str(e))
self.assertIn("don't work", str(e))
else:
raise ValueError("Should have raised ValueError")
def test_bad_unpack(self):
try:
ss.Session(unpack=_bad_unpacker)
except ValueError as e:
self.assertIn("could not handle output", str(e))
self.assertIn("don't work either", str(e))
else:
raise ValueError("Should have raised ValueError")
def test_bad_packer(self):
try:
ss.Session(packer=__name__ + "._bad_packer")
except ValueError as e:
self.assertIn("could not serialize", str(e))
self.assertIn("don't work", str(e))
else:
raise ValueError("Should have raised ValueError")
def test_bad_unpacker(self):
try:
ss.Session(unpacker=__name__ + "._bad_unpacker")
except ValueError as e:
self.assertIn("could not handle output", str(e))
self.assertIn("don't work either", str(e))
else:
raise ValueError("Should have raised ValueError")
def test_bad_roundtrip(self):
with pytest.raises(ValueError):
ss.Session(unpack=lambda b: 5)
def _datetime_test(self, session):
content = dict(t=ss.utcnow())
metadata = dict(t=ss.utcnow())
p = session.msg("msg")
msg = session.msg("msg", content=content, metadata=metadata, parent=p["header"])
smsg = session.serialize(msg)
msg2 = session.deserialize(session.feed_identities(smsg)[1])
assert isinstance(msg2["header"]["date"], datetime)
self.assertEqual(msg["header"], msg2["header"])
self.assertEqual(msg["parent_header"], msg2["parent_header"])
self.assertEqual(msg["parent_header"], msg2["parent_header"])
assert isinstance(msg["content"]["t"], datetime)
assert isinstance(msg["metadata"]["t"], datetime)
assert isinstance(msg2["content"]["t"], str)
assert isinstance(msg2["metadata"]["t"], str)
self.assertEqual(msg["content"], jsonutil.extract_dates(msg2["content"]))
self.assertEqual(msg["content"], jsonutil.extract_dates(msg2["content"]))
def test_datetimes(self, session):
self._datetime_test(session)
def test_datetimes_pickle(self):
session = ss.Session(packer="pickle")
self._datetime_test(session)
def test_datetimes_msgpack(self):
msgpack = pytest.importorskip("msgpack")
session = ss.Session(
pack=msgpack.packb,
unpack=lambda buf: msgpack.unpackb(buf, raw=False),
)
self._datetime_test(session)
def test_send_raw_sync(self, session):
ctx = zmq.Context()
A = ctx.socket(zmq.PAIR)
B = ctx.socket(zmq.PAIR)
A.bind("inproc://test")
B.connect("inproc://test")
msg = session.msg("execute", content=dict(a=10))
msg_list = [
session.pack(msg[part]) for part in ["header", "parent_header", "metadata", "content"]
]
session.send_raw(A, msg_list, ident=b"foo")
ident, new_msg_list = session.feed_identities(B.recv_multipart())
new_msg = session.deserialize(new_msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
A.close()
B.close()
ctx.term()
async def test_send_raw(self, session):
ctx = zmq.asyncio.Context()
A = ctx.socket(zmq.PAIR)
B = ctx.socket(zmq.PAIR)
A.bind("inproc://test")
B.connect("inproc://test")
msg = session.msg("execute", content=dict(a=10))
msg_list = [
session.pack(msg[part]) for part in ["header", "parent_header", "metadata", "content"]
]
session.send_raw(A, msg_list, ident=b"foo")
ident, new_msg_list = session.feed_identities(B.recv_multipart().result()) # type:ignore
new_msg = session.deserialize(new_msg_list)
self.assertEqual(ident[0], b"foo")
self.assertEqual(new_msg["msg_type"], msg["msg_type"])
self.assertEqual(new_msg["header"], msg["header"])
self.assertEqual(new_msg["parent_header"], msg["parent_header"])
self.assertEqual(new_msg["content"], msg["content"])
self.assertEqual(new_msg["metadata"], msg["metadata"])
A.close()
B.close()
ctx.term()
def test_set_packer(self, session):
s = session
s.packer = "json"
s.unpacker = "json"
def test_clone(self, session):
s = session
s._add_digest("initial")
s2 = s.clone()
assert s2.session == s.session
assert s2.digest_history == s.digest_history
assert s2.digest_history is not s.digest_history
digest = "abcdef"
s._add_digest(digest)
assert digest in s.digest_history
assert digest not in s2.digest_history
def test_squash_unicode():
assert ss.squash_unicode(dict(a="1")) == {b"a": b"1"}
assert ss.squash_unicode(["a", 1]) == [b"a", 1]
assert ss.squash_unicode("hi") == b"hi"
def test_json_packer():
ss.json_packer(dict(a=1))
with pytest.raises(ValueError):
ss.json_packer(dict(a=ss.Session()))
ss.json_packer(dict(a=datetime(2021, 4, 1, 12, tzinfo=tzlocal())))
with warnings.catch_warnings():
warnings.simplefilter("ignore")
ss.json_packer(dict(a=math.inf))
def test_message_cls():
m = ss.Message(dict(a=1))
foo = dict(m) # type:ignore
assert foo["a"] == 1
assert m["a"] == 1, m["a"]
assert "a" in m
assert str(m) == "{'a': 1}"
def test_session_factory():
s = ss.SessionFactory()
s.log.info(str(s.context))
s.context.destroy()
|