Skip to content

Instantly share code, notes, and snippets.

@danielgtaylor

danielgtaylor/git diff

Created October 15, 2014 23:22
Download ZIP

Revisions

  1. danielgtaylor created this gist Oct 15, 2014.
    201 changes: 201 additions & 0 deletions git diff
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,201 @@
    diff --git a/tests/unit/resources/test_factory.py b/tests/unit/resources/test_factory.py
    index 544ee61..2ef49c3 100644
    --- a/tests/unit/resources/test_factory.py
    +++ b/tests/unit/resources/test_factory.py
    @@ -41,7 +41,7 @@ class TestResourceFactory(BaseTestCase):
    self.factory.create_class('test')

    self.assertTrue(self.factory.load_from_definition.called,
    - 'Class was not loaded from definition')
    + 'Class was not loaded from definition')
    self.factory.load_from_definition.assert_called_with(
    'test', 'test', {}, {}, None)

    @@ -52,7 +52,7 @@ class TestResourceFactory(BaseTestCase):
    self.factory.create_class('test', 'Queue')

    self.assertTrue(self.factory.load_from_definition.called,
    - 'Class was not loaded from definition')
    + 'Class was not loaded from definition')
    self.factory.load_from_definition.assert_called_with(
    'test', 'Queue', {}, {}, None)

    @@ -60,19 +60,20 @@ class TestResourceFactory(BaseTestCase):
    TestResource = self.load('test', 'test', {}, {}, None)

    self.assertIn(ServiceResource, TestResource.__bases__,
    - 'Did not return a ServiceResource subclass for service')
    + 'Did not return a ServiceResource subclass for service')

    def test_get_resource_returns_resource_class(self):
    QueueResource = self.load('test', 'Queue', {}, {}, None)

    self.assertIn(ServiceResource, QueueResource.__bases__,
    - 'Did not return a ServiceResource subclass for resource')
    + 'Did not return a ServiceResource subclass for'
    + ' resource')

    def test_factory_sets_service_name(self):
    QueueResource = self.load('test', 'Queue', {}, {}, None)

    self.assertEqual(QueueResource.meta['service_name'], 'test',
    - 'Service name not set')
    + 'Service name not set')

    def test_factory_sets_identifiers(self):
    model = {
    @@ -85,36 +86,11 @@ class TestResourceFactory(BaseTestCase):
    MessageResource = self.load('test', 'Message', model, {}, None)

    self.assertTrue('identifiers' in MessageResource.meta,
    - 'Class has no identifiers')
    + 'Class has no identifiers')
    self.assertIn('queue_url', MessageResource.meta['identifiers'],
    - 'Missing queue_url identifier from model')
    + 'Missing queue_url identifier from model')
    self.assertIn('receipt_handle', MessageResource.meta['identifiers'],
    - 'Missing receipt_handle identifier from model')
    -
    - def test_identifiers_in_repr(self):
    - model = {
    - 'identifiers': [
    - {'name': 'QueueUrl'},
    - {'name': 'ReceiptHandle'},
    - ],
    - }
    - defs = {
    - 'Message': model
    - }
    -
    - resource = self.load('test', 'Message', model, defs, None)('url', 'handle')
    -
    - self.assertIn('test.Message', repr(resource),
    - 'Resource name should be in repr')
    -
    - self.assertIn('queue_url', repr(resource),
    - 'QueueUrl identifier name should be in repr')
    - self.assertIn("'url'", repr(resource),
    - 'QueueUrl identifier value should be in repr')
    - self.assertIn('receipt_handle', repr(resource),
    - 'ReceiptHandle identifier name should be in repr')
    - self.assertIn("'handle'", repr(resource),
    - 'ReceiptHandle identifier value should be in repr')
    + 'Missing receipt_handle identifier from model')

    def test_factory_creates_dangling_resources(self):
    defs = {
    @@ -125,9 +101,9 @@ class TestResourceFactory(BaseTestCase):
    TestResource = self.load('test', 'test', {}, defs, None)

    self.assertTrue(hasattr(TestResource, 'Queue'),
    - 'Missing Queue class from model')
    + 'Missing Queue class from model')
    self.assertTrue(hasattr(TestResource, 'Message'),
    - 'Missing Message class from model')
    + 'Missing Message class from model')

    def test_factory_creates_properties(self):
    model = {
    @@ -149,9 +125,9 @@ class TestResourceFactory(BaseTestCase):
    TestResource = self.load('test', 'test', model, {}, service_model)

    self.assertTrue(hasattr(TestResource, 'e_tag'),
    - 'ETag shape member not available on resource')
    + 'ETag shape member not available on resource')
    self.assertTrue(hasattr(TestResource, 'last_modified'),
    - 'LastModified shape member not available on resource')
    + 'LastModified shape member not available on resource')

    def test_factory_fails_on_clobber_identifier(self):
    model = {
    @@ -188,7 +164,7 @@ class TestResourceFactory(BaseTestCase):
    resource = TestResource()

    self.assertIsInstance(resource, ServiceResource,
    - 'Object is not an instance of ServiceResource')
    + 'Object is not an instance of ServiceResource')

    def test_dangling_resources_create_resource_instance(self):
    defs = {
    @@ -203,7 +179,8 @@ class TestResourceFactory(BaseTestCase):
    q = resource.Queue('test')

    self.assertIsInstance(q, ServiceResource,
    - 'Dangling resource instance not a ServiceResource')
    + 'Dangling resource instance not a'
    + ' ServiceResource')

    def test_dangling_resource_create_with_kwarg(self):
    defs = {
    @@ -218,7 +195,8 @@ class TestResourceFactory(BaseTestCase):
    q = resource.Queue(url='test')

    self.assertIsInstance(q, ServiceResource,
    - 'Dangling resource created with kwargs is not a ServiceResource')
    + 'Dangling resource created with kwargs is not'
    + 'a ServiceResource')

    def test_dangling_resource_shares_client(self):
    defs = {
    @@ -233,7 +211,8 @@ class TestResourceFactory(BaseTestCase):
    q = resource.Queue('test')

    self.assertEqual(resource.meta['client'], q.meta['client'],
    - 'Client was not shared to dangling resource instance')
    + 'Client was not shared to dangling resource'
    + ' instance')

    def test_dangling_resource_requires_identifier(self):
    defs = {
    @@ -315,9 +294,11 @@ class TestResourceFactory(BaseTestCase):
    message = queue.Message('receipt')

    self.assertEqual(message.queue_url, 'url',
    - 'Wrong queue URL set on the message resource instance')
    + 'Wrong queue URL set on the message resource'
    + ' instance')
    self.assertEqual(message.receipt_handle, 'receipt',
    - 'Wrong receipt handle set on the message resource instance')
    + 'Wrong receipt handle set on the message resource'
    + ' instance')

    def test_resource_meta_unique(self):
    queue_cls = self.load('test', 'Queue', {}, {}, None)
    @@ -328,15 +309,16 @@ class TestResourceFactory(BaseTestCase):
    self.assertNotEqual(queue1, queue2)

    self.assertEqual(queue1.meta, queue2.meta,
    - 'Queue meta copies not equal after creation')
    + 'Queue meta copies not equal after creation')

    queue1.meta['data'] = {'id': 'foo'}
    queue2.meta['data'] = {'id': 'bar'}

    self.assertNotEqual(queue_cls.meta, queue1.meta,
    - 'Modified queue instance data should not modify the class data')
    + 'Modified queue instance data should not modify'
    + ' the class data')
    self.assertNotEqual(queue1.meta, queue2.meta,
    - 'Queue data should be unique to queue instance')
    + 'Queue data should be unique to queue instance')

    @mock.patch('boto3.resources.factory.ServiceAction')
    def test_resource_calls_action(self, action_cls):
    @@ -391,7 +373,7 @@ class TestResourceFactory(BaseTestCase):

    # Accessing a property should call load
    self.assertEqual(resource.e_tag, 'tag',
    - 'ETag property returned wrong value')
    + 'ETag property returned wrong value')
    action.assert_called_once()

    # Both params should have been loaded into the data bag
    @@ -401,7 +383,7 @@ class TestResourceFactory(BaseTestCase):
    # Accessing another property should use cached value
    # instead of making a second call.
    self.assertEqual(resource.last_modified, 'never',
    - 'LastModified property returned wrong value')
    + 'LastModified property returned wrong value')
    action.assert_called_once()

    @mock.patch('boto3.resources.factory.ServiceAction')
    414 changes: 414 additions & 0 deletions test_factory.py
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,414 @@
    # Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    #
    # Licensed under the Apache License, Version 2.0 (the 'License'). You
    # may not use this file except in compliance with the License. A copy of
    # the License is located at
    #
    # http://aws.amazon.com/apache2.0/
    #
    # or in the 'license' file accompanying this file. This file is
    # distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
    # ANY KIND, either express or implied. See the License for the specific
    # language governing permissions and limitations under the License.

    from boto3.resources.base import ServiceResource
    from boto3.exceptions import ResourceLoadException
    from boto3.resources.factory import ResourceFactory
    from tests import BaseTestCase, mock


    class TestResourceFactory(BaseTestCase):
    def setUp(self):
    super(TestResourceFactory, self).setUp()
    self.factory = ResourceFactory()
    self.load = self.factory.load_from_definition

    # Don't do version lookups on the filesystem, instead always return
    # a set date and mock calls to ``open`` when required.
    self.version_patch = mock.patch(
    'boto3.resources.factory.get_latest_version')
    self.version_mock = self.version_patch.start()
    self.version_mock.return_value = '2014-01-01'

    def tearDown(self):
    super(TestResourceFactory, self).tearDown()
    self.version_patch.stop()

    def test_create_service_calls_load(self):
    self.factory.load_from_definition = mock.Mock()
    with mock.patch('boto3.resources.factory.open',
    mock.mock_open(read_data='{}'), create=True):
    self.factory.create_class('test')

    self.assertTrue(self.factory.load_from_definition.called,
    'Class was not loaded from definition')
    self.factory.load_from_definition.assert_called_with(
    'test', 'test', {}, {}, None)

    def test_create_resource_calls_load(self):
    self.factory.load_from_definition = mock.Mock()
    with mock.patch('boto3.resources.factory.open',
    mock.mock_open(read_data='{}'), create=True):
    self.factory.create_class('test', 'Queue')

    self.assertTrue(self.factory.load_from_definition.called,
    'Class was not loaded from definition')
    self.factory.load_from_definition.assert_called_with(
    'test', 'Queue', {}, {}, None)

    def test_get_service_returns_resource_class(self):
    TestResource = self.load('test', 'test', {}, {}, None)

    self.assertIn(ServiceResource, TestResource.__bases__,
    'Did not return a ServiceResource subclass for service')

    def test_get_resource_returns_resource_class(self):
    QueueResource = self.load('test', 'Queue', {}, {}, None)

    self.assertIn(ServiceResource, QueueResource.__bases__,
    'Did not return a ServiceResource subclass for'
    ' resource')

    def test_factory_sets_service_name(self):
    QueueResource = self.load('test', 'Queue', {}, {}, None)

    self.assertEqual(QueueResource.meta['service_name'], 'test',
    'Service name not set')

    def test_factory_sets_identifiers(self):
    model = {
    'identifiers': [
    {'name': 'QueueUrl'},
    {'name': 'ReceiptHandle'},
    ],
    }

    MessageResource = self.load('test', 'Message', model, {}, None)

    self.assertTrue('identifiers' in MessageResource.meta,
    'Class has no identifiers')
    self.assertIn('queue_url', MessageResource.meta['identifiers'],
    'Missing queue_url identifier from model')
    self.assertIn('receipt_handle', MessageResource.meta['identifiers'],
    'Missing receipt_handle identifier from model')

    def test_factory_creates_dangling_resources(self):
    defs = {
    'Queue': {},
    'Message': {}
    }

    TestResource = self.load('test', 'test', {}, defs, None)

    self.assertTrue(hasattr(TestResource, 'Queue'),
    'Missing Queue class from model')
    self.assertTrue(hasattr(TestResource, 'Message'),
    'Missing Message class from model')

    def test_factory_creates_properties(self):
    model = {
    'shape': 'TestShape',
    'load': {
    'request': {
    'operation': 'DescribeTest',
    }
    }
    }
    shape = mock.Mock()
    shape.members = {
    'ETag': None,
    'LastModified': None,
    }
    service_model = mock.Mock()
    service_model.shape_for.return_value = shape

    TestResource = self.load('test', 'test', model, {}, service_model)

    self.assertTrue(hasattr(TestResource, 'e_tag'),
    'ETag shape member not available on resource')
    self.assertTrue(hasattr(TestResource, 'last_modified'),
    'LastModified shape member not available on resource')

    def test_factory_fails_on_clobber_identifier(self):
    model = {
    'identifiers': [
    {'name': 'Meta'}
    ]
    }

    # This fails because each resource has a `meta` defined.
    with self.assertRaises(ValueError):
    self.load('test', 'test', model, {}, None)

    def test_factory_fails_on_clobber_action(self):
    model = {
    'identifiers': [
    {'name': 'Test'}
    ],
    'actions': {
    'Test': {
    'request': {
    'operation': 'GetTest'
    }
    }
    }
    }

    # This fails because the resource has an identifier
    # that would be clobbered by the action name.
    with self.assertRaises(ValueError):
    self.load('test', 'test', model, {}, None)

    def test_can_instantiate_service_resource(self):
    TestResource = self.load('test', 'test', {}, {}, None)
    resource = TestResource()

    self.assertIsInstance(resource, ServiceResource,
    'Object is not an instance of ServiceResource')

    def test_dangling_resources_create_resource_instance(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    }
    }

    resource = self.load('test', 'test', {}, defs, None)()
    q = resource.Queue('test')

    self.assertIsInstance(q, ServiceResource,
    'Dangling resource instance not a'
    ' ServiceResource')

    def test_dangling_resource_create_with_kwarg(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    }
    }

    resource = self.load('test', 'test', {}, defs, None)()
    q = resource.Queue(url='test')

    self.assertIsInstance(q, ServiceResource,
    'Dangling resource created with kwargs is not'
    'a ServiceResource')

    def test_dangling_resource_shares_client(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    }
    }

    resource = self.load('test', 'test', {}, defs, None)()
    q = resource.Queue('test')

    self.assertEqual(resource.meta['client'], q.meta['client'],
    'Client was not shared to dangling resource'
    ' instance')

    def test_dangling_resource_requires_identifier(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    }
    }

    resource = self.load('test', 'test', {}, defs, None)()

    with self.assertRaises(ValueError):
    resource.Queue()

    def test_dangling_resource_raises_for_unknown_arg(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    }
    }

    resource = self.load('test', 'test', {}, defs, None)()

    with self.assertRaises(ValueError):
    resource.Queue(url='foo', bar='baz')

    def test_non_service_resource_missing_defs(self):
    # Only services should get dangling defs
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ]
    },
    'Message': {
    'identifiers': [
    {'name': 'QueueUrl'},
    {'name': 'ReceiptHandle'}
    ]
    }
    }

    model = defs['Queue']

    queue = self.load('test', 'Queue', model, defs, None)('url')

    self.assertTrue(not hasattr(queue, 'Queue'))
    self.assertTrue(not hasattr(queue, 'Message'))

    def test_subresource_requires_only_identifier(self):
    defs = {
    'Queue': {
    'identifiers': [
    {'name': 'Url'}
    ],
    'subResources': {
    'resources': ['Message'],
    'identifiers': {'Url': 'QueueUrl'}
    }
    },
    'Message': {
    'identifiers': [
    {'name': 'QueueUrl'},
    {'name': 'ReceiptHandle'}
    ]
    }
    }

    model = defs['Queue']

    queue = self.load('test', 'Queue', model, defs, None)('url')

    # Let's create a message and only give it a receipt handle
    # The required queue_url identifier should be set from the
    # queue itself.
    message = queue.Message('receipt')

    self.assertEqual(message.queue_url, 'url',
    'Wrong queue URL set on the message resource'
    ' instance')
    self.assertEqual(message.receipt_handle, 'receipt',
    'Wrong receipt handle set on the message resource'
    ' instance')

    def test_resource_meta_unique(self):
    queue_cls = self.load('test', 'Queue', {}, {}, None)

    queue1 = queue_cls()
    queue2 = queue_cls()

    self.assertNotEqual(queue1, queue2)

    self.assertEqual(queue1.meta, queue2.meta,
    'Queue meta copies not equal after creation')

    queue1.meta['data'] = {'id': 'foo'}
    queue2.meta['data'] = {'id': 'bar'}

    self.assertNotEqual(queue_cls.meta, queue1.meta,
    'Modified queue instance data should not modify'
    ' the class data')
    self.assertNotEqual(queue1.meta, queue2.meta,
    'Queue data should be unique to queue instance')

    @mock.patch('boto3.resources.factory.ServiceAction')
    def test_resource_calls_action(self, action_cls):
    model = {
    'actions': {
    'GetMessageStatus': {
    'request': {
    'operation': 'DescribeMessageStatus'
    }
    }
    }
    }

    action = action_cls.return_value

    queue = self.load('test', 'Queue', model, {}, None)()
    queue.get_message_status('arg1', arg2=2)

    action.assert_called_with(queue, 'arg1', arg2=2)

    @mock.patch('boto3.resources.factory.ServiceAction')
    def test_resource_lazy_loads_properties(self, action_cls):
    model = {
    'shape': 'TestShape',
    'identifiers': [
    {'name': 'Url'}
    ],
    'load': {
    'request': {
    'operation': 'DescribeTest',
    }
    }
    }
    shape = mock.Mock()
    shape.members = {
    'Url': None,
    'ETag': None,
    'LastModified': None,
    }
    service_model = mock.Mock()
    service_model.shape_for.return_value = shape

    action = action_cls.return_value
    action.return_value = {'ETag': 'tag', 'LastModified': 'never'}

    resource = self.load('test', 'test', model, {}, service_model)('url')

    # Accessing an identifier should not call load, even if it's in
    # the shape members.
    resource.url
    action.assert_not_called()

    # Accessing a property should call load
    self.assertEqual(resource.e_tag, 'tag',
    'ETag property returned wrong value')
    action.assert_called_once()

    # Both params should have been loaded into the data bag
    self.assertIn('ETag', resource.meta['data'])
    self.assertIn('LastModified', resource.meta['data'])

    # Accessing another property should use cached value
    # instead of making a second call.
    self.assertEqual(resource.last_modified, 'never',
    'LastModified property returned wrong value')
    action.assert_called_once()

    @mock.patch('boto3.resources.factory.ServiceAction')
    def test_resource_lazy_properties_missing_load(self, action_cls):
    model = {
    'shape': 'TestShape',
    'identifiers': [
    {'name': 'Url'}
    ]
    # Note the lack of a `load` method. These resources
    # are usually loaded via a call on a parent resource.
    }
    shape = mock.Mock()
    shape.members = {
    'Url': None,
    'ETag': None,
    'LastModified': None,
    }
    service_model = mock.Mock()
    service_model.shape_for.return_value = shape

    action = action_cls.return_value
    action.return_value = {'ETag': 'tag', 'LastModified': 'never'}

    resource = self.load('test', 'test', model, {}, service_model)('url')

    with self.assertRaises(ResourceLoadException):
    resource.last_modified