__init__.py 15.2 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
def _check_config_version(cnf):
    guess = cnf.guess_version()
    if guess < 3.0:
198
199
        print('Config file format version >= 3.0 is required')
        print('Configuration file "%s" format is not up to date' % (
200
            cnf.path))
201
202
        print('but kamaki can fix this:')
        print('Calculating changes while preserving information')
203
204
        lost_terms = cnf.rescue_old_file()
        print('... DONE')
205
206
207
208
        if lost_terms:
            print 'The following information will NOT be preserved:'
            print '\t', '\n\t'.join(lost_terms)
        print('Kamaki is ready to convert the config file to version 3.0')
209
210
211
212
213
214
215
216
217
218
        stdout.write('Overwrite file %s ? [Y, y] ' % cnf.path)
        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,
219
220
221
                importance=3, details=[
                    'Please, update config file to v3.0',
                    'For automatic conversion, rerun and say Y'])
222
223


224
def _init_session(arguments, is_non_API=False):
225
226
227
228
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
229
230
    global _include
    _include = arguments['include'].value
231
232
    global _verbose
    _verbose = arguments['verbose'].value
233
    _cnf = arguments['config']
234
    _check_config_version(_cnf.value)
235

236
    global _colors
237
    _colors = _cnf.value.get_global('colors')
238
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
239
240
        from kamaki.cli.utils import remove_colors
        remove_colors()
241
242
    _silent = arguments['silent'].value
    _setup_logging(_silent, _debug, _verbose, _include)
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

    if _help or is_non_API:
        return None

    cloud = arguments['cloud'].value or 'default'
    if not cloud in _cnf.value.keys('remote'):
        raise CLIError(
            'No cloud remote "%s" is configured' % cloud,
            importance=3, details=[
                'To configure a new cloud remote, find and set the',
                'single authentication URL and token:',
                '  kamaki config set remote.%s.url <URL>' % cloud,
                '  kamaki config set remote.%s.token <t0k3n>' % cloud])
    url = _cnf.get_remote(cloud, 'url')
    if not url:
        kloger.warning(
            'WARNING: No remote.%s.url, use service urls instead' % cloud)
        return cloud
    token = _cnf.get_remote(cloud, 'token')
    if not token:
        raise CLIError(
            'No authentication token provided for %s cloud' % cloud,
            importance=3, details=[
                'Get and set a token for %s cloud:' % cloud,
                '  kamaki config set remote.%s.token <t0k3n>' % cloud])

269
    from kamaki.clients.astakos import AstakosClient as AuthCachedClient
270
    try:
271
        return AuthCachedClient(url, token)
272
    except AssertionError as ae:
273
274
        kloger.warning(
            'WARNING: Failed to load auth_url %s [ %s ]' % (url, ae))
275
        return None
276
277
278


def _load_spec_module(spec, arguments, module):
279
    if not spec:
280
281
282
        return None
    pkg = None
    for location in cmd_spec_locations:
283
        location += spec if location == '' else '.%s' % spec
284
285
286
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
287
        except ImportError as ie:
288
            continue
289
290
    if not pkg:
        kloger.debug('Loading cmd grp %s failed: %s' % (spec, ie))
291
292
293
294
295
    return pkg


def _groups_help(arguments):
    global _debug
Stavros Sachtouris's avatar
Stavros Sachtouris committed
296
    global kloger
297
    descriptions = {}
298
    for cmd_group, spec in arguments['config'].get_cli_specs():
299
300
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
301
            cmds = getattr(pkg, '_commands')
302
303
304
305
306
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
307
308
                    kloger.warning(
                        'No cmd description for module %s' % cmd_group)
309
        elif _debug:
310
            kloger.warning('Loading of %s cmd spec failed' % cmd_group)
311
312
313
314
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


315
def _load_all_commands(cmd_tree, arguments):
316
    _cnf = arguments['config']
317
    for cmd_group, spec in _cnf.get_cli_specs():
318
319
320
321
322
323
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                global kloger
324
                kloger.warning('No valid description for %s' % cmd_group)
325
326
            continue
        for spec_tree in spec_commands:
327
            if spec_tree.name == cmd_group:
328
329
330
331
332
333
334
335
                cmd_tree.add_tree(spec_tree)
                break


#  Methods to be used by CLI implementations


def print_subcommands_help(cmd):
336
337
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
338
339
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
340
341
342
343
344
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


345
def update_parser_help(parser, cmd):
346
    global _best_match
347
348
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
349

350
    description = ''
351
352
    if cmd.is_command:
        cls = cmd.get_class()
353
354
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
355
356
        description = getattr(cls, 'long_description', '')
        description = description.strip()
357
    else:
358
        parser.syntax += ' <...>'
359
    if cmd.has_description:
360
361
        parser.parser.description = cmd.help + (
            ('\n%s' % description) if description else '')
362
363
    else:
        parser.parser.description = description
364
365


366
def print_error_message(cli_err):
367
368
369
370
371
372
373
374
    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)
375
    for errmsg in cli_err.details:
376
        print('|  %s' % errmsg)
377
378


379
def exec_cmd(instance, cmd_args, help_method):
380
381
382
383
384
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
385
386
387
            if _debug:
                raise err
            if _verbose:
388
389
390
391
392
393
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

394

395
396
397
398
399
400
401
402
403
404
405
406
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


407
408
409
410
411
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
412
413
    global command
    def_params = list(command.func_defaults)
414
    def_params[0] = parameters
415
416
417
    command.func_defaults = tuple(def_params)


418
#  CLI Choice:
419

420
def run_one_cmd(exe_string, parser, auth_base):
421
422
    global _history
    _history = History(
423
        parser.arguments['config'].get_global('history_file'))
424
425
    _history.add(' '.join([exe_string] + argv[1:]))
    from kamaki.cli import one_command
426
    one_command.run(auth_base, parser, _help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
427
428


429
def run_shell(exe_string, parser, auth_base):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
430
    from command_shell import _init_shell
431
432
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
433
    shell.run(auth_base, parser)
434

435

436
437
438
439
440
441
442
443
444
445
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


446
def main():
447
448
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
449
        parser = ArgumentParseManager(exe)
450

451
        if parser.arguments['version'].value:
452
453
            exit(0)

454
        log_file = parser.arguments['config'].get_global('log_file')
455
        if log_file:
456
            logger.set_log_filename(log_file)
457
458
        global filelog
        filelog = logger.add_file_logger(__name__.split('.')[0])
459
        filelog.info('* Initial Call *\n%s\n- - -' % ' '.join(argv))
460

461
        remote_base = _init_session(parser.arguments, is_non_API(parser))
462

463
464
465
        from kamaki.cli.utils import suggest_missing
        suggest_missing()

466
        if parser.unparsed:
467
            run_one_cmd(exe, parser, remote_base)
468
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
469
            parser.parser.print_help()
470
            _groups_help(parser.arguments)
471
        else:
472
            run_shell(exe, parser, remote_base)
473
    except CLIError as err:
474
        print_error_message(err)
475
476
477
        if _debug:
            raise err
        exit(1)
478
479
    except Exception as er:
        print('Unknown Error: %s' % er)
480
        if _debug:
481
482
            raise
        exit(1)