Added method to OpenStackHeatStack to return OpenStackRouter objects.

Continuation of the story SNAPS-153 for adding creator/state machine
instances for OpenStack objects deployed via Heat.

JIRA: SNAPS-173

Change-Id: Iac9138ef7827c10db1637447d3a909e714a0301b
Signed-off-by: spisarski <s.pisarski@cablelabs.com>

diff --git a/docs/how-to-use/APITests.rst b/docs/how-to-use/APITests.rst
index ed4779a..4c1f885 100644 (file)
--- a/docs/how-to-use/APITests.rst
+++ b/docs/how-to-use/APITests.rst
@@ -429,9 +429,9 @@ heat_utils_tests.py - HeatUtilsCreateSimpleStackTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+

-| test_create_stack                     | 1             | Tests the heat_utils.create_stack() with a test template  |
+| test_create_stack                     | 1-3           | Tests the heat_utils.create_stack() with a test template  |

 +---------------------------------------+---------------+-----------------------------------------------------------+
 +---------------------------------------+---------------+-----------------------------------------------------------+

-| test_create_stack_x2                  | 1             | Tests the heat_utils.create_stack() with a test template  |
+| test_create_stack_x2                  | 1-3           | Tests the heat_utils.create_stack() with a test template  |

 |                                       |               | and attempts to deploy a second time w/o actually         |
 |                                       |               | deploying any objects                                     |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 |                                       |               | and attempts to deploy a second time w/o actually         |
 |                                       |               | deploying any objects                                     |
 +---------------------------------------+---------------+-----------------------------------------------------------+


@@ -442,22 +442,33 @@ heat_utils_tests.py - HeatUtilsCreateComplexStackTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+

-| test_get_settings_from_stack          | 1             | Tests the heat_utils functions that are responsible for   |
+| test_get_settings_from_stack          | 1-3           | Tests the heat_utils functions that are responsible for   |

 |                                       |               | reverse engineering settings objects of the types deployed|
 |                                       |               | by Heat                                                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
 |                                       |               | reverse engineering settings objects of the types deployed|
 |                                       |               | by Heat                                                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 

+heat_utils_tests.py - HeatUtilsRouterTests
+------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Heat API      | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_router_with_stack         | 1-3           | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_routers() to return the correct      |
+|                                       |               | OpenStackRouter instance                                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+

 heat_utils_tests.py - HeatUtilsVolumeTests
 ------------------------------------------
 
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
 heat_utils_tests.py - HeatUtilsVolumeTests
 ------------------------------------------
 
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+

-| test_create_vol_with_stack            | 1             | Tests ability of the function                             |
+| test_create_vol_with_stack            | 1-3           | Tests ability of the function                             |

 |                                       |               | heat_utils.create_stack() to return the correct           |
 |                                       |               | Volume domain objects deployed with Heat                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 |                                       |               | heat_utils.create_stack() to return the correct           |
 |                                       |               | Volume domain objects deployed with Heat                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+

-| test_create_vol_types_with_stack      | 1             | Tests ability of the function                             |
+| test_create_vol_types_with_stack      | 1-3           | Tests ability of the function                             |

 |                                       |               | heat_utils.get_stack_volumes_types() to return the correct|
 |                                       |               | VolumeType domain objects deployed with Heat              |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 |                                       |               | heat_utils.get_stack_volumes_types() to return the correct|
 |                                       |               | VolumeType domain objects deployed with Heat              |
 +---------------------------------------+---------------+-----------------------------------------------------------+


@@ -468,7 +479,7 @@ heat_utils_tests.py - HeatUtilsKeypairTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+

-| test_create_keypair_with_stack        | 1             | Tests ability of the function                             |
+| test_create_keypair_with_stack        | 1-3           | Tests ability of the function                             |

 |                                       |               | heat_utils.create_stack() to return the correct           |
 |                                       |               | Keypair domain objects deployed with Heat                 |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 |                                       |               | heat_utils.create_stack() to return the correct           |
 |                                       |               | Keypair domain objects deployed with Heat                 |
 +---------------------------------------+---------------+-----------------------------------------------------------+


@@ -479,7 +490,7 @@ heat_utils_tests.py - HeatUtilsFlavorTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+

-| test_create_flavor_with_stack         | 1             | Tests ability of the function                             |
+| test_create_flavor_with_stack         | 1-3           | Tests ability of the function                             |

 |                                       |               | heat_utils.get_stack_flavors() to return the correct      |
 |                                       |               | Flavor domain objects deployed with Heat                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 |                                       |               | heat_utils.get_stack_flavors() to return the correct      |
 |                                       |               | Flavor domain objects deployed with Heat                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+

diff --git a/docs/how-to-use/IntegrationTests.rst b/docs/how-to-use/IntegrationTests.rst
index 4772357..075af38 100644 (file)
--- a/docs/how-to-use/IntegrationTests.rst
+++ b/docs/how-to-use/IntegrationTests.rst
@@ -396,6 +396,28 @@ create_stack_tests.py - CreateStackVolumeTests
 |                                       |               | deploying                                                 |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
 |                                       |               | deploying                                                 |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 

+create_stack_tests.py - CreateStackFloatingIpTests
+--------------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             |   Heat API    | Description                                               |
++=======================================+===============+===========================================================+
+| test_connect_via_ssh_heat_vm          | 1             | Ensures that an OpenStackHeatStack instance can create a  |
+|                                       |               | VM with a floating IP that can be accessed via            |
+|                                       |               | OpenStackVmInstance                                       |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
+create_stack_tests.py - CreateStackRouterTests
+----------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             |   Heat API    | Description                                               |
++=======================================+===============+===========================================================+
+| test_retrieve_router_creator          | 1             | Ensures that an OpenStackHeatStack instance can return a  |
+|                                       |               | OpenStackRouter instance that it was responsible for      |
+|                                       |               | deploying                                                 |
++---------------------------------------+---------------+-----------------------------------------------------------+
+

 create_stack_tests.py - CreateStackFlavorTests
 ----------------------------------------------
 
 create_stack_tests.py - CreateStackFlavorTests
 ----------------------------------------------
 

diff --git a/snaps/domain/network.py b/snaps/domain/network.py
index 9cc1dd1..448ee89 100644 (file)
--- a/snaps/domain/network.py
+++ b/snaps/domain/network.py
@@ -48,6 +48,7 @@ class Subnet:
         """
         self.name = kwargs.get('name')
         self.id = kwargs.get('id')
         """
         self.name = kwargs.get('name')
         self.id = kwargs.get('id')

+        self.network_id = kwargs.get('network_id')

         self.cidr = kwargs.get('cidr')
         self.ip_version = kwargs.get('ip_version')
         self.gateway_ip = kwargs.get('gateway_ip')
         self.cidr = kwargs.get('cidr')
         self.ip_version = kwargs.get('ip_version')
         self.gateway_ip = kwargs.get('gateway_ip')


