__init__.py 17.6 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, exists
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, CLICmdSpecError
43
from kamaki.cli import logger
44
45
from kamaki.clients.astakos import AstakosClient as AuthCachedClient
from kamaki.clients import ClientError
46

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

55
56
57
58
#  command auxiliary methods

_best_match = []

59

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


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


79
80
def _num_of_matching_terms(basic_list, attack_list):
    if not attack_list:
81
        return len(basic_list)
82

83
84
85
86
87
88
89
90
91
    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
92

93

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

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

105
106
107
108
109
110
111
112
113
    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
114
115
116
        e.g. spec_cmd0_cmd1 will be command spec cmd0

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

        :returns: the specified class object
124
125
126
    """

    def wrap(cls):
127
        global kloger
128
129
130
131
        cls_name = cls.__name__

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

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

141
142
143
144
145
146
        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)
147
            if _debug:
148
                kloger.warning('%s failed max_len test' % cls_name)
149
            return None
150

151
152
153
154
155
156
157
        try:
            (
                cls.description, sep, cls.long_description
            ) = cls.__doc__.partition('\n')
        except AttributeError:
            raise CLICmdSpecError(
                'No commend in %s (acts as cmd description)' % cls.__name__)
158
        _construct_command_syntax(cls)
159

160
161
162
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
163

164

165
166
167
168
169
170
cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
171

172

173
174
175
#  Generic init auxiliary functions


176
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
177
178
179
    """handle logging for clients package"""

    if silent:
180
        logger.add_stream_logger(__name__, logging.CRITICAL)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
181
182
        return

183
    sfmt, rfmt = '> %(message)s', '< %(message)s'
Stavros Sachtouris's avatar
Stavros Sachtouris committed
184
    if debug:
185
186
187
188
        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)
189
    elif verbose:
190
191
192
        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)
193
    if include:
194
195
196
        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
197
    global kloger
198
    kloger = logger.get_logger(__name__)
199

200

201
202
def _check_config_version(cnf):
    guess = cnf.guess_version()
203
    if exists(cnf.path) and guess < 0.9:
204
        print('Config file format version >= 9.0 is required')
205
        print('Configuration file: %s' % cnf.path)
206
        print('Attempting to fix this:')
207
        print('Calculating changes while preserving information')
208
209
        lost_terms = cnf.rescue_old_file()
        print('... DONE')
210
211
212
        if lost_terms:
            print 'The following information will NOT be preserved:'
            print '\t', '\n\t'.join(lost_terms)
213
        print('Kamaki is ready to convert the config file')
214
        stdout.write('Create (overwrite) file %s ? [y/N] ' % cnf.path)
215
216
217
218
219
220
221
222
223
        from sys import stdin
        reply = stdin.readline()
        if reply in ('Y\n', 'y\n'):
            cnf.write()
            print('... DONE')
        else:
            print('... ABORTING')
            raise CLIError(
                'Invalid format for config file %s' % cnf.path,
224
                importance=3, details=[
225
                    'Please, update config file',
226
                    'For automatic conversion, rerun and say Y'])
227
228


229
def _init_session(arguments, is_non_API=False):
230
    """
231
    :returns: (AuthCachedClient, str) authenticator and cloud name
