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