[mirror_ovs.git] / tests / test-jsonrpc.c

/*
 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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.
 */

#include <config.h>

#include "jsonrpc.h"

#include <errno.h>
#include <fcntl.h>
#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>

#include "command-line.h"
#include "daemon.h"
#include "json.h"
#include "poll-loop.h"
#include "stream-ssl.h"
#include "stream.h"
#include "timeval.h"
#include "util.h"
#include "vlog.h"
#include "ovstest.h"

static void usage(void) NO_RETURN;
static void parse_options(int argc, char *argv[]);
static struct command *get_all_commands(void);

static void
test_jsonrpc_main(int argc, char *argv[])
{
    proctitle_init(argc, argv);
    set_program_name(argv[0]);
    service_start(&argc, &argv);
    parse_options(argc, argv);
    run_command(argc - optind, argv + optind, get_all_commands());
}

static void
parse_options(int argc, char *argv[])
{
    enum {
        OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1,
        DAEMON_OPTION_ENUMS
    };
    static const struct option long_options[] = {
        {"verbose", optional_argument, NULL, 'v'},
        {"help", no_argument, NULL, 'h'},
        DAEMON_LONG_OPTIONS,
        {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
        STREAM_SSL_LONG_OPTIONS,
        {NULL, 0, NULL, 0},
    };
    char *short_options = long_options_to_short_options(long_options);

    for (;;) {
        int c = getopt_long(argc, argv, short_options, long_options, NULL);
        if (c == -1) {
            break;
        }

        switch (c) {
        case 'h':
            usage();

        case 'v':
            vlog_set_verbosity(optarg);
            break;

        DAEMON_OPTION_HANDLERS

        STREAM_SSL_OPTION_HANDLERS

        case OPT_BOOTSTRAP_CA_CERT:
            stream_ssl_set_ca_cert_file(optarg, true);
            break;

        case '?':
            exit(EXIT_FAILURE);

        default:
            abort();
        }
    }
    free(short_options);
}

static void
usage(void)
{
    printf("%s: JSON-RPC test utility\n"
           "usage: %s [OPTIONS] COMMAND [ARG...]\n"
           "  listen LOCAL             listen for connections on LOCAL\n"
           "  request REMOTE METHOD PARAMS   send request, print reply\n"
           "  notify REMOTE METHOD PARAMS  send notification and exit\n",
           program_name, program_name);
    stream_usage("JSON-RPC", true, true, true);
    daemon_usage();
    vlog_usage();
    printf("\nOther options:\n"
           "  -h, --help                  display this help message\n");
    exit(EXIT_SUCCESS);
}
\f
/* Command helper functions. */

static struct json *
parse_json(const char *s)
{
    struct json *json = json_from_string(s);
    if (json->type == JSON_STRING) {
        ovs_fatal(0, "\"%s\": %s", s, json->u.string);
    }
    return json;
}

static void
print_and_free_json(struct json *json)
{
    char *string = json_to_string(json, JSSF_SORT);
    json_destroy(json);
    puts(string);
    free(string);
}
\f
/* Command implementations. */

static int
handle_rpc(struct jsonrpc *rpc, struct jsonrpc_msg *msg, bool *done)
{
    if (msg->type == JSONRPC_REQUEST) {
        struct jsonrpc_msg *reply = NULL;
        if (!strcmp(msg->method, "echo")) {
            reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
        } else {
            struct json *error = json_object_create();
            json_object_put_string(error, "error", "unknown method");
            reply = jsonrpc_create_error(error, msg->id);
            ovs_error(0, "unknown request %s", msg->method);
        }
        jsonrpc_send(rpc, reply);
        return 0;
    } else if (msg->type == JSONRPC_NOTIFY) {
        if (!strcmp(msg->method, "shutdown")) {
            *done = true;
            return 0;
        } else {
            ovs_error(0, "unknown notification %s", msg->method);
            return ENOTTY;
        }
    } else {
        ovs_error(0, "unsolicited JSON-RPC reply or error");
        return EPROTO;
    }
}

static void
do_listen(int argc OVS_UNUSED, char *argv[])
{
    struct pstream *pstream;
    struct jsonrpc **rpcs;
    size_t n_rpcs, allocated_rpcs;
    bool done;
    int error;

    error = jsonrpc_pstream_open(argv[1], &pstream, DSCP_DEFAULT);
    if (error) {
        ovs_fatal(error, "could not listen on \"%s\"", argv[1]);
    }

    daemonize();

    rpcs = NULL;
    n_rpcs = allocated_rpcs = 0;
    done = false;
    for (;;) {
        struct stream *stream;
        size_t i;

        /* Accept new connections. */
        error = pstream_accept(pstream, &stream);
        if (!error) {
            if (n_rpcs >= allocated_rpcs) {
                rpcs = x2nrealloc(rpcs, &allocated_rpcs, sizeof *rpcs);
            }
            rpcs[n_rpcs++] = jsonrpc_open(stream);
        } else if (error != EAGAIN) {
            ovs_fatal(error, "pstream_accept failed");
        }

        /* Service existing connections. */
        for (i = 0; i < n_rpcs; ) {
            struct jsonrpc *rpc = rpcs[i];
            struct jsonrpc_msg *msg;

            jsonrpc_run(rpc);
            if (!jsonrpc_get_backlog(rpc)) {
                error = jsonrpc_recv(rpc, &msg);
                if (!error) {
                    error = handle_rpc(rpc, msg, &done);
                    jsonrpc_msg_destroy(msg);
                } else if (error == EAGAIN) {
                    error = 0;
                }
            }

            if (!error) {
                error = jsonrpc_get_status(rpc);
            }
            if (error) {
                jsonrpc_close(rpc);
                ovs_error(error, "connection closed");
                memmove(&rpcs[i], &rpcs[i + 1],
                        (n_rpcs - i - 1) * sizeof *rpcs);
                n_rpcs--;
            } else {
                i++;
            }
        }

        /* Wait for something to do. */
        if (done && !n_rpcs) {
            break;
        }
        pstream_wait(pstream);
        for (i = 0; i < n_rpcs; i++) {
            struct jsonrpc *rpc = rpcs[i];

            jsonrpc_wait(rpc);
            if (!jsonrpc_get_backlog(rpc)) {
                jsonrpc_recv_wait(rpc);
            }
        }
        poll_block();
    }
    free(rpcs);
    pstream_close(pstream);
}

static void
do_request(int argc OVS_UNUSED, char *argv[])
{
    struct jsonrpc_msg *msg;
    struct jsonrpc *rpc;
    struct json *params;
    struct stream *stream;
    const char *method;
    char *string;
    int error;

    method = argv[2];
    params = parse_json(argv[3]);
    msg = jsonrpc_create_request(method, params, NULL);
    string = jsonrpc_msg_is_valid(msg);
    if (string) {
        ovs_fatal(0, "not a valid JSON-RPC request: %s", string);
    }

    error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
                              DSCP_DEFAULT), &stream);
    if (error) {
        ovs_fatal(error, "could not open \"%s\"", argv[1]);
    }
    rpc = jsonrpc_open(stream);

    error = jsonrpc_send(rpc, msg);
    if (error) {
        ovs_fatal(error, "could not send request");
    }

    error = jsonrpc_recv_block(rpc, &msg);
    if (error) {
        ovs_fatal(error, "error waiting for reply");
    }
    print_and_free_json(jsonrpc_msg_to_json(msg));

    jsonrpc_close(rpc);
}

