__init__.py 12.5 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

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

51
52
53
54
#  command auxiliary methods

_best_match = []

55

56
def _construct_command_syntax(cls):
57
58
59
        spec = getargspec(cls.main.im_func)
        args = spec.args[1:]
        n = len(args) - len(spec.defaults or ())
60
61
62
63
64
65
66
67
68
69
70
71
        required = ' '.join(
            '<%s>' % x.replace(
            '____', '[:').replace(
            '___', ':').replace(
            '__', ']').replace(
            '_', ' ') for x in args[:n])
        optional = ' '.join(
            '[%s]' % x.replace(
            '____', '[:').replace(
            '___', ':').replace(
            '__', ']').replace(
            '_', ' ') 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
174
175
176
177
178
179
180
181
182
    """handle logging for clients package"""

    def add_handler(name, level, prefix=''):
        h = logging.StreamHandler()
        fmt = logging.Formatter(prefix + '%(message)s')
        h.setFormatter(fmt)
        logger = logging.getLogger(name)
        logger.addHandler(h)
        logger.setLevel(level)

    if silent:
        add_handler('', logging.CRITICAL)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
183
184
185
        return

    if debug:
186
187
188
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.DEBUG, prefix='> ')
        add_handler('clients.recv', logging.DEBUG, prefix='< ')
189
        add_handler('kamaki', logging.DEBUG, prefix='(debug): ')
190
191
192
193
    elif verbose:
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.INFO, prefix='> ')
        add_handler('clients.recv', logging.INFO, prefix='< ')
194
        add_handler('kamaki', logging.INFO, prefix='(i): ')
195
196
197
    if include:
        add_handler('data.send', logging.INFO, prefix='>[data]: ')
        add_handler('data.recv', logging.INFO, prefix='<[data]: ')
198
    add_handler('kamaki', logging.WARNING, prefix='(warning): ')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
199
    global kloger
200
    kloger = logging.getLogger('kamaki')
201

202

203
204
205
206
207
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
208
209
    global _include
    _include = arguments['include'].value
210
211
212
213
    global _verbose
    _verbose = arguments['verbose'].value
    global _colors
    _colors = arguments['config'].get('global', 'colors')
214
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
215
216
        from kamaki.cli.utils import remove_colors
        remove_colors()
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    _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
238
    global kloger
239
240
241
242
243
244
245
    descriptions = {}
    for spec in arguments['config'].get_groups():
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
            cmds = None
            try:
                cmds = [
246
247
                    cmd for cmd in getattr(pkg, '_commands')
                        if arguments['config'].get(cmd.name, 'cli')
248
249
250
                ]
            except AttributeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
251
                    kloger.warning('No description for %s' % spec)
252
253
254
255
256
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
257
                    kloger.warning('no cmd specs in module %s' % spec)
258
        elif _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
259
            kloger.warning('Loading of %s cmd spec failed' % spec)
260
261
262
263
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


264
265
def _load_all_commands(cmd_tree, arguments):
    _config = arguments['config']
266
267
    for spec in [spec for spec in _config.get_groups()
        if _config.get(spec, 'cli')]:
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
        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):
286
287
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
288
289
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
290
291
292
293
294
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


295
def update_parser_help(parser, cmd):
296
    global _best_match
297
298
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
299

300
    description = ''
301
302
    if cmd.is_command:
        cls = cmd.get_class()
303
304
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
305
306
        description = getattr(cls, 'long_description', '')
        description = description.strip()
307
    else:
308
        parser.syntax += ' <...>'
309
    if cmd.has_description:
310
311
        parser.parser.description = cmd.help + (
            ('\n%s' % description) if description else '')
312
313
    else:
        parser.parser.description = description
314
315


316
def print_error_message(cli_err):
317
318
319
320
321
322
323
324
    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)
325
326
    for errmsg in cli_err.details:
        print('| %s' % errmsg)
327
328


329
def exec_cmd(instance, cmd_args, help_method):
330
331
332
333
334
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
335
336
337
            if _debug:
                raise err
            if _verbose:
338
339
340
341
342
343
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

344

345
346
347
348
349
350
351
352
353
354
355
356
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


357
358
359
360
361
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
362
363
    global command
    def_params = list(command.func_defaults)
364
    def_params[0] = parameters
365
366
367
    command.func_defaults = tuple(def_params)


368
#  CLI Choice:
369

370
371
372
373
374
375
376
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
377
378


379
def run_shell(exe_string, parser):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
380
    from command_shell import _init_shell
381
382
383
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
    shell.run(parser)
384

385
386

def main():
387
388
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
389
        parser = ArgumentParseManager(exe)
390

391
        if parser.arguments['version'].value:
392
393
            exit(0)

394
        _init_session(parser.arguments)
395

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