232
    """
233
234
235
236
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
237
238
    global _include
    _include = arguments['include'].value
239
240
    global _verbose
    _verbose = arguments['verbose'].value
241
    _cnf = arguments['config']
242
243
244
245

    if _help or is_non_API:
        return None, None

246
    _check_config_version(_cnf.value)
247

248
    global _colors
249
    _colors = _cnf.value.get_global('colors')
250
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
251
252
        from kamaki.cli.utils import remove_colors
        remove_colors()
253
254
    _silent = arguments['silent'].value
    _setup_logging(_silent, _debug, _verbose, _include)
255

256
257
258
259
260
261
    cloud = arguments['cloud'].value or _cnf.value.get(
        'global', 'default_cloud')
    if not cloud:
        num_of_clouds = len(_cnf.value.keys('cloud'))
        if num_of_clouds == 1:
            cloud = _cnf.value.keys('cloud')[0]
262
        elif num_of_clouds > 1:
263
            raise CLIError(
264
265
                'Found %s clouds but none of them is set as default' % (
                    num_of_clouds),
266
267
268
                importance=2, details=[
                    'Please, choose one of the following cloud names:',
                    ', '.join(_cnf.value.keys('cloud')),
269
270
                    'To see all cloud settings:',
                    '  kamaki config get cloud.<cloud name>',
271
272
273
274
                    'To set a default cloud:',
                    '  kamaki config set default_cloud <cloud name>',
                    'To pick a cloud for the current session, use --cloud:',
                    '  kamaki --cloud=<cloud name> ...'])
275
    if not cloud in _cnf.value.keys('cloud'):
276
        raise CLIError(
277
            'No cloud%s is configured' % ((' "%s"' % cloud) if cloud else ''),
278
            importance=3, details=[
279
280
                'To configure a new cloud "%s", find and set the' % (
                    cloud or '<cloud name>'),
281
                'single authentication URL and token:',
282
283
284
285
                '  kamaki config set cloud.%s.url <URL>' % (
                    cloud or '<cloud name>'),
                '  kamaki config set cloud.%s.token <t0k3n>' % (
                    cloud or '<cloud name>')])
286
287
    auth_args = dict()
    for term in ('url', 'token'):
288
289
        try:
            auth_args[term] = _cnf.get_cloud(cloud, term)
290
        except KeyError or IndexError:
291
            auth_args[term] = ''
292
293
        if not auth_args[term]:
            raise CLIError(
294
295
                'No authentication %s provided for cloud "%s"' % (
                    term.upper(), cloud),
296
                importance=3, details=[
297
                    'Set a %s for cloud %s:' % (term.upper(), cloud),
298
                    '  kamaki config set cloud.%s.%s <%s>' % (
299
                        cloud, term, term.upper())])
300

301
    try:
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
        auth_base = None
        for token in reversed(auth_args['token'].split()):
            try:
                if auth_base:
                    auth_base.authenticate(token)
                else:
                    auth_base = AuthCachedClient(
                        auth_args['url'], auth_args['token'])
                    auth_base.authenticate(token)
            except ClientError as ce:
                if ce.status in (401, ):
                    kloger.warning(
                        'WARNING: Failed to authorize token %s' % token)
                else:
                    raise
        return auth_base, cloud
318
    except AssertionError as ae:
319
320
        kloger.warning('WARNING: Failed to load authenticator [%s]' % ae)
        return None, cloud
321
322
323


def _load_spec_module(spec, arguments, module):
324
    if not spec:
325
326
327
        return None
    pkg = None
    for location in cmd_spec_locations:
328
        location += spec if location == '' else '.%s' % spec
329
330
331
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
332
        except ImportError as ie:
333
            continue
334
335
    if not pkg:
        kloger.debug('Loading cmd grp %s failed: %s' % (spec, ie))
336
337
338
339
340
    return pkg


def _groups_help(arguments):
    global _debug
Stavros Sachtouris's avatar
Stavros Sachtouris committed
341
    global kloger
342
    descriptions = {}
343
    acceptable_groups = arguments['config'].get_groups()
344
    for cmd_group, spec in arguments['config'].get_cli_specs():
345
346
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
347
            cmds = getattr(pkg, '_commands')
348
349
            try:
                for cmd in cmds:
350
351
                    if cmd.name in acceptable_groups:
                        descriptions[cmd.name] = cmd.description
352
353
            except TypeError:
                if _debug:
354
355
                    kloger.warning(
                        'No cmd description for module %s' % cmd_group)
356
        elif _debug:
357
            kloger.warning('Loading of %s cmd spec failed' % cmd_group)
358
359
360
361
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


362
def _load_all_commands(cmd_tree, arguments):
363
    _cnf = arguments['config']
364
    for cmd_group, spec in _cnf.get_cli_specs():
365
366
367
368
369
370
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                global kloger
371
                kloger.warning('No valid description for %s' % cmd_group)
372
373
            continue
        for spec_tree in spec_commands:
374
            if spec_tree.name == cmd_group:
375
376
377
378
379
380
381
382
                cmd_tree.add_tree(spec_tree)
                break


#  Methods to be used by CLI implementations


def print_subcommands_help(cmd):
383
384
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
385
386
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
387
388
389
390
391
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


392
def update_parser_help(parser, cmd):
393
    global _best_match
394
395
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
396

397
    description = ''
398
399
    if cmd.is_command:
        cls = cmd.get_class()
400
401
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
402
403
        description = getattr(cls, 'long_description', '')
        description = description.strip()
404
    else:
405
        parser.syntax += ' <...>'
406
    if cmd.has_description:
407
408
        parser.parser.description = cmd.help + (
            ('\n%s' % description) if description else '')
409
410
    else:
        parser.parser.description = description
411
412


413
def print_error_message(cli_err):
414
415
416
417
418
419
420
421
    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)
422
    for errmsg in cli_err.details:
423
        print('|  %s' % errmsg)
424
425


426
def exec_cmd(instance, cmd_args, help_method):
427
428
429
430
431
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
432
433
434
            if _debug:
                raise err
            if _verbose:
435
436
437
438
439
440
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

441

442
443
444
445
446
447
448
449
450
451
452
453
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


454
455
456
457
458
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
459
460
    global command
    def_params = list(command.func_defaults)
461
    def_params[0] = parameters
462
463
464
    command.func_defaults = tuple(def_params)


465
#  CLI Choice:
466

467
def run_one_cmd(exe_string, parser, auth_base, cloud):
468
469
    global _history
    _history = History(
470
        parser.arguments['config'].get_global('history_file'))
471
472
    _history.add(' '.join([exe_string] + argv[1:]))
    from kamaki.cli import one_command
473
    one_command.run(auth_base, cloud, parser, _help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
474
475


476
def run_shell(exe_string, parser, auth_base, cloud):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
477
    from command_shell import _init_shell
478
479
480
481
482
483
    try:
        username, userid = (
            auth_base.user_term('name'), auth_base.user_term('id'))
    except Exception:
        username, userid = '', ''
    shell = _init_shell(exe_string, parser, username, userid)
484
    _load_all_commands(shell.cmd_tree, parser.arguments)
485
    shell.run(auth_base, cloud, parser)
486

487

488
489
490
491
492
493
494
495
496
497
def is_non_API(parser):
    nonAPIs = ('history', 'config')
    for term in parser.unparsed:
        if not term.startswith('-'):
            if term in nonAPIs:
                return True
            return False
    return False


498
def main():
499
500
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
501
        parser = ArgumentParseManager(exe)
502

503
        if parser.arguments['version'].value:
504
505
            exit(0)

506
        log_file = parser.arguments['config'].get_global('log_file')
507
        if log_file:
508
            logger.set_log_filename(log_file)
509
510
        global filelog
        filelog = logger.add_file_logger(__name__.split('.')[0])
511
        filelog.info('* Initial Call *\n%s\n- - -' % ' '.join(argv))
512

513
        auth_base, cloud = _init_session(parser.arguments, is_non_API(parser))
514

515
        from kamaki.cli.utils import suggest_missing
516
517
518
        global _colors
        exclude = ['ansicolors'] if not _colors == 'on' else []
        suggest_missing(exclude=exclude)
519

520
        if parser.unparsed:
521
            run_one_cmd(exe, parser, auth_base, cloud)
522
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
523
            parser.parser.print_help()
524
            _groups_help(parser.arguments)
525
        else:
526
            run_shell(exe, parser, auth_base, cloud)
527
    except CLIError as err:
528
        print_error_message(err)
529
530
531
        if _debug:
            raise err
        exit(1)
532
533
    except Exception as er:
        print('Unknown Error: %s' % er)
534
        if _debug:
535
536
            raise
        exit(1)