summaryrefslogtreecommitdiff
path: root/iotronic/common/exception.py
blob: f7866458b7e907f6aab5548d1fc9311d0571f068 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# 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.

"""Iotronic base exception handling.

Includes decorator for re-raising Iotronic-type exceptions.

SHOULD include dedicated exception logging.

"""

from oslo_config import cfg
from oslo_log import log as logging
import six

from iotronic.common.i18n import _
from iotronic.common.i18n import _LE

LOG = logging.getLogger(__name__)

exc_log_opts = [
    cfg.BoolOpt('fatal_exception_format_errors',
                default=False,
                help='Used if there is a formatting error when generating an '
                     'exception message (a programming error). If True, '
                     'raise an exception; if False, use the unformatted '
                     'message.'),
]

CONF = cfg.CONF
CONF.register_opts(exc_log_opts)


def _cleanse_dict(original):
    """Strip all admin_password, new_pass, rescue_pass keys from a dict."""
    return dict((k, v) for k, v in original.iteritems() if "_pass" not in k)


class IotronicException(Exception):
    """Base Iotronic Exception

    To correctly use this class, inherit from it and define
    a 'message' property. That message will get printf'd
    with the keyword arguments provided to the constructor.

    """
    message = _("An unknown exception occurred.")
    code = 500
    headers = {}
    safe = False

    def __init__(self, message=None, **kwargs):
        self.kwargs = kwargs

        if 'code' not in self.kwargs:
            try:
                self.kwargs['code'] = self.code
            except AttributeError:
                pass

        if not message:
            try:
                message = self.message % kwargs

            except Exception as e:
                # kwargs doesn't match a variable in the message
                # log the issue and the kwargs
                LOG.exception(_LE('Exception in string format operation'))
                for name, value in kwargs.items():
                    LOG.error("%s: %s" % (name, value))

                if CONF.fatal_exception_format_errors:
                    raise e
                else:
                    # at least get the core message out if something happened
                    message = self.message

        super(IotronicException, self).__init__(message)

    def __str__(self):
        """Encode to utf-8 then wsme api can consume it as well."""
        if not six.PY3:
            return unicode(self.args[0]).encode('utf-8')

        return self.args[0]

    def format_message(self):
        if self.__class__.__name__.endswith('_Remote'):
            return self.args[0]
        else:
            return six.text_type(self)


class NotAuthorized(IotronicException):
    message = _("Not authorized.")
    code = 403


class OperationNotPermitted(NotAuthorized):
    message = _("Operation not permitted.")


class Invalid(IotronicException):
    message = _("Unacceptable parameters.")
    code = 400


class Conflict(IotronicException):
    message = _('Conflict.')
    code = 409


class TemporaryFailure(IotronicException):
    message = _("Resource temporarily unavailable, please retry.")
    code = 503


class NotAcceptable(IotronicException):
    # TODO(deva): We need to set response headers in the API for this exception
    message = _("Request not acceptable.")
    code = 406


class InvalidState(Conflict):
    message = _("Invalid resource state.")


class BoardAlreadyExists(Conflict):
    message = _("A board with UUID %(uuid)s already exists.")


class MACAlreadyExists(Conflict):
    message = _("A port with MAC address %(mac)s already exists.")


class PortAlreadyExists(Conflict):
    message = _("A port with UUID %(uuid)s already exists.")


class DuplicateName(Conflict):
    message = _("A board with name %(name)s already exists.")


class DuplicateCode(Conflict):
    message = _("A board with code %(code)s already exists.")


class InvalidUUID(Invalid):
    message = _("Expected a uuid but received %(uuid)s.")


class InvalidUuidOrName(Invalid):
    message = _("Expected a logical name or uuid but received %(name)s.")


class InvalidName(Invalid):
    message = _("Expected a logical name but received %(name)s.")


class InvalidIdentity(Invalid):
    message = _("Expected an uuid or int but received %(identity)s.")


class InvalidMAC(Invalid):
    message = _("Expected a MAC address but received %(mac)s.")


class InvalidStateRequested(Invalid):
    message = _('The requested action "%(action)s" can not be performed '
                'on board "%(board)s" while it is in state "%(state)s".')


class PatchError(Invalid):
    message = _("Couldn't apply patch '%(patch)s'. Reason: %(reason)s")


class InstanceDeployFailure(IotronicException):
    message = _("Failed to deploy instance: %(reason)s")


class ImageUnacceptable(IotronicException):
    message = _("Image %(image_id)s is unacceptable: %(reason)s")


class ImageConvertFailed(IotronicException):
    message = _("Image %(image_id)s is unacceptable: %(reason)s")


# Cannot be templated as the error syntax varies.
# msg needs to be constructed when raised.
class InvalidParameterValue(Invalid):
    message = _("%(err)s")


class MissingParameterValue(InvalidParameterValue):
    message = _("%(err)s")


class Duplicate(IotronicException):
    message = _("Resource already exists.")


class NotFound(IotronicException):
    message = _("Resource could not be found.")
    code = 404