@@ -71,6 +72,7 @@ class Subnet:
     def __eq__(self, other):
         return (self.name == other.name and
                 self.id == other.id and
     def __eq__(self, other):
         return (self.name == other.name and
                 self.id == other.id and

+                self.network_id == other.network_id and

                 self.cidr == other.cidr and
                 self.ip_version == other.ip_version and
                 self.gateway_ip == other.gateway_ip and
                 self.cidr == other.cidr and
                 self.ip_version == other.ip_version and
                 self.gateway_ip == other.gateway_ip and


@@ -134,20 +136,46 @@ class Router:
         Constructor
         :param name: the router's name
         :param id: the router's id
         Constructor
         :param name: the router's name
         :param id: the router's id

+        :param status: the router's status
+        :param tenant_id: the router's project/tenant ID
+        :param admin_state_up: Router is up when True
+        :param external_gateway_info: dict() for populating external_network_id
+                                      and external_fixed_ips
+                   external_network_id: ID of the external network to route
+                                        in dict under key 'external_fixed_ips'
+                   external_fixed_ips: List IP addresses associated with the
+                                       external_network_id found in dict under
+                                       key 'network_id'
+        :param port_subnets: list of tuples where #1 is the Port domain object
+                             and #2 is a list of associated Subnet domain
+                             objects

         """
         self.name = kwargs.get('name')
         self.id = kwargs.get('id')
         self.status = kwargs.get('status')
         self.tenant_id = kwargs.get('tenant_id')
         self.admin_state_up = kwargs.get('admin_state_up')
         """
         self.name = kwargs.get('name')
         self.id = kwargs.get('id')
         self.status = kwargs.get('status')
         self.tenant_id = kwargs.get('tenant_id')
         self.admin_state_up = kwargs.get('admin_state_up')

-        self.external_gateway_info = kwargs.get('external_gateway_info')
+        self.port_subnets = kwargs.get('port_subnets')
+
+        if (kwargs.get('external_gateway_info') and
+                isinstance(kwargs.get('external_gateway_info'), dict) and
+                kwargs.get('external_gateway_info').get('external_fixed_ips')):
+            gateway_info = kwargs.get('external_gateway_info')
+
+            self.external_network_id = gateway_info.get('network_id')
+            self.external_fixed_ips = gateway_info.get('external_fixed_ips')
+        else:
+            self.external_fixed_ips = kwargs.get('external_fixed_ips', None)
+            self.external_network_id = kwargs.get('external_network_id', None)

 
     def __eq__(self, other):
         return (self.name == other.name and self.id == other.id and
                 self.status == other.status and
                 self.tenant_id == other.tenant_id and
                 self.admin_state_up == other.admin_state_up and
 
     def __eq__(self, other):
         return (self.name == other.name and self.id == other.id and
                 self.status == other.status and
                 self.tenant_id == other.tenant_id and
                 self.admin_state_up == other.admin_state_up and

-                self.external_gateway_info == other.external_gateway_info)
+                self.external_network_id == other.external_network_id and
+                self.external_fixed_ips == other.external_fixed_ips and
+                self.port_subnets == other.port_subnets)

 
 
 class InterfaceRouter:
 
 
 class InterfaceRouter:

diff --git a/snaps/domain/test/network_tests.py b/snaps/domain/test/network_tests.py
index 24a60c9..3e449b4 100644 (file)
--- a/snaps/domain/test/network_tests.py
+++ b/snaps/domain/test/network_tests.py
@@ -213,7 +213,8 @@ class RouterDomainObjectTests(unittest.TestCase):
         self.assertEqual('hello', router.status)
         self.assertEqual('1234', router.tenant_id)
         self.assertEqual('yes', router.admin_state_up)
         self.assertEqual('hello', router.status)
         self.assertEqual('1234', router.tenant_id)
         self.assertEqual('yes', router.admin_state_up)

-        self.assertEqual('no', router.external_gateway_info)
+        self.assertIsNone(router.external_fixed_ips)
+        self.assertIsNone(router.external_network_id)

 
     def test_construction_named(self):
         router = Router(
 
     def test_construction_named(self):
         router = Router(


@@ -224,7 +225,38 @@ class RouterDomainObjectTests(unittest.TestCase):
         self.assertEqual('hello', router.status)
         self.assertEqual('1234', router.tenant_id)
         self.assertEqual('yes', router.admin_state_up)
         self.assertEqual('hello', router.status)
         self.assertEqual('1234', router.tenant_id)
         self.assertEqual('yes', router.admin_state_up)

-        self.assertEqual('no', router.external_gateway_info)
+        self.assertIsNone(router.external_fixed_ips)
+        self.assertIsNone(router.external_network_id)
+
+    def test_ext_gateway_named(self):
+        ext_gateway = {'network_id': '123',
+                       'external_fixed_ips': ['456', '789']}
+        router = Router(
+            external_fixed_ips=['456', '789'], external_network_id='123',
+            admin_state_up='yes', tenant_id='1234', status='hello', id='id',
+            name='name')
+        self.assertEqual('name', router.name)
+        self.assertEqual('id', router.id)
+        self.assertEqual('hello', router.status)
+        self.assertEqual('1234', router.tenant_id)
+        self.assertEqual('yes', router.admin_state_up)
+        self.assertEqual(['456', '789'], router.external_fixed_ips)
+        self.assertEqual('123', router.external_network_id)
+
+
+    def test_ext_net_ips_named(self):
+        ext_gateway = {'network_id': '123',
+                       'external_fixed_ips': ['456', '789']}
+        router = Router(
+            external_gateway_info=ext_gateway, admin_state_up='yes',
+            tenant_id='1234', status='hello', id='id', name='name')
+        self.assertEqual('name', router.name)
+        self.assertEqual('id', router.id)
+        self.assertEqual('hello', router.status)
+        self.assertEqual('1234', router.tenant_id)
+        self.assertEqual('yes', router.admin_state_up)
+        self.assertEqual(['456', '789'], router.external_fixed_ips)
+        self.assertEqual('123', router.external_network_id)

 
 
 class InterfaceRouterDomainObjectTests(unittest.TestCase):
 
 
 class InterfaceRouterDomainObjectTests(unittest.TestCase):

diff --git a/snaps/openstack/create_instance.py b/snaps/openstack/create_instance.py
index c3bc551..60ebf39 100644 (file)
--- a/snaps/openstack/create_instance.py
+++ b/snaps/openstack/create_instance.py
@@ -225,10 +225,9 @@ class OpenStackVmInstance(OpenStackComputeObject):
         """
         router = neutron_utils.get_router(
             self.__neutron, router_name=router_name)
         """
         router = neutron_utils.get_router(
             self.__neutron, router_name=router_name)

-        if router and router.external_gateway_info:
+        if router and router.external_network_id:

             network = neutron_utils.get_network_by_id(
             network = neutron_utils.get_network_by_id(

-                self.__neutron,
-                router.external_gateway_info['network_id'])
+                self.__neutron, router.external_network_id)

             if network:
                 return network.name
         return None
             if network:
                 return network.name
         return None

diff --git a/snaps/openstack/create_network.py b/snaps/openstack/create_network.py
index 1e69061..bf873f2 100644 (file)
--- a/snaps/openstack/create_network.py
+++ b/snaps/openstack/create_network.py
@@ -422,9 +422,6 @@ class PortSettings:
                          'subnet_name' and 'ip' values which will get mapped to
                          self.fixed_ips. These values will be directly
                          translated into the fixed_ips dict (optional)
                          'subnet_name' and 'ip' values which will get mapped to
                          self.fixed_ips. These values will be directly
                          translated into the fixed_ips dict (optional)

-        :param fixed_ips: A dict where the key is the subnet IDs and value is
-                          the IP address to assign to the port (optional and
-                          recommended to configure via ip_addrs instead)

         :param security_groups: One or more security group IDs.
         :param allowed_address_pairs: A dictionary containing a set of zero or
                                       more allowed address pairs. An address
         :param security_groups: One or more security group IDs.
         :param allowed_address_pairs: A dictionary containing a set of zero or
                                       more allowed address pairs. An address


@@ -441,8 +438,6 @@ class PortSettings:
         if 'port' in kwargs:
             kwargs = kwargs['port']
 
         if 'port' in kwargs:
             kwargs = kwargs['port']
 

-        self.network = None
-

         self.name = kwargs.get('name')
         self.network_name = kwargs.get('network_name')
 
         self.name = kwargs.get('name')
         self.network_name = kwargs.get('network_name')
 


@@ -454,7 +449,6 @@ class PortSettings:
         self.project_name = kwargs.get('project_name')
         self.mac_address = kwargs.get('mac_address')
         self.ip_addrs = kwargs.get('ip_addrs')
         self.project_name = kwargs.get('project_name')
         self.mac_address = kwargs.get('mac_address')
         self.ip_addrs = kwargs.get('ip_addrs')

-        self.fixed_ips = kwargs.get('fixed_ips')

         self.security_groups = kwargs.get('security_groups')
         self.allowed_address_pairs = kwargs.get('allowed_address_pairs')
         self.opt_value = kwargs.get('opt_value')
         self.security_groups = kwargs.get('security_groups')
         self.allowed_address_pairs = kwargs.get('allowed_address_pairs')
         self.opt_value = kwargs.get('opt_value')


@@ -466,26 +460,29 @@ class PortSettings:
             raise PortSettingsError(
                 'The attribute network_name is required')
 
             raise PortSettingsError(
                 'The attribute network_name is required')
 

-    def __set_fixed_ips(self, neutron):
+    def __get_fixed_ips(self, neutron):

         """
         Sets the self.fixed_ips value
         :param neutron: the Neutron client
         :return: None
         """
         """
         Sets the self.fixed_ips value
         :param neutron: the Neutron client
         :return: None
         """

-        if not self.fixed_ips and self.ip_addrs:
-            self.fixed_ips = list()
+
+        fixed_ips = list()
+        if self.ip_addrs:

 
             for ip_addr_dict in self.ip_addrs:
                 subnet = neutron_utils.get_subnet(
                     neutron, subnet_name=ip_addr_dict['subnet_name'])
                 if subnet and 'ip' in ip_addr_dict:
 
             for ip_addr_dict in self.ip_addrs:
                 subnet = neutron_utils.get_subnet(
                     neutron, subnet_name=ip_addr_dict['subnet_name'])
                 if subnet and 'ip' in ip_addr_dict:

-                    self.fixed_ips.append({'ip_address': ip_addr_dict['ip'],
-                                           'subnet_id': subnet.id})
+                    fixed_ips.append({'ip_address': ip_addr_dict['ip'],
+                                      'subnet_id': subnet.id})

                 else:
                     raise PortSettingsError(
                         'Invalid port configuration, subnet does not exist '
                         'with name - ' + ip_addr_dict['subnet_name'])
 
                 else:
                     raise PortSettingsError(
                         'Invalid port configuration, subnet does not exist '
                         'with name - ' + ip_addr_dict['subnet_name'])
 

+        return fixed_ips
+

     def dict_for_neutron(self, neutron, os_creds):
         """
         Returns a dictionary object representing this object.
     def dict_for_neutron(self, neutron, os_creds):
         """
         Returns a dictionary object representing this object.


@@ -497,7 +494,6 @@ class PortSettings:
         :param os_creds: the OpenStack credentials
         :return: the dictionary object
         """
         :param os_creds: the OpenStack credentials
         :return: the dictionary object
         """

-        self.__set_fixed_ips(neutron)

 
         out = dict()
 
 
         out = dict()
 


@@ -509,14 +505,13 @@ class PortSettings:
             if project:
                 project_id = project.id
 
             if project:
                 project_id = project.id
 

-        if not self.network:
-            self.network = neutron_utils.get_network(
-                neutron, network_name=self.network_name, project_id=project_id)
-        if not self.network:
+        network = neutron_utils.get_network(
+            neutron, network_name=self.network_name, project_id=project_id)
+        if not network:

             raise PortSettingsError(
                 'Cannot locate network with name - ' + self.network_name)
 
             raise PortSettingsError(
                 'Cannot locate network with name - ' + self.network_name)
 

-        out['network_id'] = self.network.id
+        out['network_id'] = network.id

 
         if self.admin_state_up is not None:
             out['admin_state_up'] = self.admin_state_up
 
         if self.admin_state_up is not None:
             out['admin_state_up'] = self.admin_state_up


@@ -531,8 +526,11 @@ class PortSettings:
                     self.project_name)
         if self.mac_address:
             out['mac_address'] = self.mac_address
                     self.project_name)
         if self.mac_address:
             out['mac_address'] = self.mac_address

-        if self.fixed_ips and len(self.fixed_ips) > 0:
-            out['fixed_ips'] = self.fixed_ips
+
+        fixed_ips = self.__get_fixed_ips(neutron)
+        if fixed_ips and len(fixed_ips) > 0:
+            out['fixed_ips'] = fixed_ips
+

         if self.security_groups:
             out['security_groups'] = self.security_groups
         if self.allowed_address_pairs and len(self.allowed_address_pairs) > 0:
         if self.security_groups:
             out['security_groups'] = self.security_groups
         if self.allowed_address_pairs and len(self.allowed_address_pairs) > 0:


@@ -554,7 +552,7 @@ class PortSettings:
                 self.project_name == other.project_name and
                 self.mac_address == other.mac_address and
                 self.ip_addrs == other.ip_addrs and
                 self.project_name == other.project_name and
                 self.mac_address == other.mac_address and
                 self.ip_addrs == other.ip_addrs and

-                self.fixed_ips == other.fixed_ips and
+                # self.fixed_ips == other.fixed_ips and

                 self.security_groups == other.security_groups and
                 self.allowed_address_pairs == other.allowed_address_pairs and
                 self.opt_value == other.opt_value and
                 self.security_groups == other.security_groups and
                 self.allowed_address_pairs == other.allowed_address_pairs and
                 self.opt_value == other.opt_value and

diff --git a/snaps/openstack/create_router.py b/snaps/openstack/create_router.py
index 98e3e14..6da5f8e 100644 (file)
--- a/snaps/openstack/create_router.py
+++ b/snaps/openstack/create_router.py
@@ -132,6 +132,8 @@ class OpenStackRouter(OpenStackNetworkObject):
                             'Error creating port with name - '
                             + port_setting.name)
 
                             'Error creating port with name - '
                             + port_setting.name)
 

