[qemu.git] / tests / test-qmp-event.c

/*
 * qapi event unit-tests.
 *
 * Copyright (c) 2014 Wenchao Xia
 *
 * Authors:
 *  Wenchao Xia   <[email protected]>
 *
 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 * See the COPYING.LIB file in the top-level directory.
 *
 */

#include "qemu/osdep.h"

#include "qemu-common.h"
#include "test-qapi-types.h"
#include "test-qapi-visit.h"
#include "test-qapi-event.h"
#include "qapi/qmp/types.h"
#include "qapi/qmp/qint.h"
#include "qapi/qmp/qobject.h"
#include "qapi/qmp-event.h"

typedef struct TestEventData {
    QDict *expect;
} TestEventData;

typedef struct QDictCmpData {
    QDict *expect;
    bool result;
} QDictCmpData;

TestEventData *test_event_data;
static CompatGMutex test_event_lock;

/* Only compares bool, int, string */
static
void qdict_cmp_do_simple(const char *key, QObject *obj1, void *opaque)

{
    QObject *obj2;
    QDictCmpData d_new, *d = opaque;

    if (!d->result) {
        return;
    }

    obj2 = qdict_get(d->expect, key);
    if (!obj2) {
        d->result = false;
        return;
    }

    if (qobject_type(obj1) != qobject_type(obj2)) {
        d->result = false;
        return;
    }

    switch (qobject_type(obj1)) {
    case QTYPE_QBOOL:
        d->result = (qbool_get_bool(qobject_to_qbool(obj1)) ==
                     qbool_get_bool(qobject_to_qbool(obj2)));
        return;
    case QTYPE_QINT:
        d->result = (qint_get_int(qobject_to_qint(obj1)) ==
                     qint_get_int(qobject_to_qint(obj2)));
        return;
    case QTYPE_QSTRING:
        d->result = g_strcmp0(qstring_get_str(qobject_to_qstring(obj1)),
                              qstring_get_str(qobject_to_qstring(obj2))) == 0;
        return;
    case QTYPE_QDICT:
        d_new.expect = qobject_to_qdict(obj2);
        d_new.result = true;
        qdict_iter(qobject_to_qdict(obj1), qdict_cmp_do_simple, &d_new);
        d->result = d_new.result;
        return;
    default:
        abort();
    }
}

static bool qdict_cmp_simple(QDict *a, QDict *b)
{
    QDictCmpData d;

    d.expect = b;
    d.result = true;
    qdict_iter(a, qdict_cmp_do_simple, &d);
    return d.result;
}

/* This function is hooked as final emit function, which can verify the
   correctness. */
static void event_test_emit(test_QAPIEvent event, QDict *d, Error **errp)
{
    QDict *t;
    int64_t s, ms;

    /* Verify that we have timestamp, then remove it to compare other fields */
    t = qdict_get_qdict(d, "timestamp");
    g_assert(t);
    s = qdict_get_try_int(t, "seconds", -2);
    ms = qdict_get_try_int(t, "microseconds", -2);
    if (s == -1) {
        g_assert(ms == -1);
    } else {
        g_assert(s >= 0);
        g_assert(ms >= 0 && ms <= 999999);
    }
    g_assert(qdict_size(t) == 2);

    qdict_del(d, "timestamp");

    g_assert(qdict_cmp_simple(d, test_event_data->expect));

}

static void event_prepare(TestEventData *data,
                          const void *unused)
{
    /* Global variable test_event_data was used to pass the expectation, so
       test cases can't be executed at same time. */
    g_mutex_lock(&test_event_lock);

    data->expect = qdict_new();
    test_event_data = data;
}

static void event_teardown(TestEventData *data,
                           const void *unused)
{
    QDECREF(data->expect);
    test_event_data = NULL;

    g_mutex_unlock(&test_event_lock);
}

static void event_test_add(const char *testpath,
                           void (*test_func)(TestEventData *data,
                                             const void *user_data))
{
    g_test_add(testpath, TestEventData, NULL, event_prepare, test_func,
               event_teardown);
}


/* Test cases */

static void test_event_a(TestEventData *data,
                         const void *unused)
{
    QDict *d;
    d = data->expect;
    qdict_put_str(d, "event", "EVENT_A");
    qapi_event_send_event_a(&error_abort);
}

