4 * Copyright (C) 2009 Red Hat Inc.
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.
12 #include "qemu/osdep.h"
14 #include "qapi/qmp/qdict.h"
15 #include "qapi/qmp/qstring.h"
16 #include "qapi/error.h"
17 #include "qemu-common.h"
20 * Public Interface test-cases
22 * (with some violations to access 'private' data)
25 static void qdict_new_test(void)
30 g_assert(qdict != NULL);
31 g_assert(qdict_size(qdict) == 0);
32 g_assert(qdict->base.refcnt == 1);
33 g_assert(qobject_type(QOBJECT(qdict)) == QTYPE_QDICT);
38 static void qdict_put_obj_test(void)
47 // key "" will have tdb hash 12345
48 qdict_put_int(qdict, "", num);
50 g_assert(qdict_size(qdict) == 1);
51 ent = QLIST_FIRST(&qdict->table[12345 % QDICT_BUCKET_MAX]);
52 qn = qobject_to_qnum(ent->value);
53 g_assert_cmpint(qnum_get_int(qn), ==, num);
58 static void qdict_destroy_simple_test(void)
63 qdict_put_int(qdict, "num", 0);
64 qdict_put_str(qdict, "str", "foo");
69 static void qdict_get_test(void)
73 const int value = -42;
74 const char *key = "test";
75 QDict *tests_dict = qdict_new();
77 qdict_put_int(tests_dict, key, value);
79 obj = qdict_get(tests_dict, key);
80 g_assert(obj != NULL);
82 qn = qobject_to_qnum(obj);
83 g_assert_cmpint(qnum_get_int(qn), ==, value);
88 static void qdict_get_int_test(void)
91 const int value = 100;
92 const char *key = "int";
93 QDict *tests_dict = qdict_new();
95 qdict_put_int(tests_dict, key, value);
97 ret = qdict_get_int(tests_dict, key);
98 g_assert(ret == value);
103 static void qdict_get_try_int_test(void)
106 const int value = 100;
107 const char *key = "int";
108 QDict *tests_dict = qdict_new();
110 qdict_put_int(tests_dict, key, value);
111 qdict_put_str(tests_dict, "string", "test");
113 ret = qdict_get_try_int(tests_dict, key, 0);
114 g_assert(ret == value);
116 ret = qdict_get_try_int(tests_dict, "missing", -42);
117 g_assert_cmpuint(ret, ==, -42);
119 ret = qdict_get_try_int(tests_dict, "string", -42);
120 g_assert_cmpuint(ret, ==, -42);
125 static void qdict_get_str_test(void)
128 const char *key = "key";
129 const char *str = "string";
130 QDict *tests_dict = qdict_new();
132 qdict_put_str(tests_dict, key, str);
134 p = qdict_get_str(tests_dict, key);
136 g_assert(strcmp(p, str) == 0);
141 static void qdict_get_try_str_test(void)
144 const char *key = "key";
145 const char *str = "string";
146 QDict *tests_dict = qdict_new();
148 qdict_put_str(tests_dict, key, str);
150 p = qdict_get_try_str(tests_dict, key);
152 g_assert(strcmp(p, str) == 0);
157 static void qdict_defaults_test(void)
164 qdict_set_default_str(dict, "foo", "abc");
165 qdict_set_default_str(dict, "foo", "def");
166 g_assert_cmpstr(qdict_get_str(dict, "foo"), ==, "abc");
167 qdict_set_default_str(dict, "bar", "ghi");
169 qdict_copy_default(copy, dict, "foo");
170 g_assert_cmpstr(qdict_get_str(copy, "foo"), ==, "abc");
171 qdict_set_default_str(copy, "bar", "xyz");
172 qdict_copy_default(copy, dict, "bar");
173 g_assert_cmpstr(qdict_get_str(copy, "bar"), ==, "xyz");
179 static void qdict_haskey_not_test(void)
181 QDict *tests_dict = qdict_new();
182 g_assert(qdict_haskey(tests_dict, "test") == 0);
187 static void qdict_haskey_test(void)
189 const char *key = "test";
190 QDict *tests_dict = qdict_new();
192 qdict_put_int(tests_dict, key, 0);
193 g_assert(qdict_haskey(tests_dict, key) == 1);
198 static void qdict_del_test(void)
200 const char *key = "key test";
201 QDict *tests_dict = qdict_new();
203 qdict_put_str(tests_dict, key, "foo");
204 g_assert(qdict_size(tests_dict) == 1);
206 qdict_del(tests_dict, key);
208 g_assert(qdict_size(tests_dict) == 0);
209 g_assert(qdict_haskey(tests_dict, key) == 0);
214 static void qobject_to_qdict_test(void)
216 QDict *tests_dict = qdict_new();
217 g_assert(qobject_to_qdict(QOBJECT(tests_dict)) == tests_dict);
222 static void qdict_iterapi_test(void)
225 const QDictEntry *ent;
226 QDict *tests_dict = qdict_new();
228 g_assert(qdict_first(tests_dict) == NULL);
230 qdict_put_int(tests_dict, "key1", 1);
231 qdict_put_int(tests_dict, "key2", 2);
232 qdict_put_int(tests_dict, "key3", 3);
235 for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){
236 g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1);
240 g_assert(count == qdict_size(tests_dict));
242 /* Do it again to test restarting */
244 for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){
245 g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1);
249 g_assert(count == qdict_size(tests_dict));
254 static void qdict_flatten_test(void)
256 QList *list1 = qlist_new();
257 QList *list2 = qlist_new();
258 QDict *dict1 = qdict_new();
259 QDict *dict2 = qdict_new();
260 QDict *dict3 = qdict_new();
263 * Test the flattening of
298 qdict_put_int(dict1, "a", 0);
299 qdict_put_int(dict1, "b", 1);
301 qlist_append_int(list1, 23);
302 qlist_append_int(list1, 66);
303 qlist_append(list1, dict1);
304 qlist_append_int(list2, 42);
305 qlist_append(list2, list1);
307 qdict_put_int(dict2, "c", 2);
308 qdict_put_int(dict2, "d", 3);
309 qdict_put(dict3, "e", list2);
310 qdict_put(dict3, "f", dict2);
311 qdict_put_int(dict3, "g", 4);
313 qdict_flatten(dict3);
315 g_assert(qdict_get_int(dict3, "e.0") == 42);
316 g_assert(qdict_get_int(dict3, "e.1.0") == 23);
317 g_assert(qdict_get_int(dict3, "e.1.1") == 66);
318 g_assert(qdict_get_int(dict3, "e.1.2.a") == 0);
319 g_assert(qdict_get_int(dict3, "e.1.2.b") == 1);
320 g_assert(qdict_get_int(dict3, "f.c") == 2);
321 g_assert(qdict_get_int(dict3, "f.d") == 3);
322 g_assert(qdict_get_int(dict3, "g") == 4);
324 g_assert(qdict_size(dict3) == 8);
329 static void qdict_array_split_test(void)
331 QDict *test_dict = qdict_new();
332 QDict *dict1, *dict2;
368 * (remaining in the old QDict)
370 * This example is given in the comment of qdict_array_split().
373 qdict_put_int(test_dict, "1.x", 0);
374 qdict_put_int(test_dict, "4.y", 1);
375 qdict_put_int(test_dict, "0.a", 42);
376 qdict_put_int(test_dict, "o.o", 7);
377 qdict_put_int(test_dict, "0.b", 23);
378 qdict_put_int(test_dict, "2", 66);
380 qdict_array_split(test_dict, &test_list);
382 dict1 = qobject_to_qdict(qlist_pop(test_list));
383 dict2 = qobject_to_qdict(qlist_pop(test_list));
384 int1 = qobject_to_qnum(qlist_pop(test_list));
389 g_assert(qlist_empty(test_list));
393 g_assert(qdict_get_int(dict1, "a") == 42);
394 g_assert(qdict_get_int(dict1, "b") == 23);
396 g_assert(qdict_size(dict1) == 2);
400 g_assert(qdict_get_int(dict2, "x") == 0);
402 g_assert(qdict_size(dict2) == 1);
406 g_assert_cmpint(qnum_get_int(int1), ==, 66);
410 g_assert(qdict_get_int(test_dict, "4.y") == 1);
411 g_assert(qdict_get_int(test_dict, "o.o") == 7);
413 g_assert(qdict_size(test_dict) == 2);
439 * That is, test whether splitting stops if there is both an entry with key
440 * of "%u" and other entries with keys prefixed "%u." for the same index.
443 test_dict = qdict_new();
445 qdict_put_int(test_dict, "0", 42);
446 qdict_put_int(test_dict, "1", 23);
447 qdict_put_int(test_dict, "1.x", 84);
449 qdict_array_split(test_dict, &test_list);
451 int1 = qobject_to_qnum(qlist_pop(test_list));
454 g_assert(qlist_empty(test_list));
458 g_assert_cmpint(qnum_get_int(int1), ==, 42);
462 g_assert(qdict_get_int(test_dict, "1") == 23);
463 g_assert(qdict_get_int(test_dict, "1.x") == 84);
465 g_assert(qdict_size(test_dict) == 2);
470 static void qdict_array_entries_test(void)
472 QDict *dict = qdict_new();
474 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 0);
476 qdict_put_int(dict, "bar", 0);
477 qdict_put_int(dict, "baz.0", 0);
478 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 0);
480 qdict_put_int(dict, "foo.1", 0);
481 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, -EINVAL);
482 qdict_put_int(dict, "foo.0", 0);
483 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 2);
484 qdict_put_int(dict, "foo.bar", 0);
485 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, -EINVAL);
486 qdict_del(dict, "foo.bar");
488 qdict_put_int(dict, "foo.2.a", 0);
489 qdict_put_int(dict, "foo.2.b", 0);
490 qdict_put_int(dict, "foo.2.c", 0);
491 g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 3);
492 g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL);
497 qdict_put_int(dict, "1", 0);
498 g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL);
499 qdict_put_int(dict, "0", 0);
500 g_assert_cmpint(qdict_array_entries(dict, ""), ==, 2);
501 qdict_put_int(dict, "bar", 0);
502 g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL);
503 qdict_del(dict, "bar");
505 qdict_put_int(dict, "2.a", 0);
506 qdict_put_int(dict, "2.b", 0);
507 qdict_put_int(dict, "2.c", 0);
508 g_assert_cmpint(qdict_array_entries(dict, ""), ==, 3);
513 static void qdict_join_test(void)
515 QDict *dict1, *dict2;
516 bool overwrite = false;
522 /* Test everything once without overwrite and once with */
525 /* Test empty dicts */
526 qdict_join(dict1, dict2, overwrite);
528 g_assert(qdict_size(dict1) == 0);
529 g_assert(qdict_size(dict2) == 0);
531 /* First iteration: Test movement */
532 /* Second iteration: Test empty source and non-empty destination */
533 qdict_put_int(dict2, "foo", 42);
535 for (i = 0; i < 2; i++) {
536 qdict_join(dict1, dict2, overwrite);
538 g_assert(qdict_size(dict1) == 1);
539 g_assert(qdict_size(dict2) == 0);
541 g_assert(qdict_get_int(dict1, "foo") == 42);
544 /* Test non-empty source and destination without conflict */
545 qdict_put_int(dict2, "bar", 23);
547 qdict_join(dict1, dict2, overwrite);
549 g_assert(qdict_size(dict1) == 2);
550 g_assert(qdict_size(dict2) == 0);
552 g_assert(qdict_get_int(dict1, "foo") == 42);
553 g_assert(qdict_get_int(dict1, "bar") == 23);
556 qdict_put_int(dict2, "foo", 84);
558 qdict_join(dict1, dict2, overwrite);
560 g_assert(qdict_size(dict1) == 2);
561 g_assert(qdict_size(dict2) == !overwrite);
563 g_assert(qdict_get_int(dict1, "foo") == (overwrite ? 84 : 42));
564 g_assert(qdict_get_int(dict1, "bar") == 23);
567 g_assert(qdict_get_int(dict2, "foo") == 84);
570 /* Check the references */
571 g_assert(qdict_get(dict1, "foo")->refcnt == 1);
572 g_assert(qdict_get(dict1, "bar")->refcnt == 1);
575 g_assert(qdict_get(dict2, "foo")->refcnt == 1);
579 qdict_del(dict1, "foo");
580 qdict_del(dict1, "bar");
583 qdict_del(dict2, "foo");
586 while (overwrite ^= true);
592 static void qdict_crumple_test_recursive(void)
594 QDict *src, *dst, *rule, *vnc, *acl, *listen;
598 qdict_put_str(src, "vnc.listen.addr", "127.0.0.1");
599 qdict_put_str(src, "vnc.listen.port", "5901");
600 qdict_put_str(src, "vnc.acl.rules.0.match", "fred");
601 qdict_put_str(src, "vnc.acl.rules.0.policy", "allow");
602 qdict_put_str(src, "vnc.acl.rules.1.match", "bob");
603 qdict_put_str(src, "vnc.acl.rules.1.policy", "deny");
604 qdict_put_str(src, "vnc.acl.default", "deny");
605 qdict_put_str(src, "vnc.acl..name", "acl0");
606 qdict_put_str(src, "vnc.acl.rule..name", "acl0");
608 dst = qobject_to_qdict(qdict_crumple(src, &error_abort));
610 g_assert_cmpint(qdict_size(dst), ==, 1);
612 vnc = qdict_get_qdict(dst, "vnc");
614 g_assert_cmpint(qdict_size(vnc), ==, 3);
616 listen = qdict_get_qdict(vnc, "listen");
618 g_assert_cmpint(qdict_size(listen), ==, 2);
619 g_assert_cmpstr("127.0.0.1", ==, qdict_get_str(listen, "addr"));
620 g_assert_cmpstr("5901", ==, qdict_get_str(listen, "port"));
622 acl = qdict_get_qdict(vnc, "acl");
624 g_assert_cmpint(qdict_size(acl), ==, 3);
626 rules = qdict_get_qlist(acl, "rules");
628 g_assert_cmpint(qlist_size(rules), ==, 2);
630 rule = qobject_to_qdict(qlist_pop(rules));
632 g_assert_cmpint(qdict_size(rule), ==, 2);
633 g_assert_cmpstr("fred", ==, qdict_get_str(rule, "match"));
634 g_assert_cmpstr("allow", ==, qdict_get_str(rule, "policy"));
637 rule = qobject_to_qdict(qlist_pop(rules));
639 g_assert_cmpint(qdict_size(rule), ==, 2);
640 g_assert_cmpstr("bob", ==, qdict_get_str(rule, "match"));
641 g_assert_cmpstr("deny", ==, qdict_get_str(rule, "policy"));
644 /* With recursive crumpling, we should see all names unescaped */
645 g_assert_cmpstr("acl0", ==, qdict_get_str(vnc, "acl.name"));
646 g_assert_cmpstr("acl0", ==, qdict_get_str(acl, "rule.name"));
652 static void qdict_crumple_test_empty(void)
658 dst = (QDict *)qdict_crumple(src, &error_abort);
660 g_assert_cmpint(qdict_size(dst), ==, 0);
666 static void qdict_crumple_test_bad_inputs(void)
672 /* rule.0 can't be both a string and a dict */
673 qdict_put_str(src, "rule.0", "fred");
674 qdict_put_str(src, "rule.0.policy", "allow");
676 g_assert(qdict_crumple(src, &error) == NULL);
677 g_assert(error != NULL);
683 /* rule can't be both a list and a dict */
684 qdict_put_str(src, "rule.0", "fred");
685 qdict_put_str(src, "rule.a", "allow");
687 g_assert(qdict_crumple(src, &error) == NULL);
688 g_assert(error != NULL);
694 /* The input should be flat, ie no dicts or lists */
695 qdict_put(src, "rule.a", qdict_new());
696 qdict_put_str(src, "rule.b", "allow");
698 g_assert(qdict_crumple(src, &error) == NULL);
699 g_assert(error != NULL);
705 /* List indexes must not have gaps */
706 qdict_put_str(src, "rule.0", "deny");
707 qdict_put_str(src, "rule.3", "allow");
709 g_assert(qdict_crumple(src, &error) == NULL);
710 g_assert(error != NULL);
716 /* List indexes must be in %zu format */
717 qdict_put_str(src, "rule.0", "deny");
718 qdict_put_str(src, "rule.+1", "allow");
720 g_assert(qdict_crumple(src, &error) == NULL);
721 g_assert(error != NULL);
731 static void qdict_put_exists_test(void)
734 const char *key = "exists";
735 QDict *tests_dict = qdict_new();
737 qdict_put_int(tests_dict, key, 1);
738 qdict_put_int(tests_dict, key, 2);
740 value = qdict_get_int(tests_dict, key);
741 g_assert(value == 2);
743 g_assert(qdict_size(tests_dict) == 1);
748 static void qdict_get_not_exists_test(void)
750 QDict *tests_dict = qdict_new();
751 g_assert(qdict_get(tests_dict, "foo") == NULL);
759 * This is a lot big for a unit-test, but there is no other place
763 static void remove_dots(char *string)
765 char *p = strchr(string, ':');
770 static QString *read_line(FILE *file, char *key)
774 if (fscanf(file, "%127s%127s", key, value) == EOF) {
778 return qstring_from_str(value);
781 #define reset_file(file) fseek(file, 0L, SEEK_SET)
783 static void qdict_stress_test(void)
790 const char *test_file_path = "qdict-test-data.txt";
792 test_file = fopen(test_file_path, "r");
793 g_assert(test_file != NULL);
797 g_assert(qdict != NULL);
799 // Add everything from the test file
800 for (lines = 0;; lines++) {
801 value = read_line(test_file, key);
805 qdict_put(qdict, key, value);
807 g_assert(qdict_size(qdict) == lines);
809 // Check if everything is really in there
810 reset_file(test_file);
812 const char *str1, *str2;
814 value = read_line(test_file, key);
818 str1 = qstring_get_str(value);
820 str2 = qdict_get_str(qdict, key);
821 g_assert(str2 != NULL);
823 g_assert(strcmp(str1, str2) == 0);
829 reset_file(test_file);
831 value = read_line(test_file, key);
835 qdict_del(qdict, key);
838 g_assert(qdict_haskey(qdict, key) == 0);
842 g_assert(qdict_size(qdict) == 0);
846 int main(int argc, char **argv)
848 g_test_init(&argc, &argv, NULL);
850 g_test_add_func("/public/new", qdict_new_test);
851 g_test_add_func("/public/put_obj", qdict_put_obj_test);
852 g_test_add_func("/public/destroy_simple", qdict_destroy_simple_test);
854 /* Continue, but now with fixtures */
855 g_test_add_func("/public/get", qdict_get_test);
856 g_test_add_func("/public/get_int", qdict_get_int_test);
857 g_test_add_func("/public/get_try_int", qdict_get_try_int_test);
858 g_test_add_func("/public/get_str", qdict_get_str_test);
859 g_test_add_func("/public/get_try_str", qdict_get_try_str_test);
860 g_test_add_func("/public/defaults", qdict_defaults_test);
861 g_test_add_func("/public/haskey_not", qdict_haskey_not_test);
862 g_test_add_func("/public/haskey", qdict_haskey_test);
863 g_test_add_func("/public/del", qdict_del_test);
864 g_test_add_func("/public/to_qdict", qobject_to_qdict_test);
865 g_test_add_func("/public/iterapi", qdict_iterapi_test);
866 g_test_add_func("/public/flatten", qdict_flatten_test);
867 g_test_add_func("/public/array_split", qdict_array_split_test);
868 g_test_add_func("/public/array_entries", qdict_array_entries_test);
869 g_test_add_func("/public/join", qdict_join_test);
871 g_test_add_func("/errors/put_exists", qdict_put_exists_test);
872 g_test_add_func("/errors/get_not_exists", qdict_get_not_exists_test);
874 g_test_add_func("/public/crumple/recursive",
875 qdict_crumple_test_recursive);
876 g_test_add_func("/public/crumple/empty",
877 qdict_crumple_test_empty);
878 g_test_add_func("/public/crumple/bad_inputs",
879 qdict_crumple_test_bad_inputs);
883 g_test_add_func("/stress/test", qdict_stress_test);