+        self.__router = neutron_utils.get_router_by_id(
+            self._neutron, self.__router.id)

         return self.__router
 
     def clean(self):
         return self.__router
 
     def clean(self):


@@ -206,8 +208,6 @@ class RouterSettings:
         :param external_gateway: Name of the external network to which to route
         :param admin_state_up: The administrative status of the router.
                                True = up / False = down (default True)
         :param external_gateway: Name of the external network to which to route
         :param admin_state_up: The administrative status of the router.
                                True = up / False = down (default True)

-        :param external_fixed_ips: Dictionary containing the IP address
-                                   parameters.

         :param internal_subnets: List of subnet names to which to connect this
                                  router for Floating IP purposes
         :param port_settings: List of PortSettings objects
         :param internal_subnets: List of subnet names to which to connect this
                                  router for Floating IP purposes
         :param port_settings: List of PortSettings objects


@@ -217,9 +217,8 @@ class RouterSettings:
         self.project_name = kwargs.get('project_name')
         self.external_gateway = kwargs.get('external_gateway')
 
         self.project_name = kwargs.get('project_name')
         self.external_gateway = kwargs.get('external_gateway')
 

-        self.admin_state_up = kwargs.get('admin_state_up')
+        self.admin_state_up = kwargs.get('admin_state_up', True)

         self.enable_snat = kwargs.get('enable_snat')
         self.enable_snat = kwargs.get('enable_snat')

-        self.external_fixed_ips = kwargs.get('external_fixed_ips')

         if kwargs.get('internal_subnets'):
             self.internal_subnets = kwargs['internal_subnets']
         else:
         if kwargs.get('internal_subnets'):
             self.internal_subnets = kwargs['internal_subnets']
         else:

diff --git a/snaps/openstack/create_stack.py b/snaps/openstack/create_stack.py
index 1820e2a..0ff24d6 100644 (file)
--- a/snaps/openstack/create_stack.py
+++ b/snaps/openstack/create_stack.py
@@ -21,6 +21,7 @@ from heatclient.exc import HTTPNotFound
 from snaps.openstack.create_flavor import OpenStackFlavor
 from snaps.openstack.create_instance import OpenStackVmInstance
 from snaps.openstack.create_keypairs import OpenStackKeypair
 from snaps.openstack.create_flavor import OpenStackFlavor
 from snaps.openstack.create_instance import OpenStackVmInstance
 from snaps.openstack.create_keypairs import OpenStackKeypair

+from snaps.openstack.create_router import OpenStackRouter

 from snaps.openstack.create_volume import OpenStackVolume
 from snaps.openstack.create_volume_type import OpenStackVolumeType
 from snaps.openstack.openstack_creator import OpenStackCloudObject
 from snaps.openstack.create_volume import OpenStackVolume
 from snaps.openstack.create_volume_type import OpenStackVolumeType
 from snaps.openstack.openstack_creator import OpenStackCloudObject


@@ -234,6 +235,28 @@ class OpenStackHeatStack(OpenStackCloudObject, object):
 
         return out
 
 
         return out
 

