__init__.py 11.2 KB
Newer Older
1
# Copyright 2011-2013 GRNET S.A. All rights reserved.
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
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.command

34
from kamaki.cli.logger import get_logger
35
36
37
from kamaki.cli.utils import (
    print_list, print_dict, print_json, print_items, ask_user,
    filter_dicts_by_dict)
38
from kamaki.cli.argument import FlagArgument, ValueArgument
39
from sys import stdin, stdout, stderr
40

41
log = get_logger(__name__)
42

Stavros Sachtouris's avatar
Stavros Sachtouris committed
43

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def DontRaiseKeyError(foo):
    def wrap(*args, **kwargs):
        try:
            return foo(*args, **kwargs)
        except KeyError:
            return None
    return wrap


def addLogSettings(foo):
    def wrap(self, *args, **kwargs):
        try:
            return foo(self, *args, **kwargs)
        finally:
            self._set_log_params()
            self._update_max_threads
    return wrap


63
class _command_init(object):
64

65
66
    def __init__(
            self,
67
68
69
70
            arguments={}, auth_base=None, cloud=None,
            _in=None, _out=None, _err=None):
        self._in, self._out, self._err = (
            _in or stdin, _out or stdout, _err or stderr)
71
72
        if hasattr(self, 'arguments'):
            arguments.update(self.arguments)
73
74
        if isinstance(self, _optional_output_cmd):
            arguments.update(self.oo_arguments)
75
76
        if isinstance(self, _optional_json):
            arguments.update(self.oj_arguments)
77
78
79
80
        if isinstance(self, _name_filter):
            arguments.update(self.nf_arguments)
        if isinstance(self, _id_filter):
            arguments.update(self.if_arguments)
81
82
83
84
        try:
            arguments.update(self.wait_arguments)
        except AttributeError:
            pass
85
        self.arguments = dict(arguments)
86
        try:
87
            self.config = self['config']
88
89
        except KeyError:
            pass
90
91
        self.auth_base = auth_base or getattr(self, 'auth_base', None)
        self.cloud = cloud or getattr(self, 'cloud', None)
92

93
94
95
96
97
98
99
100
101
102
103
    def write(self, s):
        self._out.write(u'%s' % s)
        self._out.flush()

    def writeln(self, s=''):
        self.write(u'%s\n' % s)

    def error(self, s=''):
        self._err.write(u'%s\n' % s)
        self._err.flush()

104
105
    def print_list(self, *args, **kwargs):
        kwargs.setdefault('out', self._out)
106
        return print_list(*args, **kwargs)
107
108
109

    def print_dict(self, *args, **kwargs):
        kwargs.setdefault('out', self._out)
110
        return print_dict(*args, **kwargs)
111
112
113

    def print_json(self, *args, **kwargs):
        kwargs.setdefault('out', self._out)
114
        return print_json(*args, **kwargs)
115
116
117

    def print_items(self, *args, **kwargs):
        kwargs.setdefault('out', self._out)
118
        return print_items(*args, **kwargs)
119
120
121
122

    def ask_user(self, *args, **kwargs):
        kwargs.setdefault('user_in', self._in)
        kwargs.setdefault('out', self._out)
123
        return ask_user(*args, **kwargs)
124

125
126
    @DontRaiseKeyError
    def _custom_url(self, service):
127
        return self.config.get_cloud(self.cloud, '%s_url' % service)
128
129
130

    @DontRaiseKeyError
    def _custom_token(self, service):
131
        return self.config.get_cloud(self.cloud, '%s_token' % service)
132
133
134

    @DontRaiseKeyError
    def _custom_type(self, service):
135
        return self.config.get_cloud(self.cloud, '%s_type' % service)
136
137
138

    @DontRaiseKeyError
    def _custom_version(self, service):
139
        return self.config.get_cloud(self.cloud, '%s_version' % service)
140

141
142
143
144
145
146
147
    def _uuids2usernames(self, uuids):
        return self.auth_base.post_user_catalogs(uuids).json['uuid_catalog']

    def _usernames2uuids(self, username):
        return self.auth_base.post_user_catalogs(
            displaynames=username).json['displayname_catalog']

148
    def _uuid2username(self, uuid):
149
        return self._uuids2usernames([uuid]).get(uuid, None)
150
151

    def _username2uuid(self, username):
152
        return self._usernames2uuids([username]).get(username, None)
153

154
    def _set_log_params(self):
155
        try:
156
157
158
159
160
161
162
            self.client.LOG_TOKEN = (
                self['config'].get_global('log_token').lower() == 'on')
        except Exception as e:
            log.debug('Failed to read custom log_token setting:'
                '%s\n default for log_token is off' % e)
        try:
            self.client.LOG_DATA = (
163
                self['config'].get_global('log_data').lower() == 'on')
164
        except Exception as e:
165
166
167
168
169
170
171
172
            log.debug('Failed to read custom log_data setting:'
                '%s\n default for log_data is off' % e)
        try:
            self.client.LOG_PID = (
                self['config'].get_global('log_pid').lower() == 'on')
        except Exception as e:
            log.debug('Failed to read custom log_pid setting:'
                '%s\n default for log_pid is off' % e)
173
174

    def _update_max_threads(self):
