Move IncorrectConfig, IncorrectSetup and IncorrectNodeSetup to exceptions

JIRA: YARDSTICK-1218

Change-Id: I804065e9bce3e728f5bf9e756a78df8fd28f74ac
Signed-off-by: Rodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>

7 files changed, 50 insertions, 67 deletions

diff --git a/yardstick/benchmark/scenarios/networking/vnf_generic.py b/yardstick/benchmark/scenarios/networking/vnf_generic.py
index 78f866e25..1c3ea1f8d 100644
--- a/yardstick/benchmark/scenarios/networking/vnf_generic.py
+++ b/yardstick/benchmark/scenarios/networking/vnf_generic.py
@@ -13,20 +13,19 @@
 # limitations under the License.
 
 import copy
-import logging
-import time
-
 import ipaddress
 from itertools import chain
+import logging
 import os
 import sys
+import time
 
 import six
 import yaml
 
 from yardstick.benchmark.scenarios import base as scenario_base
-from yardstick.error import IncorrectConfig
 from yardstick.common.constants import LOG_DIR
+from yardstick.common import exceptions
 from yardstick.common.process import terminate_children
 from yardstick.common import utils
 from yardstick.network_services.collector.subscriber import Collector
@@ -190,8 +189,9 @@ class NetworkServiceTestCase(scenario_base.Scenario):
             try:
                 node0_data, node1_data = vld["vnfd-connection-point-ref"]
             except (ValueError, TypeError):
-                raise IncorrectConfig("Topology file corrupted, "
-                                      "wrong endpoint count for connection")
+                raise exceptions.IncorrectConfig(
+                    error_msg='Topology file corrupted, wrong endpoint count '
+                              'for connection')
 
             node0_name = self._find_vnf_name_from_id(node0_data["member-vnf-index-ref"])
             node1_name = self._find_vnf_name_from_id(node1_data["member-vnf-index-ref"])
@@ -237,15 +237,17 @@ class NetworkServiceTestCase(scenario_base.Scenario):
 
             except KeyError:
                 LOG.exception("")
-                raise IncorrectConfig("Required interface not found, "
-                                      "topology file corrupted")
+                raise exceptions.IncorrectConfig(
+                    error_msg='Required interface not found, topology file '
+                              'corrupted')
 
         for vld in self.topology['vld']:
             try:
                 node0_data, node1_data = vld["vnfd-connection-point-ref"]
             except (ValueError, TypeError):
-                raise IncorrectConfig("Topology file corrupted, "
-                                      "wrong endpoint count for connection")
+                raise exceptions.IncorrectConfig(
+                    error_msg='Topology file corrupted, wrong endpoint count '
+                              'for connection')
 
             node0_name = self._find_vnf_name_from_id(node0_data["member-vnf-index-ref"])
             node1_name = self._find_vnf_name_from_id(node1_data["member-vnf-index-ref"])
@@ -330,8 +332,9 @@ class NetworkServiceTestCase(scenario_base.Scenario):
         except StopIteration:
             pass
 
-        raise IncorrectConfig("No implementation for %s found in %s" %
-                              (expected_name, classes_found))
+        message = ('No implementation for %s found in %s'
+                   % (expected_name, classes_found))
+        raise exceptions.IncorrectConfig(error_msg=message)
 
     @staticmethod
     def create_interfaces_from_node(vnfd, node):
diff --git a/yardstick/common/exceptions.py b/yardstick/common/exceptions.py
index 40703e623..0b1698289 100644
--- a/yardstick/common/exceptions.py
+++ b/yardstick/common/exceptions.py
@@ -155,6 +155,18 @@ class SSHTimeout(SSHError):
     pass
 
 
+class IncorrectConfig(YardstickException):
+    message = '%(error_msg)s'
+
+
+class IncorrectSetup(YardstickException):
+    message = '%(error_msg)s'
+
+
+class IncorrectNodeSetup(IncorrectSetup):
+    pass
+
+
 class ScenarioConfigContextNameNotFound(YardstickException):
     message = 'Context name "%(context_name)s" not found'
 
