mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 00:55:19 +00:00
add module to find vpc id based on cidr, name or tags
This commit is contained in:
Michal Bicz
Michal Bicz
parent
0cc4b8e044
commit
73f9654018
@ -38,7 +38,7 @@ Connection module for Amazon VPC
|
||||
# Import Python libs
|
||||
import logging
|
||||
from distutils.version import LooseVersion as _LooseVersion
|
||||
from salt.exceptions import SaltInvocationError
|
||||
from salt.exceptions import SaltInvocationError, CommandExecutionError
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
@ -125,7 +125,76 @@ def get_subnet_association(subnets, region=None, key=None, keyid=None,
|
||||
return False
|
||||
|
||||
|
||||
def exists(vpc_id=None, name=None, tags=None, region=None, key=None, keyid=None, profile=None):
|
||||
|
||||
def _find_vpc(vpc_id=None, name=None, cidr=None, tags=None, conn=None):
|
||||
'''
|
||||
Given VPC properties, find and return matching VPC_IDs
|
||||
|
||||
'''
|
||||
if not conn:
|
||||
return False
|
||||
|
||||
if not vpc_id and not name and not tags and not cidr:
|
||||
raise SaltInvocationError('At least on of the following must be specified: vpc id, name, cidr or tags.')
|
||||
|
||||
try:
|
||||
filter_parameters = {'filters': {}}
|
||||
|
||||
if vpc_id:
|
||||
filter_parameters['vpc_ids'] = [vpc_id]
|
||||
|
||||
if cidr:
|
||||
filter_parameters['filters']['cidr'] = cidr
|
||||
|
||||
if name:
|
||||
filter_parameters['filters']['tag:Name'] = name
|
||||
|
||||
if tags:
|
||||
for tag_name, tag_value in tags.items():
|
||||
filter_parameters['filters']['tag:{0}'.format(tag_name)] = tag_value
|
||||
|
||||
vpcs = conn.get_all_vpcs(**filter_parameters)
|
||||
log.debug('The filters criteria {0} matched the following VPCs:{1}'.format(filter_parameters, vpcs))
|
||||
|
||||
if vpcs:
|
||||
return [vpc.id for vpc in vpcs]
|
||||
else:
|
||||
return False
|
||||
except boto.exception.BotoServerError as e:
|
||||
log.error(e)
|
||||
return False
|
||||
|
||||
def get_id(name=None, cidr=None, tags=None, region=None, key=None, keyid=None, profile=None):
|
||||
'''
|
||||
Given a VPC properties, return VPC ID if exist.
|
||||
|
||||
CLI example::
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt myminion boto_vpc.get_id myvpc
|
||||
|
||||
'''
|
||||
conn = _get_conn(region, key, keyid, profile)
|
||||
if not conn:
|
||||
return None
|
||||
|
||||
vpcs_id = _find_vpc(name=name, cidr=cidr, tags=tags, conn=conn)
|
||||
|
||||
if vpcs_id:
|
||||
log.info("Matching VPC: {0}".format(" ".join(vpcs_id)))
|
||||
if len(vpcs_id) == 1:
|
||||
return vpcs_id[0]
|
||||
else:
|
||||
raise CommandExecutionError('Found more than one VPC matching the criteria.')
|
||||
else:
|
||||
log.warning('Could not find VPC.')
|
||||
return None
|
||||
|
||||
|
||||
|
||||
|
||||
def exists(vpc_id=None, name=None, cidr=None, tags=None, region=None, key=None, keyid=None, profile=None):
|
||||
'''
|
||||
Given a VPC ID, check to see if the given VPC ID exists.
|
||||
|
||||
@ -143,31 +212,13 @@ def exists(vpc_id=None, name=None, tags=None, region=None, key=None, keyid=None,
|
||||
if not conn:
|
||||
return False
|
||||
|
||||
if not vpc_id and not name and not tags:
|
||||
raise SaltInvocationError('At least on of the following must be specified: vpc id, name or tags.')
|
||||
|
||||
try:
|
||||
filter_parameters = {'filters': {}}
|
||||
|
||||
if vpc_id:
|
||||
filter_parameters['vpc_ids'] = [vpc_id]
|
||||
|
||||
if name:
|
||||
filter_parameters['filters']['tag:Name'] = name
|
||||
|
||||
if tags:
|
||||
for tag_name, tag_value in tags.items():
|
||||
filter_parameters['filters']['tag:{0}'.format(tag_name)] = tag_value
|
||||
vpcs = conn.get_all_vpcs(**filter_parameters)
|
||||
log.debug('The filters criteria {0} matched the following VPCs:{1}'.format(filter_parameters, vpcs))
|
||||
if vpcs:
|
||||
log.info('VPC exists.')
|
||||
return True
|
||||
else:
|
||||
log.warning('VPC does not exist.')
|
||||
return False
|
||||
except boto.exception.BotoServerError as e:
|
||||
log.error(e)
|
||||
vpcs = _find_vpc(vpc_id=vpc_id, name=name, cidr=cidr, tags=tags, conn=conn)
|
||||
|
||||
if vpcs:
|
||||
log.info('VPC exists.')
|
||||
return True
|
||||
else:
|
||||
log.warning('VPC does not exist.')
|
||||
return False
|
||||
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
from mock import patch
|
||||
|
||||
from salt.exceptions import SaltInvocationError
|
||||
from salt.exceptions import SaltInvocationError, CommandExecutionError
|
||||
from salt.modules.boto_vpc import _maybe_set_name_tag, _maybe_set_tags
|
||||
|
||||
|
||||
@ -257,14 +257,125 @@ class BotoVpcTestCase(BotoVpcTestCaseBase):
|
||||
|
||||
self.assertFalse(vpc_exists)
|
||||
|
||||
@mock_ec2
|
||||
def test_that_when_checking_if_a_vpc_exists_by_cidr_and_a_vpc_exists_the_vpc_exists_method_returns_true(self):
|
||||
'''
|
||||
Tests checking vpc existence via cidr when vpc exists
|
||||
'''
|
||||
self._create_vpc()
|
||||
|
||||
vpc_exists = boto_vpc.exists(cidr=u'10.0.0.0/24', **conn_parameters)
|
||||
|
||||
self.assertTrue(vpc_exists)
|
||||
|
||||
@mock_ec2
|
||||
@skipIf(_has_required_moto() is False, 'The moto module does not support filtering vpcs.'
|
||||
'Added support in spulec/moto#218. Next release should solve this issue.')
|
||||
def test_that_when_checking_if_a_vpc_exists_by_cidr_and_a_vpc_does_not_exist_the_vpc_exists_method_returns_false(
|
||||
self):
|
||||
'''
|
||||
Tests checking vpc existence via cidr when vpc does not exist
|
||||
'''
|
||||
self._create_vpc() # Created to ensure that the filters are applied correctly
|
||||
|
||||
vpc_exists = boto_vpc.exists(cidr=u'10.10.10.10/24', **conn_parameters)
|
||||
|
||||
self.assertFalse(vpc_exists)
|
||||
|
||||
@mock_ec2
|
||||
def test_that_when_checking_if_a_vpc_exists_but_providing_no_filters_the_vpc_exists_method_raises_a_salt_invocation_error(self):
|
||||
'''
|
||||
Tests checking vpc existence when no filters are provided
|
||||
'''
|
||||
with self.assertRaisesRegexp(SaltInvocationError, 'At least on of the following must be specified: vpc id, name or tags.'):
|
||||
with self.assertRaisesRegexp(SaltInvocationError, 'At least on of the following must be specified: vpc id, name, cidr or tags.'):
|
||||
boto_vpc.exists(**conn_parameters)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_name(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by name
|
||||
'''
|
||||
vpc = self._create_vpc(name='test')
|
||||
|
||||
vpc_id = boto_vpc.get_id(name='test', **conn_parameters)
|
||||
|
||||
self.assertEqual(vpc.id, vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_invalid_name(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by invalid name
|
||||
'''
|
||||
self._create_vpc(name='test')
|
||||
|
||||
vpc_id = boto_vpc.get_id(name='test_fake', **conn_parameters)
|
||||
|
||||
self.assertFalse(vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_cidr(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by cidr
|
||||
'''
|
||||
vpc = self._create_vpc()
|
||||
|
||||
vpc_id = boto_vpc.get_id(cidr=u'10.0.0.0/24', **conn_parameters)
|
||||
|
||||
self.assertEqual(vpc.id, vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_invalid_cidr(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by invalid cidr
|
||||
'''
|
||||
self._create_vpc()
|
||||
|
||||
vpc_id = boto_vpc.get_id(cidr=u'10.10.10.10/24', **conn_parameters)
|
||||
|
||||
self.assertFalse(vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_tags(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by tags
|
||||
'''
|
||||
vpc = self._create_vpc(tags={'test': 'testvalue'})
|
||||
|
||||
vpc_id = boto_vpc.get_id(tags={'test': 'testvalue'}, **conn_parameters)
|
||||
|
||||
self.assertEqual(vpc.id, vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_filtering_by_invalid_tags(self):
|
||||
'''
|
||||
Tests getting vpc id when filtering by invalid tags
|
||||
'''
|
||||
self._create_vpc(tags={'test': 'testvalue'})
|
||||
|
||||
vpc_id = boto_vpc.get_id(tags={'test': 'fake-testvalue'}, **conn_parameters)
|
||||
|
||||
self.assertFalse(vpc_id)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_not_providing_filters_raises_a_salt_invocation_error(self):
|
||||
'''
|
||||
Tests getting vpc id but providing no filters
|
||||
'''
|
||||
with self.assertRaisesRegexp(SaltInvocationError, 'At least on of the following must be specified: vpc id, name, cidr or tags.'):
|
||||
boto_vpc.get_id(**conn_parameters)
|
||||
|
||||
@mock_ec2
|
||||
def test_get_vpc_id_method_when_more_than_one_vpc_is_matched_raises_a_salt_command_execution_error(self):
|
||||
'''
|
||||
Tests getting vpc id but providing no filters
|
||||
'''
|
||||
|
||||
vpc1 = self._create_vpc(name='vpc-test1')
|
||||
vpc2 = self._create_vpc(name='vpc-test2')
|
||||
|
||||
with self.assertRaisesRegexp(CommandExecutionError, 'Found more than one VPC matching the criteria.'):
|
||||
boto_vpc.get_id(cidr=u'10.0.0.0/24', **conn_parameters)
|
||||
|
||||
@mock_ec2
|
||||
def test_that_when_creating_a_vpc_succeeds_the_create_vpc_method_returns_true(self):
|
||||
'''
|
||||
|
||||
Loading…
Reference in New Issue
Block a user