class DHCPLoadError(IotronicException):
    message = _("Failed to load DHCP provider %(dhcp_provider_name)s, "
                "reason: %(reason)s")


class DriverNotFound(NotFound):
    message = _("Could not find the following driver(s): %(driver_name)s.")


class ImageNotFound(NotFound):
    message = _("Image %(image_id)s could not be found.")


class NoValidHost(NotFound):
    message = _("No valid host was found. Reason: %(reason)s")


class InstanceNotFound(NotFound):
    message = _("Instance %(instance)s could not be found.")


class BoardNotFound(NotFound):
    message = _("Board %(board)s could not be found.")


class BoardNotConnected(Invalid):
    message = _("Board %(board)s is not connected.")


class BoardAssociated(InvalidState):
    message = _("Board %(board)s is associated with instance %(instance)s.")


class PortNotFound(NotFound):
    message = _("Port %(port)s could not be found.")


class FailedToUpdateDHCPOptOnPort(IotronicException):
    message = _("Update DHCP options on port: %(port_id)s failed.")


class FailedToGetIPAddressOnPort(IotronicException):
    message = _("Retrieve IP address on port: %(port_id)s failed.")


class InvalidIPv4Address(IotronicException):
    message = _("Invalid IPv4 address %(ip_address)s.")


class FailedToUpdateMacOnPort(IotronicException):
    message = _("Update MAC address on port: %(port_id)s failed.")


class NoDriversLoaded(IotronicException):
    message = _("Conductor %(conductor)s cannot be started "
                "because no drivers were loaded.")


class ConductorNotFound(NotFound):
    message = _("Conductor %(conductor)s could not be found.")


class ConductorAlreadyRegistered(IotronicException):
    message = _("Conductor %(conductor)s already registered.")


class WampAgentNotFound(NotFound):
    message = _("WampAgent %(wampagent)s could not be found.")


class WampRegistrationAgentNotFound(NotFound):
    message = _("No Wamp Registration Agent could not be found.")


class WampAgentAlreadyRegistered(IotronicException):
    message = _("WampAgent %(wampagent)s already registered.")


class PowerStateFailure(InvalidState):
    message = _("Failed to set board power state to %(pstate)s.")


class ExclusiveLockRequired(NotAuthorized):
    message = _("An exclusive lock is required, "
                "but the current context has a shared lock.")


class BoardMaintenanceFailure(Invalid):
    message = _("Failed to toggle maintenance-mode flag "
                "for board %(board)s: %(reason)s")


class BoardConsoleNotEnabled(Invalid):
    message = _("Console access is not enabled on board %(board)s")


class BoardInMaintenance(Invalid):
    message = _("The %(op)s operation can't be performed on board "
                "%(board)s because it's in maintenance mode.")


class IPMIFailure(IotronicException):
    message = _("IPMI call failed: %(cmd)s.")


class AMTConnectFailure(IotronicException):
    message = _("Failed to connect to AMT service.")


class AMTFailure(IotronicException):
    message = _("AMT call failed: %(cmd)s.")


class MSFTOCSClientApiException(IotronicException):
    message = _("MSFT OCS call failed.")


class SSHConnectFailed(IotronicException):
    message = _("Failed to establish SSH connection to host %(host)s.")


class SSHCommandFailed(IotronicException):
    message = _("Failed to execute command via SSH: %(cmd)s.")


class UnsupportedObjectError(IotronicException):
    message = _('Unsupported object type %(objtype)s')


class OrphanedObjectError(IotronicException):
    message = _('Cannot call %(method)s on orphaned %(objtype)s object')


class UnsupportedDriverExtension(Invalid):
    message = _('Driver %(driver)s does not support %(extension)s '
                '(disabled or not implemented).')


class IncompatibleObjectVersion(IotronicException):
    message = _('Version %(objver)s of %(objname)s is not supported')


class GlanceConnectionFailed(IotronicException):
    message = _("Connection to glance host %(host)s:%(port)s failed: "
                "%(reason)s")


class ImageNotAuthorized(NotAuthorized):
    message = _("Not authorized for image %(image_id)s.")


class InvalidImageRef(Invalid):
    message = _("Invalid image href %(image_href)s.")


class ImageRefValidationFailed(IotronicException):
    message = _("Validation of image href %(image_href)s failed, "
                "reason: %(reason)s")


class ImageDownloadFailed(IotronicException):
    message = _("Failed to download image %(image_href)s, reason: %(reason)s")


class KeystoneUnauthorized(IotronicException):
    message = _("Not authorized in Keystone.")


class KeystoneFailure(IotronicException):
    pass


class CatalogNotFound(IotronicException):
    message = _("Service type %(service_type)s with endpoint type "
                "%(endpoint_type)s not found in keystone service catalog.")


class ServiceUnavailable(IotronicException):
    message = _("Connection failed")


class Forbidden(IotronicException):
    message = _("Requested Iotronic API is forbidden")


class BadRequest(IotronicException):
    pass


