xref: /qemu/tests/unit/test-string-output-visitor.c (revision e7ca56562990991bc614a43b9351ee0737f3045d)
12d7799f2SPaolo Bonzini /*
22d7799f2SPaolo Bonzini  * String Output Visitor unit-tests.
32d7799f2SPaolo Bonzini  *
42d7799f2SPaolo Bonzini  * Copyright (C) 2012 Red Hat Inc.
52d7799f2SPaolo Bonzini  *
62d7799f2SPaolo Bonzini  * Authors:
72d7799f2SPaolo Bonzini  *  Paolo Bonzini <pbonzini@redhat.com> (based on test-qmp-output-visitor)
82d7799f2SPaolo Bonzini  *
92d7799f2SPaolo Bonzini  * This work is licensed under the terms of the GNU GPL, version 2 or later.
102d7799f2SPaolo Bonzini  * See the COPYING file in the top-level directory.
112d7799f2SPaolo Bonzini  */
122d7799f2SPaolo Bonzini 
13681c28a3SPeter Maydell #include "qemu/osdep.h"
142d7799f2SPaolo Bonzini 
1579ee7df8SPaolo Bonzini #include "qemu-common.h"
16da34e65cSMarkus Armbruster #include "qapi/error.h"
172d7799f2SPaolo Bonzini #include "qapi/string-output-visitor.h"
182d7799f2SPaolo Bonzini #include "test-qapi-types.h"
192d7799f2SPaolo Bonzini #include "test-qapi-visit.h"
207b1b5d19SPaolo Bonzini #include "qapi/qmp/types.h"
212d7799f2SPaolo Bonzini 
222d7799f2SPaolo Bonzini typedef struct TestOutputVisitorData {
232d7799f2SPaolo Bonzini     StringOutputVisitor *sov;
242d7799f2SPaolo Bonzini     Visitor *ov;
25b4900c0eSHu Tao     bool human;
262d7799f2SPaolo Bonzini } TestOutputVisitorData;
272d7799f2SPaolo Bonzini 
282d7799f2SPaolo Bonzini static void visitor_output_setup(TestOutputVisitorData *data,
292d7799f2SPaolo Bonzini                                  const void *unused)
302d7799f2SPaolo Bonzini {
31b4900c0eSHu Tao     data->human = false;
32b4900c0eSHu Tao     data->sov = string_output_visitor_new(data->human);
33b4900c0eSHu Tao     g_assert(data->sov != NULL);
34b4900c0eSHu Tao 
35b4900c0eSHu Tao     data->ov = string_output_get_visitor(data->sov);
36b4900c0eSHu Tao     g_assert(data->ov != NULL);
37b4900c0eSHu Tao }
38b4900c0eSHu Tao 
39b4900c0eSHu Tao static void visitor_output_setup_human(TestOutputVisitorData *data,
40b4900c0eSHu Tao                                        const void *unused)
41b4900c0eSHu Tao {
42b4900c0eSHu Tao     data->human = true;
43b4900c0eSHu Tao     data->sov = string_output_visitor_new(data->human);
442d7799f2SPaolo Bonzini     g_assert(data->sov != NULL);
452d7799f2SPaolo Bonzini 
462d7799f2SPaolo Bonzini     data->ov = string_output_get_visitor(data->sov);
472d7799f2SPaolo Bonzini     g_assert(data->ov != NULL);
482d7799f2SPaolo Bonzini }
492d7799f2SPaolo Bonzini 
502d7799f2SPaolo Bonzini static void visitor_output_teardown(TestOutputVisitorData *data,
512d7799f2SPaolo Bonzini                                     const void *unused)
522d7799f2SPaolo Bonzini {
53*e7ca5656SEric Blake     visit_free(data->ov);
542d7799f2SPaolo Bonzini     data->sov = NULL;
552d7799f2SPaolo Bonzini     data->ov = NULL;
562d7799f2SPaolo Bonzini }
572d7799f2SPaolo Bonzini 
582d7799f2SPaolo Bonzini static void test_visitor_out_int(TestOutputVisitorData *data,
592d7799f2SPaolo Bonzini                                  const void *unused)
602d7799f2SPaolo Bonzini {
6169e25563SHu Tao     int64_t value = 42;
62e940f543SMarkus Armbruster     Error *err = NULL;
632d7799f2SPaolo Bonzini     char *str;
642d7799f2SPaolo Bonzini 
6551e72bc1SEric Blake     visit_type_int(data->ov, NULL, &value, &err);
66e940f543SMarkus Armbruster     g_assert(!err);
672d7799f2SPaolo Bonzini 
682d7799f2SPaolo Bonzini     str = string_output_get_string(data->sov);
692d7799f2SPaolo Bonzini     g_assert(str != NULL);
70b4900c0eSHu Tao     if (data->human) {
71b4900c0eSHu Tao         g_assert_cmpstr(str, ==, "42 (0x2a)");
72b4900c0eSHu Tao     } else {
7369e25563SHu Tao         g_assert_cmpstr(str, ==, "42");
74b4900c0eSHu Tao     }
752d7799f2SPaolo Bonzini     g_free(str);
762d7799f2SPaolo Bonzini }
772d7799f2SPaolo Bonzini 
7869e25563SHu Tao static void test_visitor_out_intList(TestOutputVisitorData *data,
7969e25563SHu Tao                                      const void *unused)
8069e25563SHu Tao {
8169e25563SHu Tao     int64_t value[] = {0, 1, 9, 10, 16, 15, 14,
8269e25563SHu Tao         3, 4, 5, 6, 11, 12, 13, 21, 22, INT64_MAX - 1, INT64_MAX};
8369e25563SHu Tao     intList *list = NULL, **tmp = &list;
8469e25563SHu Tao     int i;
85533fdaedSMarkus Armbruster     Error *err = NULL;
8669e25563SHu Tao     char *str;
8769e25563SHu Tao 
8869e25563SHu Tao     for (i = 0; i < sizeof(value) / sizeof(value[0]); i++) {
8969e25563SHu Tao         *tmp = g_malloc0(sizeof(**tmp));
9069e25563SHu Tao         (*tmp)->value = value[i];
9169e25563SHu Tao         tmp = &(*tmp)->next;
9269e25563SHu Tao     }
9369e25563SHu Tao 
9451e72bc1SEric Blake     visit_type_intList(data->ov, NULL, &list, &err);
95533fdaedSMarkus Armbruster     g_assert(err == NULL);
9669e25563SHu Tao 
9769e25563SHu Tao     str = string_output_get_string(data->sov);
9869e25563SHu Tao     g_assert(str != NULL);
99b4900c0eSHu Tao     if (data->human) {
100b4900c0eSHu Tao         g_assert_cmpstr(str, ==,
101b4900c0eSHu Tao             "0-1,3-6,9-16,21-22,9223372036854775806-9223372036854775807 "
102b4900c0eSHu Tao             "(0x0-0x1,0x3-0x6,0x9-0x10,0x15-0x16,"
103b4900c0eSHu Tao             "0x7ffffffffffffffe-0x7fffffffffffffff)");
104b4900c0eSHu Tao     } else {
10569e25563SHu Tao         g_assert_cmpstr(str, ==,
10669e25563SHu Tao             "0-1,3-6,9-16,21-22,9223372036854775806-9223372036854775807");
107b4900c0eSHu Tao     }
10869e25563SHu Tao     g_free(str);
10969e25563SHu Tao     while (list) {
11069e25563SHu Tao         intList *tmp2;
11169e25563SHu Tao         tmp2 = list->next;
11269e25563SHu Tao         g_free(list);
11369e25563SHu Tao         list = tmp2;
11469e25563SHu Tao     }
11569e25563SHu Tao }
11669e25563SHu Tao 
1172d7799f2SPaolo Bonzini static void test_visitor_out_bool(TestOutputVisitorData *data,
1182d7799f2SPaolo Bonzini                                   const void *unused)
1192d7799f2SPaolo Bonzini {
120e940f543SMarkus Armbruster     Error *err = NULL;
1212d7799f2SPaolo Bonzini     bool value = true;
1222d7799f2SPaolo Bonzini     char *str;
1232d7799f2SPaolo Bonzini 
12451e72bc1SEric Blake     visit_type_bool(data->ov, NULL, &value, &err);
125e940f543SMarkus Armbruster     g_assert(!err);
1262d7799f2SPaolo Bonzini 
1272d7799f2SPaolo Bonzini     str = string_output_get_string(data->sov);
1282d7799f2SPaolo Bonzini     g_assert(str != NULL);
1292d7799f2SPaolo Bonzini     g_assert_cmpstr(str, ==, "true");
1302d7799f2SPaolo Bonzini     g_free(str);
1312d7799f2SPaolo Bonzini }
1322d7799f2SPaolo Bonzini 
1332d7799f2SPaolo Bonzini static void test_visitor_out_number(TestOutputVisitorData *data,
1342d7799f2SPaolo Bonzini                                     const void *unused)
1352d7799f2SPaolo Bonzini {
1362d7799f2SPaolo Bonzini     double value = 3.14;
137e940f543SMarkus Armbruster     Error *err = NULL;
1382d7799f2SPaolo Bonzini     char *str;
1392d7799f2SPaolo Bonzini 
14051e72bc1SEric Blake     visit_type_number(data->ov, NULL, &value, &err);
141e940f543SMarkus Armbruster     g_assert(!err);
1422d7799f2SPaolo Bonzini 
1432d7799f2SPaolo Bonzini     str = string_output_get_string(data->sov);
1442d7799f2SPaolo Bonzini     g_assert(str != NULL);
145173bbb75SMichael Roth     g_assert_cmpstr(str, ==, "3.140000");
1462d7799f2SPaolo Bonzini     g_free(str);
1472d7799f2SPaolo Bonzini }
1482d7799f2SPaolo Bonzini 
1492d7799f2SPaolo Bonzini static void test_visitor_out_string(TestOutputVisitorData *data,
1502d7799f2SPaolo Bonzini                                     const void *unused)
1512d7799f2SPaolo Bonzini {
1522d7799f2SPaolo Bonzini     char *string = (char *) "Q E M U";
153b4900c0eSHu Tao     const char *string_human = "\"Q E M U\"";
154e940f543SMarkus Armbruster     Error *err = NULL;
1552d7799f2SPaolo Bonzini     char *str;
1562d7799f2SPaolo Bonzini 
15751e72bc1SEric Blake     visit_type_str(data->ov, NULL, &string, &err);
158e940f543SMarkus Armbruster     g_assert(!err);
1592d7799f2SPaolo Bonzini 
1602d7799f2SPaolo Bonzini     str = string_output_get_string(data->sov);
1612d7799f2SPaolo Bonzini     g_assert(str != NULL);
162b4900c0eSHu Tao     if (data->human) {
163b4900c0eSHu Tao         g_assert_cmpstr(str, ==, string_human);
164b4900c0eSHu Tao     } else {
1652d7799f2SPaolo Bonzini         g_assert_cmpstr(str, ==, string);
166b4900c0eSHu Tao     }
1672d7799f2SPaolo Bonzini     g_free(str);
1682d7799f2SPaolo Bonzini }
1692d7799f2SPaolo Bonzini 
1702d7799f2SPaolo Bonzini static void test_visitor_out_no_string(TestOutputVisitorData *data,
1712d7799f2SPaolo Bonzini                                        const void *unused)
1722d7799f2SPaolo Bonzini {
1732d7799f2SPaolo Bonzini     char *string = NULL;
174e940f543SMarkus Armbruster     Error *err = NULL;
1752d7799f2SPaolo Bonzini     char *str;
1762d7799f2SPaolo Bonzini 
1772d7799f2SPaolo Bonzini     /* A null string should return "" */
17851e72bc1SEric Blake     visit_type_str(data->ov, NULL, &string, &err);
179e940f543SMarkus Armbruster     g_assert(!err);
1802d7799f2SPaolo Bonzini 
1812d7799f2SPaolo Bonzini     str = string_output_get_string(data->sov);
1822d7799f2SPaolo Bonzini     g_assert(str != NULL);
183b4900c0eSHu Tao     if (data->human) {
184b4900c0eSHu Tao         g_assert_cmpstr(str, ==, "<null>");
185b4900c0eSHu Tao     } else {
1862d7799f2SPaolo Bonzini         g_assert_cmpstr(str, ==, "");
187b4900c0eSHu Tao     }
1882d7799f2SPaolo Bonzini     g_free(str);
1892d7799f2SPaolo Bonzini }
1902d7799f2SPaolo Bonzini 
1912d7799f2SPaolo Bonzini static void test_visitor_out_enum(TestOutputVisitorData *data,
1922d7799f2SPaolo Bonzini                                   const void *unused)
1932d7799f2SPaolo Bonzini {
194e940f543SMarkus Armbruster     Error *err = NULL;
1952d7799f2SPaolo Bonzini     char *str;
1962d7799f2SPaolo Bonzini     EnumOne i;
1972d7799f2SPaolo Bonzini 
1987fb1cf16SEric Blake     for (i = 0; i < ENUM_ONE__MAX; i++) {
199b4900c0eSHu Tao         char *str_human;
200b4900c0eSHu Tao 
20151e72bc1SEric Blake         visit_type_EnumOne(data->ov, "unused", &i, &err);
202e940f543SMarkus Armbruster         g_assert(!err);
2032d7799f2SPaolo Bonzini 
2049e99c5fdSAndreas Färber         str_human = g_strdup_printf("\"%s\"", EnumOne_lookup[i]);
205b4900c0eSHu Tao 
2062d7799f2SPaolo Bonzini         str = string_output_get_string(data->sov);
2072d7799f2SPaolo Bonzini         g_assert(str != NULL);
208b4900c0eSHu Tao         if (data->human) {
209b4900c0eSHu Tao             g_assert_cmpstr(str, ==, str_human);
210b4900c0eSHu Tao         } else {
2112d7799f2SPaolo Bonzini             g_assert_cmpstr(str, ==, EnumOne_lookup[i]);
212b4900c0eSHu Tao         }
213b4900c0eSHu Tao         g_free(str_human);
2142d7799f2SPaolo Bonzini 	g_free(str);
2152d7799f2SPaolo Bonzini     }
2162d7799f2SPaolo Bonzini }
2172d7799f2SPaolo Bonzini 
2182d7799f2SPaolo Bonzini static void test_visitor_out_enum_errors(TestOutputVisitorData *data,
2192d7799f2SPaolo Bonzini                                          const void *unused)
2202d7799f2SPaolo Bonzini {
2217fb1cf16SEric Blake     EnumOne i, bad_values[] = { ENUM_ONE__MAX, -1 };
222e940f543SMarkus Armbruster     Error *err;
2232d7799f2SPaolo Bonzini 
2242d7799f2SPaolo Bonzini     for (i = 0; i < ARRAY_SIZE(bad_values) ; i++) {
225e940f543SMarkus Armbruster         err = NULL;
22651e72bc1SEric Blake         visit_type_EnumOne(data->ov, "unused", &bad_values[i], &err);
227e940f543SMarkus Armbruster         g_assert(err);
228e940f543SMarkus Armbruster         error_free(err);
2292d7799f2SPaolo Bonzini     }
2302d7799f2SPaolo Bonzini }
2312d7799f2SPaolo Bonzini 
232b4900c0eSHu Tao static void
233b4900c0eSHu Tao output_visitor_test_add(const char *testpath,
2342d7799f2SPaolo Bonzini                         TestOutputVisitorData *data,
235b4900c0eSHu Tao                         void (*test_func)(TestOutputVisitorData *data,
236b4900c0eSHu Tao                                           const void *user_data),
237b4900c0eSHu Tao                         bool human)
2382d7799f2SPaolo Bonzini {
239b4900c0eSHu Tao     g_test_add(testpath, TestOutputVisitorData, data,
240b4900c0eSHu Tao                human ? visitor_output_setup_human : visitor_output_setup,
2412d7799f2SPaolo Bonzini                test_func, visitor_output_teardown);
2422d7799f2SPaolo Bonzini }
2432d7799f2SPaolo Bonzini 
2442d7799f2SPaolo Bonzini int main(int argc, char **argv)
2452d7799f2SPaolo Bonzini {
2462d7799f2SPaolo Bonzini     TestOutputVisitorData out_visitor_data;
2472d7799f2SPaolo Bonzini 
2482d7799f2SPaolo Bonzini     g_test_init(&argc, &argv, NULL);
2492d7799f2SPaolo Bonzini 
2502d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/int",
251b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_int, false);
252deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/int-human",
253b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_int, true);
2542d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/bool",
255b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_bool, false);
256deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/bool-human",
257b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_bool, true);
2582d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/number",
259b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_number, false);
260deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/number-human",
261b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_number, true);
2622d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/string",
263b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_string, false);
264deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/string-human",
265b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_string, true);
2662d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/no-string",
267b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_no_string,
268b4900c0eSHu Tao                             false);
269deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/no-string-human",
270b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_no_string,
271b4900c0eSHu Tao                             true);
2722d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/enum",
273b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum, false);
274deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/enum-human",
275b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum, true);
2762d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/enum-errors",
277b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum_errors,
278b4900c0eSHu Tao                             false);
279deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/enum-errors-human",
280b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum_errors,
281b4900c0eSHu Tao                             true);
28269e25563SHu Tao     output_visitor_test_add("/string-visitor/output/intList",
283b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_intList, false);
284deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/intList-human",
285b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_intList, true);
2862d7799f2SPaolo Bonzini 
2872d7799f2SPaolo Bonzini     g_test_run();
2882d7799f2SPaolo Bonzini 
2892d7799f2SPaolo Bonzini     return 0;
2902d7799f2SPaolo Bonzini }
291