Planetlab utilities

git-svn-id: https://scm.gforge.inria.fr/svn/pacemaker@50 30fcff6e-8de6-41c7-acce-77ff6d1dd07b

1 files changed, 108 insertions, 0 deletions

diff --git a/planetlab/pssh/psshlib/cli.py b/planetlab/pssh/psshlib/cli.py
new file mode 100644
index 0000000..1686ba9
--- /dev/null
+++ b/planetlab/pssh/psshlib/cli.py
@@ -0,0 +1,108 @@
+# Copyright (c) 2009, Andrew McNabb
+# Copyright (c) 2003-2008, Brent N. Chun
+
+import optparse
+import os
+import shlex
+import sys
+import textwrap
+
+_DEFAULT_PARALLELISM = 32
+_DEFAULT_TIMEOUT     = 0 # "infinity" by default
+
+
+def common_parser():
+    """
+    Create a basic OptionParser with arguments common to all pssh programs.
+    """
+    # The "resolve" conflict handler avoids errors from the hosts option
+    # conflicting with the help option.
+    parser = optparse.OptionParser(conflict_handler='resolve')
+    # Ensure that options appearing after the command are sent to ssh.
+    parser.disable_interspersed_args()
+    parser.epilog = "Example: pssh -h nodes.txt -l irb2 -o /tmp/foo uptime"
+
+    parser.add_option('-h', '--hosts', dest='host_files', action='append',
+            metavar='HOST_FILE',
+            help='hosts file (each line "[user@]host[:port]")')
+    parser.add_option('-H', '--host', dest='host_strings', action='append',
+            metavar='HOST_STRING',
+            help='additional host entries ("[user@]host[:port]")')
+    parser.add_option('-l', '--user', dest='user',
+            help='username (OPTIONAL)')
+    parser.add_option('-p', '--par', dest='par', type='int',
+            help='max number of parallel threads (OPTIONAL)')
+    parser.add_option('-o', '--outdir', dest='outdir',
+            help='output directory for stdout files (OPTIONAL)')
+    parser.add_option('-e', '--errdir', dest='errdir',
+            help='output directory for stderr files (OPTIONAL)')
+    parser.add_option('-t', '--timeout', dest='timeout', type='int',
+            help='timeout (secs) (0 = no timeout) per host (OPTIONAL)')
+    parser.add_option('-O', '--option', dest='options', action='append',
+            metavar='OPTION', help='SSH option (OPTIONAL)')
+    parser.add_option('-v', '--verbose', dest='verbose', action='store_true',
+            help='turn on warning and diagnostic messages (OPTIONAL)')
+    parser.add_option('-A', '--askpass', dest='askpass', action='store_true',
+            help='Ask for a password (OPTIONAL)')
+    parser.add_option('-x', '--extra-args', action='callback', type='string',
+            metavar='ARGS', callback=shlex_append, dest='extra',
+            help='Extra command-line arguments, with processing for '
+            'spaces, quotes, and backslashes')
+    parser.add_option('-X', '--extra-arg', dest='extra', action='append',
+            metavar='ARG', help='Extra command-line argument')
+
+    return parser
+
+
+def common_defaults(**kwargs):
+    defaults = dict(par=_DEFAULT_PARALLELISM, timeout=_DEFAULT_TIMEOUT)
+    defaults.update(**kwargs)
+    envvars = [('user', 'PSSH_USER'),
+            ('par', 'PSSH_PAR'),
+            ('outdir', 'PSSH_OUTDIR'),
+            ('errdir', 'PSSH_ERRDIR'),
+            ('timeout', 'PSSH_TIMEOUT'),
+            ('verbose', 'PSSH_VERBOSE'),
+            ('print_out', 'PSSH_PRINT'),
+            ('askpass', 'PSSH_ASKPASS'),
+            ('inline', 'PSSH_INLINE'),
+            ('recursive', 'PSSH_RECURSIVE'),
+            ('archive', 'PSSH_ARCHIVE'),
+            ('compress', 'PSSH_COMPRESS'),
+            ('localdir', 'PSSH_LOCALDIR'),
+            ]
+    for option, var, in envvars:
+        value = os.getenv(var)
+        if value:
+            defaults[option] = value
+
+    value = os.getenv('PSSH_OPTIONS')
+    if value:
+        defaults['options'] = [value]
+
+    value = os.getenv('PSSH_HOSTS')
+    if value:
+        message1 = ('Warning: the PSSH_HOSTS environment variable is '
+            'deprecated.  Please use the "-h" option instead, and consider '
+            'creating aliases for convenience.  For example:')
+        message2 = "    alias pssh_abc='pssh -h /path/to/hosts_abc'"
+        sys.stderr.write(textwrap.fill(message1))
+        sys.stderr.write('\n')
+        sys.stderr.write(message2)
+        sys.stderr.write('\n')
+        defaults['host_files'] = [value]
+
+    return defaults
+
+
+def shlex_append(option, opt_str, value, parser):
+    """An optparse callback similar to the append action.
+
+    The given value is processed with shlex, and the resulting list is
+    concatenated to the option's dest list.
+    """
+    lst = getattr(parser.values, option.dest)
+    if lst is None:
+        lst = []
+        setattr(parser.values, option.dest, lst)
+    lst.extend(shlex.split(value))