class InvalidEndpoint(IotronicException):
    message = _("The provided endpoint is invalid")


class CommunicationError(IotronicException):
    message = _("Unable to communicate with the server.")


class HTTPForbidden(NotAuthorized):
    message = _("Access was denied to the following resource: %(resource)s")


class Unauthorized(IotronicException):
    pass


class HTTPNotFound(NotFound):
    pass


class ConfigNotFound(IotronicException):
    message = _("Could not find config at %(path)s")


class BoardLocked(Conflict):
    message = _("Board %(board)s is locked by host %(host)s, please retry "
                "after the current operation is completed.")


class BoardNotLocked(Invalid):
    message = _("Board %(board)s found not to be locked on release")


class NoFreeConductorWorker(TemporaryFailure):
    message = _('Requested action cannot be performed due to lack of free '
                'conductor workers.')
    code = 503  # Service Unavailable (temporary).


class VendorPassthruException(IotronicException):
    pass


class ConfigInvalid(IotronicException):
    message = _("Invalid configuration file. %(error_msg)s")


class DriverLoadError(IotronicException):
    message = _("Driver %(driver)s could not be loaded. Reason: %(reason)s.")


class ConsoleError(IotronicException):
    pass


class NoConsolePid(ConsoleError):
    message = _("Could not find pid in pid file %(pid_path)s")


class ConsoleSubprocessFailed(ConsoleError):
    message = _("Console subprocess failed to start. %(error)s")


class PasswordFileFailedToCreate(IotronicException):
    message = _("Failed to create the password file. %(error)s")


class IBootOperationError(IotronicException):
    pass


class IloOperationError(IotronicException):
    message = _("%(operation)s failed, error: %(error)s")


class IloOperationNotSupported(IotronicException):
    message = _("%(operation)s not supported. error: %(error)s")


class DracRequestFailed(IotronicException):
    pass


class DracClientError(DracRequestFailed):
    message = _('DRAC client failed. '
                'Last error (cURL error code): %(last_error)s, '
                'fault string: "%(fault_string)s" '
                'response_code: %(response_code)s')


class DracOperationFailed(DracRequestFailed):
    message = _('DRAC operation failed. Message: %(message)s')


class DracUnexpectedReturnValue(DracRequestFailed):
    message = _('DRAC operation yielded return value %(actual_return_value)s '
                'that is neither error nor expected %(expected_return_value)s')


class DracPendingConfigJobExists(IotronicException):
    message = _('Another job with ID %(job_id)s is already created  '
                'to configure %(target)s. Wait until existing job '
                'is completed or is canceled')


class DracInvalidFilterDialect(IotronicException):
    message = _('Invalid filter dialect \'%(invalid_filter)s\'. '
                'Supported options are %(supported)s')


class FailedToGetSensorData(IotronicException):
    message = _("Failed to get sensor data for board %(board)s. "
                "Error: %(error)s")


class FailedToParseSensorData(IotronicException):
    message = _("Failed to parse sensor data for board %(board)s. "
                "Error: %(error)s")


class InsufficientDiskSpace(IotronicException):
    message = _("Disk volume where '%(path)s' is located doesn't have "
                "enough disk space. Required %(required)d MiB, "
                "only %(actual)d MiB available space present.")


class ImageCreationFailed(IotronicException):
    message = _('Creating %(image_type)s image failed: %(error)s')


class SwiftOperationError(IotronicException):
    message = _("Swift operation '%(operation)s' failed: %(error)s")


class SNMPFailure(IotronicException):
    message = _("SNMP operation '%(operation)s' failed: %(error)s")


class FileSystemNotSupported(IotronicException):
    message = _("Failed to create a file system. "
                "File system %(fs)s is not supported.")


class IRMCOperationError(IotronicException):
    message = _('iRMC %(operation)s failed. Reason: %(error)s')


class VirtualBoxOperationFailed(IotronicException):
    message = _("VirtualBox operation '%(operation)s' failed. "
                "Error: %(error)s")


class HardwareInspectionFailure(IotronicException):
    message = _("Failed to inspect hardware. Reason: %(error)s")


class BoardCleaningFailure(IotronicException):
    message = _("Failed to clean board %(board)s: %(reason)s")


class PathNotFound(IotronicException):
    message = _("Path %(dir)s does not exist.")


class DirectoryNotWritable(IotronicException):
    message = _("Directory %(dir)s is not writable.")


class PluginNotFound(NotFound):
    message = _("Plugin %(plugin)s could not be found.")


class InjectionPluginNotFound(NotFound):
    message = _("InjectionPlugin could not be found.")


class InvalidPluginAction(Invalid):
    message = _("Invalid Action %(action)s for the plugin.")


class NeedParams(Invalid):
    message = _("Action %(action)s needs parameters.")


class ErrorExecutionOnBoard(IotronicException):
    message = _("Error in the execution of %(call)s on %(board)s: %(error)s")


class ServiceNotFound(NotFound):
    message = _("Service %(Service)s could not be found.")