root / kamaki / cli / __init__.py @ 82cc4b8f
History | View | Annotate | Download (17.7 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(cls_name, cls.description, cls) |
161 |
return cls
|
162 |
return wrap
|
163 |
|
164 |
|
165 |
cmd_spec_locations = [ |
166 |
'kamaki.cli.commands',
|
167 |
'kamaki.commands',
|
168 |
'kamaki.cli',
|
169 |
'kamaki',
|
170 |
'']
|
171 |
|
172 |
|
173 |
# Generic init auxiliary functions
|
174 |
|
175 |
|
176 |
def _setup_logging(silent=False, debug=False, verbose=False, include=False): |
177 |
"""handle logging for clients package"""
|
178 |
|
179 |
if silent:
|
180 |
logger.add_stream_logger(__name__, logging.CRITICAL) |
181 |
return
|
182 |
|
183 |
sfmt, rfmt = '> %(message)s', '< %(message)s' |
184 |
if debug:
|
185 |
print('Logging location: %s' % logger.get_log_filename())
|
186 |
logger.add_stream_logger('kamaki.clients.send', logging.DEBUG, sfmt)
|
187 |
logger.add_stream_logger('kamaki.clients.recv', logging.DEBUG, rfmt)
|
188 |
logger.add_stream_logger(__name__, logging.DEBUG) |
189 |
elif verbose:
|
190 |
logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
|
191 |
logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
|
192 |
logger.add_stream_logger(__name__, logging.INFO) |
193 |
if include:
|
194 |
logger.add_stream_logger('kamaki.clients.send', logging.INFO, sfmt)
|
195 |
logger.add_stream_logger('kamaki.clients.recv', logging.INFO, rfmt)
|
196 |
logger.add_stream_logger(__name__, logging.WARNING) |
197 |
global kloger
|
198 |
kloger = logger.get_logger(__name__) |
199 |
|
200 |
|
201 |
def _check_config_version(cnf): |
202 |
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 |
lost_terms = cnf.rescue_old_file() |
209 |
print('... DONE')
|
210 |
if lost_terms:
|
211 |
print 'The following information will NOT be preserved:' |
212 |
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 |
from sys import stdin |
216 |
reply = stdin.readline() |
217 |
if reply in ('Y\n', 'y\n'): |
218 |
cnf.write() |
219 |
print('... DONE')
|
220 |
else:
|
221 |
print('... ABORTING')
|
222 |
raise CLIError(
|
223 |
'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 |
global _help
|
234 |
_help = arguments['help'].value
|
235 |
global _debug
|
236 |
_debug = arguments['debug'].value
|
237 |
global _include
|
238 |
_include = arguments['include'].value
|
239 |
global _verbose
|
240 |
_verbose = arguments['verbose'].value
|
241 |
_cnf = arguments['config']
|
242 |
|
243 |
if _help or is_non_API: |
244 |
return None, None |
245 |
|
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'): |
251 |
from kamaki.cli.utils import remove_colors |
252 |
remove_colors() |
253 |
_silent = arguments['silent'].value
|
254 |
_setup_logging(_silent, _debug, _verbose, _include) |
255 |
|
256 |
cloud = arguments['cloud'].value or _cnf.value.get( |
257 |
'global', 'default_cloud') |
258 |
if not cloud: |
259 |
num_of_clouds = len(_cnf.value.keys('cloud')) |
260 |
if num_of_clouds == 1: |
261 |
cloud = _cnf.value.keys('cloud')[0] |
262 |
elif num_of_clouds > 1: |
263 |
raise CLIError(
|
264 |
'Found %s clouds but none of them is set as default' % (
|
265 |
num_of_clouds), |
266 |
importance=2, details=[
|
267 |
'Please, choose one of the following cloud names:',
|
268 |
', '.join(_cnf.value.keys('cloud')), |
269 |
'To see all cloud settings:',
|
270 |
' kamaki config get cloud.<cloud name>',
|
271 |
'To set a default cloud:',
|
272 |
' kamaki config set default_cloud <cloud name>',
|
273 |
'To pick a cloud for the current session, use --cloud:',
|
274 |
' 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 |
'To configure a new cloud "%s", find and set the' % (
|
280 |
cloud or '<cloud name>'), |
281 |
'single authentication URL and token:',
|
282 |
' kamaki config set cloud.%s.url <URL>' % (
|
283 |
cloud or '<cloud name>'), |
284 |
' kamaki config set cloud.%s.token <t0k3n>' % (
|
285 |
cloud or '<cloud name>')]) |
286 |
auth_args = dict()
|
287 |
for term in ('url', 'token'): |
288 |
try:
|
289 |
auth_args[term] = _cnf.get_cloud(cloud, term) |
290 |
except KeyError or IndexError: |
291 |
auth_args[term] = ''
|
292 |
if not auth_args[term]: |
293 |
raise CLIError(
|
294 |
'No authentication %s provided for cloud "%s"' % (
|
295 |
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 |
auth_base = None
|
303 |
for token in reversed(auth_args['token'].split()): |
304 |
try:
|
305 |
if auth_base:
|
306 |
auth_base.authenticate(token) |
307 |
else:
|
308 |
auth_base = AuthCachedClient( |
309 |
auth_args['url'], auth_args['token']) |
310 |
auth_base.authenticate(token) |
311 |
except ClientError as ce: |
312 |
if ce.status in (401, ): |
313 |
kloger.warning( |
314 |
'WARNING: Failed to authorize token %s' % token)
|
315 |
else:
|
316 |
raise
|
317 |
return auth_base, cloud
|
318 |
except AssertionError as ae: |
319 |
kloger.warning('WARNING: Failed to load authenticator [%s]' % ae)
|
320 |
return None, cloud |
321 |
|
322 |
|
323 |
def _load_spec_module(spec, arguments, module): |
324 |
if not spec: |
325 |
return None |
326 |
pkg = None
|
327 |
for location in cmd_spec_locations: |
328 |
location += spec if location == '' else '.%s' % spec |
329 |
try:
|
330 |
pkg = __import__(location, fromlist=[module])
|
331 |
return pkg
|
332 |
except ImportError as ie: |
333 |
continue
|
334 |
if not pkg: |
335 |
msg = 'Loading command group %s failed: %s' % (spec, ie)
|
336 |
try:
|
337 |
kloger.debug(msg) |
338 |
except AttributeError: |
339 |
print msg
|
340 |
print 'HINT: use a text editor to remove all global.*_cli' |
341 |
print ' settings from the configuration file' |
342 |
return pkg
|
343 |
|
344 |
|
345 |
def _groups_help(arguments): |
346 |
global _debug
|
347 |
global kloger
|
348 |
descriptions = {} |
349 |
acceptable_groups = arguments['config'].groups
|
350 |
for cmd_group, spec in arguments['config'].cli_specs: |
351 |
pkg = _load_spec_module(spec, arguments, '_commands')
|
352 |
if pkg:
|
353 |
cmds = getattr(pkg, '_commands') |
354 |
try:
|
355 |
for cmd_tree in cmds: |
356 |
if cmd_tree.name in acceptable_groups: |
357 |
descriptions[cmd_tree.name] = cmd_tree.description |
358 |
except TypeError: |
359 |
if _debug:
|
360 |
kloger.warning( |
361 |
'No cmd description (help) for module %s' % cmd_group)
|
362 |
elif _debug:
|
363 |
kloger.warning('Loading of %s cmd spec failed' % cmd_group)
|
364 |
print('\nOptions:\n - - - -')
|
365 |
print_dict(descriptions) |
366 |
|
367 |
|
368 |
def _load_all_commands(cmd_tree, arguments): |
369 |
_cnf = arguments['config']
|
370 |
for cmd_group, spec in _cnf.cli_specs: |
371 |
try:
|
372 |
spec_module = _load_spec_module(spec, arguments, '_commands')
|
373 |
spec_commands = getattr(spec_module, '_commands') |
374 |
except AttributeError: |
375 |
if _debug:
|
376 |
global kloger
|
377 |
kloger.warning('No valid description for %s' % cmd_group)
|
378 |
continue
|
379 |
for spec_tree in spec_commands: |
380 |
if spec_tree.name == cmd_group:
|
381 |
cmd_tree.add_tree(spec_tree) |
382 |
break
|
383 |
|
384 |
|
385 |
# Methods to be used by CLI implementations
|
386 |
|
387 |
|
388 |
def print_subcommands_help(cmd): |
389 |
printout = {} |
390 |
for subcmd in cmd.subcommands.values(): |
391 |
spec, sep, print_path = subcmd.path.partition('_')
|
392 |
printout[print_path.replace('_', ' ')] = subcmd.help |
393 |
if printout:
|
394 |
print('\nOptions:\n - - - -')
|
395 |
print_dict(printout) |
396 |
|
397 |
|
398 |
def update_parser_help(parser, cmd): |
399 |
global _best_match
|
400 |
parser.syntax = parser.syntax.split('<')[0] |
401 |
parser.syntax += ' '.join(_best_match)
|
402 |
|
403 |
description = ''
|
404 |
if cmd.is_command:
|
405 |
cls = cmd.cmd_class |
406 |
parser.syntax += ' ' + cls.syntax
|
407 |
parser.update_arguments(cls().arguments) |
408 |
description = getattr(cls, 'long_description', '').strip() |
409 |
else:
|
410 |
parser.syntax += ' <...>'
|
411 |
parser.parser.description = ( |
412 |
cmd.help + ('\n' if description else '')) if cmd.help else description |
413 |
|
414 |
|
415 |
def print_error_message(cli_err): |
416 |
errmsg = '%s' % cli_err
|
417 |
if cli_err.importance == 1: |
418 |
errmsg = magenta(errmsg) |
419 |
elif cli_err.importance == 2: |
420 |
errmsg = yellow(errmsg) |
421 |
elif cli_err.importance > 2: |
422 |
errmsg = red(errmsg) |
423 |
stdout.write(errmsg) |
424 |
for errmsg in cli_err.details: |
425 |
print('| %s' % errmsg)
|
426 |
|
427 |
|
428 |
def exec_cmd(instance, cmd_args, help_method): |
429 |
try:
|
430 |
return instance.main(*cmd_args)
|
431 |
except TypeError as err: |
432 |
if err.args and err.args[0].startswith('main()'): |
433 |
print(magenta('Syntax error'))
|
434 |
if _debug:
|
435 |
raise err
|
436 |
if _verbose:
|
437 |
print(unicode(err))
|
438 |
help_method() |
439 |
else:
|
440 |
raise
|
441 |
return 1 |
442 |
|
443 |
|
444 |
def get_command_group(unparsed, arguments): |
445 |
groups = arguments['config'].groups
|
446 |
for term in unparsed: |
447 |
if term.startswith('-'): |
448 |
continue
|
449 |
if term in groups: |
450 |
unparsed.remove(term) |
451 |
return term
|
452 |
return None |
453 |
return None |
454 |
|
455 |
|
456 |
def set_command_params(parameters): |
457 |
"""Add a parameters list to a command
|
458 |
|
459 |
:param paramters: (list of str) a list of parameters
|
460 |
"""
|
461 |
global command
|
462 |
def_params = list(command.func_defaults)
|
463 |
def_params[0] = parameters
|
464 |
command.func_defaults = tuple(def_params)
|
465 |
|
466 |
|
467 |
# CLI Choice:
|
468 |
|
469 |
def run_one_cmd(exe_string, parser, auth_base, cloud): |
470 |
global _history
|
471 |
_history = History( |
472 |
parser.arguments['config'].get_global('history_file')) |
473 |
_history.add(' '.join([exe_string] + argv[1:])) |
474 |
from kamaki.cli import one_command |
475 |
one_command.run(auth_base, cloud, parser, _help) |
476 |
|
477 |
|
478 |
def run_shell(exe_string, parser, auth_base, cloud): |
479 |
from command_shell import _init_shell |
480 |
try:
|
481 |
username, userid = ( |
482 |
auth_base.user_term('name'), auth_base.user_term('id')) |
483 |
except Exception: |
484 |
username, userid = '', '' |
485 |
shell = _init_shell(exe_string, parser, username, userid) |
486 |
_load_all_commands(shell.cmd_tree, parser.arguments) |
487 |
shell.run(auth_base, cloud, parser) |
488 |
|
489 |
|
490 |
def is_non_API(parser): |
491 |
nonAPIs = ('history', 'config') |
492 |
for term in parser.unparsed: |
493 |
if not term.startswith('-'): |
494 |
if term in nonAPIs: |
495 |
return True |
496 |
return False |
497 |
return False |
498 |
|
499 |
|
500 |
def main(): |
501 |
try:
|
502 |
exe = basename(argv[0])
|
503 |
parser = ArgumentParseManager(exe) |
504 |
|
505 |
if parser.arguments['version'].value: |
506 |
exit(0) |
507 |
|
508 |
log_file = parser.arguments['config'].get_global('log_file') |
509 |
if log_file:
|
510 |
logger.set_log_filename(log_file) |
511 |
global filelog
|
512 |
filelog = logger.add_file_logger(__name__.split('.')[0]) |
513 |
filelog.info('* Initial Call *\n%s\n- - -' % ' '.join(argv)) |
514 |
|
515 |
auth_base, cloud = _init_session(parser.arguments, is_non_API(parser)) |
516 |
|
517 |
from kamaki.cli.utils import suggest_missing |
518 |
global _colors
|
519 |
exclude = ['ansicolors'] if not _colors == 'on' else [] |
520 |
suggest_missing(exclude=exclude) |
521 |
|
522 |
if parser.unparsed:
|
523 |
run_one_cmd(exe, parser, auth_base, cloud) |
524 |
elif _help:
|
525 |
parser.parser.print_help() |
526 |
_groups_help(parser.arguments) |
527 |
else:
|
528 |
run_shell(exe, parser, auth_base, cloud) |
529 |
except CLIError as err: |
530 |
print_error_message(err) |
531 |
if _debug:
|
532 |
raise err
|
533 |
exit(1) |
534 |
except Exception as er: |
535 |
print('Unknown Error: %s' % er)
|
536 |
if _debug:
|
537 |
raise
|
538 |
exit(1) |