static void test_event_b(TestEventData *data,
                         const void *unused)
{
    QDict *d;
    d = data->expect;
    qdict_put_str(d, "event", "EVENT_B");
    qapi_event_send_event_b(&error_abort);
}

static void test_event_c(TestEventData *data,
                         const void *unused)
{
    QDict *d, *d_data, *d_b;

    UserDefOne b;
    b.integer = 2;
    b.string = g_strdup("test1");
    b.has_enum1 = false;

    d_b = qdict_new();
    qdict_put_int(d_b, "integer", 2);
    qdict_put_str(d_b, "string", "test1");

    d_data = qdict_new();
    qdict_put_int(d_data, "a", 1);
    qdict_put(d_data, "b", d_b);
    qdict_put_str(d_data, "c", "test2");

    d = data->expect;
    qdict_put_str(d, "event", "EVENT_C");
    qdict_put(d, "data", d_data);

    qapi_event_send_event_c(true, 1, true, &b, "test2", &error_abort);

    g_free(b.string);
}

/* Complex type */
static void test_event_d(TestEventData *data,
                         const void *unused)
{
    UserDefOne struct1;
    EventStructOne a;
    QDict *d, *d_data, *d_a, *d_struct1;

    struct1.integer = 2;
    struct1.string = g_strdup("test1");
    struct1.has_enum1 = true;
    struct1.enum1 = ENUM_ONE_VALUE1;

    a.struct1 = &struct1;
    a.string = g_strdup("test2");
    a.has_enum2 = true;
    a.enum2 = ENUM_ONE_VALUE2;

    d_struct1 = qdict_new();
    qdict_put_int(d_struct1, "integer", 2);
    qdict_put_str(d_struct1, "string", "test1");
    qdict_put_str(d_struct1, "enum1", "value1");

    d_a = qdict_new();
    qdict_put(d_a, "struct1", d_struct1);
    qdict_put_str(d_a, "string", "test2");
    qdict_put_str(d_a, "enum2", "value2");

    d_data = qdict_new();
    qdict_put(d_data, "a", d_a);
    qdict_put_str(d_data, "b", "test3");
    qdict_put_str(d_data, "enum3", "value3");

    d = data->expect;
    qdict_put_str(d, "event", "EVENT_D");
    qdict_put(d, "data", d_data);

    qapi_event_send_event_d(&a, "test3", false, NULL, true, ENUM_ONE_VALUE3,
                           &error_abort);

    g_free(struct1.string);
    g_free(a.string);
}

int main(int argc, char **argv)
{
#if !GLIB_CHECK_VERSION(2, 31, 0)
    if (!g_thread_supported()) {
       g_thread_init(NULL);
    }
#endif

    qmp_event_set_func_emit(event_test_emit);

    g_test_init(&argc, &argv, NULL);

    event_test_add("/event/event_a", test_event_a);
    event_test_add("/event/event_b", test_event_b);
    event_test_add("/event/event_c", test_event_c);
    event_test_add("/event/event_d", test_event_d);
    g_test_run();

    return 0;
}
Commit	Line	Data
f6dadb02 WX	1	/*
	2	* qapi event unit-tests.
	3	*
	4	* Copyright (c) 2014 Wenchao Xia
	5	*
	6	* Authors:
	7	* Wenchao Xia <[email protected]>
	8	*
	9	* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
	10	* See the COPYING.LIB file in the top-level directory.
	11	*
	12	*/
	13
