2 * Unit-tests for visitor-based serialization
4 * Copyright IBM, Corp. 2012
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
18 #include "qemu-common.h"
19 #include "test-qapi-types.h"
20 #include "test-qapi-visit.h"
21 #include "qapi/qmp/types.h"
22 #include "qapi/qmp-input-visitor.h"
23 #include "qapi/qmp-output-visitor.h"
24 #include "qapi/string-input-visitor.h"
25 #include "qapi/string-output-visitor.h"
27 typedef struct PrimitiveType {
58 const char *description;
63 static void visit_primitive_type(Visitor *v, void **native, Error **errp)
65 PrimitiveType *pt = *native;
68 visit_type_str(v, (char **)&pt->value.string, NULL, errp);
71 visit_type_bool(v, &pt->value.boolean, NULL, errp);
74 visit_type_number(v, &pt->value.number, NULL, errp);
77 visit_type_int(v, &pt->value.integer, NULL, errp);
80 visit_type_uint8(v, &pt->value.u8, NULL, errp);
83 visit_type_uint16(v, &pt->value.u16, NULL, errp);
86 visit_type_uint32(v, &pt->value.u32, NULL, errp);
89 visit_type_uint64(v, &pt->value.u64, NULL, errp);
92 visit_type_int8(v, &pt->value.s8, NULL, errp);
95 visit_type_int16(v, &pt->value.s16, NULL, errp);
98 visit_type_int32(v, &pt->value.s32, NULL, errp);
101 visit_type_int64(v, &pt->value.s64, NULL, errp);
108 typedef struct TestStruct
115 static void visit_type_TestStruct(Visitor *v, TestStruct **obj,
116 const char *name, Error **errp)
118 visit_start_struct(v, (void **)obj, NULL, name, sizeof(TestStruct), errp);
120 visit_type_int(v, &(*obj)->integer, "integer", errp);
121 visit_type_bool(v, &(*obj)->boolean, "boolean", errp);
122 visit_type_str(v, &(*obj)->string, "string", errp);
124 visit_end_struct(v, errp);
127 static TestStruct *struct_create(void)
129 TestStruct *ts = g_malloc0(sizeof(*ts));
132 ts->string = strdup("test string");
136 static void struct_compare(TestStruct *ts1, TestStruct *ts2)
140 g_assert_cmpint(ts1->integer, ==, ts2->integer);
141 g_assert(ts1->boolean == ts2->boolean);
142 g_assert_cmpstr(ts1->string, ==, ts2->string);
145 static void struct_cleanup(TestStruct *ts)
151 static void visit_struct(Visitor *v, void **native, Error **errp)
153 visit_type_TestStruct(v, (TestStruct **)native, NULL, errp);
156 static UserDefNested *nested_struct_create(void)
158 UserDefNested *udnp = g_malloc0(sizeof(*udnp));
159 udnp->string0 = strdup("test_string0");
160 udnp->dict1.string1 = strdup("test_string1");
161 udnp->dict1.dict2.userdef1 = g_malloc0(sizeof(UserDefOne));
162 udnp->dict1.dict2.userdef1->integer = 42;
163 udnp->dict1.dict2.userdef1->string = strdup("test_string");
164 udnp->dict1.dict2.string2 = strdup("test_string2");
165 udnp->dict1.has_dict3 = true;
166 udnp->dict1.dict3.userdef2 = g_malloc0(sizeof(UserDefOne));
167 udnp->dict1.dict3.userdef2->integer = 43;
168 udnp->dict1.dict3.userdef2->string = strdup("test_string");
169 udnp->dict1.dict3.string3 = strdup("test_string3");
173 static void nested_struct_compare(UserDefNested *udnp1, UserDefNested *udnp2)
177 g_assert_cmpstr(udnp1->string0, ==, udnp2->string0);
178 g_assert_cmpstr(udnp1->dict1.string1, ==, udnp2->dict1.string1);
179 g_assert_cmpint(udnp1->dict1.dict2.userdef1->integer, ==,
180 udnp2->dict1.dict2.userdef1->integer);
181 g_assert_cmpstr(udnp1->dict1.dict2.userdef1->string, ==,
182 udnp2->dict1.dict2.userdef1->string);
183 g_assert_cmpstr(udnp1->dict1.dict2.string2, ==, udnp2->dict1.dict2.string2);
184 g_assert(udnp1->dict1.has_dict3 == udnp2->dict1.has_dict3);
185 g_assert_cmpint(udnp1->dict1.dict3.userdef2->integer, ==,
186 udnp2->dict1.dict3.userdef2->integer);
187 g_assert_cmpstr(udnp1->dict1.dict3.userdef2->string, ==,
188 udnp2->dict1.dict3.userdef2->string);
189 g_assert_cmpstr(udnp1->dict1.dict3.string3, ==, udnp2->dict1.dict3.string3);
192 static void nested_struct_cleanup(UserDefNested *udnp)
194 qapi_free_UserDefNested(udnp);
197 static void visit_nested_struct(Visitor *v, void **native, Error **errp)
199 visit_type_UserDefNested(v, (UserDefNested **)native, NULL, errp);
202 static void visit_nested_struct_list(Visitor *v, void **native, Error **errp)
204 visit_type_UserDefNestedList(v, (UserDefNestedList **)native, NULL, errp);
209 typedef void (*VisitorFunc)(Visitor *v, void **native, Error **errp);
211 typedef enum VisitorCapabilities {
215 } VisitorCapabilities;
217 typedef struct SerializeOps {
218 void (*serialize)(void *native_in, void **datap,
219 VisitorFunc visit, Error **errp);
220 void (*deserialize)(void **native_out, void *datap,
221 VisitorFunc visit, Error **errp);
222 void (*cleanup)(void *datap);
224 VisitorCapabilities caps;
227 typedef struct TestArgs {
228 const SerializeOps *ops;
232 #define FLOAT_STRING_PRECISION 6 /* corresponding to n in %.nf formatting */
233 static gsize calc_float_string_storage(double value)
235 int whole_value = value;
239 } while (whole_value /= 10);
240 return i + 2 + FLOAT_STRING_PRECISION;
243 static void test_primitives(gconstpointer opaque)
245 TestArgs *args = (TestArgs *) opaque;
246 const SerializeOps *ops = args->ops;
247 PrimitiveType *pt = args->test_data;
248 PrimitiveType *pt_copy = g_malloc0(sizeof(*pt_copy));
250 void *serialize_data;
251 char *double1, *double2;
253 pt_copy->type = pt->type;
254 ops->serialize(pt, &serialize_data, visit_primitive_type, &err);
255 ops->deserialize((void **)&pt_copy, serialize_data, visit_primitive_type, &err);
257 g_assert(err == NULL);
258 g_assert(pt_copy != NULL);
259 if (pt->type == PTYPE_STRING) {
260 g_assert_cmpstr(pt->value.string, ==, pt_copy->value.string);
261 g_free((char *)pt_copy->value.string);
262 } else if (pt->type == PTYPE_NUMBER) {
263 /* we serialize with %f for our reference visitors, so rather than fuzzy
264 * floating math to test "equality", just compare the formatted values
266 double1 = g_malloc0(calc_float_string_storage(pt->value.number));
267 double2 = g_malloc0(calc_float_string_storage(pt_copy->value.number));
268 g_assert_cmpstr(double1, ==, double2);
271 } else if (pt->type == PTYPE_BOOLEAN) {
272 g_assert_cmpint(!!pt->value.max, ==, !!pt->value.max);
274 g_assert_cmpint(pt->value.max, ==, pt_copy->value.max);
277 ops->cleanup(serialize_data);
282 static void test_struct(gconstpointer opaque)
284 TestArgs *args = (TestArgs *) opaque;
285 const SerializeOps *ops = args->ops;
286 TestStruct *ts = struct_create();
287 TestStruct *ts_copy = NULL;
289 void *serialize_data;
291 ops->serialize(ts, &serialize_data, visit_struct, &err);
292 ops->deserialize((void **)&ts_copy, serialize_data, visit_struct, &err);
294 g_assert(err == NULL);
295 struct_compare(ts, ts_copy);
298 struct_cleanup(ts_copy);
300 ops->cleanup(serialize_data);
304 static void test_nested_struct(gconstpointer opaque)
306 TestArgs *args = (TestArgs *) opaque;
307 const SerializeOps *ops = args->ops;
308 UserDefNested *udnp = nested_struct_create();
309 UserDefNested *udnp_copy = NULL;
311 void *serialize_data;
313 ops->serialize(udnp, &serialize_data, visit_nested_struct, &err);
314 ops->deserialize((void **)&udnp_copy, serialize_data, visit_nested_struct, &err);
316 g_assert(err == NULL);
317 nested_struct_compare(udnp, udnp_copy);
319 nested_struct_cleanup(udnp);
320 nested_struct_cleanup(udnp_copy);
322 ops->cleanup(serialize_data);
326 static void test_nested_struct_list(gconstpointer opaque)
328 TestArgs *args = (TestArgs *) opaque;
329 const SerializeOps *ops = args->ops;
330 UserDefNestedList *listp = NULL, *tmp, *tmp_copy, *listp_copy = NULL;
332 void *serialize_data;
335 for (i = 0; i < 8; i++) {
336 tmp = g_malloc0(sizeof(UserDefNestedList));
337 tmp->value = nested_struct_create();
342 ops->serialize(listp, &serialize_data, visit_nested_struct_list, &err);
343 ops->deserialize((void **)&listp_copy, serialize_data,
344 visit_nested_struct_list, &err);
346 g_assert(err == NULL);
349 tmp_copy = listp_copy;
352 nested_struct_compare(listp->value, listp_copy->value);
354 listp_copy = listp_copy->next;
357 qapi_free_UserDefNestedList(tmp);
358 qapi_free_UserDefNestedList(tmp_copy);
360 ops->cleanup(serialize_data);
364 PrimitiveType pt_values[] = {
367 .description = "string_empty",
368 .type = PTYPE_STRING,
372 .description = "string_whitespace",
373 .type = PTYPE_STRING,
374 .value.string = "a b c\td",
377 .description = "string_newlines",
378 .type = PTYPE_STRING,
379 .value.string = "a\nb\n",
382 .description = "string_commas",
383 .type = PTYPE_STRING,
384 .value.string = "a,b, c,d",
387 .description = "string_single_quoted",
388 .type = PTYPE_STRING,
389 .value.string = "'a b',cd",
392 .description = "string_double_quoted",
393 .type = PTYPE_STRING,
394 .value.string = "\"a b\",cd",
398 .description = "boolean_true1",
399 .type = PTYPE_BOOLEAN,
400 .value.boolean = true,
403 .description = "boolean_true2",
404 .type = PTYPE_BOOLEAN,
408 .description = "boolean_true3",
409 .type = PTYPE_BOOLEAN,
413 .description = "boolean_false1",
414 .type = PTYPE_BOOLEAN,
415 .value.boolean = false,
418 .description = "boolean_false2",
419 .type = PTYPE_BOOLEAN,
422 /* number tests (double) */
423 /* note: we format these to %.6f before comparing, since that's how
424 * we serialize them and it doesn't make sense to check precision
428 .description = "number_sanity1",
429 .type = PTYPE_NUMBER,
433 .description = "number_sanity2",
434 .type = PTYPE_NUMBER,
435 .value.number = 3.14159265,
438 .description = "number_min",
439 .type = PTYPE_NUMBER,
440 .value.number = DBL_MIN,
443 .description = "number_max",
444 .type = PTYPE_NUMBER,
445 .value.number = DBL_MAX,
447 /* integer tests (int64) */
449 .description = "integer_sanity1",
450 .type = PTYPE_INTEGER,
454 .description = "integer_sanity2",
455 .type = PTYPE_INTEGER,
456 .value.integer = INT64_MAX / 2 + 1,
459 .description = "integer_min",
460 .type = PTYPE_INTEGER,
461 .value.integer = INT64_MIN,
464 .description = "integer_max",
465 .type = PTYPE_INTEGER,
466 .value.integer = INT64_MAX,
470 .description = "uint8_sanity1",
475 .description = "uint8_sanity2",
477 .value.u8 = UINT8_MAX / 2 + 1,
480 .description = "uint8_min",
485 .description = "uint8_max",
487 .value.u8 = UINT8_MAX,
491 .description = "uint16_sanity1",
496 .description = "uint16_sanity2",
498 .value.u16 = UINT16_MAX / 2 + 1,
501 .description = "uint16_min",
506 .description = "uint16_max",
508 .value.u16 = UINT16_MAX,
512 .description = "uint32_sanity1",
517 .description = "uint32_sanity2",
519 .value.u32 = UINT32_MAX / 2 + 1,
522 .description = "uint32_min",
527 .description = "uint32_max",
529 .value.u32 = UINT32_MAX,
533 .description = "uint64_sanity1",
538 .description = "uint64_sanity2",
540 .value.u64 = UINT64_MAX / 2 + 1,
543 .description = "uint64_min",
548 .description = "uint64_max",
550 .value.u64 = UINT64_MAX,
554 .description = "int8_sanity1",
559 .description = "int8_sanity2",
561 .value.s8 = INT8_MAX / 2 + 1,
564 .description = "int8_min",
566 .value.s8 = INT8_MIN,
569 .description = "int8_max",
571 .value.s8 = INT8_MAX,
575 .description = "int16_sanity1",
580 .description = "int16_sanity2",
582 .value.s16 = INT16_MAX / 2 + 1,
585 .description = "int16_min",
587 .value.s16 = INT16_MIN,
590 .description = "int16_max",
592 .value.s16 = INT16_MAX,
596 .description = "int32_sanity1",
601 .description = "int32_sanity2",
603 .value.s32 = INT32_MAX / 2 + 1,
606 .description = "int32_min",
608 .value.s32 = INT32_MIN,
611 .description = "int32_max",
613 .value.s32 = INT32_MAX,
617 .description = "int64_sanity1",
622 .description = "int64_sanity2",
624 .value.s64 = INT64_MAX / 2 + 1,
627 .description = "int64_min",
629 .value.s64 = INT64_MIN,
632 .description = "int64_max",
634 .value.s64 = INT64_MAX,
636 { .type = PTYPE_EOL }
639 /* visitor-specific op implementations */
641 typedef struct QmpSerializeData {
642 QmpOutputVisitor *qov;
643 QmpInputVisitor *qiv;
646 static void qmp_serialize(void *native_in, void **datap,
647 VisitorFunc visit, Error **errp)
649 QmpSerializeData *d = g_malloc0(sizeof(*d));
651 d->qov = qmp_output_visitor_new();
652 visit(qmp_output_get_visitor(d->qov), &native_in, errp);
656 static void qmp_deserialize(void **native_out, void *datap,
657 VisitorFunc visit, Error **errp)
659 QmpSerializeData *d = datap;
660 QString *output_json = qobject_to_json(qmp_output_get_qobject(d->qov));
661 QObject *obj = qobject_from_json(qstring_get_str(output_json));
663 QDECREF(output_json);
664 d->qiv = qmp_input_visitor_new(obj);
666 visit(qmp_input_get_visitor(d->qiv), native_out, errp);
669 static void qmp_cleanup(void *datap)
671 QmpSerializeData *d = datap;
672 qmp_output_visitor_cleanup(d->qov);
673 qmp_input_visitor_cleanup(d->qiv);
678 typedef struct StringSerializeData {
680 StringOutputVisitor *sov;
681 StringInputVisitor *siv;
682 } StringSerializeData;
684 static void string_serialize(void *native_in, void **datap,
685 VisitorFunc visit, Error **errp)
687 StringSerializeData *d = g_malloc0(sizeof(*d));
689 d->sov = string_output_visitor_new();
690 visit(string_output_get_visitor(d->sov), &native_in, errp);
694 static void string_deserialize(void **native_out, void *datap,
695 VisitorFunc visit, Error **errp)
697 StringSerializeData *d = datap;
699 d->string = string_output_get_string(d->sov);
700 d->siv = string_input_visitor_new(d->string);
701 visit(string_input_get_visitor(d->siv), native_out, errp);
704 static void string_cleanup(void *datap)
706 StringSerializeData *d = datap;
708 string_output_visitor_cleanup(d->sov);
709 string_input_visitor_cleanup(d->siv);
714 /* visitor registration, test harness */
716 /* note: to function interchangeably as a serialization mechanism your
717 * visitor test implementation should pass the test cases for all visitor
718 * capabilities: primitives, structures, and lists
720 static const SerializeOps visitors[] = {
723 .serialize = qmp_serialize,
724 .deserialize = qmp_deserialize,
725 .cleanup = qmp_cleanup,
726 .caps = VCAP_PRIMITIVES | VCAP_STRUCTURES | VCAP_LISTS
730 .serialize = string_serialize,
731 .deserialize = string_deserialize,
732 .cleanup = string_cleanup,
733 .caps = VCAP_PRIMITIVES
738 static void add_visitor_type(const SerializeOps *ops)
740 char testname_prefix[128];
745 sprintf(testname_prefix, "/visitor/serialization/%s", ops->type);
747 if (ops->caps & VCAP_PRIMITIVES) {
748 while (pt_values[i].type != PTYPE_EOL) {
749 sprintf(testname, "%s/primitives/%s", testname_prefix,
750 pt_values[i].description);
751 args = g_malloc0(sizeof(*args));
753 args->test_data = &pt_values[i];
754 g_test_add_data_func(testname, args, test_primitives);
759 if (ops->caps & VCAP_STRUCTURES) {
760 sprintf(testname, "%s/struct", testname_prefix);
761 args = g_malloc0(sizeof(*args));
763 args->test_data = NULL;
764 g_test_add_data_func(testname, args, test_struct);
766 sprintf(testname, "%s/nested_struct", testname_prefix);
767 args = g_malloc0(sizeof(*args));
769 args->test_data = NULL;
770 g_test_add_data_func(testname, args, test_nested_struct);
773 if (ops->caps & VCAP_LISTS) {
774 sprintf(testname, "%s/nested_struct_list", testname_prefix);
775 args = g_malloc0(sizeof(*args));
777 args->test_data = NULL;
778 g_test_add_data_func(testname, args, test_nested_struct_list);
782 int main(int argc, char **argv)
786 g_test_init(&argc, &argv, NULL);
788 while (visitors[i].type != NULL) {
789 add_visitor_type(&visitors[i]);