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