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 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
|
from tests import unittest
from botocore import model
from botocore.compat import OrderedDict
from botocore.exceptions import MissingServiceIdError
def test_missing_model_attribute_raises_exception():
# We're using a nose test generator here to cut down
# on the duplication. The property names below
# all have the same test logic.
service_model = model.ServiceModel({'metadata': {'endpointPrefix': 'foo'}})
property_names = ['api_version', 'protocol']
def _test_attribute_raise_exception(attr_name):
try:
getattr(service_model, attr_name)
except model.UndefinedModelAttributeError:
# This is what we expect, so the test passes.
pass
except Exception as e:
raise AssertionError("Expected UndefinedModelAttributeError to "
"be raised, but %s was raised instead" %
(e.__class__))
else:
raise AssertionError(
"Expected UndefinedModelAttributeError to "
"be raised, but no exception was raised for: %s" % attr_name)
for name in property_names:
yield _test_attribute_raise_exception, name
class TestServiceId(unittest.TestCase):
def test_hypenize_replaces_spaces(self):
self.assertEqual(
model.ServiceId('my service').hyphenize(), 'my-service'
)
def test_hyphenize_lower_cases(self):
self.assertEqual(model.ServiceId('MyService').hyphenize(), 'myservice')
class TestServiceModel(unittest.TestCase):
def setUp(self):
self.model = {
'metadata': {'protocol': 'query',
'endpointPrefix': 'endpoint-prefix',
'serviceId': 'MyService'},
'documentation': 'Documentation value',
'operations': {},
'shapes': {
'StringShape': {'type': 'string'}
}
}
self.service_model = model.ServiceModel(self.model)
def test_metadata_available(self):
# You should be able to access the metadata in a service description
# through the service model object.
self.assertEqual(self.service_model.metadata.get('protocol'), 'query')
def test_service_name_can_be_overriden(self):
service_model = model.ServiceModel(self.model,
service_name='myservice')
self.assertEqual(service_model.service_name, 'myservice')
def test_service_name_defaults_to_endpoint_prefix(self):
self.assertEqual(self.service_model.service_name, 'endpoint-prefix')
def test_service_id(self):
self.assertEqual(self.service_model.service_id, 'MyService')
def test_hyphenize_service_id(self):
self.assertEqual(
self.service_model.service_id.hyphenize(), 'myservice')
def test_service_id_does_not_exist(self):
service_model = {
'metadata': {
'protocol': 'query',
'endpointPrefix': 'endpoint-prefix',
},
'documentation': 'Documentation value',
'operations': {},
'shapes': {
'StringShape': {'type': 'string'}
}
}
service_name = 'myservice'
service_model = model.ServiceModel(service_model, service_name)
with self.assertRaisesRegexp(model.UndefinedModelAttributeError,
service_name):
service_model.service_id
def test_operation_does_not_exist(self):
with self.assertRaises(model.OperationNotFoundError):
self.service_model.operation_model('NoExistOperation')
def test_signing_name_defaults_to_endpoint_prefix(self):
self.assertEqual(self.service_model.signing_name, 'endpoint-prefix')
def test_documentation_exposed_as_property(self):
self.assertEqual(self.service_model.documentation,
'Documentation value')
def test_shape_names(self):
self.assertEqual(self.service_model.shape_names, ['StringShape'])
def test_repr_has_service_name(self):
self.assertEqual(repr(self.service_model),
'ServiceModel(endpoint-prefix)')
class TestOperationModelFromService(unittest.TestCase):
def setUp(self):
self.model = {
'metadata': {'protocol': 'query', 'endpointPrefix': 'foo'},
'documentation': '',
'operations': {
'OperationName': {
'http': {
'method': 'POST',
'requestUri': '/',
},
'name': 'OperationName',
'input': {
'shape': 'OperationNameRequest'
},
'output': {
'shape': 'OperationNameResponse',
},
'errors': [{'shape': 'NoSuchResourceException'}],
'documentation': 'Docs for OperationName',
'authtype': 'v4'
},
'OperationTwo': {
'http': {
'method': 'POST',
'requestUri': '/',
},
'name': 'OperationTwo',
'input': {
'shape': 'OperationNameRequest'
},
'output': {
'shape': 'OperationNameResponse',
},
'errors': [{'shape': 'NoSuchResourceException'}],
'documentation': 'Docs for OperationTwo',
}
},
'shapes': {
'OperationNameRequest': {
'type': 'structure',
'members': {
'Arg1': {'shape': 'stringType'},
'Arg2': {'shape': 'stringType'},
}
},
'OperationNameResponse': {
'type': 'structure',
'members': {
'String': {
'shape': 'stringType',
}
}
},
'NoSuchResourceException': {
'type': 'structure',
'members': {}
},
'stringType': {
'type': 'string',
}
}
}
self.service_model = model.ServiceModel(self.model)
def test_wire_name_always_matches_model(self):
service_model = model.ServiceModel(self.model)
operation = model.OperationModel(
self.model['operations']['OperationName'], service_model, 'Foo')
self.assertEqual(operation.name, 'Foo')
self.assertEqual(operation.wire_name, 'OperationName')
def test_operation_name_in_repr(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertIn('OperationName', repr(operation))
def test_name_and_wire_name_defaults_to_same_value(self):
service_model = model.ServiceModel(self.model)
operation = model.OperationModel(
self.model['operations']['OperationName'], service_model)
self.assertEqual(operation.name, 'OperationName')
self.assertEqual(operation.wire_name, 'OperationName')
def test_name_from_service(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertEqual(operation.name, 'OperationName')
def test_name_from_service_model_when_differs_from_name(self):
self.model['operations']['Foo'] = \
self.model['operations']['OperationName']
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('Foo')
self.assertEqual(operation.name, 'Foo')
def test_operation_input_model(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertEqual(operation.name, 'OperationName')
# Operations should also have a reference to the top level metadata.
self.assertEqual(operation.metadata['protocol'], 'query')
self.assertEqual(operation.http['method'], 'POST')
self.assertEqual(operation.http['requestUri'], '/')
shape = operation.input_shape
self.assertEqual(shape.name, 'OperationNameRequest')
self.assertEqual(list(sorted(shape.members)), ['Arg1', 'Arg2'])
def test_has_documentation_property(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertEqual(operation.documentation, 'Docs for OperationName')
def test_service_model_available_from_operation_model(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
# This is an identity comparison because we don't implement
# __eq__, so we may need to change this in the future.
self.assertEqual(
operation.service_model, service_model)
def test_operation_output_model(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
output = operation.output_shape
self.assertEqual(list(output.members), ['String'])
self.assertFalse(operation.has_streaming_output)
def test_operation_shape_not_required(self):
# It's ok if there's no output shape. We'll just get a return value of
# None.
del self.model['operations']['OperationName']['output']
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
output_shape = operation.output_shape
self.assertIsNone(output_shape)
def test_error_shapes(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
# OperationName only has a NoSuchResourceException
self.assertEqual(len(operation.error_shapes), 1)
self.assertEqual(
operation.error_shapes[0].name, 'NoSuchResourceException')
def test_has_auth_type(self):
operation = self.service_model.operation_model('OperationName')
self.assertEqual(operation.auth_type, 'v4')
def test_auth_type_not_set(self):
operation = self.service_model.operation_model('OperationTwo')
self.assertIsNone(operation.auth_type)
def test_deprecated_present(self):
self.model['operations']['OperationName']['deprecated'] = True
service_model = model.ServiceModel(self.model)
operation_name = service_model.operation_model('OperationName')
self.assertTrue(operation_name.deprecated)
def test_deprecated_present_false(self):
self.model['operations']['OperationName']['deprecated'] = False
service_model = model.ServiceModel(self.model)
operation_name = service_model.operation_model('OperationName')
self.assertFalse(operation_name.deprecated)
def test_deprecated_absent(self):
service_model = model.ServiceModel(self.model)
operation_two = service_model.operation_model('OperationTwo')
self.assertFalse(operation_two.deprecated)
def test_endpoint_operation_present(self):
self.model['operations']['OperationName']['endpointoperation'] = True
service_model = model.ServiceModel(self.model)
operation_name = service_model.operation_model('OperationName')
self.assertTrue(operation_name.is_endpoint_discovery_operation)
def test_endpoint_operation_present_false(self):
self.model['operations']['OperationName']['endpointoperation'] = False
service_model = model.ServiceModel(self.model)
operation_name = service_model.operation_model('OperationName')
self.assertFalse(operation_name.is_endpoint_discovery_operation)
def test_endpoint_operation_absent(self):
operation_two = self.service_model.operation_model('OperationName')
self.assertFalse(operation_two.is_endpoint_discovery_operation)
def test_endpoint_discovery_present(self):
operation = self.model['operations']['OperationName']
operation['endpointdiscovery'] = {'required': True}
service_model = model.ServiceModel(self.model)
operation_name = service_model.operation_model('OperationName')
self.assertTrue(operation_name.endpoint_discovery.get('required'))
def test_endpoint_discovery_absent(self):
operation_name = self.service_model.operation_model('OperationName')
self.assertIsNone(operation_name.endpoint_discovery)
class TestOperationModelEventStreamTypes(unittest.TestCase):
def setUp(self):
super(TestOperationModelEventStreamTypes, self).setUp()
self.model = {
'metadata': {'protocol': 'rest-xml', 'endpointPrefix': 'foo'},
'documentation': '',
'operations': {
'OperationName': {
'http': {
'method': 'POST',
'requestUri': '/',
},
'name': 'OperationName',
'input': {'shape': 'OperationRequest'},
'output': {'shape': 'OperationResponse'},
}
},
'shapes': {
'NormalStructure': {
'type': 'structure',
'members': {
'Input': {'shape': 'StringType'}
}
},
'OperationRequest': {
'type': 'structure',
'members': {
'String': {'shape': 'StringType'},
"Body": {'shape': 'EventStreamStructure'}
},
'payload': 'Body'
},
'OperationResponse': {
'type': 'structure',
'members': {
'String': {'shape': 'StringType'},
"Body": {'shape': 'EventStreamStructure'}
},
'payload': 'Body'
},
'StringType': {'type': 'string'},
'BlobType': {'type': 'blob'},
'EventStreamStructure': {
'eventstream': True,
'type': 'structure',
'members': {
'EventA': {'shape': 'EventAStructure'},
'EventB': {'shape': 'EventBStructure'}
}
},
'EventAStructure': {
'event': True,
'type': 'structure',
'members': {
'Payload': {
'shape': 'BlobType',
'eventpayload': True
},
'Header': {
'shape': 'StringType',
'eventheader': True
}
}
},
'EventBStructure': {
'event': True,
'type': 'structure',
'members': {
'Records': {'shape': 'StringType'}
}
}
}
}
def update_operation(self, **kwargs):
operation = self.model['operations']['OperationName']
operation.update(kwargs)
def test_event_stream_input_for_operation(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertTrue(operation.has_event_stream_input)
event_stream_input = operation.get_event_stream_input()
self.assertEqual(event_stream_input.name, 'EventStreamStructure')
def test_no_event_stream_input_for_operation(self):
self.update_operation(input={'shape': 'NormalStructure'})
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertFalse(operation.has_event_stream_input)
self.assertEqual(operation.get_event_stream_input(), None)
def test_event_stream_output_for_operation(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertTrue(operation.has_event_stream_output)
output = operation.get_event_stream_output()
self.assertEqual(output.name, 'EventStreamStructure')
def test_no_event_stream_output_for_operation(self):
self.update_operation(output={'shape': 'NormalStructure'})
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertFalse(operation.has_event_stream_output)
self.assertEqual(operation.get_event_stream_output(), None)
def test_no_output_shape(self):
self.update_operation(output=None)
del self.model['operations']['OperationName']['output']
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertFalse(operation.has_event_stream_output)
self.assertEqual(operation.get_event_stream_output(), None)
class TestOperationModelStreamingTypes(unittest.TestCase):
def setUp(self):
super(TestOperationModelStreamingTypes, self).setUp()
self.model = {
'metadata': {'protocol': 'query', 'endpointPrefix': 'foo'},
'documentation': '',
'operations': {
'OperationName': {
'name': 'OperationName',
'input': {
'shape': 'OperationRequest',
},
'output': {
'shape': 'OperationResponse',
},
}
},
'shapes': {
'OperationRequest': {
'type': 'structure',
'members': {
'String': {
'shape': 'stringType',
},
"Body": {
'shape': 'blobType',
}
},
'payload': 'Body'
},
'OperationResponse': {
'type': 'structure',
'members': {
'String': {
'shape': 'stringType',
},
"Body": {
'shape': 'blobType',
}
},
'payload': 'Body'
},
'stringType': {
'type': 'string',
},
'blobType': {
'type': 'blob'
}
}
}
def remove_payload(self, type):
self.model['shapes']['Operation' + type].pop('payload')
def test_streaming_input_for_operation(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertTrue(operation.has_streaming_input)
self.assertEqual(operation.get_streaming_input().name, 'blobType')
def test_not_streaming_input_for_operation(self):
self.remove_payload('Request')
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertFalse(operation.has_streaming_input)
self.assertEqual(operation.get_streaming_input(), None)
def test_streaming_output_for_operation(self):
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertTrue(operation.has_streaming_output)
self.assertEqual(operation.get_streaming_output().name, 'blobType')
def test_not_streaming_output_for_operation(self):
self.remove_payload('Response')
service_model = model.ServiceModel(self.model)
operation = service_model.operation_model('OperationName')
self.assertFalse(operation.has_streaming_output)
self.assertEqual(operation.get_streaming_output(), None)
class TestDeepMerge(unittest.TestCase):
def setUp(self):
self.shapes = {
'SetQueueAttributes': {
'type': 'structure',
'members': {
'MapExample': {'shape': 'StrToStrMap',
'locationName': 'Attribute'},
}
},
'SetQueueAttributes2': {
'type': 'structure',
'members': {
'MapExample': {'shape': 'StrToStrMap',
'locationName': 'Attribute2'},
}
},
'StrToStrMap': {
'type': 'map',
'key': {'shape': 'StringType', 'locationName': 'Name'},
'value': {'shape': 'StringType', 'locationName': 'Value'},
'flattened': True,
'name': 'NotAttribute',
},
'StringType': {'type': 'string'}
}
self.shape_resolver = model.ShapeResolver(self.shapes)
def test_deep_merge(self):
shape = self.shape_resolver.get_shape_by_name('SetQueueAttributes')
map_merged = shape.members['MapExample']
# map_merged has a serialization as a member trait as well as
# in the StrToStrMap.
# The member trait should have precedence.
self.assertEqual(map_merged.serialization,
# member beats the definition.
{'name': 'Attribute',
# From the definition.
'flattened': True,})
# Ensure we don't merge/mutate the original dicts.
self.assertEqual(map_merged.key.serialization['name'], 'Name')
self.assertEqual(map_merged.value.serialization['name'], 'Value')
self.assertEqual(map_merged.key.serialization['name'], 'Name')
def test_merges_copy_dict(self):
shape = self.shape_resolver.get_shape_by_name('SetQueueAttributes')
map_merged = shape.members['MapExample']
self.assertEqual(map_merged.serialization.get('name'), 'Attribute')
shape2 = self.shape_resolver.get_shape_by_name('SetQueueAttributes2')
map_merged2 = shape2.members['MapExample']
self.assertEqual(map_merged2.serialization.get('name'), 'Attribute2')
class TestShapeResolver(unittest.TestCase):
def test_get_shape_by_name(self):
shape_map = {
'Foo': {
'type': 'structure',
'members': {
'Bar': {'shape': 'StringType'},
'Baz': {'shape': 'StringType'},
}
},
"StringType": {
"type": "string"
}
}
resolver = model.ShapeResolver(shape_map)
shape = resolver.get_shape_by_name('Foo')
self.assertEqual(shape.name, 'Foo')
self.assertEqual(shape.type_name, 'structure')
def test_resolve_shape_reference(self):
shape_map = {
'Foo': {
'type': 'structure',
'members': {
'Bar': {'shape': 'StringType'},
'Baz': {'shape': 'StringType'},
}
},
"StringType": {
"type": "string"
}
}
resolver = model.ShapeResolver(shape_map)
shape = resolver.resolve_shape_ref({'shape': 'StringType'})
self.assertEqual(shape.name, 'StringType')
self.assertEqual(shape.type_name, 'string')
def test_resolve_shape_references_with_member_traits(self):
shape_map = {
'Foo': {
'type': 'structure',
'members': {
'Bar': {'shape': 'StringType'},
'Baz': {'shape': 'StringType', 'locationName': 'other'},
}
},
"StringType": {
"type": "string"
}
}
resolver = model.ShapeResolver(shape_map)
shape = resolver.resolve_shape_ref({'shape': 'StringType',
'locationName': 'other'})
self.assertEqual(shape.serialization['name'], 'other')
self.assertEqual(shape.name, 'StringType')
def test_serialization_cache(self):
shape_map = {
'Foo': {
'type': 'structure',
'members': {
'Baz': {'shape': 'StringType', 'locationName': 'other'},
}
},
"StringType": {
"type": "string"
}
}
resolver = model.ShapeResolver(shape_map)
shape = resolver.resolve_shape_ref({'shape': 'StringType',
'locationName': 'other'})
self.assertEqual(shape.serialization['name'], 'other')
# serialization is computed on demand, and a cache is kept.
# This is just verifying that trying to access serialization again
# gives the same result. We don't actually care that it's cached,
# we just care that the cache doesn't mess with correctness.
self.assertEqual(shape.serialization['name'], 'other')
def test_shape_overrides(self):
shape_map = {
"StringType": {
"type": "string",
"documentation": "Original documentation"
}
}
resolver = model.ShapeResolver(shape_map)
shape = resolver.get_shape_by_name('StringType')
self.assertEqual(shape.documentation, 'Original documentation')
shape = resolver.resolve_shape_ref({'shape': 'StringType',
'documentation': 'override'})
self.assertEqual(shape.documentation, 'override')
def test_shape_type_structure(self):
shapes = {
'ChangePasswordRequest': {
'type': 'structure',
'members': {
'OldPassword': {'shape': 'passwordType'},
'NewPassword': {'shape': 'passwordType'},
}
},
'passwordType': {
"type":"string",
}
}
resolver = model.ShapeResolver(shapes)
shape = resolver.get_shape_by_name('ChangePasswordRequest')
self.assertEqual(shape.type_name, 'structure')
self.assertEqual(shape.name, 'ChangePasswordRequest')
self.assertEqual(list(sorted(shape.members)),
['NewPassword', 'OldPassword'])
self.assertEqual(shape.members['OldPassword'].name, 'passwordType')
self.assertEqual(shape.members['OldPassword'].type_name, 'string')
def test_shape_metadata(self):
shapes = {
'ChangePasswordRequest': {
'type': 'structure',
'required': ['OldPassword', 'NewPassword'],
'members': {
'OldPassword': {'shape': 'passwordType'},
'NewPassword': {'shape': 'passwordType'},
}
},
'passwordType': {
"type":"string",
"min":1,
"max":128,
"sensitive":True
}
}
resolver = model.ShapeResolver(shapes)
shape = resolver.get_shape_by_name('ChangePasswordRequest')
self.assertEqual(shape.metadata['required'],
['OldPassword', 'NewPassword'])
member = shape.members['OldPassword']
self.assertEqual(member.metadata['min'], 1)
self.assertEqual(member.metadata['max'], 128)
self.assertEqual(member.metadata['sensitive'], True)
def test_shape_list(self):
shapes = {
'mfaDeviceListType': {
"type":"list",
"member": {"shape": "MFADevice"},
},
'MFADevice': {
'type': 'structure',
'members': {
'UserName': {'shape': 'userNameType'}
}
},
'userNameType': {
'type': 'string'
}
}
resolver = model.ShapeResolver(shapes)
shape = resolver.get_shape_by_name('mfaDeviceListType')
self.assertEqual(shape.member.type_name, 'structure')
self.assertEqual(shape.member.name, 'MFADevice')
self.assertEqual(list(shape.member.members), ['UserName'])
def test_shape_does_not_exist(self):
resolver = model.ShapeResolver({})
with self.assertRaises(model.NoShapeFoundError):
resolver.get_shape_by_name('NoExistShape')
def test_missing_type_key(self):
shapes = {
'UnknownType': {
'NotTheTypeKey': 'someUnknownType'
}
}
resolver = model.ShapeResolver(shapes)
with self.assertRaises(model.InvalidShapeError):
resolver.get_shape_by_name('UnknownType')
def test_bad_shape_ref(self):
# This is an example of a denormalized model,
# which should raise an exception.
shapes = {
'Struct': {
'type': 'structure',
'members': {
'A': {'type': 'string'},
'B': {'type': 'string'},
}
}
}
resolver = model.ShapeResolver(shapes)
with self.assertRaises(model.InvalidShapeReferenceError):
struct = resolver.get_shape_by_name('Struct')
# Resolving the members will fail because
# the 'A' and 'B' members are not shape refs.
struct.members
def test_shape_name_in_repr(self):
shapes = {
'StringType': {
'type': 'string',
}
}
resolver = model.ShapeResolver(shapes)
self.assertIn('StringType',
repr(resolver.get_shape_by_name('StringType')))
class TestBuilders(unittest.TestCase):
def test_structure_shape_builder_with_scalar_types(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {'type': 'string'},
'B': {'type': 'integer'},
}).build_model()
self.assertIsInstance(shape, model.StructureShape)
self.assertEqual(sorted(list(shape.members)), ['A', 'B'])
self.assertEqual(shape.members['A'].type_name, 'string')
self.assertEqual(shape.members['B'].type_name, 'integer')
def test_structure_shape_with_structure_type(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'structure',
'members': {
'A-1': {'type': 'string'},
}
},
}).build_model()
self.assertIsInstance(shape, model.StructureShape)
self.assertEqual(list(shape.members), ['A'])
self.assertEqual(shape.members['A'].type_name, 'structure')
self.assertEqual(list(shape.members['A'].members), ['A-1'])
def test_structure_shape_with_list(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'list',
'member': {
'type': 'string'
}
},
}).build_model()
self.assertIsInstance(shape.members['A'], model.ListShape)
self.assertEqual(shape.members['A'].member.type_name, 'string')
def test_structure_shape_with_map_type(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'map',
'key': {'type': 'string'},
'value': {'type': 'string'},
}
}).build_model()
self.assertIsInstance(shape.members['A'], model.MapShape)
map_shape = shape.members['A']
self.assertEqual(map_shape.key.type_name, 'string')
self.assertEqual(map_shape.value.type_name, 'string')
def test_nested_structure(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'structure',
'members': {
'B': {
'type': 'structure',
'members': {
'C': {
'type': 'string',
}
}
}
}
}
}).build_model()
self.assertEqual(
shape.members['A'].members['B'].members['C'].type_name, 'string')
def test_enum_values_on_string_used(self):
b = model.DenormalizedStructureBuilder()
enum_values = ['foo', 'bar', 'baz']
shape = b.with_members({
'A': {
'type': 'string',
'enum': enum_values,
},
}).build_model()
self.assertIsInstance(shape, model.StructureShape)
string_shape = shape.members['A']
self.assertIsInstance(string_shape, model.StringShape)
self.assertEqual(string_shape.metadata['enum'], enum_values)
self.assertEqual(string_shape.enum, enum_values)
def test_documentation_on_shape_used(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'string',
'documentation': 'MyDocs',
},
}).build_model()
self.assertEqual(shape.members['A'].documentation,
'MyDocs')
def test_use_shape_name_when_provided(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members({
'A': {
'type': 'string',
'shape_name': 'MyStringShape',
},
}).build_model()
self.assertEqual(shape.members['A'].name, 'MyStringShape')
def test_unknown_shape_type(self):
b = model.DenormalizedStructureBuilder()
with self.assertRaises(model.InvalidShapeError):
b.with_members({
'A': {
'type': 'brand-new-shape-type',
},
}).build_model()
def test_ordered_shape_builder(self):
b = model.DenormalizedStructureBuilder()
shape = b.with_members(OrderedDict(
[
('A', {
'type': 'string'
}),
('B', {
'type': 'structure',
'members': OrderedDict(
[
('C', {
'type': 'string'
}),
('D', {
'type': 'string'
})
]
)
})
]
)).build_model()
# Members should be in order
self.assertEqual(['A', 'B'], list(shape.members.keys()))
# Nested structure members should *also* stay ordered
self.assertEqual(['C', 'D'], list(shape.members['B'].members.keys()))
if __name__ == '__main__':
unittest.main()
|