ovs/tests/appctl.py

# Copyright (c) 2012 Nicira, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import argparse
import sys

import ovs.daemon
import ovs.unixctl
import ovs.unixctl.client
import ovs.util
import ovs.vlog
from ovs.fatal_signal import signal_alarm


def connect_to_target(target):
    error, str_result = ovs.unixctl.socket_name_from_target(target)
    if error:
        ovs.util.ovs_fatal(error, str_result)
    else:
        socket_name = str_result

    error, client = ovs.unixctl.client.UnixctlClient.create(socket_name)
    if error:
        ovs.util.ovs_fatal(error, "cannot connect to \"%s\"" % socket_name)

    return client


def reply_to_string(reply, fmt=ovs.unixctl.UnixctlOutputFormat.TEXT,
                    fmt_flags={}):
    if fmt == ovs.unixctl.UnixctlOutputFormat.TEXT:
        body = str(reply)
    else:
        body = ovs.json.to_string(reply, **fmt_flags)

    if body and not body.endswith("\n"):
        body += "\n"

    return body


def main():
    parser = argparse.ArgumentParser(description="Python Implementation of"
                                     " ovs-appctl.")
    parser.add_argument("-t", "--target", default="ovs-vswitchd",
                        help="pidfile or socket to contact")

    parser.add_argument("command", metavar="COMMAND",
                        help="Command to run.")
    parser.add_argument("argv", metavar="ARG", nargs="*",
                        help="Arguments to the command.")
    parser.add_argument("-T", "--timeout", metavar="SECS",
                        help="wait at most SECS seconds for a response")
    parser.add_argument("-f", "--format", metavar="FMT",
                        help="Output format.", default="text",
                        choices=[fmt.name.lower()
                                 for fmt in ovs.unixctl.UnixctlOutputFormat],
                        type=str.lower)
    parser.add_argument("--pretty", action="store_true",
                        help="Format the output in a more readable fashion."
                             " Requires: --format json.")
    args = parser.parse_args()

    if (args.format != ovs.unixctl.UnixctlOutputFormat.JSON.name.lower()
        and args.pretty):
        ovs.util.ovs_fatal(0, "--pretty is supported with --format json only")

    signal_alarm(int(args.timeout) if args.timeout else None)

    ovs.vlog.Vlog.init()
    target = args.target
    format = ovs.unixctl.UnixctlOutputFormat[args.format.upper()]
    format_flags = dict(pretty=True) if args.pretty else {}
    client = connect_to_target(target)

    if format != ovs.unixctl.UnixctlOutputFormat.TEXT:
        err_no, error, _ = client.transact(
            "set-options", ["--format", args.format])

        if err_no:
            ovs.util.ovs_fatal(err_no, "%s: transaction error" % target)
        elif error is not None:
            sys.stderr.write(reply_to_string(error))
            ovs.util.ovs_error(0, "%s: server returned an error" % target)
            sys.exit(2)

    err_no, error, result = client.transact(args.command, args.argv)
    client.close()

    if err_no:
        ovs.util.ovs_fatal(err_no, "%s: transaction error" % target)
    elif error is not None:
        sys.stderr.write(reply_to_string(error))
        ovs.util.ovs_error(0, "%s: server returned an error" % target)
        sys.exit(2)
    else:
        assert result is not None
        sys.stdout.write(reply_to_string(result, format, format_flags))


if __name__ == '__main__':
    main()