16af2cc69c0d791d8c072a7a2bb53c289d927832
[yardstick.git] / 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 InfluxDBConfigurationMissing(YardstickException):
63     message = ('InfluxDB configuration is not available. Add "influxdb" as '
64                'a dispatcher and the configuration section')
65
66
67 class YardstickBannedModuleImported(YardstickException):
68     # pragma: no cover
69     message = 'Module "%(module)s" cannnot be imported. Reason: "%(reason)s"'
70
71
72 class PayloadMissingAttributes(YardstickException):
73     message = ('Error instantiating a Payload class, missing attributes: '
74                '%(missing_attributes)s')
75
76
77 class HeatTemplateError(YardstickException):
78     """Error in Heat during the stack deployment"""
79     message = ('Error in Heat during the creation of the OpenStack stack '
80                '"%(stack_name)s"')
81
82
83 class IPv6RangeError(YardstickException):
84     message = 'Start IP "%(start_ip)s" is greater than end IP "%(end_ip)s"'
85
86
87 class TrafficProfileNotImplemented(YardstickException):
88     message = 'No implementation for traffic profile %(profile_class)s.'
89
90
91 class DPDKSetupDriverError(YardstickException):
92     message = '"igb_uio" driver is not loaded'
93
94
95 class OVSUnsupportedVersion(YardstickException):
96     message = ('Unsupported OVS version "%(ovs_version)s". Please check the '
97                'config. OVS to DPDK version map: %(ovs_to_dpdk_map)s.')
98
99
100 class OVSHugepagesInfoError(YardstickException):
101     message = 'MemInfo cannnot be retrieved.'
102
103
104 class OVSHugepagesNotConfigured(YardstickException):
105     message = 'HugePages are not configured in this system.'
106
107
108 class OVSHugepagesZeroFree(YardstickException):
109     message = ('There are no HugePages free in this system. Total HugePages '
110                'configured: %(total_hugepages)s')
111
112
113 class OVSDeployError(YardstickException):
114     message = 'OVS deploy tool failed with error: %(stderr)s.'
115
116
117 class OVSSetupError(YardstickException):
118     message = 'OVS setup error. Command: %(command)s. Error: %(error)s.'
119
120
121 class LibvirtCreateError(YardstickException):
122     message = 'Error creating the virtual machine. Error: %(error)s.'
123
124
125 class LibvirtQemuImageBaseImageNotPresent(YardstickException):
126     message = ('Error creating the qemu image for %(vm_image)s. Base image: '
127                '%(base_image)s. Base image not present in execution host or '
128                'remote host.')
129
130
131 class LibvirtQemuImageCreateError(YardstickException):
132     message = ('Error creating the qemu image for %(vm_image)s. Base image: '
133                '%(base_image)s. Error: %(error)s.')
134
135
136 class ScenarioConfigContextNameNotFound(YardstickException):
137     message = 'Context name "%(context_name)s" not found'
138
139
140 class StackCreationInterrupt(YardstickException):
141     message = 'Stack create interrupted.'
142
143
144 class TaskRenderArgumentError(YardstickException):
145     message = 'Error reading the task input arguments'
146
147
148 class TaskReadError(YardstickException):
149     message = 'Failed to read task %(task_file)s'
150
151
152 class TaskRenderError(YardstickException):
153     message = 'Failed to render template:\n%(input_task)s'
154
155
156 class TimerTimeout(YardstickException):
157     message = 'Timer timeout expired, %(timeout)s seconds'
158
159
160 class WaitTimeout(YardstickException):
161     message = 'Wait timeout while waiting for condition'
162
163
164 class ScenarioCreateNetworkError(YardstickException):
165     message = 'Create Neutron Network Scenario failed'
166
167
168 class ScenarioCreateSubnetError(YardstickException):
169     message = 'Create Neutron Subnet Scenario failed'
170
171
172 class ScenarioDeleteRouterError(YardstickException):
173     message = 'Delete Neutron Router Scenario failed'
174
175
176 class MissingPodInfoError(YardstickException):
177     message = 'Missing pod args, please check'
178
179
180 class UnsupportedPodFormatError(YardstickException):
181     message = 'Failed to load pod info, unsupported format'
182
183
184 class ScenarioCreateRouterError(YardstickException):
185     message = 'Create Neutron Router Scenario failed'
186
187
188 class ScenarioRemoveRouterIntError(YardstickException):
189     message = 'Remove Neutron Router Interface Scenario failed'
190
191
192 class ScenarioCreateFloatingIPError(YardstickException):
193     message = 'Create Neutron Floating IP Scenario failed'
194
195
196 class ScenarioDeleteFloatingIPError(YardstickException):
197     message = 'Delete Neutron Floating IP Scenario failed'
198
199
200 class ScenarioCreateSecurityGroupError(YardstickException):
201     message = 'Create Neutron Security Group Scenario failed'
202
203
204 class ScenarioDeleteNetworkError(YardstickException):
205     message = 'Delete Neutron Network Scenario failed'
206
207
208 class ScenarioCreateServerError(YardstickException):
209     message = 'Nova Create Server Scenario failed'
210
211
212 class ScenarioDeleteServerError(YardstickException):
213     message = 'Delete Server Scenario failed'
214
215
216 class ScenarioCreateKeypairError(YardstickException):
217     message = 'Nova Create Keypair Scenario failed'
218
219
220 class ScenarioDeleteKeypairError(YardstickException):
221     message = 'Nova Delete Keypair Scenario failed'
222
223
224 class ScenarioAttachVolumeError(YardstickException):
225     message = 'Nova Attach Volume Scenario failed'
226
227
228 class ScenarioGetServerError(YardstickException):
229     message = 'Nova Get Server Scenario failed'
230
231
232 class ScenarioGetFlavorError(YardstickException):
233     message = 'Nova Get Falvor Scenario failed'