python: Upgrade daemon module to argparse.

This patch also updates it's callers.

debian/ovs-monitor-ipsec

@@ -25,7 +25,7 @@
 #    adding an interface to racoon.conf.
 
 
-import getopt
+import argparse
 import glob
 import logging
 import logging.handlers
@@ -405,17 +405,6 @@ def prune_schema(schema):
     schema.tables = new_tables
 
 
-def usage():
-    print "usage: %s [OPTIONS] DATABASE" % sys.argv[0]
-    print "where DATABASE is a socket on which ovsdb-server is listening."
-    ovs.daemon.usage()
-    print """\
-Other options:
-    --root-prefix=DIR   Use DIR as alternate root directory (for testing).
-    -h, --help          Display this help message."""
-    sys.exit(0)
-
-
 def update_ipsec(ipsec, interfaces, new_interfaces):
     for name, vals in interfaces.iteritems():
         if name not in new_interfaces:
@@ -446,32 +435,23 @@ def get_ssl_cert(data):
     return None
 
 
-def main(argv):
+def main():
-    try:
-        options, args = getopt.gnu_getopt(
-            argv[1:], 'h', ['help', 'root-prefix='] + ovs.daemon.LONG_OPTIONS)
-    except getopt.GetoptError, geo:
-        sys.stderr.write("%s: %s\n" % (ovs.util.PROGRAM_NAME, geo.msg))
-        sys.exit(1)
 
-    for key, value in options:
+    parser = argparse.ArgumentParser()
-        if key in ['-h', '--help']:
+    parser.add_argument("database", metavar="DATABASE",
-            usage()
+                        help="A socket on which ovsdb-server is listening.")
-        elif key == "--root-prefix":
+    parser.add_argument("--root-prefix", metavar="DIR",
-            global root_prefix
+                        help="Use DIR as alternate root directory"
-            root_prefix = value
+                        " (for testing).")
-        elif not ovs.daemon.parse_opt(key, value):
-            sys.stderr.write("%s: unhandled option %s\n"
-                             % (ovs.util.PROGRAM_NAME, key))
-            sys.exit(1)
 
-    if len(args) != 1:
+    ovs.daemon.add_args(parser)
-        sys.stderr.write("%s: exactly one nonoption argument is required "
+    args = parser.parse_args()
-                         "(use --help for help)\n" % ovs.util.PROGRAM_NAME)
+    ovs.daemon.handle_args(args)
-        sys.exit(1)
 
-    remote = args[0]
+    global root_prefix
+    root_prefix = args.root_prefix
 
+    remote = args.database
     schema_file = "%s/vswitch.ovsschema" % ovs.dirs.PKGDATADIR
     schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
     prune_schema(schema)
@@ -533,7 +513,7 @@ def main(argv):
 
 if __name__ == '__main__':
     try:
-        main(sys.argv)
+        main()
     except SystemExit:
         # Let system.exit() calls complete normally
         raise

python/ovs/daemon.py

@@ -487,26 +487,43 @@ def _check_already_running():
         _fatal("%s: pidfile check failed (%s), aborting"
                % (_pidfile, os.strerror(pid)))
 
-# XXX Python's getopt does not support options with optional arguments, so we
+
-# have to separate --pidfile (with no argument) from --pidfile-name (with an
+def add_args(parser):
-# argument).  Need to write our own getopt I guess.
+    """Populates 'parser', an ArgumentParser allocated using the argparse
-LONG_OPTIONS = ["detach", "no-chdir", "pidfile", "pidfile-name=",
+    module, with the command line arguments required by the daemon module."""
-                "overwrite-pidfile", "monitor"]
+
+    pidfile = make_pidfile_name(None)
+
+    group = parser.add_argument_group(title="Daemon Options")
+    group.add_argument("--detach", action="store_true",
+            help="Run in background as a daemon.")
+    group.add_argument("--no-chdir", action="store_true",
+            help="Do not chdir to '/'.")
+    group.add_argument("--monitor", action="store_true",
+            help="Monitor %s process." % ovs.util.PROGRAM_NAME)
+    group.add_argument("--pidfile", nargs="?", default=pidfile,
+            help="Create pidfile (default %s)." % pidfile)
+    group.add_argument("--overwrite-pidfile", action="store_true",
+            help="With --pidfile, start even if already running.")
 
 
-def parse_opt(option, arg):
+def handle_args(args):
-    if option == '--detach':
+    """Handles daemon module settings in 'args'.  'args' is an object
+    containing values parsed by the parse_args() method of ArgumentParser.  The
+    parent ArgumentParser should have been prepared by add_args() before
+    calling parse_args()."""
+
+    if args.detach:
         set_detach()
