python: Break unixctl implementation into registry, client, and server.
[sliver-openvswitch.git] / tests / test-unixctl.py
1 # Copyright (c) 2012 Nicira, Inc.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at:
6 #
7 #     http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import argparse
16 import sys
17
18 import ovs.daemon
19 import ovs.unixctl
20 import ovs.unixctl.server
21
22 vlog = ovs.vlog.Vlog("test-unixctl")
23 exiting = False
24
25 def unixctl_exit(conn, unused_argv, aux):
26     assert aux == "aux_exit"
27     global exiting
28
29     exiting = True
30     conn.reply(None)
31
32
33 def unixctl_echo(conn, argv, aux):
34     assert aux == "aux_echo"
35     conn.reply(str(argv))
36
37
38 def unixctl_echo_error(conn, argv, aux):
39     assert aux ==  "aux_echo_error"
40     conn.reply_error(str(argv))
41
42
43 def unixctl_block(conn, unused_argv, unused_aux):
44     pass
45
46
47 def main():
48     parser = argparse.ArgumentParser(
49         description="Open vSwitch unixctl test program for Python")
50     parser.add_argument("--unixctl", help="UNIXCTL socket location or 'none'.")
51
52     ovs.daemon.add_args(parser)
53     ovs.vlog.add_args(parser)
54     args = parser.parse_args()
55     ovs.daemon.handle_args(args)
56     ovs.vlog.handle_args(args)
57
58     ovs.daemon.daemonize_start()
59     error, server = ovs.unixctl.server.UnixctlServer.create(args.unixctl)
60     if error:
61         ovs.util.ovs_fatal(error, "could not create unixctl server at %s"
62                            % args.unixctl, vlog)
63
64     ovs.unixctl.command_register("exit", "", 0, 0, unixctl_exit, "aux_exit")
65     ovs.unixctl.command_register("echo", "[arg ...]", 1, 2, unixctl_echo,
66                                  "aux_echo")
67     ovs.unixctl.command_register("echo_error", "[arg ...]", 1, 2,
68                                  unixctl_echo_error, "aux_echo_error")
69     ovs.unixctl.command_register("block", "", 0, 0, unixctl_block, None)
70     ovs.daemon.daemonize_complete()
71
72     vlog.info("Entering run loop.")
73     poller = ovs.poller.Poller()
74     while not exiting:
75         server.run()
76         server.wait(poller)
77         if exiting:
78             poller.immediate_wake()
79         poller.block()
80     server.close()
81
82
83 if __name__ == '__main__':
84     try:
85         main()
86     except SystemExit:
87         # Let system.exit() calls complete normally
88         raise
89     except:
90         vlog.exception("traceback")
91         sys.exit(ovs.daemon.RESTART_EXIT_CODE)