681c28a3	14	#include "qemu/osdep.h"
f6dadb02 WX	15
	16	#include "qemu-common.h"
	17	#include "test-qapi-types.h"
	18	#include "test-qapi-visit.h"
	19	#include "test-qapi-event.h"
	20	#include "qapi/qmp/types.h"
	21	#include "qapi/qmp/qint.h"
	22	#include "qapi/qmp/qobject.h"
	23	#include "qapi/qmp-event.h"
	24
	25	typedef struct TestEventData {
	26	QDict *expect;
	27	} TestEventData;
	28
	29	typedef struct QDictCmpData {
	30	QDict *expect;
	31	bool result;
	32	} QDictCmpData;
	33
	34	TestEventData *test_event_data;
	35	static CompatGMutex test_event_lock;
	36
	37	/* Only compares bool, int, string */
	38	static
	39	void qdict_cmp_do_simple(const char key, QObject obj1, void *opaque)
	40
	41	{
	42	QObject *obj2;
	43	QDictCmpData d_new, *d = opaque;
	44
	45	if (!d->result) {
	46	return;
	47	}
	48
	49	obj2 = qdict_get(d->expect, key);
	50	if (!obj2) {
	51	d->result = false;
	52	return;
	53	}
	54
	55	if (qobject_type(obj1) != qobject_type(obj2)) {
	56	d->result = false;
	57	return;
	58	}
	59
	60	switch (qobject_type(obj1)) {
	61	case QTYPE_QBOOL:
fc48ffc3 EB	62	d->result = (qbool_get_bool(qobject_to_qbool(obj1)) ==
fc48ffc3 EB	63	qbool_get_bool(qobject_to_qbool(obj2)));
f6dadb02 WX	64	return;
	65	case QTYPE_QINT:
	66	d->result = (qint_get_int(qobject_to_qint(obj1)) ==
	67	qint_get_int(qobject_to_qint(obj2)));
	68	return;
	69	case QTYPE_QSTRING:
	70	d->result = g_strcmp0(qstring_get_str(qobject_to_qstring(obj1)),
	71	qstring_get_str(qobject_to_qstring(obj2))) == 0;
	72	return;
	73	case QTYPE_QDICT:
	74	d_new.expect = qobject_to_qdict(obj2);
	75	d_new.result = true;
	76	qdict_iter(qobject_to_qdict(obj1), qdict_cmp_do_simple, &d_new);
	77	d->result = d_new.result;
	78	return;
	79	default:
	80	abort();
	81	}
	82	}
	83
	84	static bool qdict_cmp_simple(QDict a, QDict b)
	85	{
	86	QDictCmpData d;
	87
	88	d.expect = b;
	89	d.result = true;
	90	qdict_iter(a, qdict_cmp_do_simple, &d);
	91	return d.result;
	92	}
	93
	94	/* This function is hooked as final emit function, which can verify the
	95	correctness. */