+    def get_router_creators(self):
+        """
+        Returns a list of router creator objects as configured by the heat
+        template
+        :return: list() of OpenStackRouter objects
+        """
+
+        neutron = neutron_utils.neutron_client(self._os_creds)
+
+        out = list()
+        stack_routers = heat_utils.get_stack_routers(
+            self.__heat_cli, neutron, self.__stack)
+
+        for routers in stack_routers:
+            settings = settings_utils.create_router_settings(
+                neutron, routers)
+            creator = OpenStackRouter(self._os_creds, settings)
+            out.append(creator)
+            creator.initialize()
+
+        return out
+

     def get_vm_inst_creators(self, heat_keypair_option=None):
         """
         Returns a list of VM Instance creator objects as configured by the heat
     def get_vm_inst_creators(self, heat_keypair_option=None):
         """
         Returns a list of VM Instance creator objects as configured by the heat

diff --git a/snaps/openstack/tests/create_network_tests.py b/snaps/openstack/tests/create_network_tests.py
index 9cee130..49ad6ab 100644 (file)
--- a/snaps/openstack/tests/create_network_tests.py
+++ b/snaps/openstack/tests/create_network_tests.py
@@ -248,7 +248,6 @@ class PortSettingsUnitTests(unittest.TestCase):
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.mac_address)
         self.assertIsNone(settings.ip_addrs)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.mac_address)
         self.assertIsNone(settings.ip_addrs)

-        self.assertIsNone(settings.fixed_ips)

         self.assertIsNone(settings.security_groups)
         self.assertIsNone(settings.allowed_address_pairs)
         self.assertIsNone(settings.opt_value)
         self.assertIsNone(settings.security_groups)
         self.assertIsNone(settings.allowed_address_pairs)
         self.assertIsNone(settings.opt_value)


@@ -264,7 +263,6 @@ class PortSettingsUnitTests(unittest.TestCase):
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.mac_address)
         self.assertIsNone(settings.ip_addrs)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.mac_address)
         self.assertIsNone(settings.ip_addrs)

-        self.assertIsNone(settings.fixed_ips)

         self.assertIsNone(settings.security_groups)
         self.assertIsNone(settings.allowed_address_pairs)
         self.assertIsNone(settings.opt_value)
         self.assertIsNone(settings.security_groups)
         self.assertIsNone(settings.allowed_address_pairs)
         self.assertIsNone(settings.opt_value)


@@ -274,14 +272,12 @@ class PortSettingsUnitTests(unittest.TestCase):
 
     def test_all(self):
         ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]
 
     def test_all(self):
         ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]

-        fixed_ips = {'sub_id', '10.0.0.10'}

         allowed_address_pairs = {'10.0.0.101', '1234.5678'}
 
         settings = PortSettings(name='foo', network_name='bar',
                                 admin_state_up=False,
                                 project_name='foo-project',
                                 mac_address='1234', ip_addrs=ip_addrs,
         allowed_address_pairs = {'10.0.0.101', '1234.5678'}
 
         settings = PortSettings(name='foo', network_name='bar',
                                 admin_state_up=False,
                                 project_name='foo-project',
                                 mac_address='1234', ip_addrs=ip_addrs,

-                                fixed_ips=fixed_ips,

                                 security_groups=['foo_grp_id'],
                                 allowed_address_pairs=allowed_address_pairs,
                                 opt_value='opt value', opt_name='opt name',
                                 security_groups=['foo_grp_id'],
                                 allowed_address_pairs=allowed_address_pairs,
                                 opt_value='opt value', opt_name='opt name',


@@ -293,7 +289,6 @@ class PortSettingsUnitTests(unittest.TestCase):
         self.assertEqual('foo-project', settings.project_name)
         self.assertEqual('1234', settings.mac_address)
         self.assertEqual(ip_addrs, settings.ip_addrs)
         self.assertEqual('foo-project', settings.project_name)
         self.assertEqual('1234', settings.mac_address)
         self.assertEqual(ip_addrs, settings.ip_addrs)

-        self.assertEqual(fixed_ips, settings.fixed_ips)

         self.assertEqual(1, len(settings.security_groups))
         self.assertEqual('foo_grp_id', settings.security_groups[0])
         self.assertEqual(allowed_address_pairs, settings.allowed_address_pairs)
         self.assertEqual(1, len(settings.security_groups))
         self.assertEqual('foo_grp_id', settings.security_groups[0])
         self.assertEqual(allowed_address_pairs, settings.allowed_address_pairs)


@@ -304,25 +299,21 @@ class PortSettingsUnitTests(unittest.TestCase):
 
     def test_config_all(self):
         ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]
 
     def test_config_all(self):
         ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]

-        fixed_ips = {'sub_id', '10.0.0.10'}

         allowed_address_pairs = {'10.0.0.101', '1234.5678'}
 
         settings = PortSettings(
             **{'name': 'foo', 'network_name': 'bar', 'admin_state_up': False,
                'project_name': 'foo-project', 'mac_address': '1234',
         allowed_address_pairs = {'10.0.0.101', '1234.5678'}
 
         settings = PortSettings(
             **{'name': 'foo', 'network_name': 'bar', 'admin_state_up': False,
                'project_name': 'foo-project', 'mac_address': '1234',

-               'ip_addrs': ip_addrs,
-               'fixed_ips': fixed_ips, 'security_groups': ['foo_grp_id'],
+               'ip_addrs': ip_addrs, 'security_groups': ['foo_grp_id'],

                'allowed_address_pairs': allowed_address_pairs,
                'allowed_address_pairs': allowed_address_pairs,

-               'opt_value': 'opt value',
-               'opt_name': 'opt name', 'device_owner': 'owner',
-               'device_id': 'device number'})
+               'opt_value': 'opt value', 'opt_name': 'opt name',
+               'device_owner': 'owner', 'device_id': 'device number'})

         self.assertEqual('foo', settings.name)
         self.assertEqual('bar', settings.network_name)
         self.assertFalse(settings.admin_state_up)
         self.assertEqual('foo-project', settings.project_name)
         self.assertEqual('1234', settings.mac_address)
         self.assertEqual(ip_addrs, settings.ip_addrs)
         self.assertEqual('foo', settings.name)
         self.assertEqual('bar', settings.network_name)
         self.assertFalse(settings.admin_state_up)
         self.assertEqual('foo-project', settings.project_name)
         self.assertEqual('1234', settings.mac_address)
         self.assertEqual(ip_addrs, settings.ip_addrs)

-        self.assertEqual(fixed_ips, settings.fixed_ips)

         self.assertEqual(1, len(settings.security_groups))
         self.assertEqual('foo_grp_id', settings.security_groups[0])
         self.assertEqual(allowed_address_pairs, settings.allowed_address_pairs)
         self.assertEqual(1, len(settings.security_groups))
         self.assertEqual('foo_grp_id', settings.security_groups[0])
         self.assertEqual(allowed_address_pairs, settings.allowed_address_pairs)

diff --git a/snaps/openstack/tests/create_router_tests.py b/snaps/openstack/tests/create_router_tests.py
index db3170e..d0f0a9f 100644 (file)
--- a/snaps/openstack/tests/create_router_tests.py
+++ b/snaps/openstack/tests/create_router_tests.py
@@ -23,7 +23,7 @@ from snaps.openstack.create_network import OpenStackNetwork
 from snaps.openstack.create_router import (
     RouterSettings, RouterSettingsError)
 from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase
 from snaps.openstack.create_router import (
     RouterSettings, RouterSettingsError)
 from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase

-from snaps.openstack.utils import neutron_utils
+from snaps.openstack.utils import neutron_utils, settings_utils

 
 __author__ = 'mmakati'
 
 
 __author__ = 'mmakati'
 


@@ -51,9 +51,8 @@ class RouterSettingsUnitTests(unittest.TestCase):
         self.assertEqual('foo', settings.name)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.external_gateway)
         self.assertEqual('foo', settings.name)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.external_gateway)

-        self.assertIsNone(settings.admin_state_up)
+        self.assertTrue(settings.admin_state_up)

         self.assertIsNone(settings.enable_snat)
         self.assertIsNone(settings.enable_snat)

-        self.assertIsNone(settings.external_fixed_ips)

         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(0, len(settings.internal_subnets))
         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(0, len(settings.internal_subnets))


