Created custom exceptions for VM instance creation.

Created VmInstanceSettingsError for errors creating VmInstanceSettings
objects
Created FloatingIpSettingsError for errors creating FloatingIpSettings
objects
Created VmInstanceCreationError for errors creating VM instances

JIRA: SNAPS-132

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

2 files changed, 51 insertions, 29 deletions

diff --git a/snaps/openstack/create_instance.py b/snaps/openstack/create_instance.py
index 97f04f3..d5917a8 100644
--- a/snaps/openstack/create_instance.py
+++ b/snaps/openstack/create_instance.py
@@ -126,7 +126,7 @@ class OpenStackVmInstance:
 
         if block:
             if not self.vm_active(block=True):
-                raise Exception(
+                raise VmInstanceCreationError(
                     'Fatal error, VM did not become ACTIVE within the alloted '
                     'time')
 
@@ -136,7 +136,7 @@ class OpenStackVmInstance:
                 nova_utils.add_security_group(self.__nova, self.__vm,
                                               sec_grp_name)
             else:
-                raise Exception(
+                raise VmInstanceCreationError(
                     'Cannot applying security group with name ' +
                     sec_grp_name +
                     ' to VM that did not activate with name - ' +
@@ -157,7 +157,7 @@ class OpenStackVmInstance:
             port = port_dict.get(floating_ip_setting.port_name)
 
             if not port:
-                raise Exception(
+                raise VmInstanceCreationError(
                     'Cannot find port object with name - ' +
                     floating_ip_setting.port_name)
 
@@ -178,9 +178,9 @@ class OpenStackVmInstance:
                     floating_ip_setting.router_name)
                 self.__add_floating_ip(floating_ip, port, subnet)
             else:
-                raise Exception('Unable to add floating IP to port,'
-                                ' cannot locate router with an external '
-                                'gateway ')
+                raise VmInstanceCreationError(
+                    'Unable to add floating IP to port, cannot locate router '
+                    'with an external gateway ')
 
     def __ext_gateway_by_router(self, router_name):
         """
@@ -314,11 +314,12 @@ class OpenStackVmInstance:
                     count -= 1
                     pass
         else:
-            raise Exception(
+            raise VmInstanceCreationError(
                 'Unable find IP address on which to place the floating IP')
 
         logger.error('Timeout attempting to add the floating IP to instance.')
-        raise Exception('Timeout while attempting add floating IP to instance')
+        raise VmInstanceCreationError(
+            'Timeout while attempting add floating IP to instance')
 
     def get_os_creds(self):
         """
@@ -568,7 +569,8 @@ class OpenStackVmInstance:
             return False
 
         if status == 'ERROR':
-            raise Exception('Instance had an error during deployment')
+            raise VmInstanceCreationError(
+                'Instance had an error during deployment')
         logger.debug(
             'Instance status [%s] is - %s', self.instance_settings.name,
             status)
@@ -743,7 +745,7 @@ class VmInstanceSettings:
             elif isinstance(kwargs['security_group_names'], str):
                 self.security_group_names = [kwargs['security_group_names']]
             else:
-                raise Exception(
+                raise VmInstanceSettingsError(
                     'Invalid data type for security_group_names attribute')
         else:
             self.security_group_names = set()
@@ -781,11 +783,11 @@ class VmInstanceSettings:
             self.availability_zone = None
 
         if not self.name or not self.flavor:
-            raise Exception(
+            raise VmInstanceSettingsError(
                 'Instance configuration requires the attributes: name, flavor')
 
         if len(self.port_settings) == 0:
-            raise Exception(
+            raise VmInstanceSettingsError(
                 'Instance configuration requires port settings (aka. NICS)')
 
 
@@ -822,6 +824,24 @@ class FloatingIpSettings:
             self.provisioning = True
 
         if not self.name or not self.port_name or not self.router_name:
-            raise Exception(
+            raise FloatingIpSettingsError(
                 'The attributes name, port_name and router_name are required '
                 'for FloatingIPSettings')
+
+
+class VmInstanceSettingsError(Exception):
+    """
+    Exception to be thrown when an VM instance settings are incorrect
+    """
+
+
+class FloatingIpSettingsError(Exception):
+    """
+    Exception to be thrown when an VM instance settings are incorrect
+    """
+
+
+class VmInstanceCreationError(Exception):
+    """
+    Exception to be thrown when an VM instance cannot be created
+    """
diff --git a/snaps/openstack/tests/create_instance_tests.py b/snaps/openstack/tests/create_instance_tests.py
index ebdb76a..66b83cb 100644
--- a/snaps/openstack/tests/create_instance_tests.py
+++ b/snaps/openstack/tests/create_instance_tests.py
@@ -20,12 +20,14 @@ import unittest
 import uuid
 
 import os
+from neutronclient.common.exceptions import InvalidIpForSubnetClient
 
 from snaps import file_utils
 from snaps.openstack.create_flavor import OpenStackFlavor, FlavorSettings
 from snaps.openstack.create_image import OpenStackImage, ImageSettings
 from snaps.openstack.create_instance import (
-    VmInstanceSettings, OpenStackVmInstance, FloatingIpSettings)
+    VmInstanceSettings, OpenStackVmInstance, FloatingIpSettings,
+    VmInstanceSettingsError, FloatingIpSettingsError)
 from snaps.openstack.create_keypairs import OpenStackKeypair, KeypairSettings
 from snaps.openstack.create_network import OpenStackNetwork, PortSettings
 from snaps.openstack.create_router import OpenStackRouter
@@ -50,27 +52,27 @@ class VmInstanceSettingsUnitTests(unittest.TestCase):
     """
 
     def test_no_params(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings()
 
     def test_empty_config(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings(config=dict())
 
     def test_name_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings(name='foo')
 
     def test_config_with_name_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings(config={'name': 'foo'})
 
     def test_name_flavor_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings(name='foo', flavor='bar')
 
     def test_config_with_name_flavor_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(VmInstanceSettingsError):
             VmInstanceSettings(config={'name': 'foo', 'flavor': 'bar'})
 
     def test_name_flavor_port_only(self):
@@ -175,35 +177,35 @@ class FloatingIpSettingsUnitTests(unittest.TestCase):
     """
 
     def test_no_params(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings()
 
     def test_empty_config(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(**dict())
 
     def test_name_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(name='foo')
 
     def test_config_with_name_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(**{'name': 'foo'})
 
     def test_name_port_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(name='foo', port_name='bar')
 
     def test_config_with_name_port_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(**{'name': 'foo', 'port_name': 'bar'})
 
     def test_name_router_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(name='foo', router_name='bar')
 
     def test_config_with_name_router_only(self):
-        with self.assertRaises(Exception):
+        with self.assertRaises(FloatingIpSettingsError):
             FloatingIpSettings(**{'name': 'foo', 'router_name': 'bar'})
 
     def test_name_port_router_only(self):
@@ -882,7 +884,7 @@ class CreateInstancePortManipulationTests(OSIntegrationTestCase):
             self.os_creds, instance_settings,
             self.image_creator.image_settings)
 
-        with self.assertRaises(Exception):
+        with self.assertRaises(InvalidIpForSubnetClient):
             self.inst_creator.create()
 
     def test_set_custom_valid_mac(self):