xref: /qemu/tests/unit/test-string-output-visitor.c (revision d40d74a645feea0ad01482da2358804f6574dce0)
12d7799f2SPaolo Bonzini /*
22d7799f2SPaolo Bonzini  * String Output Visitor unit-tests.
32d7799f2SPaolo Bonzini  *
42d7799f2SPaolo Bonzini  * Copyright (C) 2012 Red Hat Inc.
52d7799f2SPaolo Bonzini  *
62d7799f2SPaolo Bonzini  * Authors:
7b3db211fSDaniel P. Berrange  *  Paolo Bonzini <pbonzini@redhat.com> (based on test-qobject-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-visit.h"
192d7799f2SPaolo Bonzini 
202d7799f2SPaolo Bonzini typedef struct TestOutputVisitorData {
212d7799f2SPaolo Bonzini     Visitor *ov;
2223d1705fSEric Blake     char *str;
23b4900c0eSHu Tao     bool human;
242d7799f2SPaolo Bonzini } TestOutputVisitorData;
252d7799f2SPaolo Bonzini 
26a8fff94dSEric Blake static void visitor_output_setup_internal(TestOutputVisitorData *data,
27a8fff94dSEric Blake                                           bool human)
28a8fff94dSEric Blake {
29a8fff94dSEric Blake     data->human = human;
303b098d56SEric Blake     data->ov = string_output_visitor_new(human, &data->str);
31a8fff94dSEric Blake     g_assert(data->ov);
32a8fff94dSEric Blake }
33a8fff94dSEric Blake 
342d7799f2SPaolo Bonzini static void visitor_output_setup(TestOutputVisitorData *data,
352d7799f2SPaolo Bonzini                                  const void *unused)
362d7799f2SPaolo Bonzini {
37a8fff94dSEric Blake     return visitor_output_setup_internal(data, false);
38b4900c0eSHu Tao }
39b4900c0eSHu Tao 
40b4900c0eSHu Tao static void visitor_output_setup_human(TestOutputVisitorData *data,
41b4900c0eSHu Tao                                        const void *unused)
42b4900c0eSHu Tao {
43a8fff94dSEric Blake     return visitor_output_setup_internal(data, true);
442d7799f2SPaolo Bonzini }
452d7799f2SPaolo Bonzini 
462d7799f2SPaolo Bonzini static void visitor_output_teardown(TestOutputVisitorData *data,
472d7799f2SPaolo Bonzini                                     const void *unused)
482d7799f2SPaolo Bonzini {
49e7ca5656SEric Blake     visit_free(data->ov);
502d7799f2SPaolo Bonzini     data->ov = NULL;
5123d1705fSEric Blake     g_free(data->str);
5223d1705fSEric Blake     data->str = NULL;
5323d1705fSEric Blake }
5423d1705fSEric Blake 
5523d1705fSEric Blake static char *visitor_get(TestOutputVisitorData *data)
5623d1705fSEric Blake {
573b098d56SEric Blake     visit_complete(data->ov, &data->str);
5823d1705fSEric Blake     g_assert(data->str);
5923d1705fSEric Blake     return data->str;
602d7799f2SPaolo Bonzini }
612d7799f2SPaolo Bonzini 
62a8fff94dSEric Blake static void visitor_reset(TestOutputVisitorData *data)
63a8fff94dSEric Blake {
64a8fff94dSEric Blake     bool human = data->human;
65a8fff94dSEric Blake 
66a8fff94dSEric Blake     visitor_output_teardown(data, NULL);
67a8fff94dSEric Blake     visitor_output_setup_internal(data, human);
68a8fff94dSEric Blake }
69a8fff94dSEric Blake 
702d7799f2SPaolo Bonzini static void test_visitor_out_int(TestOutputVisitorData *data,
712d7799f2SPaolo Bonzini                                  const void *unused)
722d7799f2SPaolo Bonzini {
7369e25563SHu Tao     int64_t value = 42;
74e940f543SMarkus Armbruster     Error *err = NULL;
752d7799f2SPaolo Bonzini     char *str;
762d7799f2SPaolo Bonzini 
7751e72bc1SEric Blake     visit_type_int(data->ov, NULL, &value, &err);
78e940f543SMarkus Armbruster     g_assert(!err);
792d7799f2SPaolo Bonzini 
8023d1705fSEric Blake     str = visitor_get(data);
81b4900c0eSHu Tao     if (data->human) {
82b4900c0eSHu Tao         g_assert_cmpstr(str, ==, "42 (0x2a)");
83b4900c0eSHu Tao     } else {
8469e25563SHu Tao         g_assert_cmpstr(str, ==, "42");
85b4900c0eSHu Tao     }
862d7799f2SPaolo Bonzini }
872d7799f2SPaolo Bonzini 
8869e25563SHu Tao static void test_visitor_out_intList(TestOutputVisitorData *data,
8969e25563SHu Tao                                      const void *unused)
9069e25563SHu Tao {
9169e25563SHu Tao     int64_t value[] = {0, 1, 9, 10, 16, 15, 14,
9269e25563SHu Tao         3, 4, 5, 6, 11, 12, 13, 21, 22, INT64_MAX - 1, INT64_MAX};
9369e25563SHu Tao     intList *list = NULL, **tmp = &list;
9469e25563SHu Tao     int i;
95533fdaedSMarkus Armbruster     Error *err = NULL;
9669e25563SHu Tao     char *str;
9769e25563SHu Tao 
98*d40d74a6SPhilippe Mathieu-Daudé     for (i = 0; i < ARRAY_SIZE(value); i++) {
9969e25563SHu Tao         *tmp = g_malloc0(sizeof(**tmp));
10069e25563SHu Tao         (*tmp)->value = value[i];
10169e25563SHu Tao         tmp = &(*tmp)->next;
10269e25563SHu Tao     }
10369e25563SHu Tao 
10451e72bc1SEric Blake     visit_type_intList(data->ov, NULL, &list, &err);
105533fdaedSMarkus Armbruster     g_assert(err == NULL);
10669e25563SHu Tao 
10723d1705fSEric Blake     str = visitor_get(data);
108b4900c0eSHu Tao     if (data->human) {
109b4900c0eSHu Tao         g_assert_cmpstr(str, ==,
110b4900c0eSHu Tao             "0-1,3-6,9-16,21-22,9223372036854775806-9223372036854775807 "
111b4900c0eSHu Tao             "(0x0-0x1,0x3-0x6,0x9-0x10,0x15-0x16,"
112b4900c0eSHu Tao             "0x7ffffffffffffffe-0x7fffffffffffffff)");
113b4900c0eSHu Tao     } else {
11469e25563SHu Tao         g_assert_cmpstr(str, ==,
11569e25563SHu Tao             "0-1,3-6,9-16,21-22,9223372036854775806-9223372036854775807");
116b4900c0eSHu Tao     }
117a8fff94dSEric Blake     qapi_free_intList(list);
11869e25563SHu Tao }
11969e25563SHu Tao 
1202d7799f2SPaolo Bonzini static void test_visitor_out_bool(TestOutputVisitorData *data,
1212d7799f2SPaolo Bonzini                                   const void *unused)
1222d7799f2SPaolo Bonzini {
123e940f543SMarkus Armbruster     Error *err = NULL;
1242d7799f2SPaolo Bonzini     bool value = true;
1252d7799f2SPaolo Bonzini     char *str;
1262d7799f2SPaolo Bonzini 
12751e72bc1SEric Blake     visit_type_bool(data->ov, NULL, &value, &err);
128e940f543SMarkus Armbruster     g_assert(!err);
1292d7799f2SPaolo Bonzini 
13023d1705fSEric Blake     str = visitor_get(data);
1312d7799f2SPaolo Bonzini     g_assert_cmpstr(str, ==, "true");
1322d7799f2SPaolo Bonzini }
1332d7799f2SPaolo Bonzini 
1342d7799f2SPaolo Bonzini static void test_visitor_out_number(TestOutputVisitorData *data,
1352d7799f2SPaolo Bonzini                                     const void *unused)
1362d7799f2SPaolo Bonzini {
1372d7799f2SPaolo Bonzini     double value = 3.14;
138e940f543SMarkus Armbruster     Error *err = NULL;
1392d7799f2SPaolo Bonzini     char *str;
1402d7799f2SPaolo Bonzini 
14151e72bc1SEric Blake     visit_type_number(data->ov, NULL, &value, &err);
142e940f543SMarkus Armbruster     g_assert(!err);
1432d7799f2SPaolo Bonzini 
14423d1705fSEric Blake     str = visitor_get(data);
145173bbb75SMichael Roth     g_assert_cmpstr(str, ==, "3.140000");
1462d7799f2SPaolo Bonzini }
1472d7799f2SPaolo Bonzini 
1482d7799f2SPaolo Bonzini static void test_visitor_out_string(TestOutputVisitorData *data,
1492d7799f2SPaolo Bonzini                                     const void *unused)
1502d7799f2SPaolo Bonzini {
1512d7799f2SPaolo Bonzini     char *string = (char *) "Q E M U";
152b4900c0eSHu Tao     const char *string_human = "\"Q E M U\"";
153e940f543SMarkus Armbruster     Error *err = NULL;
1542d7799f2SPaolo Bonzini     char *str;
1552d7799f2SPaolo Bonzini 
15651e72bc1SEric Blake     visit_type_str(data->ov, NULL, &string, &err);
157e940f543SMarkus Armbruster     g_assert(!err);
1582d7799f2SPaolo Bonzini 
15923d1705fSEric Blake     str = visitor_get(data);
160b4900c0eSHu Tao     if (data->human) {
161b4900c0eSHu Tao         g_assert_cmpstr(str, ==, string_human);
162b4900c0eSHu Tao     } else {
1632d7799f2SPaolo Bonzini         g_assert_cmpstr(str, ==, string);
164b4900c0eSHu Tao     }
1652d7799f2SPaolo Bonzini }
1662d7799f2SPaolo Bonzini 
1672d7799f2SPaolo Bonzini static void test_visitor_out_no_string(TestOutputVisitorData *data,
1682d7799f2SPaolo Bonzini                                        const void *unused)
1692d7799f2SPaolo Bonzini {
1702d7799f2SPaolo Bonzini     char *string = NULL;
1712d7799f2SPaolo Bonzini     char *str;
1722d7799f2SPaolo Bonzini 
1732d7799f2SPaolo Bonzini     /* A null string should return "" */
174a8fff94dSEric Blake     visit_type_str(data->ov, NULL, &string, &error_abort);
1752d7799f2SPaolo Bonzini 
17623d1705fSEric Blake     str = visitor_get(data);
177b4900c0eSHu Tao     if (data->human) {
178b4900c0eSHu Tao         g_assert_cmpstr(str, ==, "<null>");
179b4900c0eSHu Tao     } else {
1802d7799f2SPaolo Bonzini         g_assert_cmpstr(str, ==, "");
181b4900c0eSHu Tao     }
1822d7799f2SPaolo Bonzini }
1832d7799f2SPaolo Bonzini 
1842d7799f2SPaolo Bonzini static void test_visitor_out_enum(TestOutputVisitorData *data,
1852d7799f2SPaolo Bonzini                                   const void *unused)
1862d7799f2SPaolo Bonzini {
1872d7799f2SPaolo Bonzini     char *str;
1882d7799f2SPaolo Bonzini     EnumOne i;
1892d7799f2SPaolo Bonzini 
1907fb1cf16SEric Blake     for (i = 0; i < ENUM_ONE__MAX; i++) {
191a8fff94dSEric Blake         visit_type_EnumOne(data->ov, "unused", &i, &error_abort);
192b4900c0eSHu Tao 
19323d1705fSEric Blake         str = visitor_get(data);
194b4900c0eSHu Tao         if (data->human) {
195977c736fSMarkus Armbruster             char *str_human = g_strdup_printf("\"%s\"", EnumOne_str(i));
196a8fff94dSEric Blake 
197b4900c0eSHu Tao             g_assert_cmpstr(str, ==, str_human);
198a8fff94dSEric Blake             g_free(str_human);
199b4900c0eSHu Tao         } else {
200977c736fSMarkus Armbruster             g_assert_cmpstr(str, ==, EnumOne_str(i));
201b4900c0eSHu Tao         }
202a8fff94dSEric Blake         visitor_reset(data);
2032d7799f2SPaolo Bonzini     }
2042d7799f2SPaolo Bonzini }
2052d7799f2SPaolo Bonzini 
2062d7799f2SPaolo Bonzini static void test_visitor_out_enum_errors(TestOutputVisitorData *data,
2072d7799f2SPaolo Bonzini                                          const void *unused)
2082d7799f2SPaolo Bonzini {
2097fb1cf16SEric Blake     EnumOne i, bad_values[] = { ENUM_ONE__MAX, -1 };
210e940f543SMarkus Armbruster     Error *err;
2112d7799f2SPaolo Bonzini 
2122d7799f2SPaolo Bonzini     for (i = 0; i < ARRAY_SIZE(bad_values) ; i++) {
213e940f543SMarkus Armbruster         err = NULL;
21451e72bc1SEric Blake         visit_type_EnumOne(data->ov, "unused", &bad_values[i], &err);
215a8fff94dSEric Blake         error_free_or_abort(&err);
2162d7799f2SPaolo Bonzini     }
2172d7799f2SPaolo Bonzini }
2182d7799f2SPaolo Bonzini 
219b4900c0eSHu Tao static void
220b4900c0eSHu Tao output_visitor_test_add(const char *testpath,
2212d7799f2SPaolo Bonzini                         TestOutputVisitorData *data,
222b4900c0eSHu Tao                         void (*test_func)(TestOutputVisitorData *data,
223b4900c0eSHu Tao                                           const void *user_data),
224b4900c0eSHu Tao                         bool human)
2252d7799f2SPaolo Bonzini {
226b4900c0eSHu Tao     g_test_add(testpath, TestOutputVisitorData, data,
227b4900c0eSHu Tao                human ? visitor_output_setup_human : visitor_output_setup,
2282d7799f2SPaolo Bonzini                test_func, visitor_output_teardown);
2292d7799f2SPaolo Bonzini }
2302d7799f2SPaolo Bonzini 
2312d7799f2SPaolo Bonzini int main(int argc, char **argv)
2322d7799f2SPaolo Bonzini {
2332d7799f2SPaolo Bonzini     TestOutputVisitorData out_visitor_data;
2342d7799f2SPaolo Bonzini 
2352d7799f2SPaolo Bonzini     g_test_init(&argc, &argv, NULL);
2362d7799f2SPaolo Bonzini 
2372d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/int",
238b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_int, false);
239deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/int-human",
240b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_int, true);
2412d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/bool",
242b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_bool, false);
243deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/bool-human",
244b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_bool, true);
2452d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/number",
246b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_number, false);
247deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/number-human",
248b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_number, true);
2492d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/string",
250b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_string, false);
251deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/string-human",
252b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_string, true);
2532d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/no-string",
254b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_no_string,
255b4900c0eSHu Tao                             false);
256deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/no-string-human",
257b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_no_string,
258b4900c0eSHu Tao                             true);
2592d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/enum",
260b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum, false);
261deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/enum-human",
262b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum, true);
2632d7799f2SPaolo Bonzini     output_visitor_test_add("/string-visitor/output/enum-errors",
264b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum_errors,
265b4900c0eSHu Tao                             false);
266deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/enum-errors-human",
267b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_enum_errors,
268b4900c0eSHu Tao                             true);
26969e25563SHu Tao     output_visitor_test_add("/string-visitor/output/intList",
270b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_intList, false);
271deb847bfSDr. David Alan Gilbert     output_visitor_test_add("/string-visitor/output/intList-human",
272b4900c0eSHu Tao                             &out_visitor_data, test_visitor_out_intList, true);
2732d7799f2SPaolo Bonzini 
2742d7799f2SPaolo Bonzini     g_test_run();
2752d7799f2SPaolo Bonzini 
2762d7799f2SPaolo Bonzini     return 0;
2772d7799f2SPaolo Bonzini }
278