static void
do_notify(int argc OVS_UNUSED, char *argv[])
{
    struct jsonrpc_msg *msg;
    struct jsonrpc *rpc;
    struct json *params;
    struct stream *stream;
    const char *method;
    char *string;
    int error;

    method = argv[2];
    params = parse_json(argv[3]);
    msg = jsonrpc_create_notify(method, params);
    string = jsonrpc_msg_is_valid(msg);
    if (string) {
        ovs_fatal(0, "not a JSON RPC-valid notification: %s", string);
    }

    error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
                              DSCP_DEFAULT), &stream);
    if (error) {
        ovs_fatal(error, "could not open \"%s\"", argv[1]);
    }
    rpc = jsonrpc_open(stream);

    error = jsonrpc_send_block(rpc, msg);
    if (error) {
        ovs_fatal(error, "could not send notification");
    }
    jsonrpc_close(rpc);
}

static void
do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
    usage();
}

static struct command all_commands[] = {
    { "listen", 1, 1, do_listen },
    { "request", 3, 3, do_request },
    { "notify", 3, 3, do_notify },
    { "help", 0, INT_MAX, do_help },
    { NULL, 0, 0, NULL },
};

static struct command *
get_all_commands(void)
{
    return all_commands;
}

OVSTEST_REGISTER("test-jsonrpc", test_jsonrpc_main);
Commit	Line	Data
f2129093	1	/*
eadd1644	2	* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
f2129093 BP	3	*
	4	* Licensed under the Apache License, Version 2.0 (the "License");
	5	* you may not use this file except in compliance with the License.
	6	* You may obtain a copy of the License at:
	7	*
	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	10	* Unless required by applicable law or agreed to in writing, software
	11	* distributed under the License is distributed on an "AS IS" BASIS,
	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	13	* See the License for the specific language governing permissions and
	14	* limitations under the License.
	15	*/
	16
	17	#include <config.h>
	18
	19	#include "jsonrpc.h"
	20
	21	#include <errno.h>
	22	#include <fcntl.h>
	23	#include <getopt.h>
	24	#include <stdio.h>
	25	#include <stdlib.h>
	26
	27	#include "command-line.h"
	28	#include "daemon.h"
	29	#include "json.h"
	30	#include "poll-loop.h"
