root / kamaki / cli / __init__.py @ 38db356b
History | View | Annotate | Download (18 kB)
1 |
# Copyright 2012-2013 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# 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 |
from kamaki.clients.astakos import AstakosClient as AuthCachedClient |
45 |
from kamaki.clients import ClientError |
46 |
|
47 |
_help = False
|
48 |
_debug = False
|
49 |
_include = False
|
50 |
_verbose = False
|
51 |
_colors = False
|
52 |
kloger = None
|
53 |
filelog = None
|
54 |
|
55 |
# command auxiliary methods
|
56 |
|
57 |
_best_match = [] |
58 |
|
59 |
|
60 |
def _arg2syntax(arg): |
61 |
return arg.replace(
|
62 |
'____', '[:').replace( |
63 |
'___', ':').replace( |
64 |
'__', ']').replace( |
65 |
'_', ' ') |
66 |
|
67 |
|
68 |
def _construct_command_syntax(cls): |
69 |
spec = getargspec(cls.main.im_func) |
70 |
args = spec.args[1:]
|
71 |
n = len(args) - len(spec.defaults or ()) |
72 |
required = ' '.join(['<%s>' % _arg2syntax(x) for x in args[:n]]) |
73 |
optional = ' '.join(['[%s]' % _arg2syntax(x) for x in args[n:]]) |
74 |
cls.syntax = ' '.join(x for x in [required, optional] if x) |
75 |
if spec.varargs:
|
76 |
cls.syntax += ' <%s ...>' % spec.varargs
|
77 |
|
78 |
|
79 |
def _num_of_matching_terms(basic_list, attack_list): |
80 |
if not attack_list: |
81 |
return len(basic_list) |
82 |
|
83 |
matching_terms = 0
|
84 |
for i, term in enumerate(basic_list): |
85 |
try:
|
86 |
if term != attack_list[i]:
|
87 |
break
|
88 |
except IndexError: |
89 |
break
|
90 |
matching_terms += 1
|
91 |
return matching_terms
|
92 |
|
93 |
|
94 |
def _update_best_match(name_terms, prefix=[]): |
95 |
if prefix:
|
96 |
pref_list = prefix if isinstance(prefix, list) else prefix.split('_') |
97 |
else:
|
98 |
pref_list = [] |
99 |
|
100 |
num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list) |
101 |
global _best_match
|
102 |
if not prefix: |
103 |
_best_match = [] |
104 |
|
105 |
if num_of_matching_terms and len(_best_match) <= num_of_matching_terms: |
106 |
if len(_best_match) < num_of_matching_terms: |
107 |
_best_match = name_terms[:num_of_matching_terms] |
108 |
return True |
109 |
return False |
110 |
|
111 |
|
112 |
def command(cmd_tree, prefix='', descedants_depth=1): |
113 |
"""Load a class as a command
|
114 |
e.g. spec_cmd0_cmd1 will be command spec cmd0
|
115 |
|
116 |
:param cmd_tree: is initialized in cmd_spec file and is the structure
|
117 |
where commands are loaded. Var name should be _commands
|
118 |
:param prefix: if given, load only commands prefixed with prefix,
|
119 |
:param descedants_depth: is the depth of the tree descedants of the
|
120 |
prefix command. It is used ONLY if prefix and if prefix is not
|
121 |
a terminal command
|
122 |
|
123 |
:returns: the specified class object
|
124 |
"""
|
125 |
|
126 |
def wrap(cls): |
127 |
global kloger
|
128 |
cls_name = cls.__name__ |
129 |
|
130 |
if not cmd_tree: |
131 |
if _debug:
|
132 |
kloger.warning('command %s found but not loaded' % cls_name)
|
133 |
return cls
|
134 |
|
135 |
name_terms = cls_name.split('_')
|
136 |
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 |
global _best_match
|
142 |
max_len = len(_best_match) + descedants_depth
|
143 |
if len(name_terms) > max_len: |
144 |
partial = '_'.join(name_terms[:max_len])
|
145 |
if not cmd_tree.has_command(partial): # add partial path |
146 |
cmd_tree.add_command(partial) |
147 |
if _debug:
|
148 |
kloger.warning('%s failed max_len test' % cls_name)
|
149 |
return None |
150 |
|
151 |
try:
|
152 |
( |
153 |
cls.description, sep, cls.long_description |
154 |
) = cls.__doc__.partition('\n')
|
155 |
except AttributeError: |
156 |
raise CLICmdSpecError(
|
157 |
'No commend in %s (acts as cmd description)' % cls.__name__)
|
158 |
_construct_command_syntax(cls) |
159 |
|
160 |
cmd_tree.add_command( |
161 |
cls_name, cls.description, cls, cls.long_description) |
162 |
return cls
|
163 |
return wrap
|
164 |
|
165 |
|
166 |
cmd_spec_locations = [ |
167 |
'kamaki.cli.commands',
|
168 |
'kamaki.commands',
|
169 |
'kamaki.cli',
|
170 |
'kamaki',
|
171 |
'']
|
172 |
|
173 |
|
174 |
# Generic init auxiliary functions
|
175 |
|
176 |
|
177 |
def _setup_logging(silent=False, debug=False, verbose=False, include=False): |
178 |
"""handle logging for clients package"""
|
179 |
|
180 |
if silent:
|
181 |
logger.add_stream_logger(__name__, logging.CRITICAL) |
182 |
return
|
183 |
|
184 |
sfmt, rfmt = '> %(message)s', '< %(message)s' |
185 |
if debug:
|
186 |
print('Logging location: %s' % logger.get_log_filename())
|
187 |
logger.add_stream_logger('kamaki.clients.send', logging.DEBUG, sfmt)
|
188 |
logger.add_stream_logger('kamaki.clients.recv', logging.DEBUG, rfmt)
|
189 |
logger.add_stream_logger(__name__, logging.DEBUG) |
190 |
elif verbose:
|
191 |
logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
|
192 |
logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
|
193 |
logger.add_stream_logger(__name__, logging.INFO) |
194 |
if include:
|
195 |
logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
|
196 |
logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
|
197 |
logger.add_stream_logger(__name__, logging.WARNING) |
198 |
global kloger
|
199 |
kloger = logger.get_logger(__name__) |
200 |
|
201 |
|
202 |
def _check_config_version(cnf): |
203 |
guess = cnf.guess_version() |
204 |
if exists(cnf.path) and guess < 0.9: |
205 |
print('Config file format version >= 9.0 is required')
|
206 |
print('Configuration file: %s' % cnf.path)
|
207 |
print('Attempting to fix this:')
|
208 |
print('Calculating changes while preserving information')
|
209 |
lost_terms = cnf.rescue_old_file() |
210 |
print('... DONE')
|
211 |
if lost_terms:
|
212 |
print 'The following information will NOT be preserved:' |
213 |
print '\t', '\n\t'.join(lost_terms) |
214 |
print('Kamaki is ready to convert the config file')
|
215 |
stdout.write('Create (overwrite) file %s ? [y/N] ' % cnf.path)
|
216 |
from sys import stdin |
217 |
reply = stdin.readline() |
218 |
if reply in ('Y\n', 'y\n'): |
219 |
cnf.write() |
220 |
print('... DONE')
|
221 |
else:
|
222 |
print('... ABORTING')
|
223 |
raise CLIError(
|
224 |
'Invalid format for config file %s' % cnf.path,
|
225 |
importance=3, details=[
|
226 |
'Please, update config file',
|
227 |
'For automatic conversion, rerun and say Y'])
|
228 |
|
229 |
|
230 |
def _init_session(arguments, is_non_API=False): |
231 |
"""
|
232 |
:returns: (AuthCachedClient, str) authenticator and cloud name
|
233 |
"""
|
234 |
global _help
|
235 |
_help = arguments['help'].value
|
236 |
global _debug
|
237 |
_debug = arguments['debug'].value
|
238 |
global _include
|
239 |
_include = arguments['include'].value
|
240 |
global _verbose
|
241 |
_verbose = arguments['verbose'].value
|
242 |
_cnf = arguments['config']
|
243 |
|
244 |
if _help or is_non_API: |
245 |
return None, None |
246 |
|
247 |
_check_config_version(_cnf.value) |
248 |
|
249 |
global _colors
|
250 |
_colors = _cnf.value.get_global('colors')
|
251 |
if not (stdout.isatty() and _colors == 'on'): |
252 |
from kamaki.cli.utils import remove_colors |
253 |
remove_colors() |
254 |
_silent = arguments['silent'].value
|
255 |
_setup_logging(_silent, _debug, _verbose, _include) |
256 |
|
257 |
cloud = arguments['cloud'].value or _cnf.value.get( |
258 |
'global', 'default_cloud') |
259 |
if not cloud: |
260 |
num_of_clouds = len(_cnf.value.keys('cloud')) |
261 |
if num_of_clouds == 1: |
262 |
cloud = _cnf.value.keys('cloud')[0] |
263 |
elif num_of_clouds > 1: |
264 |
raise CLIError(
|
265 |
'Found %s clouds but none of them is set as default' % (
|
266 |
num_of_clouds), |
267 |
importance=2, details=[
|
268 |
'Please, choose one of the following cloud names:',
|
269 |
', '.join(_cnf.value.keys('cloud')), |
270 |
'To see all cloud settings:',
|
271 |
' kamaki config get cloud.<cloud name>',
|
272 |
'To set a default cloud:',
|
273 |
' kamaki config set default_cloud <cloud name>',
|
274 |
'To pick a cloud for the current session, use --cloud:',
|
275 |
' kamaki --cloud=<cloud name> ...'])
|
276 |
if not cloud in _cnf.value.keys('cloud'): |
277 |
raise CLIError(
|
278 |
'No cloud%s is configured' % ((' "%s"' % cloud) if cloud else ''), |
279 |
importance=3, details=[
|
280 |
'To configure a new cloud "%s", find and set the' % (
|
281 |
cloud or '<cloud name>'), |
282 |
'single authentication URL and token:',
|
283 |
' kamaki config set cloud.%s.url <URL>' % (
|
284 |
cloud or '<cloud name>'), |
285 |
' kamaki config set cloud.%s.token <t0k3n>' % (
|
286 |
cloud or '<cloud name>')]) |
287 |
auth_args = dict()
|
288 |
for term in ('url', 'token'): |
289 |
try:
|
290 |
auth_args[term] = _cnf.get_cloud(cloud, term) |
291 |
except KeyError or IndexError: |
292 |
auth_args[term] = ''
|
293 |
if not auth_args[term]: |
294 |
raise CLIError(
|
295 |
'No authentication %s provided for cloud "%s"' % (
|
296 |
term.upper(), cloud), |
297 |
importance=3, details=[
|
298 |
'Set a %s for cloud %s:' % (term.upper(), cloud),
|
299 |
' kamaki config set cloud.%s.%s <%s>' % (
|
300 |
cloud, term, term.upper())]) |
301 |
|
302 |
try:
|
303 |
auth_base = None
|
304 |
for token in reversed(auth_args['token'].split()): |
305 |
try:
|
306 |
if auth_base:
|
307 |
auth_base.authenticate(token) |
308 |
else:
|
309 |
auth_base = AuthCachedClient( |
310 |
auth_args['url'], auth_args['token']) |
311 |
from kamaki.cli.commands import _command_init |
312 |
fake_cmd = _command_init(arguments) |
313 |
fake_cmd.client = auth_base |
314 |
fake_cmd._set_log_params() |
315 |
fake_cmd._update_max_threads() |
316 |
auth_base.authenticate(token) |
317 |
except ClientError as ce: |
318 |
if ce.status in (401, ): |
319 |
kloger.warning( |
320 |
'WARNING: Failed to authorize token %s' % token)
|
321 |
else:
|
322 |
raise
|
323 |
return auth_base, cloud
|
324 |
except AssertionError as ae: |
325 |
kloger.warning('WARNING: Failed to load authenticator [%s]' % ae)
|
326 |
return None, cloud |
327 |
|
328 |
|
329 |
def _load_spec_module(spec, arguments, module): |
330 |
if not spec: |
331 |
return None |
332 |
pkg = None
|
333 |
for location in cmd_spec_locations: |
334 |
location += spec if location == '' else '.%s' % spec |
335 |
try:
|
336 |
pkg = __import__(location, fromlist=[module])
|
337 |
return pkg
|
338 |
except ImportError as ie: |
339 |
continue
|
340 |
if not pkg: |
341 |
msg = 'Loading command group %s failed: %s' % (spec, ie)
|
342 |
try:
|
343 |
kloger.debug(msg) |
344 |
except AttributeError: |
345 |
print msg
|
346 |
print 'HINT: use a text editor to remove all global.*_cli' |
347 |
print ' settings from the configuration file' |
348 |
return pkg
|
349 |
|
350 |
|
351 |
def _groups_help(arguments): |
352 |
global _debug
|
353 |
global kloger
|
354 |
descriptions = {} |
355 |
acceptable_groups = arguments['config'].groups
|
356 |
for cmd_group, spec in arguments['config'].cli_specs: |
357 |
pkg = _load_spec_module(spec, arguments, '_commands')
|
358 |
if pkg:
|
359 |
cmds = getattr(pkg, '_commands') |
360 |
try:
|
361 |
for cmd_tree in cmds: |
362 |
if cmd_tree.name in acceptable_groups: |
363 |
descriptions[cmd_tree.name] = cmd_tree.description |
364 |
except TypeError: |
365 |
if _debug:
|
366 |
kloger.warning( |
367 |
'No cmd description (help) for module %s' % cmd_group)
|
368 |
elif _debug:
|
369 |
kloger.warning('Loading of %s cmd spec failed' % cmd_group)
|
370 |
print('\nOptions:\n - - - -')
|
371 |
print_dict(descriptions) |
372 |
|
373 |
|
374 |
def _load_all_commands(cmd_tree, arguments): |
375 |
_cnf = arguments['config']
|
376 |
for cmd_group, spec in _cnf.cli_specs: |
377 |
try:
|
378 |
spec_module = _load_spec_module(spec, arguments, '_commands')
|
379 |
spec_commands = getattr(spec_module, '_commands') |
380 |
except AttributeError: |
381 |
if _debug:
|
382 |
global kloger
|
383 |
kloger.warning('No valid description for %s' % cmd_group)
|
384 |
continue
|
385 |
for spec_tree in spec_commands: |
386 |
if spec_tree.name == cmd_group:
|
387 |
cmd_tree.add_tree(spec_tree) |
388 |
break
|
389 |
|
390 |
|
391 |
# Methods to be used by CLI implementations
|
392 |
|
393 |
|
394 |
def print_subcommands_help(cmd): |
395 |
printout = {} |
396 |
for subcmd in cmd.subcommands.values(): |
397 |
spec, sep, print_path = subcmd.path.partition('_')
|
398 |
printout[print_path.replace('_', ' ')] = subcmd.help |
399 |
if printout:
|
400 |
print('\nOptions:\n - - - -')
|
401 |
print_dict(printout) |
402 |
|
403 |
|
404 |
def update_parser_help(parser, cmd): |
405 |
global _best_match
|
406 |
parser.syntax = parser.syntax.split('<')[0] |
407 |
parser.syntax += ' '.join(_best_match)
|
408 |
|
409 |
description = ''
|
410 |
if cmd.is_command:
|
411 |
cls = cmd.cmd_class |
412 |
parser.syntax += ' ' + cls.syntax
|
413 |
parser.update_arguments(cls().arguments) |
414 |
description = getattr(cls, 'long_description', '').strip() |
415 |
else:
|
416 |
parser.syntax += ' <...>'
|
417 |
parser.parser.description = ( |
418 |
cmd.help + ('\n' if description else '')) if cmd.help else description |
419 |
|
420 |
|
421 |
def print_error_message(cli_err): |
422 |
errmsg = '%s' % cli_err
|
423 |
if cli_err.importance == 1: |
424 |
errmsg = magenta(errmsg) |
425 |
elif cli_err.importance == 2: |
426 |
errmsg = yellow(errmsg) |
427 |
elif cli_err.importance > 2: |
428 |
errmsg = red(errmsg) |
429 |
stdout.write(errmsg) |
430 |
for errmsg in cli_err.details: |
431 |
print('| %s' % errmsg)
|
432 |
|
433 |
|
434 |
def exec_cmd(instance, cmd_args, help_method): |
435 |
try:
|
436 |
return instance.main(*cmd_args)
|
437 |
except TypeError as err: |
438 |
if err.args and err.args[0].startswith('main()'): |
439 |
print(magenta('Syntax error'))
|
440 |
if _debug:
|
441 |
raise err
|
442 |
if _verbose:
|
443 |
print(unicode(err))
|
444 |
help_method() |
445 |
else:
|
446 |
raise
|
447 |
return 1 |
448 |
|
449 |
|
450 |
def get_command_group(unparsed, arguments): |
451 |
groups = arguments['config'].groups
|
452 |
for term in unparsed: |
453 |
if term.startswith('-'): |
454 |
continue
|
455 |
if term in groups: |
456 |
unparsed.remove(term) |
457 |
return term
|
458 |
return None |
459 |
return None |
460 |
|
461 |
|
462 |
def set_command_params(parameters): |
463 |
"""Add a parameters list to a command
|
464 |
|
465 |
:param paramters: (list of str) a list of parameters
|
466 |
"""
|
467 |
global command
|
468 |
def_params = list(command.func_defaults)
|
469 |
def_params[0] = parameters
|
470 |
command.func_defaults = tuple(def_params)
|
471 |
|
472 |
|
473 |
# CLI Choice:
|
474 |
|
475 |
def run_one_cmd(exe_string, parser, auth_base, cloud): |
476 |
global _history
|
477 |
_history = History( |
478 |
parser.arguments['config'].get_global('history_file')) |
479 |
_history.add(' '.join([exe_string] + argv[1:])) |
480 |
from kamaki.cli import one_command |
481 |
one_command.run(auth_base, cloud, parser, _help) |
482 |
|
483 |
|
484 |
def run_shell(exe_string, parser, auth_base, cloud): |
485 |
from command_shell import _init_shell |
486 |
try:
|
487 |
username, userid = ( |
488 |
auth_base.user_term('name'), auth_base.user_term('id')) |
489 |
except Exception: |
490 |
username, userid = '', '' |
491 |
shell = _init_shell(exe_string, parser, username, userid) |
492 |
_load_all_commands(shell.cmd_tree, parser.arguments) |
493 |
shell.run(auth_base, cloud, parser) |
494 |
|
495 |
|
496 |
def is_non_API(parser): |
497 |
nonAPIs = ('history', 'config') |
498 |
for term in parser.unparsed: |
499 |
if not term.startswith('-'): |
500 |
if term in nonAPIs: |
501 |
return True |
502 |
return False |
503 |
return False |
504 |
|
505 |
|
506 |
def main(): |
507 |
try:
|
508 |
exe = basename(argv[0])
|
509 |
parser = ArgumentParseManager(exe) |
510 |
|
511 |
if parser.arguments['version'].value: |
512 |
exit(0) |
513 |
|
514 |
log_file = parser.arguments['config'].get_global('log_file') |
515 |
if log_file:
|
516 |
logger.set_log_filename(log_file) |
517 |
global filelog
|
518 |
filelog = logger.add_file_logger(__name__.split('.')[0]) |
519 |
filelog.info('* Initial Call *\n%s\n- - -' % ' '.join(argv)) |
520 |
|
521 |
auth_base, cloud = _init_session(parser.arguments, is_non_API(parser)) |
522 |
|
523 |
from kamaki.cli.utils import suggest_missing |
524 |
global _colors
|
525 |
exclude = ['ansicolors'] if not _colors == 'on' else [] |
526 |
suggest_missing(exclude=exclude) |
527 |
|
528 |
if parser.unparsed:
|
529 |
run_one_cmd(exe, parser, auth_base, cloud) |
530 |
elif _help:
|
531 |
parser.parser.print_help() |
532 |
_groups_help(parser.arguments) |
533 |
else:
|
534 |
run_shell(exe, parser, auth_base, cloud) |
535 |
except CLIError as err: |
536 |
print_error_message(err) |
537 |
if _debug:
|
538 |
raise err
|
539 |
exit(1) |
540 |
except Exception as er: |
541 |
print('Unknown Error: %s' % er)
|
542 |
if _debug:
|
543 |
raise
|
544 |
exit(1) |