-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add custom create_tag method to ec2 resource #160
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Copyright 2015 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Copyright 2015 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. | ||
|
||
|
||
def inject_create_tags(event_name, class_attributes, **kwargs): | ||
"""This injects a custom create_tags method onto the ec2 service resource | ||
|
||
This is needed because the resource model is not able to express | ||
creating multiple tag resources based on the fact you can apply a set | ||
of tags to multiple ec2 resources. | ||
""" | ||
class_attributes['create_tags'] = create_tags | ||
|
||
|
||
def create_tags(self, **kwargs): | ||
# Call the client method | ||
self.meta.client.create_tags(**kwargs) | ||
resources = kwargs.get('Resources', []) | ||
tags = kwargs.get('Tags', []) | ||
tag_resources = [] | ||
|
||
# Generate all of the tag resources that just were created with the | ||
# preceding client call. | ||
for resource in resources: | ||
for tag in tags: | ||
# Add each tag from the tag set for each resource to the list | ||
# that is returned by the method. | ||
tag_resource = self.Tag(resource, tag['Key'], tag['Value']) | ||
tag_resources.append(tag_resource) | ||
return tag_resources |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Copyright 2015 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 tests import unittest | ||
|
||
import mock | ||
|
||
import boto3.session | ||
|
||
|
||
class TestCreateTagsInjection(unittest.TestCase): | ||
def test_create_tags_injected_to_resource(self): | ||
session = boto3.session.Session(region_name='us-west-2') | ||
with mock.patch('boto3.ec2.createtags.create_tags') as mock_method: | ||
resource = session.resource('ec2') | ||
self.assertTrue(hasattr(resource, 'create_tags'), | ||
'EC2 resource does not have create_tags method.') | ||
self.assertIs(resource.create_tags, mock_method, | ||
'custom create_tags method was not injected onto ' | ||
'EC2 service resource') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Copyright 2015 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Copyright 2015 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 tests import unittest | ||
import mock | ||
|
||
from boto3.ec2 import createtags | ||
|
||
|
||
class TestCreateTags(unittest.TestCase): | ||
def setUp(self): | ||
self.client = mock.Mock() | ||
self.resource = mock.Mock() | ||
self.resource.meta.client = self.client | ||
self.ref_tags = [ | ||
'tag1', | ||
'tag2', | ||
'tag3', | ||
'tag4', | ||
'tag5', | ||
'tag6' | ||
] | ||
self.resource.Tag.side_effect = self.ref_tags | ||
|
||
def test_create_tags(self): | ||
ref_kwargs = { | ||
'Resources': ['foo', 'bar'], | ||
'Tags': [ | ||
{'Key': 'key1', 'Value': 'value1'}, | ||
{'Key': 'key2', 'Value': 'value2'}, | ||
{'Key': 'key3', 'Value': 'value3'} | ||
] | ||
} | ||
|
||
result_tags = createtags.create_tags(self.resource, **ref_kwargs) | ||
|
||
# Ensure the client method was called properly. | ||
self.client.create_tags.assert_called_with(**ref_kwargs) | ||
|
||
# Ensure the calls to the Tag reference were correct. | ||
self.assertEqual( | ||
self.resource.Tag.call_args_list, | ||
[mock.call('foo', 'key1', 'value1'), | ||
mock.call('foo', 'key2', 'value2'), | ||
mock.call('foo', 'key3', 'value3'), | ||
mock.call('bar', 'key1', 'value1'), | ||
mock.call('bar', 'key2', 'value2'), | ||
mock.call('bar', 'key3', 'value3')]) | ||
|
||
# Ensure the return values are as expected. | ||
self.assertEqual(result_tags, self.ref_tags) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels too much like testing implementation details for a functional test. If we move this method or rename it, this test will fail.
If we want something higher level than a unit test, I'd prefer an integration test.