9467fe62	31	#include "stream-ssl.h"
f2129093 BP	32	#include "stream.h"
	33	#include "timeval.h"
	34	#include "util.h"
	35	#include "vlog.h"
eadd1644	36	#include "ovstest.h"
f2129093	37
f2129093 BP	38	static void usage(void) NO_RETURN;
f2129093 BP	39	static void parse_options(int argc, char *argv[]);
d2586fce	40	static struct command *get_all_commands(void);
f2129093	41
eadd1644 AZ	42	static void
eadd1644 AZ	43	test_jsonrpc_main(int argc, char *argv[])
f2129093	44	{
40f0707c	45	proctitle_init(argc, argv);
f2129093	46	set_program_name(argv[0]);
dad530c1	47	service_start(&argc, &argv);
f2129093	48	parse_options(argc, argv);
d2586fce	49	run_command(argc - optind, argv + optind, get_all_commands());
f2129093 BP	50	}
	51
	52	static void
	53	parse_options(int argc, char *argv[])
	54	{
9467fe62	55	enum {
8274ae95 BP	56	OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1,
8274ae95 BP	57	DAEMON_OPTION_ENUMS
9467fe62	58	};
07fc4ed3	59	static const struct option long_options[] = {
e3c17733 BP	60	{"verbose", optional_argument, NULL, 'v'},
e3c17733 BP	61	{"help", no_argument, NULL, 'h'},
f2129093	62	DAEMON_LONG_OPTIONS,
e3c17733	63	{"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
bf8f2167	64	STREAM_SSL_LONG_OPTIONS,
e3c17733	65	{NULL, 0, NULL, 0},
f2129093 BP	66	};
	67	char *short_options = long_options_to_short_options(long_options);
	68
	69	for (;;) {
	70	int c = getopt_long(argc, argv, short_options, long_options, NULL);
	71	if (c == -1) {
	72	break;
	73	}
	74
	75	switch (c) {
	76	case 'h':
	77	usage();
	78
	79	case 'v':
	80	vlog_set_verbosity(optarg);
	81	break;
	82
	83	DAEMON_OPTION_HANDLERS
	84
9467fe62 BP	85	STREAM_SSL_OPTION_HANDLERS
	86
	87	case OPT_BOOTSTRAP_CA_CERT:
	88	stream_ssl_set_ca_cert_file(optarg, true);
	89	break;
9467fe62	90
f2129093 BP	91	case '?':
	92	exit(EXIT_FAILURE);
	93
	94	default:
	95	abort();
	96	}
	97	}
	98	free(short_options);
	99	}
	100
	101	static void
	102	usage(void)
	103	{
	104	printf("%s: JSON-RPC test utility\n"
	105	"usage: %s [OPTIONS] COMMAND [ARG...]\n"
	106	" listen LOCAL listen for connections on LOCAL\n"
	107	" request REMOTE METHOD PARAMS send request, print reply\n"
	108	" notify REMOTE METHOD PARAMS send notification and exit\n",
	109	program_name, program_name);
9467fe62	110	stream_usage("JSON-RPC", true, true, true);
f2129093 BP	111	daemon_usage();
	112	vlog_usage();
	113	printf("\nOther options:\n"
	114	" -h, --help display this help message\n");
	115	exit(EXIT_SUCCESS);
	116	}
	117	\f
	118	/* Command helper functions. */
	119
	120	static struct json *
	121	parse_json(const char *s)
	122	{
	123	struct json *json = json_from_string(s);
	124	if (json->type == JSON_STRING) {
	125	ovs_fatal(0, "\"%s\": %s", s, json->u.string);
	126	}
	127	return json;
	128	}
	129
	130	static void
	131	print_and_free_json(struct json *json)
	132	{
	133	char *string = json_to_string(json, JSSF_SORT);
	134	json_destroy(json);
	135	puts(string);
	136	free(string);
	137	}
	138	\f
	139	/* Command implementations. */
	140
c1ce8fbf	141	static int
f2129093 BP	142	handle_rpc(struct jsonrpc rpc, struct jsonrpc_msg msg, bool *done)
f2129093 BP	143	{
f2129093	144	if (msg->type == JSONRPC_REQUEST) {
c1ce8fbf	145	struct jsonrpc_msg *reply = NULL;
f2129093 BP	146	if (!strcmp(msg->method, "echo")) {
	147	reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
	148	} else {
	149	struct json *error = json_object_create();
	150	json_object_put_string(error, "error", "unknown method");
	151	reply = jsonrpc_create_error(error, msg->id);
	152	ovs_error(0, "unknown request %s", msg->method);
	153	}
c1ce8fbf BP	154	jsonrpc_send(rpc, reply);
c1ce8fbf BP	155	return 0;
f2129093 BP	156	} else if (msg->type == JSONRPC_NOTIFY) {
	157	if (!strcmp(msg->method, "shutdown")) {
	158	*done = true;
c1ce8fbf	159	return 0;
f2129093	160	} else {
f2129093	161	ovs_error(0, "unknown notification %s", msg->method);
c1ce8fbf	162	return ENOTTY;
f2129093 BP	163	}
f2129093 BP	164	} else {
f2129093	165	ovs_error(0, "unsolicited JSON-RPC reply or error");
c1ce8fbf	166	return EPROTO;
f2129093 BP	167	}
	168	}
	169
	170	static void
c69ee87c	171	do_listen(int argc OVS_UNUSED, char *argv[])
f2129093 BP	172	{
	173	struct pstream *pstream;
	174	struct jsonrpc **rpcs;
	175	size_t n_rpcs, allocated_rpcs;
	176	bool done;
	177	int error;
	178
f125905c	179	error = jsonrpc_pstream_open(argv[1], &pstream, DSCP_DEFAULT);
f2129093 BP	180	if (error) {
	181	ovs_fatal(error, "could not listen on \"%s\"", argv[1]);
	182	}
	183
	184	daemonize();
	185
	186	rpcs = NULL;
	187	n_rpcs = allocated_rpcs = 0;
	188	done = false;
	189	for (;;) {
	190	struct stream *stream;
	191	size_t i;
	192
	193	/* Accept new connections. */
	194	error = pstream_accept(pstream, &stream);
	195	if (!error) {
	196	if (n_rpcs >= allocated_rpcs) {
	197	rpcs = x2nrealloc(rpcs, &allocated_rpcs, sizeof *rpcs);
	198	}
	199	rpcs[n_rpcs++] = jsonrpc_open(stream);
	200	} else if (error != EAGAIN) {
	201	ovs_fatal(error, "pstream_accept failed");
	202	}
	203
	204	/* Service existing connections. */
	205	for (i = 0; i < n_rpcs; ) {
	206	struct jsonrpc *rpc = rpcs[i];
	207	struct jsonrpc_msg *msg;
	208
	209	jsonrpc_run(rpc);
	210	if (!jsonrpc_get_backlog(rpc)) {
	211	error = jsonrpc_recv(rpc, &msg);
	212	if (!error) {
c1ce8fbf	213	error = handle_rpc(rpc, msg, &done);
f2129093	214	jsonrpc_msg_destroy(msg);
c1ce8fbf BP	215	} else if (error == EAGAIN) {
c1ce8fbf BP	216	error = 0;
f2129093 BP	217	}
	218	}
	219
c1ce8fbf BP	220	if (!error) {
	221	error = jsonrpc_get_status(rpc);
	222	}
f2129093 BP	223	if (error) {
	224	jsonrpc_close(rpc);
	225	ovs_error(error, "connection closed");
	226	memmove(&rpcs[i], &rpcs[i + 1],
	227	(n_rpcs - i - 1) * sizeof *rpcs);
	228	n_rpcs--;
	229	} else {
	230	i++;
	231	}
	232	}
	233
	234	/* Wait for something to do. */
	235	if (done && !n_rpcs) {
	236	break;
	237	}
	238	pstream_wait(pstream);
	239	for (i = 0; i < n_rpcs; i++) {
	240	struct jsonrpc *rpc = rpcs[i];
	241
	242	jsonrpc_wait(rpc);
	243	if (!jsonrpc_get_backlog(rpc)) {
	244	jsonrpc_recv_wait(rpc);
	245	}
	246	}
	247	poll_block();
	248	}
93ff0290 BP	249	free(rpcs);
93ff0290 BP	250	pstream_close(pstream);
f2129093 BP	251	}
f2129093 BP	252
f2129093	253	static void
c69ee87c	254	do_request(int argc OVS_UNUSED, char *argv[])
f2129093 BP	255	{
	256	struct jsonrpc_msg *msg;
	257	struct jsonrpc *rpc;
	258	struct json *params;
	259	struct stream *stream;
	260	const char *method;
	261	char *string;
	262	int error;
	263
	264	method = argv[2];
	265	params = parse_json(argv[3]);
20bed8be	266	msg = jsonrpc_create_request(method, params, NULL);
f2129093 BP	267	string = jsonrpc_msg_is_valid(msg);
	268	if (string) {
	269	ovs_fatal(0, "not a valid JSON-RPC request: %s", string);
	270	}
	271
f125905c MM	272	error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
f125905c MM	273	DSCP_DEFAULT), &stream);
f2129093 BP	274	if (error) {
	275	ovs_fatal(error, "could not open \"%s\"", argv[1]);
	276	}
	277	rpc = jsonrpc_open(stream);
	278
	279	error = jsonrpc_send(rpc, msg);
	280	if (error) {
	281	ovs_fatal(error, "could not send request");
	282	}
	283
	284	error = jsonrpc_recv_block(rpc, &msg);
	285	if (error) {
	286	ovs_fatal(error, "error waiting for reply");
	287	}
	288	print_and_free_json(jsonrpc_msg_to_json(msg));
	289
	290	jsonrpc_close(rpc);
	291	}
	292
	293	static void