diff --git a/yardstick/error.py b/yardstick/error.py
deleted file mode 100644
index cb4f306eb..000000000
--- a/yardstick/error.py
+++ /dev/null
@@ -1,28 +0,0 @@
-# Copyright (c) 2016-2017 Intel Corporation
-#
-# 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.
-
-
-class IncorrectConfig(Exception):
-    """Class handles incorrect configuration during setup"""
-    pass
-
-
-class IncorrectSetup(Exception):
-    """Class handles incorrect setup during setup"""
-    pass
-
-
-class IncorrectNodeSetup(IncorrectSetup):
-    """Class handles incorrect setup during setup"""
-    pass
diff --git a/yardstick/network_services/helpers/dpdkbindnic_helper.py b/yardstick/network_services/helpers/dpdkbindnic_helper.py
index e98a738c3..1c74355ef 100644
--- a/yardstick/network_services/helpers/dpdkbindnic_helper.py
+++ b/yardstick/network_services/helpers/dpdkbindnic_helper.py
@@ -20,9 +20,6 @@ from itertools import chain
 
 from yardstick.common import exceptions
 from yardstick.common.utils import validate_non_string_sequence
-from yardstick.error import IncorrectConfig
-from yardstick.error import IncorrectSetup
-from yardstick.error import IncorrectNodeSetup
 
 
 NETWORK_KERNEL = 'network_kernel'
@@ -51,7 +48,7 @@ class DpdkInterface(object):
         try:
             assert self.local_mac
         except (AssertionError, KeyError):
-            raise IncorrectConfig
+            raise exceptions.IncorrectConfig(error_msg='')
 
     @property
     def local_mac(self):
@@ -98,11 +95,12 @@ class DpdkInterface(object):
             # if we don't find all the keys then don't update
             pass
 
-        except (IncorrectNodeSetup, exceptions.SSHError,
+        except (exceptions.IncorrectNodeSetup, exceptions.SSHError,
                 exceptions.SSHTimeout):
-            raise IncorrectConfig(
-                "Unable to probe missing interface fields '%s', on node %s "
-                "SSH Error" % (', '.join(self.missing_fields), self.dpdk_node.node_key))
+            message = ('Unable to probe missing interface fields "%s", on '
+                       'node %s SSH Error' % (', '.join(self.missing_fields),
+                                              self.dpdk_node.node_key))
+            raise exceptions.IncorrectConfig(error_msg=message)
 
 
 class DpdkNode(object):
@@ -119,11 +117,12 @@ class DpdkNode(object):
         try:
             self.dpdk_interfaces = {intf['name']: DpdkInterface(self, intf['virtual-interface'])
                                     for intf in self.interfaces}
-        except IncorrectConfig:
+        except exceptions.IncorrectConfig:
             template = "MAC address is required for all interfaces, missing on: {}"
             errors = (intf['name'] for intf in self.interfaces if
                       'local_mac' not in intf['virtual-interface'])
-            raise IncorrectSetup(template.format(", ".join(errors)))
+            raise exceptions.IncorrectSetup(
+                error_msg=template.format(", ".join(errors)))
 
     @property
     def dpdk_helper(self):
@@ -177,7 +176,7 @@ class DpdkNode(object):
                 self._probe_netdevs()
                 try:
                     self._probe_missing_values()
-                except IncorrectConfig:
+                except exceptions.IncorrectConfig:
                     # ignore for now
                     pass
 
@@ -194,7 +193,7 @@ class DpdkNode(object):
                       missing_fields)
             errors = "\n".join(errors)
             if errors:
-                raise IncorrectSetup(errors)
+                raise exceptions.IncorrectSetup(error_msg=errors)
 
         finally:
             self._dpdk_helper = None
diff --git a/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py b/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
index 9bfbf0752..2885dc6fb 100644
--- a/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
+++ b/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
@@ -20,11 +20,11 @@ import mock
 import unittest
 
 from yardstick import tests
+from yardstick.common import exceptions
 from yardstick.common import utils
 from yardstick.network_services.collector.subscriber import Collector
 from yardstick.network_services.traffic_profile import base
 from yardstick.network_services.vnf_generic import vnfdgen
-from yardstick.error import IncorrectConfig
 from yardstick.network_services.vnf_generic.vnf.base import GenericTrafficGen
 from yardstick.network_services.vnf_generic.vnf.base import GenericVNF
 
@@ -423,7 +423,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
         with mock.patch.dict(sys.modules, tests.STL_MOCKS):
             self.assertIsNotNone(self.s.get_vnf_impl(vnfd))
 
-        with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+        with self.assertRaises(exceptions.IncorrectConfig) as raised:
             self.s.get_vnf_impl('NonExistentClass')
 
         exc_str = str(raised.exception)
@@ -465,7 +465,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
 
         cfg_patch = mock.patch.object(self.s, 'context_cfg', cfg)
         with cfg_patch:
-            with self.assertRaises(IncorrectConfig):
+            with self.assertRaises(exceptions.IncorrectConfig):
                 self.s.map_topology_to_infrastructure()
 
     def test_map_topology_to_infrastructure_config_invalid(self):
@@ -482,7 +482,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
 
         config_patch = mock.patch.object(self.s, 'context_cfg', cfg)
         with config_patch:
-            with self.assertRaises(IncorrectConfig):
+            with self.assertRaises(exceptions.IncorrectConfig):
                 self.s.map_topology_to_infrastructure()
 
     def test__resolve_topology_invalid_config(self):
@@ -496,7 +496,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             for interface in self.tg__1['interfaces'].values():
                 del interface['local_mac']
 
-            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+            with self.assertRaises(exceptions.IncorrectConfig) as raised:
                 self.s._resolve_topology()
 
             self.assertIn('not found', str(raised.exception))
@@ -509,7 +509,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.s.topology["vld"][0]['vnfd-connection-point-ref'].append(
                 self.s.topology["vld"][0]['vnfd-connection-point-ref'][0])
 
-            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+            with self.assertRaises(exceptions.IncorrectConfig) as raised:
                 self.s._resolve_topology()
 
             self.assertIn('wrong endpoint count', str(raised.exception))
@@ -518,7 +518,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.s.topology["vld"][0]['vnfd-connection-point-ref'] = \
                 self.s.topology["vld"][0]['vnfd-connection-point-ref'][:1]
 
-            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+            with self.assertRaises(exceptions.IncorrectConfig) as raised:
                 self.s._resolve_topology()
 
             self.assertIn('wrong endpoint count', str(raised.exception))
diff --git a/yardstick/tests/unit/common/test_utils.py b/yardstick/tests/unit/common/test_utils.py
index b6d7bf5a3..87995ac49 100644
--- a/yardstick/tests/unit/common/test_utils.py
+++ b/yardstick/tests/unit/common/test_utils.py
@@ -21,7 +21,6 @@ import unittest
 
 import yardstick
 from yardstick import ssh
-import yardstick.error
 from yardstick.common import constants
 from yardstick.common import utils
 from yardstick.common import exceptions
diff --git a/yardstick/tests/unit/network_services/helpers/test_dpdkbindnic_helper.py b/yardstick/tests/unit/network_services/helpers/test_dpdkbindnic_helper.py
index 0278c20dc..9d94e3d0b 100644
--- a/yardstick/tests/unit/network_services/helpers/test_dpdkbindnic_helper.py
+++ b/yardstick/tests/unit/network_services/helpers/test_dpdkbindnic_helper.py
@@ -18,9 +18,6 @@ import unittest
 import os
 
 from yardstick.common import exceptions
-from yardstick.error import IncorrectConfig
-from yardstick.error import IncorrectNodeSetup
-from yardstick.error import IncorrectSetup
 from yardstick.network_services.helpers.dpdkbindnic_helper import DpdkInterface
 from yardstick.network_services.helpers.dpdkbindnic_helper import DpdkNode
 from yardstick.network_services.helpers.dpdkbindnic_helper import DpdkBindHelper
@@ -143,12 +140,13 @@ class TestDpdkInterface(unittest.TestCase):
 
     def test_probe_missing_values_negative(self):
         mock_dpdk_node = mock.Mock()
-        mock_dpdk_node.netdevs.values.side_effect = IncorrectNodeSetup
+        mock_dpdk_node.netdevs.values.side_effect = (
+            exceptions.IncorrectNodeSetup(error_msg=''))
 
         interface = {'local_mac': '0a:de:ad:be:ef:f5'}
         dpdk_intf = DpdkInterface(mock_dpdk_node, interface)
 
-        with self.assertRaises(IncorrectConfig):
+        with self.assertRaises(exceptions.IncorrectConfig):
             dpdk_intf.probe_missing_values()
 
 
@@ -214,7 +212,7 @@ class TestDpdkNode(unittest.TestCase):
     def test_check(self):
         def update():
             if not mock_force_rebind.called:
-                raise IncorrectConfig
+                raise exceptions.IncorrectConfig(error_msg='')
 
             interfaces[0]['virtual-interface'].update({
                 'vpci': '0000:01:02.1',
@@ -249,7 +247,7 @@ class TestDpdkNode(unittest.TestCase):
 
         dpdk_node = DpdkNode(NAME, self.INTERFACES, mock_ssh_helper)
 
-        with self.assertRaises(IncorrectSetup):
+        with self.assertRaises(exceptions.IncorrectSetup):
             dpdk_node.check()
 
     def test_probe_netdevs(self):