__init__.py 12.4 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
Stavros Sachtouris's avatar
Stavros Sachtouris committed
43
from kamaki.logger import add_stream_logger, get_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

52
53
54
55
#  command auxiliary methods

_best_match = []

56

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


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


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

80
81
82
83
84
85
86
87
88
    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
89

90

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

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

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

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

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

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

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

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

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

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

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

157

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

165

166
167
168
#  Generic init auxiliary functions


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

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

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

192

193
194
195
196
197
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
198
199
    global _include
    _include = arguments['include'].value
200
201
202
203
    global _verbose
    _verbose = arguments['verbose'].value
    global _colors
    _colors = arguments['config'].get('global', 'colors')
204
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
205
206
        from kamaki.cli.utils import remove_colors
        remove_colors()
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    _silent = arguments['silent'].value
    _setup_logging(_silent, _debug, _verbose, _include)


def _load_spec_module(spec, arguments, module):
    spec_name = arguments['config'].get(spec, 'cli')
    if spec_name is None:
        return None
    pkg = None
    for location in cmd_spec_locations:
        location += spec_name if location == '' else '.%s' % spec_name
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
        except ImportError:
            continue
    return pkg


def _groups_help(arguments):
    global _debug
Stavros Sachtouris's avatar
Stavros Sachtouris committed
228
    global kloger
229
230
231
232
233
234
    descriptions = {}
    for spec in arguments['config'].get_groups():
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
            cmds = None
            try:
235
236
237
                _cnf = arguments['config']
                cmds = [cmd for cmd in getattr(pkg, '_commands') if _cnf.get(
                    cmd.name, 'cli')]
238
239
            except AttributeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
240
                    kloger.warning('No description for %s' % spec)
241
242
243
244
245
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
246
                    kloger.warning('no cmd specs in module %s' % spec)
247
        elif _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
248
            kloger.warning('Loading of %s cmd spec failed' % spec)
249
250
251
252
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


253
def _load_all_commands(cmd_tree, arguments):
254
255
256
    _cnf = arguments['config']
    specs = [spec for spec in _cnf.get_groups() if _cnf.get(spec, 'cli')]
    for spec in specs:
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                global kloger
                kloger.warning('No valid description for %s' % spec)
            continue
        for spec_tree in spec_commands:
            if spec_tree.name == spec:
                cmd_tree.add_tree(spec_tree)
                break


#  Methods to be used by CLI implementations


def print_subcommands_help(cmd):
275
276
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
277
278
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
279
280
281
282
283
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


284
def update_parser_help(parser, cmd):
285
    global _best_match
286
287
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
288

289
    description = ''
290
291
    if cmd.is_command:
        cls = cmd.get_class()
292
293
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
294
295
        description = getattr(cls, 'long_description', '')
        description = description.strip()
296
    else:
297
        parser.syntax += ' <...>'
298
    if cmd.has_description:
299
300
        parser.parser.description = cmd.help + (
            ('\n%s' % description) if description else '')
301
302
    else:
        parser.parser.description = description
303
304


305
def print_error_message(cli_err):
306
307
308
309
310
311
312
313
    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)
314
315
    for errmsg in cli_err.details:
        print('| %s' % errmsg)
316
317


318
def exec_cmd(instance, cmd_args, help_method):
319
320
321
322
323
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
324
325
326
            if _debug:
                raise err
            if _verbose:
327
328
329
330
331
332
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

333

334
335
336
337
338
339
340
341
342
343
344
345
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


346
347
348
349
350
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
351
352
    global command
    def_params = list(command.func_defaults)
353
    def_params[0] = parameters
354
355
356
    command.func_defaults = tuple(def_params)


357
#  CLI Choice:
358

359
360
361
362
363
364
365
def run_one_cmd(exe_string, parser):
    global _history
    _history = History(
        parser.arguments['config'].get('history', 'file'))
    _history.add(' '.join([exe_string] + argv[1:]))
    from kamaki.cli import one_command
    one_command.run(parser, _help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
366
367


368
def run_shell(exe_string, parser):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
369
    from command_shell import _init_shell
370
371
372
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
    shell.run(parser)
373

374
375

def main():
376
377
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
378
        parser = ArgumentParseManager(exe)
379

380
        if parser.arguments['version'].value:
381
382
            exit(0)

383
384
385
386
387
        log_file = parser.arguments['config'].get('global', 'log_file')
        if log_file:
            from kamaki.logger import set_log_filename
            set_log_filename(log_file)

388
        _init_session(parser.arguments)
389

390
391
392
        from kamaki.cli.utils import suggest_missing
        suggest_missing()

393
        if parser.unparsed:
394
            run_one_cmd(exe, parser)
395
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
396
            parser.parser.print_help()
397
            _groups_help(parser.arguments)
398
        else:
399
            run_shell(exe, parser)
400
    except CLIError as err:
401
        print_error_message(err)
402
403
404
        if _debug:
            raise err
        exit(1)
405
406
    except Exception as er:
        print('Unknown Error: %s' % er)
407
        if _debug:
408
409
            raise
        exit(1)