c69ee87c	294	do_notify(int argc OVS_UNUSED, char *argv[])
f2129093 BP	295	{
	296	struct jsonrpc_msg *msg;
	297	struct jsonrpc *rpc;
	298	struct json *params;
	299	struct stream *stream;
	300	const char *method;
	301	char *string;
	302	int error;
	303
	304	method = argv[2];
	305	params = parse_json(argv[3]);
	306	msg = jsonrpc_create_notify(method, params);
	307	string = jsonrpc_msg_is_valid(msg);
	308	if (string) {
	309	ovs_fatal(0, "not a JSON RPC-valid notification: %s", string);
	310	}
	311
f125905c MM	312	error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
f125905c MM	313	DSCP_DEFAULT), &stream);
f2129093 BP	314	if (error) {
	315	ovs_fatal(error, "could not open \"%s\"", argv[1]);
	316	}
	317	rpc = jsonrpc_open(stream);
	318
	319	error = jsonrpc_send_block(rpc, msg);
	320	if (error) {
99155935	321	ovs_fatal(error, "could not send notification");
f2129093 BP	322	}
	323	jsonrpc_close(rpc);
	324	}
	325
	326	static void
c69ee87c	327	do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
f2129093 BP	328	{
	329	usage();
	330	}
	331
	332	static struct command all_commands[] = {
	333	{ "listen", 1, 1, do_listen },
	334	{ "request", 3, 3, do_request },
	335	{ "notify", 3, 3, do_notify },
	336	{ "help", 0, INT_MAX, do_help },
	337	{ NULL, 0, 0, NULL },
	338	};
eadd1644	339
d2586fce GS	340	static struct command *
	341	get_all_commands(void)
	342	{
	343	return all_commands;
	344	}
	345
eadd1644	346	OVSTEST_REGISTER("test-jsonrpc", test_jsonrpc_main);