016a335b	96	static void event_test_emit(test_QAPIEvent event, QDict d, Error *errp)
f6dadb02	97	{
f6dadb02 WX	98	QDict *t;
	99	int64_t s, ms;
	100
	101	/* Verify that we have timestamp, then remove it to compare other fields */
4b32e11a	102	t = qdict_get_qdict(d, "timestamp");
f6dadb02	103	g_assert(t);
4b32e11a MA	104	s = qdict_get_try_int(t, "seconds", -2);
4b32e11a MA	105	ms = qdict_get_try_int(t, "microseconds", -2);
f6dadb02 WX	106	if (s == -1) {
	107	g_assert(ms == -1);
	108	} else {
4b32e11a	109	g_assert(s >= 0);
f6dadb02 WX	110	g_assert(ms >= 0 && ms <= 999999);
	111	}
	112	g_assert(qdict_size(t) == 2);
	113
	114	qdict_del(d, "timestamp");
	115
	116	g_assert(qdict_cmp_simple(d, test_event_data->expect));
	117
	118	}
	119
	120	static void event_prepare(TestEventData *data,
	121	const void *unused)
	122	{
	123	/* Global variable test_event_data was used to pass the expectation, so
	124	test cases can't be executed at same time. */
	125	g_mutex_lock(&test_event_lock);
	126
	127	data->expect = qdict_new();
	128	test_event_data = data;
	129	}
	130
	131	static void event_teardown(TestEventData *data,
	132	const void *unused)
	133	{
	134	QDECREF(data->expect);
	135	test_event_data = NULL;
	136
	137	g_mutex_unlock(&test_event_lock);
	138	}
	139
	140	static void event_test_add(const char *testpath,
	141	void (test_func)(TestEventData data,
	142	const void *user_data))
	143	{
	144	g_test_add(testpath, TestEventData, NULL, event_prepare, test_func,
	145	event_teardown);
	146	}
	147
	148
	149	/* Test cases */
	150
	151	static void test_event_a(TestEventData *data,
	152	const void *unused)
	153	{
	154	QDict *d;
	155	d = data->expect;
46f5ac20	156	qdict_put_str(d, "event", "EVENT_A");
f6dadb02 WX	157	qapi_event_send_event_a(&error_abort);
	158	}
	159
	160	static void test_event_b(TestEventData *data,
	161	const void *unused)
	162	{
	163	QDict *d;
	164	d = data->expect;
46f5ac20	165	qdict_put_str(d, "event", "EVENT_B");
f6dadb02 WX	166	qapi_event_send_event_b(&error_abort);
	167	}
	168
	169	static void test_event_c(TestEventData *data,
	170	const void *unused)
	171	{
	172	QDict d, d_data, *d_b;
	173
	174	UserDefOne b;
ddf21908	175	b.integer = 2;
f6dadb02 WX	176	b.string = g_strdup("test1");
	177	b.has_enum1 = false;
	178
	179	d_b = qdict_new();
46f5ac20 EB	180	qdict_put_int(d_b, "integer", 2);
46f5ac20 EB	181	qdict_put_str(d_b, "string", "test1");
f6dadb02 WX	182
f6dadb02 WX	183	d_data = qdict_new();
46f5ac20	184	qdict_put_int(d_data, "a", 1);
f6dadb02	185	qdict_put(d_data, "b", d_b);
46f5ac20	186	qdict_put_str(d_data, "c", "test2");
f6dadb02 WX	187
f6dadb02 WX	188	d = data->expect;
46f5ac20	189	qdict_put_str(d, "event", "EVENT_C");
f6dadb02 WX	190	qdict_put(d, "data", d_data);
	191
	192	qapi_event_send_event_c(true, 1, true, &b, "test2", &error_abort);
	193
	194	g_free(b.string);
	195	}
	196
	197	/* Complex type */
	198	static void test_event_d(TestEventData *data,
	199	const void *unused)
	200	{
	201	UserDefOne struct1;
	202	EventStructOne a;
f6dadb02 WX	203	QDict d, d_data, d_a, d_struct1;
f6dadb02 WX	204
ddf21908	205	struct1.integer = 2;
f6dadb02 WX	206	struct1.string = g_strdup("test1");
	207	struct1.has_enum1 = true;
	208	struct1.enum1 = ENUM_ONE_VALUE1;
	209
	210	a.struct1 = &struct1;
	211	a.string = g_strdup("test2");
	212	a.has_enum2 = true;
	213	a.enum2 = ENUM_ONE_VALUE2;
	214
	215	d_struct1 = qdict_new();
46f5ac20 EB	216	qdict_put_int(d_struct1, "integer", 2);
	217	qdict_put_str(d_struct1, "string", "test1");
	218	qdict_put_str(d_struct1, "enum1", "value1");
f6dadb02 WX	219
	220	d_a = qdict_new();
	221	qdict_put(d_a, "struct1", d_struct1);
46f5ac20 EB	222	qdict_put_str(d_a, "string", "test2");
46f5ac20 EB	223	qdict_put_str(d_a, "enum2", "value2");
f6dadb02 WX	224
	225	d_data = qdict_new();
	226	qdict_put(d_data, "a", d_a);
46f5ac20 EB	227	qdict_put_str(d_data, "b", "test3");
46f5ac20 EB	228	qdict_put_str(d_data, "enum3", "value3");
f6dadb02 WX	229
f6dadb02 WX	230	d = data->expect;
46f5ac20	231	qdict_put_str(d, "event", "EVENT_D");
f6dadb02 WX	232	qdict_put(d, "data", d_data);
	233
	234	qapi_event_send_event_d(&a, "test3", false, NULL, true, ENUM_ONE_VALUE3,
	235	&error_abort);
	236
	237	g_free(struct1.string);
	238	g_free(a.string);
	239	}
	240
	241	int main(int argc, char **argv)
	242	{
af35e5e1 PB	243	#if !GLIB_CHECK_VERSION(2, 31, 0)
	244	if (!g_thread_supported()) {
	245	g_thread_init(NULL);
	246	}
	247	#endif
	248
f6dadb02 WX	249	qmp_event_set_func_emit(event_test_emit);
	250
	251	g_test_init(&argc, &argv, NULL);
	252
	253	event_test_add("/event/event_a", test_event_a);
	254	event_test_add("/event/event_b", test_event_b);
	255	event_test_add("/event/event_c", test_event_c);
	256	event_test_add("/event/event_d", test_event_d);
	257	g_test_run();
	258
	259	return 0;
	260	}