Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / errors.py @ 8694bdad

History | View | Annotate | Download (6.2 kB)

1
# Copyright 2013 GRNET S.A. All rights reserved.
2
#
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
#
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
#
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
#
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
#
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33

    
34
from kamaki.cli.logger import get_logger
35

    
36
log = get_logger('kamaki.cli')
37

    
38

    
39
class CLIError(Exception):
40

    
41
    def __init__(self, message, details=[], importance=0):
42
        """
43
        :param message: is the main message of the Error
44
        :param defaults: is a list of previous errors
45
        :param importance: of the output for the user (0, 1, 2, 3)
46
        """
47
        message += '' if message and message.endswith('\n') else '\n'
48
        super(CLIError, self).__init__(message)
49
        self.details = (list(details) if (
50
            isinstance(details, list) or isinstance(details, tuple)) else [
51
                '%s' % details]) if details else []
52
        try:
53
            self.importance = int(importance or 0)
54
        except ValueError:
55
            self.importance = 0
56

    
57

    
58
class CLIUnimplemented(CLIError):
59
    def __init__(
60
            self,
61
            message='I \'M SORRY, DAVE.\nI \'M AFRAID I CAN\'T DO THAT.',
62
            details=[
63
                '      _        |',
64
                '   _-- --_     |',
65
                '  --     --    |',
66
                ' --   .   --   |',
67
                ' -_       _-   |',
68
                '   -_   _-     |',
69
                '      -        |'],
70
            importance=3):
71
        super(CLIUnimplemented, self).__init__(message, details, importance)
72

    
73

    
74
class CLIBaseUrlError(CLIError):
75
    def __init__(self, message='', details=[], importance=2, service=None):
76
        service = '%s' % (service or '')
77
        message = message or 'No URL for %s' % service.lower()
78
        details = details or [
79
            'Two ways to resolve this:',
80
            '(Use the correct cloud name, instead of "default")',
81
            'A. (recommended) Let kamaki discover endpoint URLs for all',
82
            'services by setting a single Authentication URL and token:',
83
            '  /config set cloud.default.url <AUTH_URL>',
84
            '  /config set cloud.default.token <t0k3n>',
85
            'B. (advanced users) Explicitly set an %s endpoint URL' % (
86
                service.upper()),
87
            'Note: URL option has a higher priority, so delete it to',
88
            'make that work',
89
            '  /config delete cloud.default.url',
90
            '  /config set cloud.%s.url <%s_URL>' % (
91
                service, service.upper())]
92
        super(CLIBaseUrlError, self).__init__(message, details, importance)
93

    
94

    
95
class CLISyntaxError(CLIError):
96
    def __init__(self, message='Syntax Error', details=[], importance=1):
97
        super(CLISyntaxError, self).__init__(message, details, importance)
98

    
99

    
100
class CLIInvalidArgument(CLISyntaxError):
101
    def __init__(self, message='Invalid Argument', details=[], importance=1):
102
        super(CLIInvalidArgument, self).__init__(message, details, importance)
103

    
104

    
105
class CLIUnknownCommand(CLIError):
106
    def __init__(self, message='Unknown Command', details=[], importance=1):
107
        super(CLIUnknownCommand, self).__init__(message, details, importance)
108

    
109

    
110
class CLICmdSpecError(CLIError):
111
    def __init__(
112
            self, message='Command Specification Error',
113
            details=[], importance=0):
114
        super(CLICmdSpecError, self).__init__(message, details, importance)
115

    
116

    
117
def raiseCLIError(err, message='', importance=0, details=[]):
118
    """
119
    :param err: (Exception) the original error message, if None, a new
120
        CLIError is born which is conceptually bind to raiser
121

122
    :param message: (str) a custom error message that overrides err's
123

124
    :param importance: (int) instruction to called application (e.g. for
125
        coloring printed error messages)
126

127
    :param details: (list) various information on the error
128

129
    :raises CLIError: it is the purpose of this method
130
    """
131
    from traceback import format_stack
132

    
133
    stack = ['%s' % type(err)] if err else ['<kamaki.cli.errors.CLIError>']
134
    stack += format_stack()
135

    
136
    details = list(details) if (
137
        isinstance(details, list) or isinstance(details, tuple)) else [
138
            '%s' % details]
139
    details += getattr(err, 'details', [])
140

    
141
    origerr = (('%s' % err) or '%s' % type(err)) if err else stack[0]
142
    message = '%s' % message or origerr
143

    
144
    try:
145
        status = err.status or err.errno
146
    except AttributeError:
147
        try:
148
            status = err.errno
149
        except AttributeError:
150
            status = None
151

    
152
    if origerr not in details + [message]:
153
        details.append(origerr)
154

    
155
    message += '' if message and message.endswith('\n') else '\n'
156
    if status:
157
        message = '(%s) %s' % (status, message)
158
        try:
159
            status = int(status)
160
        except ValueError:
161
            raise CLIError(message, details, importance or 0)
162
        importance = importance or status // 100
163
    importance = getattr(err, 'importance', importance)
164
    raise CLIError(message, details, importance)