@@ -66,9 +65,8 @@ class RouterSettingsUnitTests(unittest.TestCase):
         self.assertEqual('foo', settings.name)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.external_gateway)
         self.assertEqual('foo', settings.name)
         self.assertIsNone(settings.project_name)
         self.assertIsNone(settings.external_gateway)

-        self.assertIsNone(settings.admin_state_up)
+        self.assertTrue(settings.admin_state_up)

         self.assertIsNone(settings.enable_snat)
         self.assertIsNone(settings.enable_snat)

-        self.assertIsNone(settings.external_fixed_ips)

         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(0, len(settings.internal_subnets))
         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(0, len(settings.internal_subnets))


@@ -80,14 +78,13 @@ class RouterSettingsUnitTests(unittest.TestCase):
         port_settings = PortSettings(name='foo', network_name='bar')
         settings = RouterSettings(
             name='foo', project_name='bar', external_gateway='foo_gateway',
         port_settings = PortSettings(name='foo', network_name='bar')
         settings = RouterSettings(
             name='foo', project_name='bar', external_gateway='foo_gateway',

-            admin_state_up=True, enable_snat=False, external_fixed_ips=['ip1'],
+            admin_state_up=True, enable_snat=False,

             internal_subnets=['10.0.0.1/24'], interfaces=[port_settings])
         self.assertEqual('foo', settings.name)
         self.assertEqual('bar', settings.project_name)
         self.assertEqual('foo_gateway', settings.external_gateway)
         self.assertTrue(settings.admin_state_up)
         self.assertFalse(settings.enable_snat)
             internal_subnets=['10.0.0.1/24'], interfaces=[port_settings])
         self.assertEqual('foo', settings.name)
         self.assertEqual('bar', settings.project_name)
         self.assertEqual('foo_gateway', settings.external_gateway)
         self.assertTrue(settings.admin_state_up)
         self.assertFalse(settings.enable_snat)

-        self.assertEqual(['ip1'], settings.external_fixed_ips)

         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(1, len(settings.internal_subnets))
         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(1, len(settings.internal_subnets))


@@ -98,8 +95,7 @@ class RouterSettingsUnitTests(unittest.TestCase):
         settings = RouterSettings(
             **{'name': 'foo', 'project_name': 'bar',
                'external_gateway': 'foo_gateway', 'admin_state_up': True,
         settings = RouterSettings(
             **{'name': 'foo', 'project_name': 'bar',
                'external_gateway': 'foo_gateway', 'admin_state_up': True,

-               'enable_snat': False, 'external_fixed_ips': ['ip1'],
-               'internal_subnets': ['10.0.0.1/24'],
+               'enable_snat': False, 'internal_subnets': ['10.0.0.1/24'],

                'interfaces':
                    [{'port': {'name': 'foo-port',
                               'network_name': 'bar-net'}}]})
                'interfaces':
                    [{'port': {'name': 'foo-port',
                               'network_name': 'bar-net'}}]})


@@ -108,7 +104,6 @@ class RouterSettingsUnitTests(unittest.TestCase):
         self.assertEqual('foo_gateway', settings.external_gateway)
         self.assertTrue(settings.admin_state_up)
         self.assertFalse(settings.enable_snat)
         self.assertEqual('foo_gateway', settings.external_gateway)
         self.assertTrue(settings.admin_state_up)
         self.assertFalse(settings.enable_snat)

-        self.assertEqual(['ip1'], settings.external_fixed_ips)

         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(1, len(settings.internal_subnets))
         self.assertIsNotNone(settings.internal_subnets)
         self.assertTrue(isinstance(settings.internal_subnets, list))
         self.assertEqual(1, len(settings.internal_subnets))


@@ -166,8 +161,9 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 

-        self.assertTrue(verify_router_attributes(
-            router, self.router_creator, ext_gateway=self.ext_net_name))
+        self.assertEqual(self.router_creator.get_router(), router)
+
+        self.check_router_recreation(router, router_settings)

 
     def test_create_router_admin_user_to_new_project(self):
         """
 
     def test_create_router_admin_user_to_new_project(self):
         """


@@ -186,8 +182,9 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 

-        self.assertTrue(verify_router_attributes(
-            router, self.router_creator, ext_gateway=self.ext_net_name))
+        self.assertEqual(self.router_creator.get_router(), router)
+
+        self.check_router_recreation(router, router_settings)

 
     def test_create_router_new_user_to_admin_project(self):
         """
 
     def test_create_router_new_user_to_admin_project(self):
         """


@@ -206,8 +203,9 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 

-        self.assertTrue(verify_router_attributes(
-            router, self.router_creator, ext_gateway=self.ext_net_name))
+        self.assertEqual(self.router_creator.get_router(), router)
+
+        self.check_router_recreation(router, router_settings)

 
     def test_create_delete_router(self):
         """
 
     def test_create_delete_router(self):
         """


@@ -249,26 +247,28 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 
                                           router_settings=router_settings)
         self.assertIsNotNone(router)
 

-        self.assertTrue(verify_router_attributes(router, self.router_creator,
-                                                 admin_state=False))
+        self.assertEqual(self.router_creator.get_router(), router)
+
+        self.check_router_recreation(router, router_settings)

 
     def test_create_router_admin_state_True(self):
         """
         Test creation of a basic router with admin state Up.
         """
 
     def test_create_router_admin_state_True(self):
         """
         Test creation of a basic router with admin state Up.
         """

-        router_settings = RouterSettings(name=self.guid + '-pub-router',
-                                         admin_state_up=True)
+        router_settings = RouterSettings(
+            name=self.guid + '-pub-router', admin_state_up=True)

 
 

-        self.router_creator = create_router.OpenStackRouter(self.os_creds,
-                                                            router_settings)
+        self.router_creator = create_router.OpenStackRouter(
+            self.os_creds, router_settings)

         self.router_creator.create()
 
         self.router_creator.create()
 

-        router = neutron_utils.get_router(self.neutron,
-                                          router_settings=router_settings)
+        router = neutron_utils.get_router(
+            self.neutron, router_settings=router_settings)

         self.assertIsNotNone(router)
 
         self.assertIsNotNone(router)
 

-        self.assertTrue(verify_router_attributes(router, self.router_creator,
-                                                 admin_state=True))
+        self.assertEqual(self.router_creator.get_router(), router)
+
+        self.check_router_recreation(router, router_settings)

 
     def test_create_router_private_network(self):
         """
 
     def test_create_router_private_network(self):
         """


@@ -321,10 +321,10 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
                                                             router_settings)
         self.router_creator.create()
 
                                                             router_settings)
         self.router_creator.create()
 

-        router = neutron_utils.get_router(self.neutron,
-                                          router_settings=router_settings)
+        router = neutron_utils.get_router(
+            self.neutron, router_settings=router_settings)

 
 

-        self.assertTrue(verify_router_attributes(router, self.router_creator))
+        self.assertEqual(router, self.router_creator.get_router())

 
         # Instantiate second identical creator to ensure a second router
         # has not been created
 
         # Instantiate second identical creator to ensure a second router
         # has not been created


@@ -333,6 +333,8 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
         router2 = router_creator2.create()
         self.assertIsNotNone(self.router_creator.get_router(), router2)
 
         router2 = router_creator2.create()
         self.assertIsNotNone(self.router_creator.get_router(), router2)
 

+        self.check_router_recreation(router2, router_settings)
+

     def test_create_router_external_network(self):
         """
         Test creation of a router connected to an external network and a
     def test_create_router_external_network(self):
         """
         Test creation of a router connected to an external network and a


@@ -360,15 +362,52 @@ class CreateRouterSuccessTests(OSIntegrationTestCase):
         router_settings = RouterSettings(
             name=self.guid + '-pub-router', external_gateway=self.ext_net_name,
             port_settings=port_settings)
         router_settings = RouterSettings(
             name=self.guid + '-pub-router', external_gateway=self.ext_net_name,
             port_settings=port_settings)

-        self.router_creator = create_router.OpenStackRouter(self.os_creds,
-                                                            router_settings)
+        self.router_creator = create_router.OpenStackRouter(
+            self.os_creds, router_settings)

         self.router_creator.create()
 
         self.router_creator.create()
 

-        router = neutron_utils.get_router(self.neutron,
-                                          router_settings=router_settings)
+        router = neutron_utils.get_router(
+            self.neutron, router_settings=router_settings)
+
+        self.assertEquals(router, self.router_creator.get_router())

 
 