-    elif option == '--no-chdir':
+
+    if args.no_chdir:
         set_no_chdir()
-    elif option == '--pidfile':
+
-        set_pidfile(None)
+    if args.pidfile:
-    elif option == '--pidfile-name':
+        set_pidfile(args.pidfile)
-        set_pidfile(arg)
+
-    elif option == '--overwrite-pidfile':
+    if args.overwrite_pidfile:
         ignore_existing_pidfile()
-    elif option == '--monitor':
+
+    if args.monitor:
         set_monitor()
-    else:
-        return False
-    return True

tests/daemon-py.at

@@ -6,7 +6,7 @@ AT_CAPTURE_FILE([pid])
 AT_CAPTURE_FILE([expected])
 # Start the daemon and wait for the pidfile to get created
 # and that its contents are the correct pid.
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid& echo $! > expected], [0])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid& echo $! > expected], [0])
 OVS_WAIT_UNTIL([test -s pid], [kill `cat expected`])
 AT_CHECK(
   [pid=`cat pid` && expected=`cat expected` && test "$pid" = "$expected"],
@@ -25,7 +25,7 @@ AT_CAPTURE_FILE([parent])
 AT_CAPTURE_FILE([parentpid])
 AT_CAPTURE_FILE([newpid])
 # Start the daemon and wait for the pidfile to get created.
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --monitor& echo $! > parent], [0])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --monitor& echo $! > parent], [0])
 OVS_WAIT_UNTIL([test -s pid], [kill `cat parent`])
 # Check that the pidfile names a running process,
 # and that the parent process of that process is our child process.
@@ -68,7 +68,7 @@ AT_CAPTURE_FILE([parent])
 AT_CAPTURE_FILE([parentpid])
 AT_CAPTURE_FILE([newpid])
 # Start the daemon and wait for the pidfile to get created.
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --monitor& echo $! > parent], [0])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --monitor& echo $! > parent], [0])
 OVS_WAIT_UNTIL([test -s pid], [kill `cat parent`])
 # Check that the pidfile names a running process,
 # and that the parent process of that process is our child process.
@@ -110,7 +110,7 @@ AT_CAPTURE_FILE([pid])
 # Start the daemon and make sure that the pidfile exists immediately.
 # We don't wait for the pidfile to get created because the daemon is
 # supposed to do so before the parent exits.
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --detach], [0])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --detach], [0])
 AT_CHECK([test -s pid])
 AT_CHECK([kill -0 `cat pid`])
 # Kill the daemon and make sure that the pidfile gets deleted.
@@ -133,7 +133,7 @@ AT_CAPTURE_FILE([init])
 # Start the daemon and make sure that the pidfile exists immediately.
 # We don't wait for the pidfile to get created because the daemon is
 # supposed to do so before the parent exits.
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/daemon --detach --monitor], [0])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/daemon --detach --monitor], [0])
 AT_CHECK([test -s daemon])
 # Check that the pidfile names a running process,
 # and that the parent process of that process is a running process,
@@ -172,7 +172,7 @@ AT_CLEANUP
 AT_SETUP([daemon --detach startup errors - Python])
 AT_SKIP_IF([test $HAVE_PYTHON = no])
 AT_CAPTURE_FILE([pid])
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --detach --bail], [1], [], [stderr])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --detach --bail], [1], [], [stderr])
 AT_CHECK([grep 'test-daemon.py: exiting after daemonize_start() as requested' stderr],
   [0], [ignore], [])
 AT_CHECK([test ! -s pid])
@@ -181,7 +181,7 @@ AT_CLEANUP
 AT_SETUP([daemon --detach --monitor startup errors - Python])
 AT_SKIP_IF([test $HAVE_PYTHON = no])
 AT_CAPTURE_FILE([pid])
-AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --detach --monitor --bail], [1], [], [stderr])
+AT_CHECK([$PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --detach --monitor --bail], [1], [], [stderr])
 AT_CHECK([grep 'test-daemon.py: exiting after daemonize_start() as requested' stderr],
   [0], [ignore], [])
 AT_CHECK([test ! -s pid])
@@ -192,7 +192,7 @@ AT_SKIP_IF([test $HAVE_PYTHON = no])
 AT_CAPTURE_FILE([pid])
 AT_CAPTURE_FILE([status])
 AT_CAPTURE_FILE([stderr])
-AT_CHECK([(yes 2>stderr; echo $? > status) | $PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --detach], [0], [], [])
+AT_CHECK([(yes 2>stderr; echo $? > status) | $PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --detach], [0], [], [])
 AT_CHECK([kill `cat pid`])
 AT_CHECK([test -s status])
 if grep '[[bB]]roken pipe' stderr >/dev/null 2>&1; then
@@ -212,7 +212,7 @@ AT_CAPTURE_FILE([pid])
 AT_CAPTURE_FILE([status])
 AT_CAPTURE_FILE([stderr])
 OVSDB_INIT([db])
-AT_CHECK([(yes 2>stderr; echo $? > status) | $PYTHON $srcdir/test-daemon.py --pidfile-name=$PWD/pid --detach], [0], [], [])
+AT_CHECK([(yes 2>stderr; echo $? > status) | $PYTHON $srcdir/test-daemon.py --pidfile=`pwd`/pid --detach], [0], [], [])
 AT_CHECK([kill `cat pid`])
 AT_CHECK([test -s status])
 if grep '[[bB]]roken pipe' stderr >/dev/null 2>&1; then

tests/jsonrpc-py.at

@@ -2,7 +2,7 @@ AT_BANNER([JSON-RPC - Python])
 
 AT_SETUP([JSON-RPC request and successful reply - Python])
 AT_SKIP_IF([test $HAVE_PYTHON = no])
-AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile-name=$PWD/pid listen punix:socket])
+AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile=`pwd`/pid listen punix:socket])
 AT_CHECK([test -s pid])
 AT_CHECK([kill -0 `cat pid`])
 AT_CHECK(
@@ -14,7 +14,7 @@ AT_CLEANUP
 
 AT_SETUP([JSON-RPC request and error reply - Python])
 AT_SKIP_IF([test $HAVE_PYTHON = no])
-AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile-name=$PWD/pid listen punix:socket])
+AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile=`pwd`/pid listen punix:socket])
 AT_CHECK([test -s pid])
 AT_CHECK([kill -0 `cat pid`])
 AT_CHECK(
@@ -26,7 +26,7 @@ AT_CLEANUP
 
 AT_SETUP([JSON-RPC notification - Python])
 AT_SKIP_IF([test $HAVE_PYTHON = no])
-AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile-name=$PWD/pid listen punix:socket])
+AT_CHECK([$PYTHON $srcdir/test-jsonrpc.py --detach --pidfile=`pwd`/pid listen punix:socket])
 AT_CHECK([test -s pid])
 # When a daemon dies it deletes its pidfile, so make a copy.
 AT_CHECK([cp pid pid2])

tests/ovs-monitor-ipsec.at

@@ -47,7 +47,7 @@ OVS_VSCTL_SETUP
 ###
 AT_CHECK(
   [$PYTHON $top_srcdir/debian/ovs-monitor-ipsec "--root-prefix=`pwd`" \
-        "--pidfile-name=`pwd`/ovs-monitor-ipsec.pid" \
+        "--pidfile=`pwd`/ovs-monitor-ipsec.pid" \
         unix:socket 2>log 3>actions &])
 AT_CAPTURE_FILE([log])
 AT_CAPTURE_FILE([actions])

tests/ovs-xapi-sync.at

