ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

[cloud] New module: AWS Direct Connect connection (#26152)

Browse source 
* New module for AWS Direct Connect connections

Unittests for new module

Added utils that will be used by other Direct Connect modules

* pep8 fixes

* Correct aws_direct_connect_connection EXAMPLES to be valid yaml

* Make requested changes

* remove use of the variable changed

get rid of unnecessary parentheses

* Fix unit test

* Rename variable.

* Fix metadata version
This commit is contained in:
Sloane Hertel 2017-08-23 11:56:19 -04:00 committed by Ryan Brown
parent 1d4ca0fd51
commit 24b49c2539
10 changed files with 621 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

304
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py Normal file
View file

@ -0,0 +1,304 @@
#!/usr/bin/python
# Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = """
---
module: aws_direct_connect_connection
short_description: Creates, deletes, modifies a DirectConnect connection
description:
- Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location.
Upon creation the connection may be added to a link aggregation group or established as a standalone connection.
The connection may later be associated or disassociated with a link aggregation group.
version_added: "2.4"
author: "Sloane Hertel (@s-hertel)"
requirements:
- boto3
- botocore
options:
state:
description:
- The state of the Direct Connect connection.
choices:
- present
- absent
name:
description:
- The name of the Direct Connect connection. This is required to create a
new connection. To recreate or delete a connection I(name) or I(connection_id)
is required.
connection_id:
description:
- The ID of the Direct Connect connection. I(name) or I(connection_id) is
required to recreate or delete a connection. Modifying attributes of a
connection with I(force_update) will result in a new Direct Connect connection ID.
location:
description:
- Where the Direct Connect connection is located. Required when I(state=present).
bandwidth:
description:
- The bandwidth of the Direct Connect connection. Required when I(state=present).
choices:
- 1Gbps
- 10Gbps
link_aggregation_group:
description:
- The ID of the link aggregation group you want to associate with the connection.
This is optional in case a stand-alone connection is desired.
force_update:
description:
- To modify bandwidth or location the connection will need to be deleted and recreated.
By default this will not happen - this option must be set to True.
"""
EXAMPLES = """
# create a Direct Connect connection
aws_direct_connect_connection:
name: ansible-test-connection
state: present
location: EqDC2
link_aggregation_group: dxlag-xxxxxxxx
bandwidth: 1Gbps
register: dc
# disassociate the LAG from the connection
aws_direct_connect_connection:
state: present
connection_id: dc.connection.connection_id
location: EqDC2
bandwidth: 1Gbps
# replace the connection with one with more bandwidth
aws_direct_connect_connection:
state: present
name: ansible-test-connection
location: EqDC2
bandwidth: 10Gbps
force_update: True
# delete the connection
aws_direct_connect_connection:
state: absent
name: ansible-test-connection
"""
RETURN = """
connection:
description:
- The attributes of the Direct Connect connection
type: complex
returned: I(state=present)
contains:
aws_device:
description: The endpoint which the physical connection terminates on.
bandwidth:
description: The bandwidth of the connection.
connection_id:
description: ID of the Direct Connect connection.
connection_state:
description: The state of the connection.
location:
description: Where the connection is located.
owner_account:
description: The owner of the connection.
region:
description: The region in which the connection exists.
"""
import traceback
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ec2 import (camel_dict_to_snake_dict, ec2_argument_spec, HAS_BOTO3,
get_aws_connection_info, boto3_conn, AWSRetry)
from ansible.module_utils.aws.direct_connect import (DirectConnectError, delete_connection,
associate_connection_and_lag, disassociate_connection_and_lag)
try:
import botocore
except:
pass
# handled by imported HAS_BOTO3
retry_params = {"tries": 10, "delay": 5, "backoff": 1.2}
def connection_status(client, connection_id):
return connection_exists(client, connection_id=connection_id, connection_name=None, verify=False)
@AWSRetry.backoff(**retry_params)
def connection_exists(client, connection_id=None, connection_name=None, verify=True):
try:
if connection_id:
response = client.describe_connections(connectionId=connection_id)
else:
response = client.describe_connections()
except botocore.exceptions.ClientError as e:
raise DirectConnectError(msg="Failed to describe DirectConnect ID {0}".format(connection_id),
last_traceback=traceback.format_exc(),
response=e.response)
match = []
connection = []
# look for matching connections
if len(response.get('connections', [])) == 1 and connection_id:
if response['connections'][0]['connectionState'] != 'deleted':
match.append(response['connections'][0]['connectionId'])
connection.extend(response['connections'])
for conn in response.get('connections', []):
if connection_name == conn['connectionName'] and conn['connectionState'] != 'deleted':
match.append(conn['connectionId'])
connection.append(conn)
# verifying if the connections exists; if true, return connection identifier, otherwise return False
if verify and len(match) == 1:
return match[0]
elif verify:
return False
# not verifying if the connection exists; just return current connection info
elif len(connection) == 1:
return {'connection': connection[0]}
return {'connection': {}}
@AWSRetry.backoff(**retry_params)
def create_connection(client, location, bandwidth, name, lag_id):
if not name:
raise DirectConnectError(msg="Failed to create a Direct Connect connection: name required.")
try:
if lag_id:
connection = client.create_connection(location=location,
bandwidth=bandwidth,
connectionName=name,
lagId=lag_id)
else:
connection = client.create_connection(location=location,
bandwidth=bandwidth,
connectionName=name)
except botocore.exceptions.ClientError as e:
raise DirectConnectError(msg="Failed to create DirectConnect connection {0}".format(name),
last_traceback=traceback.format_exc(),
response=e.response)
return connection['connectionId']
def changed_properties(current_status, location, bandwidth):
current_bandwidth = current_status['bandwidth']
current_location = current_status['location']
return current_bandwidth != bandwidth or current_location != location
@AWSRetry.backoff(**retry_params)
def update_associations(client, latest_state, connection_id, lag_id):
changed = False
if 'lagId' in latest_state and lag_id != latest_state['lagId']:
disassociate_connection_and_lag(client, connection_id, lag_id=latest_state['lagId'])
changed = True
if (changed and lag_id) or (lag_id and 'lagId' not in latest_state):
associate_connection_and_lag(client, connection_id, lag_id)
changed = True
return changed
def ensure_present(client, connection_id, connection_name, location, bandwidth, lag_id, forced_update):
# the connection is found; get the latest state and see if it needs to be updated
if connection_id:
latest_state = connection_status(client, connection_id=connection_id)['connection']
if changed_properties(latest_state, location, bandwidth) and forced_update:
ensure_absent(client, connection_id)
return ensure_present(client=client,
connection_id=None,
connection_name=connection_name,
location=location,
bandwidth=bandwidth,
lag_id=lag_id,
forced_update=forced_update)
elif update_associations(client, latest_state, connection_id, lag_id):
return True, connection_id
# no connection found; create a new one
else:
return True, create_connection(client, location, bandwidth, connection_name, lag_id)
return False, connection_id
@AWSRetry.backoff(**retry_params)
def ensure_absent(client, connection_id):
changed = False
if connection_id:
delete_connection(client, connection_id)
changed = True
return changed
def main():
argument_spec = ec2_argument_spec()
argument_spec.update(dict(
state=dict(required=True, choices=['present', 'absent']),
name=dict(),
location=dict(),
bandwidth=dict(choices=['1Gbps', '10Gbps']),
link_aggregation_group=dict(),
connection_id=dict(),
forced_update=dict(type='bool', default=False)
))
module = AnsibleModule(argument_spec=argument_spec,
required_one_of=[('connection_id', 'name')],
required_if=[('state', 'present', ('location', 'bandwidth'))])
if not HAS_BOTO3:
module.fail_json(msg='boto3 required for this module')
region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module, boto3=True)
if not region:
module.fail_json(msg="Either region or AWS_REGION or EC2_REGION environment variable or boto config aws_region or ec2_region must be set.")
connection = boto3_conn(module, conn_type='client',
resource='directconnect', region=region,
endpoint=ec2_url, **aws_connect_kwargs)
connection_id = connection_exists(connection,
connection_id=module.params.get('connection_id'),
connection_name=module.params.get('name'))
if not connection_id and module.params.get('connection_id'):
module.fail_json(msg="The Direct Connect connection {0} does not exist.".format(module.params.get('connection_id')))
state = module.params.get('state')
try:
if state == 'present':
changed, connection_id = ensure_present(connection,
connection_id=connection_id,
connection_name=module.params.get('name'),
location=module.params.get('location'),
bandwidth=module.params.get('bandwidth'),
lag_id=module.params.get('link_aggregation_group'),
forced_update=module.params.get('forced_update'))
response = connection_status(connection, connection_id)
elif state == 'absent':
changed = ensure_absent(connection, connection_id)
response = {}
except DirectConnectError as e:
if e.response:
module.fail_json(msg=e.msg, exception=e.last_traceback, **e.response)
elif e.last_traceback:
module.fail_json(msg=e.msg, exception=e.last_traceback)
else:
module.fail_json(msg=e.msg)
module.exit_json(changed=changed, **camel_dict_to_snake_dict(response))
if __name__ == '__main__':
main()

27
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/associations_are_not_updated/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,27 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "df6f9966-5b55-11e7-a69f-95e467ba41d7",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:30:03 GMT",
"content-length": "214"
},
"RequestId": "df6f9966-5b55-11e7-a69f-95e467ba41d7",
"HTTPStatusCode": 200
},
"connections": [
{
"connectionState": "requested",
"connectionId": "dxcon-fgq9rgot",
"location": "EqSe2",
"connectionName": "ansible-test-connection",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
]
}
}

27
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/changed_properties/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,27 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 1,
"HTTPHeaders": {
"x-amzn-requestid": "ded68d99-5b55-11e7-8bdd-db27cb754a2c",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:30:02 GMT",
"content-length": "214"
},
"RequestId": "ded68d99-5b55-11e7-8bdd-db27cb754a2c",
"HTTPStatusCode": 200
},
"connections": [
{
"connectionState": "requested",
"connectionId": "dxcon-fgq9rgot",
"location": "EqSe2",
"connectionName": "ansible-test-connection",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
]
}
}

17
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/connection_does_not_exist/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,17 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "b9e352dd-5b55-11e7-9750-d97c605bdcae",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:29:00 GMT",
"content-length": "18"
},
"RequestId": "b9e352dd-5b55-11e7-9750-d97c605bdcae",
"HTTPStatusCode": 200
},
"connections": []
}
}

27
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/connection_exists_by_id/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,27 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "b8f5493c-5b55-11e7-a718-2b51b84a4672",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:28:58 GMT",
"content-length": "214"
},
"RequestId": "b8f5493c-5b55-11e7-a718-2b51b84a4672",
"HTTPStatusCode": 200
},
"connections": [
{
"connectionState": "requested",
"connectionId": "dxcon-fgq9rgot",
"location": "EqSe2",
"connectionName": "ansible-test-connection",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
]
}
}

45
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/connection_exists_by_name/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,45 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "b9a0566c-5b55-11e7-9750-d97c605bdcae",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:29:00 GMT",
"content-length": "586"
},
"RequestId": "b9a0566c-5b55-11e7-9750-d97c605bdcae",
"HTTPStatusCode": 200
},
"connections": [
{
"connectionState": "requested",
"connectionId": "dxcon-fgq9rgot",
"location": "EqSe2",
"connectionName": "ansible-test-connection",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
},
{
"connectionState": "requested",
"connectionId": "dxcon-fh69i7ez",
"location": "PEH51",
"connectionName": "test2shertel",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
},
{
"connectionState": "deleted",
"connectionId": "dxcon-fgcw1bgr",
"location": "EqSe2",
"connectionName": "ansible-test-2",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
]
}
}

27
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/connection_status/directconnect.DescribeConnections_1.json Normal file
View file

@ -0,0 +1,27 @@
{
"status_code": 200,
"data": {
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "b85f71db-5b55-11e7-a718-2b51b84a4672",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:28:58 GMT",
"content-length": "214"
},
"RequestId": "b85f71db-5b55-11e7-a718-2b51b84a4672",
"HTTPStatusCode": 200
},
"connections": [
{
"connectionState": "requested",
"connectionId": "dxcon-fgq9rgot",
"location": "EqSe2",
"connectionName": "ansible-test-connection",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
]
}
}

23
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/create_and_delete/directconnect.CreateConnection_1.json Normal file
View file

@ -0,0 +1,23 @@
{
"status_code": 200,
"data": {
"connectionState": "requested",
"connectionId": "dxcon-fgbw50lg",
"location": "EqSe2",
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "dfb3ce3c-5b55-11e7-8bdd-db27cb754a2c",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:30:03 GMT",
"content-length": "187"
},
"RequestId": "dfb3ce3c-5b55-11e7-8bdd-db27cb754a2c",
"HTTPStatusCode": 200
},
"connectionName": "ansible-test-2",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
}

23
test/units/modules/cloud/amazon/placebo_recordings/aws_direct_connect_connection/create_and_delete/directconnect.DeleteConnection_1.json Normal file
View file

@ -0,0 +1,23 @@
{
"status_code": 200,
"data": {
"connectionState": "deleted",
"connectionId": "dxcon-fgbw50lg",
"location": "EqSe2",
"ResponseMetadata": {
"RetryAttempts": 0,
"HTTPHeaders": {
"x-amzn-requestid": "dfccd47d-5b55-11e7-8bdd-db27cb754a2c",
"content-type": "application/x-amz-json-1.1",
"date": "Tue, 27 Jun 2017 16:30:03 GMT",
"content-length": "185"
},
"RequestId": "dfccd47d-5b55-11e7-8bdd-db27cb754a2c",
"HTTPStatusCode": 200
},
"connectionName": "ansible-test-2",
"bandwidth": "1Gbps",
"ownerAccount": "448830907657",
"region": "us-west-2"
}
}

101
test/units/modules/cloud/amazon/test_aws_direct_connect_connection.py Normal file
View file

@ -0,0 +1,101 @@
# (c) 2017 Red Hat Inc.
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
from . placebo_fixtures import placeboify, maybe_sleep
from ansible.modules.cloud.amazon import aws_direct_connect_connection
from ansible.module_utils.ec2 import get_aws_connection_info, boto3_conn
class FakeModule(object):
def __init__(self, **kwargs):
self.params = kwargs
def fail_json(self, *args, **kwargs):
self.exit_args = args
self.exit_kwargs = kwargs
raise Exception('FAIL')
def exit_json(self, *args, **kwargs):
self.exit_args = args
self.exit_kwargs = kwargs
# When rerecording these tests, create a stand alone connection with default values in us-west-2
# with the name ansible-test-connection and set connection_id to the appropriate value
connection_id = "dxcon-fgq9rgot"
connection_name = 'ansible-test-connection'
def test_connection_status(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
status = aws_direct_connect_connection.connection_status(client, connection_id)['connection']
assert status['connectionName'] == connection_name
assert status['connectionId'] == connection_id
def test_connection_exists_by_id(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
exists = aws_direct_connect_connection.connection_exists(client, connection_id)
assert exists == connection_id
def test_connection_exists_by_name(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
exists = aws_direct_connect_connection.connection_exists(client, None, connection_name)
assert exists == connection_id
def test_connection_does_not_exist(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
exists = aws_direct_connect_connection.connection_exists(client, 'dxcon-notthere')
assert exists is False
def test_changed_properties(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
status = aws_direct_connect_connection.connection_status(client, connection_id)['connection']
location = "differentlocation"
bandwidth = status['bandwidth']
assert aws_direct_connect_connection.changed_properties(status, location, bandwidth) is True
def test_associations_are_not_updated(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
status = aws_direct_connect_connection.connection_status(client, connection_id)['connection']
lag_id = status.get('lagId')
assert aws_direct_connect_connection.update_associations(client, status, connection_id, lag_id) is False
def test_create_and_delete(placeboify, maybe_sleep):
client = placeboify.client('directconnect')
created_conn = verify_create_works(placeboify, maybe_sleep, client)
deleted_conn = verify_delete_works(placeboify, maybe_sleep, client, created_conn)
def verify_create_works(placeboify, maybe_sleep, client):
created = aws_direct_connect_connection.create_connection(client=client,
location="EqSE2",
bandwidth="1Gbps",
name="ansible-test-2",
lag_id=None)
assert created.startswith('dxcon')
return created
def verify_delete_works(placeboify, maybe_sleep, client, conn_id):
changed = aws_direct_connect_connection.ensure_absent(client, conn_id)
assert changed is True