-        self.assertTrue(verify_router_attributes(
-            router, self.router_creator, ext_gateway=self.ext_net_name))
+        self.check_router_recreation(router, router_settings)
+
+    def check_router_recreation(self, router, orig_settings):
+        """
+        Validates the derived RouterSettings with the original
+        :param router: the Router domain object to test
+        :param orig_settings: the original RouterSettings object that was
+                              responsible for creating the router
+        :return: the derived RouterSettings object
+        """
+        derived_settings = settings_utils.create_router_settings(
+            self.neutron, router)
+        self.assertIsNotNone(derived_settings)
+        self.assertEqual(
+            orig_settings.enable_snat, derived_settings.enable_snat)
+        self.assertEqual(orig_settings.external_gateway,
+                         derived_settings.external_gateway)
+        self.assertEqual(orig_settings.name, derived_settings.name)
+        self.assertEqual(orig_settings.internal_subnets,
+                         derived_settings.internal_subnets)
+
+        if orig_settings.external_gateway:
+            self.assertEqual(len(orig_settings.port_settings),
+                             len(derived_settings.port_settings))
+        else:
+            self.assertEqual(len(orig_settings.port_settings),
+                             len(derived_settings.port_settings))
+
+        if len(orig_settings.port_settings) > 0:
+            self.assertEqual(orig_settings.port_settings[0].name,
+                             derived_settings.port_settings[0].name)
+
+        if len(orig_settings.port_settings) > 1:
+            self.assertEqual(orig_settings.port_settings[1].name,
+                             derived_settings.port_settings[1].name)
+
+        return derived_settings

 
 
 class CreateRouterNegativeTests(OSIntegrationTestCase):
 
 
 class CreateRouterNegativeTests(OSIntegrationTestCase):


@@ -415,42 +454,3 @@ class CreateRouterNegativeTests(OSIntegrationTestCase):
             self.router_creator = create_router.OpenStackRouter(
                 self.os_creds, router_settings)
             self.router_creator.create()
             self.router_creator = create_router.OpenStackRouter(
                 self.os_creds, router_settings)
             self.router_creator.create()

-
-
-def verify_router_attributes(router_operational, router_creator,
-                             admin_state=True, ext_gateway=None):
-    """
-    Helper function to validate the attributes of router created with the one
-    operational
-    :param router_operational: Operational Router object returned from neutron
-                               utils of type snaps.domain.Router
-    :param router_creator: router_creator object returned from creating a
-                           router in the router test functions
-    :param admin_state: True if router is expected to be Up, else False
-    :param ext_gateway: None if router is not connected to external gateway
-    :return:
-    """
-
-    router = router_creator.get_router()
-
-    if not router_operational:
-        return False
-    elif not router_creator:
-        return False
-    elif not (router_operational.name == router_creator.router_settings.name):
-        return False
-    elif not (router_operational.id == router.id):
-        return False
-    elif not (router_operational.status == router.status):
-        return False
-    elif not (router_operational.tenant_id == router.tenant_id):
-        return False
-    elif not (admin_state == router_operational.admin_state_up):
-        return False
-    elif (ext_gateway is None) and \
-            (router_operational.external_gateway_info is not None):
-        return False
-    elif ext_gateway is not None:
-        if router_operational.external_gateway_info is None:
-            return False
-    return True

diff --git a/snaps/openstack/tests/create_stack_tests.py b/snaps/openstack/tests/create_stack_tests.py
index 94085a0..daf114b 100644 (file)
--- a/snaps/openstack/tests/create_stack_tests.py
+++ b/snaps/openstack/tests/create_stack_tests.py
@@ -493,6 +493,80 @@ class CreateStackFloatingIpTests(OSIntegrationTestCase):
                 self.assertEqual(0, len(vm_settings.floating_ip_settings))
 
 
                 self.assertEqual(0, len(vm_settings.floating_ip_settings))
 
 

+class CreateStackRouterTests(OSIntegrationTestCase):
+    """
+    Tests for the CreateStack class defined in create_stack.py where the
+    target is a Network, Subnet, and Router
+    """
+
+    def setUp(self):
+        """
+        Instantiates the CreateStack object that is responsible for downloading
+        and creating an OS stack file within OpenStack
+        """
+        super(self.__class__, self).__start__()
+
+        self.guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
+
+        self.heat_creds = self.admin_os_creds
+        self.heat_creds.project_name = self.admin_os_creds.project_name
+
+        self.heat_cli = heat_utils.heat_client(self.heat_creds)
+        self.neutron = neutron_utils.neutron_client(self.os_creds)
+        self.stack_creator = None
+
+        self.net_name = self.guid + '-net'
+        self.subnet_name = self.guid + '-subnet'
+        self.router_name = self.guid + '-router'
+
+        self.env_values = {
+            'net_name': self.net_name,
+            'subnet_name': self.subnet_name,
+            'router_name': self.router_name,
+            'external_net_name': self.ext_net_name}
+
+        self.heat_tmplt_path = pkg_resources.resource_filename(
+            'snaps.openstack.tests.heat', 'router_heat_template.yaml')
+
+        stack_settings = StackSettings(
+            name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
+            template_path=self.heat_tmplt_path,
+            env_values=self.env_values)
+        self.stack_creator = create_stack.OpenStackHeatStack(
+            self.heat_creds, stack_settings)
+        self.created_stack = self.stack_creator.create()
+        self.assertIsNotNone(self.created_stack)
+
+    def tearDown(self):
+        """
+        Cleans the stack and downloaded stack file
+        """
+        if self.stack_creator:
+            try:
+                self.stack_creator.clean()
+            except:
+                pass
+
+        super(self.__class__, self).__clean__()
+
+    def test_retrieve_router_creator(self):
+        """
+        Tests the creation of an OpenStack stack from Heat template file and
+        the retrieval of an OpenStackRouter creator/state machine instance
+        """
+        router_creators = self.stack_creator.get_router_creators()
+        self.assertEqual(1, len(router_creators))
+
+        creator = router_creators[0]
+        self.assertEqual(self.router_name, creator.router_settings.name)
+
+        router = creator.get_router()
+
+        ext_net = neutron_utils.get_network(
+            self.neutron, network_name=self.ext_net_name)
+        self.assertEqual(ext_net.id, router.external_network_id)
+
+

 class CreateStackVolumeTests(OSIntegrationTestCase):
     """
     Tests for the CreateStack class as they pertain to volumes
 class CreateStackVolumeTests(OSIntegrationTestCase):
     """
     Tests for the CreateStack class as they pertain to volumes

diff --git a/snaps/openstack/tests/heat/router_heat_template.yaml b/snaps/openstack/tests/heat/router_heat_template.yaml
new file mode 100644 (file)
index 0000000..ee7f60c
--- /dev/null
+++ b/snaps/openstack/tests/heat/router_heat_template.yaml
@@ -0,0 +1,69 @@
+##############################################################################
+# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
+#                    and others.  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.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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.
+##############################################################################
+heat_template_version: 2015-04-30
+
+description: >
+  Sample template with two VMs instantiated against different images and
+  flavors on the same network and the first one has a floating IP
+
+parameters:
+  net_name:
+    type: string
+    label: Test network name
+    description: The name of the stack's network
+    default: test_net
+  subnet_name:
+    type: string
+    label: Test subnet name
+    description: The name of the stack's subnet
+    default: test_subnet
+  router_name:
+    type: string
+    label: Test router name
+    description: The name of the stack's router
+    default: mgmt_router
+  external_net_name:
+    type: string
+    description: Name of the external network which management network will connect to
+    default: external
+
+resources:
+  network:
+    type: OS::Neutron::Net
+    properties:
+      name: { get_param: net_name }
+
+  subnet:
+    type: OS::Neutron::Subnet
+    properties:
+      name: { get_param: subnet_name }
+      ip_version: 4
+      cidr: 10.1.2.0/24
+      network: { get_resource: network }
+
+  management_router:
+    type: OS::Neutron::Router
+    properties:
+      name: { get_param: router_name }
+      external_gateway_info:
+        network: { get_param: external_net_name }
+
+  management_router_interface:
+    type: OS::Neutron::RouterInterface
+    properties:
+      router: { get_resource: management_router }
+      subnet: { get_resource: subnet }

