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
339
340
341
342
343
344
345
346
347
|
#
# Copyright (C) 2010-2015 CEA/DAM
#
# This file is part of ClusterShell.
#
# ClusterShell 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 2.1 of the License, or (at your option) any later version.
#
# ClusterShell 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 ClusterShell; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""
Common ClusterShell CLI OptionParser
With few exceptions, ClusterShell command-lines share most option
arguments. This module provides a common OptionParser class.
"""
from copy import copy
import optparse
from ClusterShell import __version__
from ClusterShell.Engine.Factory import PreferredEngine
from ClusterShell.CLI.Display import THREE_CHOICES
def check_autostep(option, opt, value):
"""type-checker function for autostep"""
try:
if '%' in value:
return float(value[:-1]) / 100.0
return int(value)
except ValueError:
if value == 'auto':
return value
error_fmt = "option %s: invalid value: %r, should be node count, " \
"node percentage or 'auto'"
raise optparse.OptionValueError(error_fmt % (opt, value))
def check_safestring(option, opt, value):
"""type-checker function for safestring"""
try:
safestr = str(value)
# check if the string is not empty and not an option
if not safestr or safestr.startswith('-'):
raise ValueError()
return safestr
except ValueError:
raise optparse.OptionValueError(
"option %s: invalid value: %r" % (opt, value))
class Option(optparse.Option):
"""This Option subclass adds a new safestring type."""
TYPES = optparse.Option.TYPES + ("autostep", "safestring",)
TYPE_CHECKER = copy(optparse.Option.TYPE_CHECKER)
TYPE_CHECKER["autostep"] = check_autostep
TYPE_CHECKER["safestring"] = check_safestring
class OptionParser(optparse.OptionParser):
"""Derived OptionParser for all CLIs"""
def __init__(self, usage, **kwargs):
"""Initialize ClusterShell CLI OptionParser"""
optparse.OptionParser.__init__(self, usage,
version="%%prog %s" % __version__,
option_class=Option,
**kwargs)
# Set parsing to stop on the first non-option
self.disable_interspersed_args()
# Always install groupsource support
self.add_option("-s", "--groupsource", action="store",
type="safestring", dest="groupsource",
help="optional groups.conf(5) group source to use")
def install_clush_config_options(self):
"""Install config options for clush"""
# config file override (--conf)
self.add_option("--conf", action="store", metavar='FILE',
help="use alternate config file for clush.conf(5)")
# config file option overrides (-O)
self.add_option("-O", "--option", action="append", metavar="KEY=VALUE",
dest="option", default=[],
help="override any key=value clush.conf(5) options")
def install_groupsconf_option(self):
"""Install an alternate groups.conf file option"""
self.add_option("--groupsconf", action="store", metavar='FILE',
help="use alternate config file for groups.conf(5)")
def install_nodes_options(self):
"""Install nodes selection options"""
optgrp = optparse.OptionGroup(self, "Selecting target nodes")
optgrp.add_option("-w", action="append", type="safestring",
dest="nodes", help="nodes where to run the command")
optgrp.add_option("-x", action="append", type="safestring",
dest="exclude", metavar="NODES",
help="exclude nodes from the node list")
optgrp.add_option("-a", "--all", action="store_true", dest="nodes_all",
help="run command on all nodes")
optgrp.add_option("-g", "--group", action="append", type="safestring",
dest="group", help="run command on a group of nodes")
optgrp.add_option("-X", action="append", dest="exgroup",
metavar="GROUP", type="safestring",
help="exclude nodes from this group")
optgrp.add_option("-E", "--engine", action="store", dest="engine",
choices=["auto"] + list(PreferredEngine.engines),
default="auto", help=optparse.SUPPRESS_HELP)
optgrp.add_option("--hostfile", "--machinefile", action="append",
dest="hostfile", default=[], metavar='FILE',
help="path to file containing a list of target hosts")
optgrp.add_option("--topology", action="store", dest="topofile",
default=None, metavar='FILE',
help="topology configuration file to use for tree "
"mode")
optgrp.add_option("--pick", action="store", dest="pick",
metavar="N", type="int",
help="pick N node(s) at random in nodeset")
self.add_option_group(optgrp)
def install_display_options(self,
debug_option=True,
verbose_options=False,
separator_option=False,
dshbak_compat=False,
msgtree_mode=False):
"""Install options needed by Display class"""
optgrp = optparse.OptionGroup(self, "Output behaviour")
if verbose_options:
optgrp.add_option("-q", "--quiet", action="store_true",
dest="quiet", help="be quiet, print essential output only")
optgrp.add_option("-v", "--verbose", action="store_true",
dest="verbose", help="be verbose, print informative messages")
if debug_option:
optgrp.add_option("-d", "--debug", action="store_true",
dest="debug",
help="output more messages for debugging purpose")
optgrp.add_option("-G", "--groupbase", action="store_true",
dest="groupbase", default=False,
help="do not display group source prefix")
optgrp.add_option("-L", action="store_true", dest="line_mode",
help="disable header block and order output by nodes")
optgrp.add_option("-N", action="store_false", dest="label",
default=True, help="disable labeling of command line")
if dshbak_compat:
optgrp.add_option("-b", "-c", "--dshbak", action="store_true",
dest="gather", help="gather nodes with same output")
else:
optgrp.add_option("-P", "--progress", action="store_true",
dest="progress", help="show progress during command execution")
optgrp.add_option("-b", "--dshbak", action="store_true",
dest="gather", help="gather nodes with same output")
optgrp.add_option("-B", action="store_true", dest="gatherall",
default=False, help="like -b but including standard error")
optgrp.add_option("-r", "--regroup", action="store_true",
dest="regroup", default=False,
help="fold nodeset using node groups")
if separator_option:
optgrp.add_option("-S", "--separator", action="store",
dest="separator", default=':',
help="node / line content separator string "
"(default: ':')")
else:
optgrp.add_option("-S", "--maxrc", action="store_true", dest="maxrc",
help="return the largest of command return codes")
if msgtree_mode:
# clubak specific
optgrp.add_option("-F", "--fast", action="store_true",
dest="fast_mode",
help="faster but memory hungry mode")
optgrp.add_option("-T", "--tree", action="store_true",
dest="trace_mode",
help="message tree trace mode")
optgrp.add_option("--interpret-keys", action="store",
dest="interpret_keys", choices=THREE_CHOICES,
default=THREE_CHOICES[-1], help="whether to "
"interpret keys (never, always or auto)")
optgrp.add_option("--color", action="store", dest="whencolor",
choices=THREE_CHOICES, help="whether to use ANSI "
"colors (never, always or auto)")
optgrp.add_option("--diff", action="store_true", dest="diff",
help="show diff between gathered outputs")
optgrp.add_option("--outdir", action="store", dest="outdir", help="output directory for stdout files (OPTIONAL)")
optgrp.add_option("--errdir", action="store", dest="errdir", help="output directory for stderr files (OPTIONAL)")
self.add_option_group(optgrp)
def _copy_callback(self, option, opt_str, value, parser):
"""special callback method for copy and rcopy toggles"""
# enable interspersed args again
self.enable_interspersed_args()
# set True to dest option attribute
setattr(parser.values, option.dest, True)
def install_filecopy_options(self):
"""Install file copying specific options"""
optgrp = optparse.OptionGroup(self, "File copying")
optgrp.add_option("-c", "--copy", action="callback", dest="copy",
callback=self._copy_callback,
help="copy local file or directory to remote nodes")
optgrp.add_option("--rcopy", action="callback", dest="rcopy",
callback=self._copy_callback,
help="copy file or directory from remote nodes")
optgrp.add_option("--dest", action="store", dest="dest_path",
help="destination file or directory on the nodes")
optgrp.add_option("-p", action="store_true", dest="preserve_flag",
help="preserve modification times and modes")
self.add_option_group(optgrp)
def install_connector_options(self):
"""Install engine/connector (ssh, ...) options"""
optgrp = optparse.OptionGroup(self, "Connection options")
optgrp.add_option("-f", "--fanout", action="store", dest="fanout",
help="use a specified fanout", type="int")
#help="queueing delay for traffic grooming"
optgrp.add_option("--grooming", action="store", dest="grooming_delay",
help=optparse.SUPPRESS_HELP, type="float")
optgrp.add_option("-l", "--user", action="store", type="safestring",
dest="user", help="execute remote command as user")
optgrp.add_option("-o", "--options", action="store", dest="options",
help="can be used to give ssh options")
optgrp.add_option("-t", "--connect_timeout", action="store",
dest="connect_timeout",
help="limit time to connect to a node", type="float")
optgrp.add_option("-u", "--command_timeout", action="store",
dest="command_timeout",
help="limit time for command to run on the node",
type="float")
optgrp.add_option("-m", "--mode", action="store", dest="mode",
help="run mode; define MODEs in <confdir>/*.conf")
optgrp.add_option("-R", "--worker", action="store", dest="worker",
help="worker name to use for command execution "
"('exec', 'rsh', 'ssh', etc. default is 'ssh')")
optgrp.add_option("--remote", action="store", dest="remote",
choices=('yes', 'no'),
help="whether to enable remote execution: in tree "
"mode, 'yes' forces connections to the leaf "
"nodes for execution, 'no' establishes "
"connections up to the leaf parent nodes for "
"execution (default is 'yes')")
self.add_option_group(optgrp)
def install_nodeset_commands(self):
"""Install nodeset commands"""
optgrp = optparse.OptionGroup(self, "Commands")
optgrp.add_option("-c", "--count", action="store_true", dest="count",
default=False,
help="show number of nodes in nodeset(s)")
optgrp.add_option("-e", "--expand", action="store_true", dest="expand",
default=False,
help="expand nodeset(s) to separate nodes")
optgrp.add_option("-f", "--fold", action="store_true", dest="fold",
default=False, help="fold nodeset(s) (or separate "
"nodes) into one nodeset")
optgrp.add_option("-l", "--list", action="count", dest="list",
default=False, help="list node groups from one "
"source (see -s GROUPSOURCE)")
optgrp.add_option("-L", "--list-all", action="count", dest="listall",
default=False,
help="list node groups from all group sources")
optgrp.add_option("-r", "--regroup", action="store_true",
dest="regroup", default=False,
help="fold nodes using node groups (see -s "
"GROUPSOURCE)")
optgrp.add_option("--list-sources", "--groupsources",
action="store_true", dest="groupsources",
default=False,
help="list all active group sources (see "
"groups.conf(5))")
# special hidden command for bash completion scripts
optgrp.add_option("--completion", action="store_true",
dest="completion",
default=False, help=optparse.SUPPRESS_HELP)
self.add_option_group(optgrp)
def install_nodeset_operations(self):
"""Install nodeset operations"""
optgrp = optparse.OptionGroup(self, "Operations")
optgrp.add_option("-x", "--exclude", action="append", dest="sub_nodes",
default=[], type="string",
help="exclude specified nodeset")
optgrp.add_option("-i", "--intersection", action="append",
dest="and_nodes", default=[], type="string",
help="calculate nodesets intersection")
optgrp.add_option("-X", "--xor", action="append", dest="xor_nodes",
default=[], type="string",
help="calculate symmetric difference between "
"nodesets")
self.add_option_group(optgrp)
def install_nodeset_options(self):
"""Install nodeset options"""
optgrp = optparse.OptionGroup(self, "Options")
optgrp.add_option("-a", "--all", action="store_true", dest="all",
help="call external node groups support to "
"display all nodes")
optgrp.add_option("--autostep", action="store", dest="autostep",
help="enable a-b/step style syntax when folding, "
"value is min node count threshold (eg. '4', "
"'50%' or 'auto')",
type="autostep")
optgrp.add_option("-d", "--debug", action="store_true", dest="debug",
help="output more messages for debugging purpose")
optgrp.add_option("-q", "--quiet", action="store_true", dest="quiet",
help="be quiet, print essential output only")
optgrp.add_option("-R", "--rangeset", action="store_true",
dest="rangeset", help="switch to RangeSet instead "
"of NodeSet. Useful when working on numerical "
"cluster ranges, eg. 1,5,18-31")
optgrp.add_option("-G", "--groupbase", action="store_true",
dest="groupbase", help="hide group source prefix "
"(always \"@groupname\")")
optgrp.add_option("-S", "--separator", action="store", dest="separator",
default=' ', help="separator string to use when "
"expanding nodesets (default: ' ')")
optgrp.add_option("-O", "--output-format", action="store",
dest="output_format", metavar='FORMAT', default='%s',
help="output format (default: '%s')")
optgrp.add_option("-I", "--slice", action="store",
dest="slice_rangeset",
help="return sliced off result", type="string")
optgrp.add_option("--split", action="store", dest="maxsplit",
help="split result into a number of subsets",
type="int")
optgrp.add_option("--contiguous", action="store_true",
dest="contiguous", help="split result into "
"contiguous subsets")
optgrp.add_option("--axis", action="store", dest="axis",
metavar="RANGESET", help="fold along these axis only "
"(axis 1..n for nD nodeset)")
optgrp.add_option("--pick", action="store", dest="pick",
metavar="N", type="int",
help="pick N node(s) at random in nodeset")
self.add_option_group(optgrp)
|
