__init__.py 13.8 KB
Newer Older
1
# Copyright 2012-2013 GRNET S.A. All rights reserved.
2
3
4
5
6
7
#
# 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
8
9
#      copyright notice, this list of conditions and the following
#      disclaimer.
10
11
#
#   2. Redistributions in binary form must reproduce the above
12
13
14
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#
# 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
32
# or implied, of GRNET S.A.command
33
34

import logging
35
from sys import argv, exit, stdout
36
from os.path import basename
37
from inspect import getargspec
38

39
from kamaki.cli.argument import ArgumentParseManager
40
from kamaki.cli.history import History
41
from kamaki.cli.utils import print_dict, red, magenta, yellow
42
from kamaki.cli.errors import CLIError
43
from kamaki.cli import logger
44

45
46
_help = False
_debug = False
47
_include = False
48
49
_verbose = False
_colors = False
Stavros Sachtouris's avatar
Stavros Sachtouris committed
50
kloger = None
51
filelog = None
52

53
54
55
56
#  command auxiliary methods

_best_match = []

57

58
59
60
def _arg2syntax(arg):
    return arg.replace(
        '____', '[:').replace(
61
62
63
            '___', ':').replace(
                '__', ']').replace(
                    '_', ' ')
64
65


66
def _construct_command_syntax(cls):
67
68
69
        spec = getargspec(cls.main.im_func)
        args = spec.args[1:]
        n = len(args) - len(spec.defaults or ())
70
71
        required = ' '.join(['<%s>' % _arg2syntax(x) for x in args[:n]])
        optional = ' '.join(['[%s]' % _arg2syntax(x) for x in args[n:]])
72
73
74
75
76
        cls.syntax = ' '.join(x for x in [required, optional] if x)
        if spec.varargs:
            cls.syntax += ' <%s ...>' % spec.varargs


77
78
def _num_of_matching_terms(basic_list, attack_list):
    if not attack_list:
79
        return len(basic_list)
80

81
82
83
84
85
86
87
88
89
    matching_terms = 0
    for i, term in enumerate(basic_list):
        try:
            if term != attack_list[i]:
                break
        except IndexError:
            break
        matching_terms += 1
    return matching_terms
90

91

92
93
94
95
96
def _update_best_match(name_terms, prefix=[]):
    if prefix:
        pref_list = prefix if isinstance(prefix, list) else prefix.split('_')
    else:
        pref_list = []
97

98
99
    num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list)
    global _best_match
100
101
    if not prefix:
        _best_match = []
102

103
104
105
106
107
108
109
110
111
    if num_of_matching_terms and len(_best_match) <= num_of_matching_terms:
        if len(_best_match) < num_of_matching_terms:
            _best_match = name_terms[:num_of_matching_terms]
        return True
    return False


def command(cmd_tree, prefix='', descedants_depth=1):
    """Load a class as a command
112
113
114
        e.g. spec_cmd0_cmd1 will be command spec cmd0

        :param cmd_tree: is initialized in cmd_spec file and is the structure
115
            where commands are loaded. Var name should be _commands
116
117
        :param prefix: if given, load only commands prefixed with prefix,
        :param descedants_depth: is the depth of the tree descedants of the
118
119
            prefix command. It is used ONLY if prefix and if prefix is not
            a terminal command
120
121

        :returns: the specified class object
122
123
124
    """

    def wrap(cls):
125
        global kloger
126
127
128
129
        cls_name = cls.__name__

        if not cmd_tree:
            if _debug:
130
                kloger.warning('command %s found but not loaded' % cls_name)
131
            return cls
132

133
134
        name_terms = cls_name.split('_')
        if not _update_best_match(name_terms, prefix):
135
            if _debug:
136
                kloger.warning('%s failed to update_best_match' % cls_name)
137
            return None
138

139
140
141
142
143
144
        global _best_match
        max_len = len(_best_match) + descedants_depth
        if len(name_terms) > max_len:
            partial = '_'.join(name_terms[:max_len])
            if not cmd_tree.has_command(partial):  # add partial path
                cmd_tree.add_command(partial)
145
            if _debug:
146
                kloger.warning('%s failed max_len test' % cls_name)
147
            return None
148

149
150
151
        (
            cls.description, sep, cls.long_description
        ) = cls.__doc__.partition('\n')
152
        _construct_command_syntax(cls)
153

154
155
156
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
157

158

159
160
161
162
163
164
cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
165

166

167
168
169
#  Generic init auxiliary functions


170
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
171
172
173
    """handle logging for clients package"""

    if silent:
174
        logger.add_stream_logger(__name__, logging.CRITICAL)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
175
176
        return

177
    sfmt, rfmt = '> %(message)s', '< %(message)s'
Stavros Sachtouris's avatar
Stavros Sachtouris committed
178
    if debug:
179
180
181
182
        print('Logging location: %s' % logger.get_log_filename())
        logger.add_stream_logger('kamaki.clients.send', logging.DEBUG, sfmt)
        logger.add_stream_logger('kamaki.clients.recv', logging.DEBUG, rfmt)
        logger.add_stream_logger(__name__, logging.DEBUG)
183
    elif verbose:
184
185
186
        logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
        logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
        logger.add_stream_logger(__name__, logging.INFO)
187
    if include:
188
189
190
        logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
        logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
    logger.add_stream_logger(__name__, logging.WARNING)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
191
    global kloger
192
    kloger = logger.get_logger(__name__)
193

194

195
196
197
198
199
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
200
201
    global _include
    _include = arguments['include'].value
202
203
    global _verbose
    _verbose = arguments['verbose'].value
204
    _cnf = arguments['config']
205
206
207
208
209
210

    guess = _cnf.value.guess_version()
    if guess < 3.0:
        print('PLEASE DO NOT PANIC: EXIT THE BUILDING QUIETLY')
    raise CLIError('STOP HERE, PLEASE %s' % guess)

211
    global _colors
212
    _colors = _cnf.get('global', 'colors')
213
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
214
215
        from kamaki.cli.utils import remove_colors
        remove_colors()
216
217
    _silent = arguments['silent'].value
    _setup_logging(_silent, _debug, _verbose, _include)
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
    picked_cloud = arguments['cloud'].value
    if picked_cloud:
        global_url = _cnf.get('remotes', picked_cloud)
        if not global_url:
            raise CLIError(
                'No remote cloud "%s" in kamaki configuration' % picked_cloud,
                importance=3, details=[
                    'To check if this remote cloud alias is declared:',
                    '  /config get remotes.%s' % picked_cloud,
                    'To set a remote authentication URI aliased as "%s"' % (
                        picked_cloud),
                    '  /config set remotes.%s <URI>' % picked_cloud
                ])
    else:
        global_url = _cnf.get('global', 'auth_url')
    global_token = _cnf.get('global', 'token')
234
    from kamaki.clients.astakos import AstakosClient as AuthCachedClient
235
236
237
238
239
240
    try:
        return AuthCachedClient(global_url, global_token)
    except AssertionError as ae:
        kloger.warning('WARNING: Failed to load auth_url %s [ %s ]' % (
            global_url, ae))
        return None
241
242
243


def _load_spec_module(spec, arguments, module):
244
245
    #spec_name = arguments['config'].get('cli', spec)
    if not spec:
246
247
248
        return None
    pkg = None
    for location in cmd_spec_locations:
249
        location += spec if location == '' else '.%s' % spec
250
251
252
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
253
        except ImportError as ie:
254
            continue
255
256
    if not pkg:
        kloger.debug('Loading cmd grp %s failed: %s' % (spec, ie))
257
258
259
260
261
    return pkg


def _groups_help(arguments):
    global _debug
Stavros Sachtouris's avatar
Stavros Sachtouris committed
262
    global kloger
263
    descriptions = {}
264
    for cmd_group, spec in arguments['config'].get_cli_specs():
265
266
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
267
            cmds = getattr(pkg, '_commands')
268
269
270
271
272
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
273
274
                    kloger.warning(
                        'No cmd description for module %s' % cmd_group)
275
        elif _debug:
276
            kloger.warning('Loading of %s cmd spec failed' % cmd_group)