diff --git a/snaps/openstack/utils/heat_utils.py b/snaps/openstack/utils/heat_utils.py
index ad354e0..02b4f7c 100644 (file)
--- a/snaps/openstack/utils/heat_utils.py
+++ b/snaps/openstack/utils/heat_utils.py
@@ -197,14 +197,32 @@ def get_stack_networks(heat_cli, neutron, stack):
     out = list()
     resources = get_resources(heat_cli, stack, 'OS::Neutron::Net')
     for resource in resources:
     out = list()
     resources = get_resources(heat_cli, stack, 'OS::Neutron::Net')
     for resource in resources:

-        network = neutron_utils.get_network_by_id(
-            neutron, resource.id)
+        network = neutron_utils.get_network_by_id(neutron, resource.id)

         if network:
             out.append(network)
 
     return out
 
 
         if network:
             out.append(network)
 
     return out
 
 

+def get_stack_routers(heat_cli, neutron, stack):
+    """
+    Returns a list of Network domain objects deployed by this stack
+    :param heat_cli: the OpenStack heat client object
+    :param neutron: the OpenStack neutron client object
+    :param stack: the SNAPS-OO Stack domain object
+    :return: a list of Network objects
+    """
+
+    out = list()
+    resources = get_resources(heat_cli, stack, 'OS::Neutron::Router')
+    for resource in resources:
+        router = neutron_utils.get_router_by_id(neutron, resource.id)
+        if router:
+            out.append(router)
+
+    return out
+
+

 def get_stack_servers(heat_cli, nova, stack):
     """
     Returns a list of VMInst domain objects associated with a Stack
 def get_stack_servers(heat_cli, nova, stack):
     """
     Returns a list of VMInst domain objects associated with a Stack

diff --git a/snaps/openstack/utils/neutron_utils.py b/snaps/openstack/utils/neutron_utils.py
index 806bb53..24c4afd 100644 (file)
--- a/snaps/openstack/utils/neutron_utils.py
+++ b/snaps/openstack/utils/neutron_utils.py
@@ -231,7 +231,7 @@ def create_router(neutron, os_creds, router_settings):
         json_body = router_settings.dict_for_neutron(neutron, os_creds)
         logger.info('Creating router with name - ' + router_settings.name)
         os_router = neutron.create_router(json_body)
         json_body = router_settings.dict_for_neutron(neutron, os_creds)
         logger.info('Creating router with name - ' + router_settings.name)
         os_router = neutron.create_router(json_body)

-        return Router(**os_router['router'])
+        return __map_router(neutron, os_router['router'])

     else:
         logger.error("Failed to create router.")
         raise NeutronException('Failed to create router')
     else:
         logger.error("Failed to create router.")
         raise NeutronException('Failed to create router')


@@ -257,7 +257,7 @@ def get_router_by_id(neutron, router_id):
     """
     router = neutron.show_router(router_id)
     if router:
     """
     router = neutron.show_router(router_id)
     if router:

-        return Router(**router['router'])
+        return __map_router(neutron, router['router'])

 
 
 def get_router(neutron, router_settings=None, router_name=None):
 
 
 def get_router(neutron, router_settings=None, router_name=None):


@@ -281,11 +281,40 @@ def get_router(neutron, router_settings=None, router_name=None):
         return None
 
     routers = neutron.list_routers(**router_filter)
         return None
 
     routers = neutron.list_routers(**router_filter)

+

     for routerInst in routers['routers']:
     for routerInst in routers['routers']:

-        return Router(**routerInst)
+        return __map_router(neutron, routerInst)
+

     return None
 
 
     return None
 
 

+def __map_router(neutron, os_router):
+    """
+    Takes an OpenStack router instance and maps it to a SNAPS Router domain
+    object
+    :param neutron: the neutron client
+    :param os_router: the OpenStack Router object
+    :return:
+    """
+    device_ports = neutron.list_ports(
+        **{'device_id': os_router['id']})['ports']
+    port_subnets = list()
+
+    # Order by create date
+    sorted_ports = sorted(device_ports, key=lambda dev_port: dev_port['created_at'])
+
+    for port in sorted_ports:
+        subnets = list()
+        for fixed_ip in port['fixed_ips']:
+            subnet = get_subnet_by_id(neutron, fixed_ip['subnet_id'])
+            if subnet and subnet.network_id == port['network_id']:
+                subnets.append(subnet)
+        port_subnets.append((Port(**port), subnets))
+
+    os_router['port_subnets'] = port_subnets
+    return Router(**os_router)
+
+

 def add_interface_router(neutron, router, subnet=None, port=None):
     """
     Adds an interface router for OpenStack for either a subnet or port.
 def add_interface_router(neutron, router, subnet=None, port=None):
     """
     Adds an interface router for OpenStack for either a subnet or port.

