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 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
|
import json
import sys
from dataclasses import dataclass
from datetime import (
datetime,
timedelta,
)
from inspect import (
Parameter,
signature,
)
from typing import (
Dict,
List,
Optional,
)
from unittest.mock import ANY
import pytest
import aristaproto
def test_has_field():
@dataclass
class Bar(aristaproto.Message):
baz: int = aristaproto.int32_field(1)
@dataclass
class Foo(aristaproto.Message):
bar: Bar = aristaproto.message_field(1)
# Unset by default
foo = Foo()
assert aristaproto.serialized_on_wire(foo.bar) is False
# Serialized after setting something
foo.bar.baz = 1
assert aristaproto.serialized_on_wire(foo.bar) is True
# Still has it after setting the default value
foo.bar.baz = 0
assert aristaproto.serialized_on_wire(foo.bar) is True
# Manual override (don't do this)
foo.bar._serialized_on_wire = False
assert aristaproto.serialized_on_wire(foo.bar) is False
# Can manually set it but defaults to false
foo.bar = Bar()
assert aristaproto.serialized_on_wire(foo.bar) is False
@dataclass
class WithCollections(aristaproto.Message):
test_list: List[str] = aristaproto.string_field(1)
test_map: Dict[str, str] = aristaproto.map_field(
2, aristaproto.TYPE_STRING, aristaproto.TYPE_STRING
)
# Is always set from parse, even if all collections are empty
with_collections_empty = WithCollections().parse(bytes(WithCollections()))
assert aristaproto.serialized_on_wire(with_collections_empty) is True
with_collections_list = WithCollections().parse(
bytes(WithCollections(test_list=["a", "b", "c"]))
)
assert aristaproto.serialized_on_wire(with_collections_list) is True
with_collections_map = WithCollections().parse(
bytes(WithCollections(test_map={"a": "b", "c": "d"}))
)
assert aristaproto.serialized_on_wire(with_collections_map) is True
def test_class_init():
@dataclass
class Bar(aristaproto.Message):
name: str = aristaproto.string_field(1)
@dataclass
class Foo(aristaproto.Message):
name: str = aristaproto.string_field(1)
child: Bar = aristaproto.message_field(2)
foo = Foo(name="foo", child=Bar(name="bar"))
assert foo.to_dict() == {"name": "foo", "child": {"name": "bar"}}
assert foo.to_pydict() == {"name": "foo", "child": {"name": "bar"}}
def test_enum_as_int_json():
class TestEnum(aristaproto.Enum):
ZERO = 0
ONE = 1
@dataclass
class Foo(aristaproto.Message):
bar: TestEnum = aristaproto.enum_field(1)
# JSON strings are supported, but ints should still be supported too.
foo = Foo().from_dict({"bar": 1})
assert foo.bar == TestEnum.ONE
# Plain-ol'-ints should serialize properly too.
foo.bar = 1
assert foo.to_dict() == {"bar": "ONE"}
# Similar expectations for pydict
foo = Foo().from_pydict({"bar": 1})
assert foo.bar == TestEnum.ONE
assert foo.to_pydict() == {"bar": TestEnum.ONE}
def test_unknown_fields():
@dataclass
class Newer(aristaproto.Message):
foo: bool = aristaproto.bool_field(1)
bar: int = aristaproto.int32_field(2)
baz: str = aristaproto.string_field(3)
@dataclass
class Older(aristaproto.Message):
foo: bool = aristaproto.bool_field(1)
newer = Newer(foo=True, bar=1, baz="Hello")
serialized_newer = bytes(newer)
# Unknown fields in `Newer` should round trip with `Older`
round_trip = bytes(Older().parse(serialized_newer))
assert serialized_newer == round_trip
new_again = Newer().parse(round_trip)
assert newer == new_again
def test_oneof_support():
@dataclass
class Sub(aristaproto.Message):
val: int = aristaproto.int32_field(1)
@dataclass
class Foo(aristaproto.Message):
bar: int = aristaproto.int32_field(1, group="group1")
baz: str = aristaproto.string_field(2, group="group1")
sub: Sub = aristaproto.message_field(3, group="group2")
abc: str = aristaproto.string_field(4, group="group2")
foo = Foo()
assert aristaproto.which_one_of(foo, "group1")[0] == ""
foo.bar = 1
foo.baz = "test"
# Other oneof fields should now be unset
assert not hasattr(foo, "bar")
assert object.__getattribute__(foo, "bar") == aristaproto.PLACEHOLDER
assert aristaproto.which_one_of(foo, "group1")[0] == "baz"
foo.sub = Sub(val=1)
assert aristaproto.serialized_on_wire(foo.sub)
foo.abc = "test"
# Group 1 shouldn't be touched, group 2 should have reset
assert not hasattr(foo, "sub")
assert object.__getattribute__(foo, "sub") == aristaproto.PLACEHOLDER
assert aristaproto.which_one_of(foo, "group2")[0] == "abc"
# Zero value should always serialize for one-of
foo = Foo(bar=0)
assert aristaproto.which_one_of(foo, "group1")[0] == "bar"
assert bytes(foo) == b"\x08\x00"
# Round trip should also work
foo2 = Foo().parse(bytes(foo))
assert aristaproto.which_one_of(foo2, "group1")[0] == "bar"
assert foo.bar == 0
assert aristaproto.which_one_of(foo2, "group2")[0] == ""
@pytest.mark.skipif(
sys.version_info < (3, 10),
reason="pattern matching is only supported in python3.10+",
)
def test_oneof_pattern_matching():
from .oneof_pattern_matching import test_oneof_pattern_matching
test_oneof_pattern_matching()
def test_json_casing():
@dataclass
class CasingTest(aristaproto.Message):
pascal_case: int = aristaproto.int32_field(1)
camel_case: int = aristaproto.int32_field(2)
snake_case: int = aristaproto.int32_field(3)
kabob_case: int = aristaproto.int32_field(4)
# Parsing should accept almost any input
test = CasingTest().from_dict(
{"PascalCase": 1, "camelCase": 2, "snake_case": 3, "kabob-case": 4}
)
assert test == CasingTest(1, 2, 3, 4)
# Serializing should be strict.
assert json.loads(test.to_json()) == {
"pascalCase": 1,
"camelCase": 2,
"snakeCase": 3,
"kabobCase": 4,
}
assert json.loads(test.to_json(casing=aristaproto.Casing.SNAKE)) == {
"pascal_case": 1,
"camel_case": 2,
"snake_case": 3,
"kabob_case": 4,
}
def test_dict_casing():
@dataclass
class CasingTest(aristaproto.Message):
pascal_case: int = aristaproto.int32_field(1)
camel_case: int = aristaproto.int32_field(2)
snake_case: int = aristaproto.int32_field(3)
kabob_case: int = aristaproto.int32_field(4)
# Parsing should accept almost any input
test = CasingTest().from_dict(
{"PascalCase": 1, "camelCase": 2, "snake_case": 3, "kabob-case": 4}
)
assert test == CasingTest(1, 2, 3, 4)
# Serializing should be strict.
assert test.to_dict() == {
"pascalCase": 1,
"camelCase": 2,
"snakeCase": 3,
"kabobCase": 4,
}
assert test.to_pydict() == {
"pascalCase": 1,
"camelCase": 2,
"snakeCase": 3,
"kabobCase": 4,
}
assert test.to_dict(casing=aristaproto.Casing.SNAKE) == {
"pascal_case": 1,
"camel_case": 2,
"snake_case": 3,
"kabob_case": 4,
}
assert test.to_pydict(casing=aristaproto.Casing.SNAKE) == {
"pascal_case": 1,
"camel_case": 2,
"snake_case": 3,
"kabob_case": 4,
}
def test_optional_flag():
@dataclass
class Request(aristaproto.Message):
flag: Optional[bool] = aristaproto.message_field(1, wraps=aristaproto.TYPE_BOOL)
# Serialization of not passed vs. set vs. zero-value.
assert bytes(Request()) == b""
assert bytes(Request(flag=True)) == b"\n\x02\x08\x01"
assert bytes(Request(flag=False)) == b"\n\x00"
# Differentiate between not passed and the zero-value.
assert Request().parse(b"").flag is None
assert Request().parse(b"\n\x00").flag is False
def test_optional_datetime_to_dict():
@dataclass
class Request(aristaproto.Message):
date: Optional[datetime] = aristaproto.message_field(1, optional=True)
# Check dict serialization
assert Request().to_dict() == {}
assert Request().to_dict(include_default_values=True) == {"date": None}
assert Request(date=datetime(2020, 1, 1)).to_dict() == {
"date": "2020-01-01T00:00:00Z"
}
assert Request(date=datetime(2020, 1, 1)).to_dict(include_default_values=True) == {
"date": "2020-01-01T00:00:00Z"
}
# Check pydict serialization
assert Request().to_pydict() == {}
assert Request().to_pydict(include_default_values=True) == {"date": None}
assert Request(date=datetime(2020, 1, 1)).to_pydict() == {
"date": datetime(2020, 1, 1)
}
assert Request(date=datetime(2020, 1, 1)).to_pydict(
include_default_values=True
) == {"date": datetime(2020, 1, 1)}
def test_to_json_default_values():
@dataclass
class TestMessage(aristaproto.Message):
some_int: int = aristaproto.int32_field(1)
some_double: float = aristaproto.double_field(2)
some_str: str = aristaproto.string_field(3)
some_bool: bool = aristaproto.bool_field(4)
# Empty dict
test = TestMessage().from_dict({})
assert json.loads(test.to_json(include_default_values=True)) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
# All default values
test = TestMessage().from_dict(
{"someInt": 0, "someDouble": 0.0, "someStr": "", "someBool": False}
)
assert json.loads(test.to_json(include_default_values=True)) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
def test_to_dict_default_values():
@dataclass
class TestMessage(aristaproto.Message):
some_int: int = aristaproto.int32_field(1)
some_double: float = aristaproto.double_field(2)
some_str: str = aristaproto.string_field(3)
some_bool: bool = aristaproto.bool_field(4)
# Empty dict
test = TestMessage().from_dict({})
assert test.to_dict(include_default_values=True) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
test = TestMessage().from_pydict({})
assert test.to_pydict(include_default_values=True) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
# All default values
test = TestMessage().from_dict(
{"someInt": 0, "someDouble": 0.0, "someStr": "", "someBool": False}
)
assert test.to_dict(include_default_values=True) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
test = TestMessage().from_pydict(
{"someInt": 0, "someDouble": 0.0, "someStr": "", "someBool": False}
)
assert test.to_pydict(include_default_values=True) == {
"someInt": 0,
"someDouble": 0.0,
"someStr": "",
"someBool": False,
}
# Some default and some other values
@dataclass
class TestMessage2(aristaproto.Message):
some_int: int = aristaproto.int32_field(1)
some_double: float = aristaproto.double_field(2)
some_str: str = aristaproto.string_field(3)
some_bool: bool = aristaproto.bool_field(4)
some_default_int: int = aristaproto.int32_field(5)
some_default_double: float = aristaproto.double_field(6)
some_default_str: str = aristaproto.string_field(7)
some_default_bool: bool = aristaproto.bool_field(8)
test = TestMessage2().from_dict(
{
"someInt": 2,
"someDouble": 1.2,
"someStr": "hello",
"someBool": True,
"someDefaultInt": 0,
"someDefaultDouble": 0.0,
"someDefaultStr": "",
"someDefaultBool": False,
}
)
assert test.to_dict(include_default_values=True) == {
"someInt": 2,
"someDouble": 1.2,
"someStr": "hello",
"someBool": True,
"someDefaultInt": 0,
"someDefaultDouble": 0.0,
"someDefaultStr": "",
"someDefaultBool": False,
}
test = TestMessage2().from_pydict(
{
"someInt": 2,
"someDouble": 1.2,
"someStr": "hello",
"someBool": True,
"someDefaultInt": 0,
"someDefaultDouble": 0.0,
"someDefaultStr": "",
"someDefaultBool": False,
}
)
assert test.to_pydict(include_default_values=True) == {
"someInt": 2,
"someDouble": 1.2,
"someStr": "hello",
"someBool": True,
"someDefaultInt": 0,
"someDefaultDouble": 0.0,
"someDefaultStr": "",
"someDefaultBool": False,
}
# Nested messages
@dataclass
class TestChildMessage(aristaproto.Message):
some_other_int: int = aristaproto.int32_field(1)
@dataclass
class TestParentMessage(aristaproto.Message):
some_int: int = aristaproto.int32_field(1)
some_double: float = aristaproto.double_field(2)
some_message: TestChildMessage = aristaproto.message_field(3)
test = TestParentMessage().from_dict({"someInt": 0, "someDouble": 1.2})
assert test.to_dict(include_default_values=True) == {
"someInt": 0,
"someDouble": 1.2,
"someMessage": {"someOtherInt": 0},
}
test = TestParentMessage().from_pydict({"someInt": 0, "someDouble": 1.2})
assert test.to_pydict(include_default_values=True) == {
"someInt": 0,
"someDouble": 1.2,
"someMessage": {"someOtherInt": 0},
}
def test_to_dict_datetime_values():
@dataclass
class TestDatetimeMessage(aristaproto.Message):
bar: datetime = aristaproto.message_field(1)
baz: timedelta = aristaproto.message_field(2)
test = TestDatetimeMessage().from_dict(
{"bar": "2020-01-01T00:00:00Z", "baz": "86400.000s"}
)
assert test.to_dict() == {"bar": "2020-01-01T00:00:00Z", "baz": "86400.000s"}
test = TestDatetimeMessage().from_pydict(
{"bar": datetime(year=2020, month=1, day=1), "baz": timedelta(days=1)}
)
assert test.to_pydict() == {
"bar": datetime(year=2020, month=1, day=1),
"baz": timedelta(days=1),
}
def test_oneof_default_value_set_causes_writes_wire():
@dataclass
class Empty(aristaproto.Message):
pass
@dataclass
class Foo(aristaproto.Message):
bar: int = aristaproto.int32_field(1, group="group1")
baz: str = aristaproto.string_field(2, group="group1")
qux: Empty = aristaproto.message_field(3, group="group1")
def _round_trip_serialization(foo: Foo) -> Foo:
return Foo().parse(bytes(foo))
foo1 = Foo(bar=0)
foo2 = Foo(baz="")
foo3 = Foo(qux=Empty())
foo4 = Foo()
assert bytes(foo1) == b"\x08\x00"
assert (
aristaproto.which_one_of(foo1, "group1")
== aristaproto.which_one_of(_round_trip_serialization(foo1), "group1")
== ("bar", 0)
)
assert bytes(foo2) == b"\x12\x00" # Baz is just an empty string
assert (
aristaproto.which_one_of(foo2, "group1")
== aristaproto.which_one_of(_round_trip_serialization(foo2), "group1")
== ("baz", "")
)
assert bytes(foo3) == b"\x1a\x00"
assert (
aristaproto.which_one_of(foo3, "group1")
== aristaproto.which_one_of(_round_trip_serialization(foo3), "group1")
== ("qux", Empty())
)
assert bytes(foo4) == b""
assert (
aristaproto.which_one_of(foo4, "group1")
== aristaproto.which_one_of(_round_trip_serialization(foo4), "group1")
== ("", None)
)
def test_message_repr():
from tests.output_aristaproto.recursivemessage import Test
assert repr(Test(name="Loki")) == "Test(name='Loki')"
assert repr(Test(child=Test(), name="Loki")) == "Test(name='Loki', child=Test())"
def test_bool():
"""Messages should evaluate similarly to a collection
>>> test = []
>>> bool(test)
... False
>>> test.append(1)
>>> bool(test)
... True
>>> del test[0]
>>> bool(test)
... False
"""
@dataclass
class Falsy(aristaproto.Message):
pass
@dataclass
class Truthy(aristaproto.Message):
bar: int = aristaproto.int32_field(1)
assert not Falsy()
t = Truthy()
assert not t
t.bar = 1
assert t
t.bar = 0
assert not t
# valid ISO datetimes according to https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
iso_candidates = """2009-12-12T12:34
2009
2009-05-19
2009-05-19
20090519
2009123
2009-05
2009-123
2009-222
2009-001
2009-W01-1
2009-W51-1
2009-W33
2009W511
2009-05-19
2009-05-19 00:00
2009-05-19 14
2009-05-19 14:31
2009-05-19 14:39:22
2009-05-19T14:39Z
2009-W21-2
2009-W21-2T01:22
2009-139
2009-05-19 14:39:22-06:00
2009-05-19 14:39:22+0600
2009-05-19 14:39:22-01
20090621T0545Z
2007-04-06T00:00
2007-04-05T24:00
2010-02-18T16:23:48.5
2010-02-18T16:23:48,444
2010-02-18T16:23:48,3-06:00
2010-02-18T16:23:00.4
2010-02-18T16:23:00,25
2010-02-18T16:23:00.33+0600
2010-02-18T16:00:00.23334444
2010-02-18T16:00:00,2283
2009-05-19 143922
2009-05-19 1439""".split("\n")
def test_iso_datetime():
@dataclass
class Envelope(aristaproto.Message):
ts: datetime = aristaproto.message_field(1)
msg = Envelope()
for _, candidate in enumerate(iso_candidates):
msg.from_dict({"ts": candidate})
assert isinstance(msg.ts, datetime)
def test_iso_datetime_list():
@dataclass
class Envelope(aristaproto.Message):
timestamps: List[datetime] = aristaproto.message_field(1)
msg = Envelope()
msg.from_dict({"timestamps": iso_candidates})
assert all([isinstance(item, datetime) for item in msg.timestamps])
def test_service_argument__expected_parameter():
from tests.output_aristaproto.service import TestStub
sig = signature(TestStub.do_thing)
do_thing_request_parameter = sig.parameters["do_thing_request"]
assert do_thing_request_parameter.default is Parameter.empty
assert do_thing_request_parameter.annotation == "DoThingRequest"
def test_is_set():
@dataclass
class Spam(aristaproto.Message):
foo: bool = aristaproto.bool_field(1)
bar: Optional[int] = aristaproto.int32_field(2, optional=True)
assert not Spam().is_set("foo")
assert not Spam().is_set("bar")
assert Spam(foo=True).is_set("foo")
assert Spam(foo=True, bar=0).is_set("bar")
def test_equality_comparison():
from tests.output_aristaproto.bool import Test as TestMessage
msg = TestMessage(value=True)
assert msg == msg
assert msg == ANY
assert msg == TestMessage(value=True)
assert msg != 1
assert msg != TestMessage(value=False)
|