@@ -27,7 +27,7 @@ ovs_vsctl () {
 OVS_VSCTL_SETUP
 
 # Start ovs-xapi-sync.
-AT_CHECK([$PYTHON ./ovs-xapi-sync "--pidfile-name=`pwd`/ovs-xapi-sync.pid" \
+AT_CHECK([$PYTHON ./ovs-xapi-sync "--pidfile=`pwd`/ovs-xapi-sync.pid" \
                   "--root-prefix=`pwd`" unix:socket >log 2>&1 &])
 AT_CAPTURE_FILE([log])
 

tests/test-daemon.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import getopt
+import argparse
 import logging
 import signal
 import sys
@@ -26,31 +26,22 @@ def handler(signum, _):
     raise Exception("Signal handler called with %d" % signum)
 
 
-def main(argv):
+def main():
     logging.basicConfig(level=logging.DEBUG)
 
     signal.signal(signal.SIGHUP, handler)
 
-    try:
+    parser = argparse.ArgumentParser(
-        options, args = getopt.gnu_getopt(
+            description="Open vSwitch daemonization test program for Python.")
-            argv[1:], 'b', ["bail", "help"] + ovs.daemon.LONG_OPTIONS)
+    parser.add_argument("-b", "--bail", action="store_true",
-    except getopt.GetoptError, geo:
+            help="Exit with an error after daemonize_start().")
-        sys.stderr.write("%s: %s\n" % (ovs.util.PROGRAM_NAME, geo.msg))
-        sys.exit(1)
 
-    bail = False
+    ovs.daemon.add_args(parser)
-    for key, value in options:
+    args = parser.parse_args()
-        if key == '--help':
+    ovs.daemon.handle_args(args)
-            usage()
-        elif key in ['-b', '--bail']:
-            bail = True
-        elif not ovs.daemon.parse_opt(key, value):
-            sys.stderr.write("%s: unhandled option %s\n"
-                             % (ovs.util.PROGRAM_NAME, key))
-            sys.exit(1)
 
     ovs.daemon.daemonize_start()
-    if bail:
+    if args.bail:
         sys.stderr.write("%s: exiting after daemonize_start() as requested\n"
                          % ovs.util.PROGRAM_NAME)
         sys.exit(1)
@@ -60,22 +51,9 @@ def main(argv):
         time.sleep(1)
 
 
-def usage():
-    sys.stdout.write("""\
-%s: Open vSwitch daemonization test program for Python
-usage: %s [OPTIONS]
-""" % ovs.util.PROGRAM_NAME)
-    ovs.daemon.usage()
-    sys.stdout.write("""
-Other options:
-  -h, --help              display this help message
-  -b, --bail              exit with an error after daemonize_start()
-""")
-    sys.exit(0)
-
 if __name__ == '__main__':
     try:
-        main(sys.argv)
+        main()
     except SystemExit:
         # Let system.exit() calls complete normally
         raise

tests/test-jsonrpc.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import argparse
 import errno
-import getopt
 import os
 import sys
 
@@ -158,28 +158,35 @@ def do_notify(name, method, params_string):
 
 
 def main(argv):
-    try:
-        options, args = getopt.gnu_getopt(
-            argv[1:], 'h', ["help"] + ovs.daemon.LONG_OPTIONS)
-    except getopt.GetoptError, geo:
-        sys.stderr.write("%s: %s\n" % (ovs.util.PROGRAM_NAME, geo.msg))
-        sys.exit(1)
 
-    for key, value in options:
+    parser = argparse.ArgumentParser(
-        if key in ['-h', '--help']:
+            description="JSON-RPC test utility for Python.",
-            usage()
+            formatter_class=argparse.RawDescriptionHelpFormatter)
-        elif not ovs.daemon.parse_opt(key, value):
-            sys.stderr.write("%s: unhandled option %s\n"
-                             % (ovs.util.PROGRAM_NAME, key))
-            sys.exit(1)
 
     commands = {"listen": (do_listen, 1),
                 "request": (do_request, 3),
                 "notify": (do_notify, 3),
-                "help": (usage, (0,))}
+                "help": (parser.print_help, (0,))}
 
-    command_name = args[0]
+    group_description = """\
-    args = args[1:]
+listen LOCAL             listen for connections on LOCAL
+request REMOTE METHOD PARAMS   send request, print reply
+notify REMOTE METHOD PARAMS  send notification and exit
+""" + ovs.stream.usage("JSON-RPC")
+
+    group = parser.add_argument_group(title="Commands",
+                                      description=group_description)
+    group.add_argument('command', metavar="COMMAND", nargs=1,
+                        choices=commands, help="Command to use.")
+    group.add_argument('command_args', metavar="ARG", nargs='*',
+                       help="Arguments to COMMAND.")
+
+    ovs.daemon.add_args(parser)
+    args = parser.parse_args()
+    ovs.daemon.handle_args(args)
+
+    command_name = args.command[0]
+    args = args.command_args
     if not command_name in commands:
         sys.stderr.write("%s: unknown command \"%s\" "
                          "(use --help for help)\n" % (argv[0], command_name))
@@ -204,22 +211,5 @@ def main(argv):
     func(*args)
 
 
-def usage():
-    sys.stdout.write("""\
-%s: JSON-RPC test utility for Python
-usage: %s [OPTIONS] COMMAND [ARG...]
-  listen LOCAL             listen for connections on LOCAL
-  request REMOTE METHOD PARAMS   send request, print reply
-  notify REMOTE METHOD PARAMS  send notification and exit
-""" % (ovs.util.PROGRAM_NAME, ovs.util.PROGRAM_NAME))
-    sys.stdout.write(ovs.stream.usage("JSON-RPC") + "\n")
-    ovs.daemon.usage()
-    sys.stdout.write("""
-Other options:
-  -h, --help              display this help message
-""")
-    sys.exit(0)
-
-
 if __name__ == '__main__':
     main(sys.argv)

xenserver/usr_share_openvswitch_scripts_ovs-xapi-sync

@@ -22,7 +22,7 @@
 #   - Set the "iface-id" key in the Interface table.
 #   - Set the fail-mode on internal bridges.
 
-import getopt
+import argparse
 import logging
 import logging.handlers
 import os
@@ -215,24 +215,13 @@ def prune_schema(schema):
     schema.tables = new_tables
 
 
-def usage():
-    print "usage: %s [OPTIONS] DATABASE" % sys.argv[0]
-    print "where DATABASE is a socket on which ovsdb-server is listening."
-    ovs.daemon.usage()
-    print """\
-Other options:
-    --root-prefix=DIR   Use DIR as alternate root directory (for testing).
-    -h, --help               display this help message"""
-    sys.exit(0)
-
-
 def handler(signum, _):
     global force_run
     if (signum == signal.SIGHUP):
         force_run = True
 
 
-def main(argv):
+def main():
     global force_run
 
     s_log.addHandler(logging.StreamHandler())
@@ -247,30 +236,21 @@ def main(argv):
         s_log.warn("failed to open logfile (%s)" % e)
     s_log.setLevel(logging.INFO)
 
-    try:
+    parser = argparse.ArgumentParser()
-        options, args = getopt.gnu_getopt(
+    parser.add_argument("database", metavar="DATABASE",
-            argv[1:], 'h', ['help', 'root-prefix='] + ovs.daemon.LONG_OPTIONS)
+            help="A socket on which ovsdb-server is listening.")
-    except getopt.GetoptError, geo:
+    parser.add_argument("--root-prefix", metavar="DIR",
-        sys.stderr.write("%s: %s\n" % (ovs.util.PROGRAM_NAME, geo.msg))
+                        help="Use DIR as alternate root directory"
-        sys.exit(1)
+                        " (for testing).")
 
-    for key, value in options:
+    ovs.daemon.add_args(parser)
-        if key in ['-h', '--help']:
+    args = parser.parse_args()
-            usage()
+    ovs.daemon.handle_args(args)
-        elif key == '--root-prefix':
-            global root_prefix
-            root_prefix = value
-        elif not ovs.daemon.parse_opt(key, value):
-            sys.stderr.write("%s: unhandled option %s\n"
-                             % (ovs.util.PROGRAM_NAME, key))
-            sys.exit(1)
 
-    if len(args) != 1:
+    global root_prefix
-        sys.stderr.write("%s: exactly one nonoption argument is required "
+    root_prefix = args.root_prefix
-                         "(use --help for help)\n" % ovs.util.PROGRAM_NAME)
-        sys.exit(1)
 
-    remote = args[0]
+    remote = args.database
     schema_file = "%s/vswitch.ovsschema" % ovs.dirs.PKGDATADIR
     schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
     prune_schema(schema)
@@ -376,7 +356,7 @@ def main(argv):
 
 if __name__ == '__main__':
     try:
-        main(sys.argv)
+        main()
     except SystemExit:
         # Let system.exit() calls complete normally
         raise