277
278
279
280
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


281
def _load_all_commands(cmd_tree, arguments):
282
    _cnf = arguments['config']
283
284
    #specs = [spec for spec in _cnf.get_groups() if _cnf.get(spec, 'cli')]
    for cmd_group, spec in _cnf.get_cli_specs():
285
286
287
288
289
290
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                global kloger
291
                kloger.warning('No valid description for %s' % cmd_group)
292
293
            continue
        for spec_tree in spec_commands:
294
            if spec_tree.name == cmd_group:
295
296
297
298
299
300
301
302
                cmd_tree.add_tree(spec_tree)
                break


#  Methods to be used by CLI implementations


def print_subcommands_help(cmd):
303
304
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
305
306
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
307
308
309
310
311
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


312
def update_parser_help(parser, cmd):
313
    global _best_match
314
315
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
316

317
    description = ''
318
319
    if cmd.is_command:
        cls = cmd.get_class()
320
321
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
322
323
        description = getattr(cls, 'long_description', '')
        description = description.strip()
324
    else:
325
        parser.syntax += ' <...>'
326
    if cmd.has_description:
327
328
        parser.parser.description = cmd.help + (
            ('\n%s' % description) if description else '')
329
330
    else:
        parser.parser.description = description
331
332


333
def print_error_message(cli_err):
334
335
336
337
338
339
340
341
    errmsg = '%s' % cli_err
    if cli_err.importance == 1:
        errmsg = magenta(errmsg)
    elif cli_err.importance == 2:
        errmsg = yellow(errmsg)
    elif cli_err.importance > 2:
        errmsg = red(errmsg)
    stdout.write(errmsg)
342
    for errmsg in cli_err.details:
343
        print('|  %s' % errmsg)
344
345


346
def exec_cmd(instance, cmd_args, help_method):
347
348
349
350
351
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
352
353
354
            if _debug:
                raise err
            if _verbose:
355
356
357
358
359
360
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

361

362
363
364
365
366
367
368
369
370
371
372
373
def get_command_group(unparsed, arguments):
    groups = arguments['config'].get_groups()
    for term in unparsed:
        if term.startswith('-'):
            continue
        if term in groups:
            unparsed.remove(term)
            return term
        return None
    return None


374
375
376
377
378
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
379
380
    global command
    def_params = list(command.func_defaults)
381
    def_params[0] = parameters
382
383
384
    command.func_defaults = tuple(def_params)


385
#  CLI Choice:
386

387
def run_one_cmd(exe_string, parser, auth_base):
388
389
390
391
392
    global _history
    _history = History(
        parser.arguments['config'].get('history', 'file'))
    _history.add(' '.join([exe_string] + argv[1:]))
    from kamaki.cli import one_command
393
    one_command.run(auth_base, parser, _help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
394
395


396
def run_shell(exe_string, parser, auth_base):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
397
    from command_shell import _init_shell
398
399
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
400
    shell.run(auth_base, parser)
401

402
403

def main():
404
405
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
406
        parser = ArgumentParseManager(exe)
407

408
        if parser.arguments['version'].value:
409
410
            exit(0)

411
412
        log_file = parser.arguments['config'].get('global', 'log_file')
        if log_file:
413
            logger.set_log_filename(log_file)
414
415
        global filelog
        filelog = logger.add_file_logger(__name__.split('.')[0])
416
        filelog.info('* Initial Call *\n%s\n- - -' % ' '.join(argv))
417

418
        auth_base = _init_session(parser.arguments)
419

420
421
422
        from kamaki.cli.utils import suggest_missing
        suggest_missing()

423
        if parser.unparsed:
424
            run_one_cmd(exe, parser, auth_base)
425
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
426
            parser.parser.print_help()
427
            _groups_help(parser.arguments)
428
        else:
429
            run_shell(exe, parser, auth_base)
430
    except CLIError as err:
431
        print_error_message(err)
432
433
434
        if _debug:
            raise err
        exit(1)
435
436
    except Exception as er:
        print('Unknown Error: %s' % er)
437
        if _debug:
438
439
            raise
        exit(1)