-
Notifications
You must be signed in to change notification settings - Fork 313
/
cli.py
338 lines (313 loc) · 12.9 KB
/
cli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# Copyright 2009-2014 Justin Riley
#
# This file is part of StarCluster.
#
# StarCluster is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# StarCluster is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with StarCluster. If not, see <http://www.gnu.org/licenses/>.
"""
StarCluster Command Line Interface:
starcluster [global-opts] action [action-opts] [<action-args> ...]
"""
import os
import sys
import shlex
import socket
import optparse
import platform
from boto.exception import BotoServerError, EC2ResponseError, S3ResponseError
from starcluster import config
from starcluster import static
from starcluster import logger
from starcluster import commands
from starcluster import exception
from starcluster import completion
from starcluster.logger import log, console
from starcluster import __version__
__description__ = """
StarCluster - (http://star.mit.edu/cluster) (v. %s)
Software Tools for Academics and Researchers (STAR)
Please submit bug reports to starcluster@mit.edu
""" % __version__
class StarClusterCLI(object):
"""
StarCluster Command Line Interface
"""
def __init__(self):
self._gparser = None
self.subcmds_map = {}
@property
def gparser(self):
if not self._gparser:
self._gparser = self.create_global_parser()
return self._gparser
def print_header(self):
print >> sys.stderr, __description__.replace('\n', '', 1)
def parse_subcommands(self, gparser=None):
"""
Parse global arguments, find subcommand from list of subcommand
objects, parse local subcommand arguments and return a tuple of
global options, selected command object, command options, and
command arguments.
Call execute() on the command object to run. The command object has
members 'gopts' and 'opts' set for global and command options
respectively, you don't need to call execute with those but you could
if you wanted to.
"""
gparser = gparser or self.gparser
# parse global options.
gopts, args = gparser.parse_args()
if not args:
gparser.print_help()
raise SystemExit("\nError: you must specify an action.")
# set debug level if specified
if gopts.DEBUG:
console.setLevel(logger.DEBUG)
config.DEBUG_CONFIG = True
# load StarClusterConfig into global options
try:
cfg = config.StarClusterConfig(gopts.CONFIG)
cfg.load()
except exception.ConfigNotFound, e:
log.error(e.msg)
e.display_options()
sys.exit(1)
except exception.ConfigError, e:
log.error(e.msg)
sys.exit(1)
gopts.CONFIG = cfg
# Parse command arguments and invoke command.
subcmdname, subargs = args[0], args[1:]
try:
sc = self.subcmds_map[subcmdname]
lparser = optparse.OptionParser(sc.__doc__.strip())
sc.gopts = gopts
sc.parser = lparser
sc.gparser = gparser
sc.subcmds_map = self.subcmds_map
sc.addopts(lparser)
sc.opts, subsubargs = lparser.parse_args(subargs)
except KeyError:
raise SystemExit("Error: invalid command '%s'" % subcmdname)
return gopts, sc, sc.opts, subsubargs
def create_global_parser(self, subcmds=None, no_usage=False,
add_help=True):
if no_usage:
gparser = optparse.OptionParser(usage=optparse.SUPPRESS_USAGE,
add_help_option=add_help)
else:
gparser = optparse.OptionParser(__doc__.strip(),
version=__version__,
add_help_option=add_help)
# Build map of name -> command and docstring.
cmds_header = 'Available Commands:'
gparser.usage += '\n\n%s\n' % cmds_header
gparser.usage += '%s\n' % ('-' * len(cmds_header))
gparser.usage += "NOTE: Pass --help to any command for a list of "
gparser.usage += 'its options and detailed usage information\n\n'
subcmds = subcmds or commands.all_cmds
for sc in subcmds:
helptxt = sc.__doc__.splitlines()[3].strip()
gparser.usage += '- %s: %s\n' % (', '.join(sc.names), helptxt)
for n in sc.names:
assert n not in self.subcmds_map
self.subcmds_map[n] = sc
gparser.add_option("-d", "--debug", dest="DEBUG",
action="store_true", default=False,
help="print debug messages (useful for "
"diagnosing problems)")
gparser.add_option("-c", "--config", dest="CONFIG", action="store",
metavar="FILE",
help="use alternate config file (default: %s)" %
static.STARCLUSTER_CFG_FILE)
gparser.add_option("-r", "--region", dest="REGION", action="store",
help="specify a region to use (default: us-east-1)")
gparser.disable_interspersed_args()
return gparser
def __write_module_version(self, modname, fp):
"""
Write module version information to a file
"""
try:
mod = __import__(modname)
fp.write("%s: %s\n" % (mod.__name__, mod.__version__))
except Exception, e:
print "error getting version for '%s' module: %s" % (modname, e)
def bug_found(self):
"""
Builds a crash-report when StarCluster encounters an unhandled
exception. Report includes system info, python version, dependency
versions, and a full debug log and stack-trace of the crash.
"""
dashes = '-' * 10
header = dashes + ' %s ' + dashes + '\n'
crashfile = open(static.CRASH_FILE, 'w')
argv = sys.argv[:]
argv[0] = os.path.basename(argv[0])
argv = ' '.join(argv)
crashfile.write(header % "SYSTEM INFO")
crashfile.write("StarCluster: %s\n" % __version__)
crashfile.write("Python: %s\n" % sys.version.replace('\n', ' '))
crashfile.write("Platform: %s\n" % platform.platform())
dependencies = ['boto', 'paramiko', 'Crypto']
for dep in dependencies:
self.__write_module_version(dep, crashfile)
crashfile.write("\n" + header % "CRASH DETAILS")
crashfile.write('Command: %s\n\n' % argv)
for line in logger.get_session_log():
crashfile.write(line)
crashfile.close()
print
log.error("Oops! Looks like you've found a bug in StarCluster")
log.error("Crash report written to: %s" % static.CRASH_FILE)
log.error("Please remove any sensitive data from the crash report")
log.error("and submit it to starcluster@mit.edu")
sys.exit(1)
def get_global_opts(self):
"""
Parse and return global options. This method will silently return None
if any errors are encountered during parsing.
"""
gparser = self.create_global_parser(no_usage=True, add_help=False)
try:
sys.stdout = open(os.devnull, 'w')
sys.stderr = open(os.devnull, 'w')
gopts, _ = gparser.parse_args()
return gopts
except SystemExit:
pass
finally:
sys.stdout = sys.__stdout__
sys.stderr = sys.__stderr__
def is_completion_active(self):
return 'OPTPARSE_AUTO_COMPLETE' in os.environ
def _init_completion(self):
"""
Restore original sys.argv from COMP_LINE in the case that starcluster
is being called by Bash/ZSH for completion options. Bash/ZSH will
simply call 'starcluster' with COMP_LINE environment variable set to
the current (partial) argv for completion.
StarCluster's Bash/ZSH completion code needs to read the global config
option in case an alternate config is specified at the command line
when completing options. StarCluster's completion code uses the config
to generate completion options. Setting sys.argv to $COMP_LINE in this
case allows the global option parser to be used to extract the global
-c option (if specified) and load the proper config in the completion
code.
"""
if 'COMP_LINE' in os.environ:
newargv = shlex.split(os.environ.get('COMP_LINE'))
for i, arg in enumerate(newargv):
arg = os.path.expanduser(arg)
newargv[i] = os.path.expandvars(arg)
sys.argv = newargv
def handle_completion(self):
if self.is_completion_active():
gparser = self.create_global_parser(no_usage=True, add_help=False)
# set sys.path to COMP_LINE if it exists
self._init_completion()
# fetch the global options
gopts = self.get_global_opts()
# try to load StarClusterConfig into global options
if gopts:
try:
cfg = config.StarClusterConfig(gopts.CONFIG)
cfg.load()
except exception.ConfigError:
cfg = None
gopts.CONFIG = cfg
scmap = {}
for sc in commands.all_cmds:
sc.gopts = gopts
for n in sc.names:
scmap[n] = sc
listcter = completion.ListCompleter(scmap.keys())
subcter = completion.NoneCompleter()
completion.autocomplete(gparser, listcter, None, subcter,
subcommands=scmap)
sys.exit(1)
def main(self):
"""
StarCluster main
"""
# Handle Bash/ZSH completion if necessary
self.handle_completion()
# Show StarCluster header
self.print_header()
# Parse subcommand options and args
gopts, sc, opts, args = self.parse_subcommands()
if args and args[0] == 'help':
# make 'help' subcommand act like --help option
sc.parser.print_help()
sys.exit(0)
# run the subcommand and handle exceptions
try:
sc.execute(args)
except (EC2ResponseError, S3ResponseError, BotoServerError), e:
log.error("%s: %s" % (e.error_code, e.error_message),
exc_info=True)
sys.exit(1)
except socket.error, e:
log.exception("Connection error:")
log.error("Check your internet connection?")
sys.exit(1)
except exception.ThreadPoolException, e:
log.error(e.format_excs())
self.bug_found()
except exception.ClusterDoesNotExist, e:
cm = gopts.CONFIG.get_cluster_manager()
cls = ''
try:
cls = cm.get_clusters(load_plugins=False, load_receipt=False)
except:
log.debug("Error fetching cluster list", exc_info=True)
log.error(e.msg)
if cls:
taglist = ', '.join([c.cluster_tag for c in cls])
active_clusters = "(active clusters: %s)" % taglist
log.error(active_clusters)
sys.exit(1)
except exception.BaseException, e:
log.error(e.msg, extra={'__textwrap__': True})
log.debug(e.msg, exc_info=True)
sys.exit(1)
except SystemExit:
# re-raise SystemExit to avoid the bug-catcher below
raise
except Exception:
log.error("Unhandled exception occured", exc_info=True)
self.bug_found()
def warn_debug_file_moved():
old_file = os.path.join(static.TMP_DIR, 'starcluster-debug-%s.log' %
static.CURRENT_USER)
if os.path.exists(old_file):
stars = '*' * 50
log.warn(stars)
log.warn("The default log file location is now:")
log.warn("")
log.warn(static.DEBUG_FILE)
log.warn("")
log.warn("Please delete or move the old log file located at:")
log.warn("")
log.warn(old_file)
log.warn(stars)
def main():
try:
static.create_sc_config_dirs()
logger.configure_sc_logging()
warn_debug_file_moved()
StarClusterCLI().main()
except KeyboardInterrupt:
print "Interrupted, exiting."
sys.exit(1)
if __name__ == '__main__':
main()