diff --git a/snaps/openstack/utils/settings_utils.py b/snaps/openstack/utils/settings_utils.py
index 2ab3c28..2e29063 100644 (file)
--- a/snaps/openstack/utils/settings_utils.py
+++ b/snaps/openstack/utils/settings_utils.py
@@ -21,6 +21,7 @@ from snaps.openstack.create_instance import (
 from snaps.openstack.create_keypairs import KeypairSettings
 from snaps.openstack.create_network import (
     PortSettings, SubnetSettings, NetworkSettings)
 from snaps.openstack.create_keypairs import KeypairSettings
 from snaps.openstack.create_network import (
     PortSettings, SubnetSettings, NetworkSettings)

+from snaps.openstack.create_router import RouterSettings

 from snaps.openstack.create_volume import VolumeSettings
 from snaps.openstack.create_volume_type import (
     VolumeTypeSettings, VolumeTypeEncryptionSettings, ControlLocation)
 from snaps.openstack.create_volume import VolumeSettings
 from snaps.openstack.create_volume_type import (
     VolumeTypeSettings, VolumeTypeEncryptionSettings, ControlLocation)


@@ -67,6 +68,60 @@ def create_subnet_settings(neutron, network):
     return out
 
 
     return out
 
 

+def create_router_settings(neutron, router):
+    """
+    Returns a RouterSettings object
+    :param neutron: the neutron client
+    :param router: a SNAPS-OO Router domain object
+    :return:
+    """
+    ext_net_name = None
+
+    if router.external_network_id:
+        network = neutron_utils.get_network_by_id(
+            neutron, router.external_network_id)
+        if network:
+            ext_net_name = network.name
+
+    ports_tuple_list = list()
+    if router.port_subnets:
+        for port, subnets in router.port_subnets:
+            network = neutron_utils.get_network_by_id(
+                neutron, port.network_id)
+
+            ip_addrs = list()
+            if network and router.external_fixed_ips:
+                for ext_fixed_ips in router.external_fixed_ips:
+                    for subnet in subnets:
+                        if ext_fixed_ips['subnet_id'] == subnet.id:
+                            ip_addrs.append(ext_fixed_ips['ip_address'])
+            else:
+                for ip in port.ips:
+                    ip_addrs.append(ip)
+
+            ip_list = list()
+            if len(ip_addrs) > 0:
+                for ip_addr in ip_addrs:
+                    if isinstance(ip_addr, dict):
+                        ip_list.append(ip_addr['ip_address'])
+                    else:
+                        ip_list.append(ip_addr)
+
+            ports_tuple_list.append((network, ip_list))
+
+    port_settings = __create_port_settings(neutron, ports_tuple_list)
+
+    filtered_settings = list()
+    for port_setting in port_settings:
+        if port_setting.network_name != ext_net_name:
+            filtered_settings.append(port_setting)
+
+    return RouterSettings(
+        name=router.name, external_gateway=ext_net_name,
+        admin_state_up=router.admin_state_up,
+        port_settings=filtered_settings)
+
+

 def create_volume_settings(volume):
     """
     Returns a VolumeSettings object
 def create_volume_settings(volume):
     """
     Returns a VolumeSettings object


@@ -162,8 +217,15 @@ def create_vm_inst_settings(nova, neutron, server):
     kwargs = dict()
     kwargs['name'] = server.name
     kwargs['flavor'] = flavor_name
     kwargs = dict()
     kwargs['name'] = server.name
     kwargs['flavor'] = flavor_name

+
+    net_tuples = list()
+    for net_name, ips in server.networks.items():
+        network = neutron_utils.get_network(neutron, network_name=net_name)
+        if network:
+            net_tuples.append((network, ips))
+

     kwargs['port_settings'] = __create_port_settings(
     kwargs['port_settings'] = __create_port_settings(

-        neutron, server.networks)
+        neutron, net_tuples)

     kwargs['security_group_names'] = server.sec_grp_names
     kwargs['floating_ip_settings'] = __create_floatingip_settings(
         neutron, kwargs['port_settings'])
     kwargs['security_group_names'] = server.sec_grp_names
     kwargs['floating_ip_settings'] = __create_floatingip_settings(
         neutron, kwargs['port_settings'])


@@ -175,24 +237,32 @@ def __create_port_settings(neutron, networks):
     """
     Returns a list of port settings based on the networks parameter
     :param neutron: the neutron client
     """
     Returns a list of port settings based on the networks parameter
     :param neutron: the neutron client

-    :param networks: a dict where the key is the network name and the value
-                     is a list of IP addresses
+    :param networks: a list of tuples where #1 is the SNAPS Network domain
+                     object and #2 is a list of IP addresses

     :return:
     """
     out = list()
 
     :return:
     """
     out = list()
 

-    for net_name, ips in networks.items():
-        network = neutron_utils.get_network(neutron, network_name=net_name)
+    for network, ips in networks:

         ports = neutron_utils.get_ports(neutron, network, ips)
         for port in ports:
         ports = neutron_utils.get_ports(neutron, network, ips)
         for port in ports:

-            kwargs = dict()
-            if port.name:
-                kwargs['name'] = port.name
-            kwargs['network_name'] = network.name
-            kwargs['mac_address'] = port.mac_address
-            kwargs['allowed_address_pairs'] = port.allowed_address_pairs
-            kwargs['admin_state_up'] = port.admin_state_up
-            out.append(PortSettings(**kwargs))
+            if port.device_owner != 'network:dhcp':
+                ip_addrs = list()
+                for ip_dict in port.ips:
+                    subnet = neutron_utils.get_subnet_by_id(
+                        neutron, ip_dict['subnet_id'])
+                    ip_addrs.append({'subnet_name': subnet.name,
+                                     'ip': ip_dict['ip_address']})
+
+                kwargs = dict()
+                if port.name:
+                    kwargs['name'] = port.name
+                kwargs['network_name'] = network.name
+                kwargs['mac_address'] = port.mac_address
+                kwargs['allowed_address_pairs'] = port.allowed_address_pairs
+                kwargs['admin_state_up'] = port.admin_state_up
+                kwargs['ip_addrs'] = ip_addrs
+                out.append(PortSettings(**kwargs))

 
     return out
 
 
     return out
 

diff --git a/snaps/openstack/utils/tests/heat_utils_tests.py b/snaps/openstack/utils/tests/heat_utils_tests.py
index 567cf7b..56bed6b 100644 (file)
--- a/snaps/openstack/utils/tests/heat_utils_tests.py
+++ b/snaps/openstack/utils/tests/heat_utils_tests.py
@@ -405,6 +405,85 @@ class HeatUtilsCreateComplexStackTests(OSComponentTestCase):
         self.assertEqual(self.keypair_name, keypair2_settings.name)
 
 
         self.assertEqual(self.keypair_name, keypair2_settings.name)
 
 

+class HeatUtilsRouterTests(OSComponentTestCase):
+    """
+    Test Heat volume functionality
+    """
+
+    def setUp(self):
+        """
+        Instantiates OpenStack instances that cannot be spawned by Heat
+        """
+        guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
+        stack_name = guid + '-stack'
+
+        self.net_name = guid + '-net'
+        self.subnet_name = guid + '-subnet'
+        self.router_name = guid + '-router'
+
+        env_values = {
+            'net_name': self.net_name,
+            'subnet_name': self.subnet_name,
+            'router_name': self.router_name,
+            'external_net_name': self.ext_net_name}
+
+        heat_tmplt_path = pkg_resources.resource_filename(
+            'snaps.openstack.tests.heat', 'router_heat_template.yaml')
+        self.stack_settings = StackSettings(
+            name=stack_name, template_path=heat_tmplt_path,
+            env_values=env_values)
+        self.stack = None
+        self.heat_client = heat_utils.heat_client(self.os_creds)
+        self.neutron = neutron_utils.neutron_client(self.os_creds)
+
+    def tearDown(self):
+        """
+        Cleans the image and downloaded image file
+        """
+        if self.stack:
+            try:
+                heat_utils.delete_stack(self.heat_client, self.stack)
+            except:
+                pass
+
+    def test_create_router_with_stack(self):
+        """
+        Tests the creation of an OpenStack router with Heat and the retrieval
+        of the Router Domain objects from heat_utils#get_stack_routers().
+        """
+        self.stack = heat_utils.create_stack(
+            self.heat_client, self.stack_settings)
+
+        # Wait until stack deployment has completed
+        end_time = time.time() + create_stack.STACK_COMPLETE_TIMEOUT
+        is_active = False
+        while time.time() < end_time:
+            status = heat_utils.get_stack_status(self.heat_client,
+                                                 self.stack.id)
+            if status == create_stack.STATUS_CREATE_COMPLETE:
+                is_active = True
+                break
+            elif status == create_stack.STATUS_CREATE_FAILED:
+                is_active = False
+                break
+
+            time.sleep(3)
+
+        self.assertTrue(is_active)
+
+        routers = heat_utils.get_stack_routers(
+            self.heat_client, self.neutron, self.stack)
+
+        self.assertEqual(1, len(routers))
+
+        router = routers[0]
+        self.assertEqual(self.router_name, router.name)
+
+        ext_net = neutron_utils.get_network(
+            self.neutron, network_name=self.ext_net_name)
+        self.assertEqual(ext_net.id, router.external_network_id)
+
+

 class HeatUtilsVolumeTests(OSComponentTestCase):
     """
     Test Heat volume functionality
 class HeatUtilsVolumeTests(OSComponentTestCase):
     """
     Test Heat volume functionality

diff --git a/snaps/openstack/utils/tests/neutron_utils_tests.py b/snaps/openstack/utils/tests/neutron_utils_tests.py
index 05d508d..0726920 100644 (file)
--- a/snaps/openstack/utils/tests/neutron_utils_tests.py
+++ b/snaps/openstack/utils/tests/neutron_utils_tests.py
@@ -352,7 +352,7 @@ class NeutronUtilsRouterTests(OSComponentTestCase):
         ext_net = neutron_utils.get_network(
             self.neutron, network_name=self.ext_net_name)
         self.assertEqual(
         ext_net = neutron_utils.get_network(
             self.neutron, network_name=self.ext_net_name)
         self.assertEqual(

-            self.router.external_gateway_info['network_id'], ext_net.id)
+            self.router.external_network_id, ext_net.id)

 
     def test_create_router_empty_name(self):
         """
 
     def test_create_router_empty_name(self):
         """

diff --git a/snaps/openstack/utils/tests/settings_utils_tests.py b/snaps/openstack/utils/tests/settings_utils_tests.py
index 69bdf7c..3073d53 100644 (file)
--- a/snaps/openstack/utils/tests/settings_utils_tests.py
+++ b/snaps/openstack/utils/tests/settings_utils_tests.py
@@ -150,8 +150,6 @@ class SettingsUtilsVmInstTests(OSComponentTestCase):
         Instantiates the CreateImage object that is responsible for downloading
         and creating an OS image file within OpenStack
         """
         Instantiates the CreateImage object that is responsible for downloading
         and creating an OS image file within OpenStack
         """

-        # super(self.__class__, self).__start__()
-

         self.nova = nova_utils.nova_client(self.os_creds)
         self.glance = glance_utils.glance_client(self.os_creds)
         self.neutron = neutron_utils.neutron_client(self.os_creds)
         self.nova = nova_utils.nova_client(self.os_creds)
         self.glance = glance_utils.glance_client(self.os_creds)
         self.neutron = neutron_utils.neutron_client(self.os_creds)