175
        if getattr(self, 'client', None):
176
            max_threads = int(self['config'].get_global('max_threads'))
177
            assert max_threads > 0, 'invalid max_threads config option'
178
            self.client.MAX_THREADS = max_threads
179

180
181
    def _safe_progress_bar(
            self, msg, arg='progress_bar', countdown=False, timeout=100):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
182
183
184
        """Try to get a progress bar, but do not raise errors"""
        try:
            progress_bar = self.arguments[arg]
185
            progress_bar.file = self._err
186
187
            gen = progress_bar.get_generator(
                msg, countdown=countdown, timeout=timeout)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
188
189
190
191
192
193
194
195
196
197
        except Exception:
            return (None, None)
        return (progress_bar, gen)

    def _safe_progress_bar_finish(self, progress_bar):
        try:
            progress_bar.finish()
        except Exception:
            pass

198
199
200
201
    def __getitem__(self, argterm):
        """
        :param argterm: (str) the name/label of an argument in self.arguments

202
203
        :returns: the value of the corresponding Argument (not the argument
            object)
204
205
206

        :raises KeyError: if argterm not in self.arguments of this object
        """
207
        return self.arguments[argterm].value
208
209
210
211
212
213
214
215
216
217
218
219
220

    def __setitem__(self, argterm, arg):
        """Install an argument as argterm
        If argterm points to another argument, the other argument is lost

        :param argterm: (str)

        :param arg: (Argument)
        """
        if not hasattr(self, 'arguments'):
            self.arguments = {}
        self.arguments[argterm] = arg

221
222
223
224
225
226
227
228
229
230
    def get_argument_object(self, argterm):
        """
        :param argterm: (str) the name/label of an argument in self.arguments

        :returns: the arument object

        :raises KeyError: if argterm not in self.arguments of this object
        """
        return self.arguments[argterm]

231
    def get_argument(self, argterm):
232
233
234
235
236
237
238
        """
        :param argterm: (str) the name/label of an argument in self.arguments

        :returns: the value of the arument object

        :raises KeyError: if argterm not in self.arguments of this object
        """
239
        return self[argterm]
240
241


242
243
244
#  feature classes - inherit them to get special features for your commands


245
246
247
248
249
250
251
252
253
class _optional_output_cmd(object):

    oo_arguments = dict(
        with_output=FlagArgument('show response headers', ('--with-output')),
        json_output=FlagArgument('show headers in json', ('-j', '--json'))
    )

    def _optional_output(self, r):
        if self['json_output']:
254
            print_json(r, out=self._out)
255
        elif self['with_output']:
256
            print_items([r] if isinstance(r, dict) else r, out=self._out)
257
258
259
260
261
262
263
264


class _optional_json(object):

    oj_arguments = dict(
        json_output=FlagArgument('show headers in json', ('-j', '--json'))
    )

265
    def _print(self, output, print_method=print_items, **print_method_kwargs):
266
        if self['json_output']:
267
            print_json(output, out=self._out)
268
        else:
269
270
            print_method_kwargs.setdefault('out', self._out)
            print_method(output, **print_method_kwargs)
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


class _name_filter(object):

    nf_arguments = dict(
        name=ValueArgument('filter by name', '--name'),
        name_pref=ValueArgument(
            'filter by name prefix (case insensitive)', '--name-prefix'),
        name_suff=ValueArgument(
            'filter by name suffix (case insensitive)', '--name-suffix'),
        name_like=ValueArgument(
            'print only if name contains this (case insensitive)',
            '--name-like')
    )

    def _non_exact_name_filter(self, items):
        np, ns, nl = self['name_pref'], self['name_suff'], self['name_like']
        return [item for item in items if (
            (not np) or item['name'].lower().startswith(np.lower())) and (
            (not ns) or item['name'].lower().endswith(ns.lower())) and (
            (not nl) or nl.lower() in item['name'].lower())]

    def _exact_name_filter(self, items):
        return filter_dicts_by_dict(items, dict(name=self['name'])) if (
            self['name']) else items

    def _filter_by_name(self, items):
        return self._non_exact_name_filter(self._exact_name_filter(items))


class _id_filter(object):

    if_arguments = dict(
        id=ValueArgument('filter by id', '--id'),
        id_pref=ValueArgument(
            'filter by id prefix (case insensitive)', '--id-prefix'),
        id_suff=ValueArgument(
            'filter by id suffix (case insensitive)', '--id-suffix'),
        id_like=ValueArgument(
            'print only if id contains this (case insensitive)',
            '--id-like')
    )

    def _non_exact_id_filter(self, items):
        np, ns, nl = self['id_pref'], self['id_suff'], self['id_like']
        return [item for item in items if (
            (not np) or (
                '%s' % item['id']).lower().startswith(np.lower())) and (
            (not ns) or ('%s' % item['id']).lower().endswith(ns.lower())) and (
            (not nl) or nl.lower() in ('%s' % item['id']).lower())]

    def _exact_id_filter(self, items):
        return filter_dicts_by_dict(items, dict(id=self['id'])) if (
            self['id']) else items

    def _filter_by_id(self, items):
        return self._non_exact_id_filter(self._exact_id_filter(items))