yardstick/common/exceptions.py

   1 # Copyright (c) 2017 Intel Corporation
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 from oslo_utils import excutils
  16
  17
  18 class ProcessExecutionError(RuntimeError):
  19     def __init__(self, message, returncode):
  20         super(ProcessExecutionError, self).__init__(message)
  21         self.returncode = returncode
  22
  23
  24 class YardstickException(Exception):
  25     """Base Yardstick Exception.
  26
  27     To correctly use this class, inherit from it and define
  28     a 'message' property. That message will get printf'd
  29     with the keyword arguments provided to the constructor.
  30
  31     Based on NeutronException class.
  32     """
  33     message = "An unknown exception occurred."
  34
  35     def __init__(self, **kwargs):
  36         try:
  37             super(YardstickException, self).__init__(self.message % kwargs)
  38             self.msg = self.message % kwargs
  39         except Exception:  # pylint: disable=broad-except
  40             with excutils.save_and_reraise_exception() as ctxt:
  41                 if not self.use_fatal_exceptions():
  42                     ctxt.reraise = False
  43                     # at least get the core message out if something happened
  44                     super(YardstickException, self).__init__(self.message)
  45
  46     def __str__(self):
  47         return self.msg
  48
  49     def use_fatal_exceptions(self):
  50         """Is the instance using fatal exceptions.
  51
  52         :returns: Always returns False.
  53         """
  54         return False
  55
  56
  57 class FunctionNotImplemented(YardstickException):
  58     message = ('The function "%(function_name)s" is not implemented in '
  59                '"%(class_name)" class.')
  60
  61
  62 class HeatTemplateError(YardstickException):
  63     """Error in Heat during the stack deployment"""
  64     message = ('Error in Heat during the creation of the OpenStack stack '
  65                '"%(stack_name)"')
  66
  67
  68 class DPDKSetupDriverError(YardstickException):
  69     message = '"igb_uio" driver is not loaded'