2 * Options Visitor unit-tests.
4 * Copyright (C) 2013 Red Hat, Inc.
7 * Laszlo Ersek <lersek@redhat.com> (based on test-string-output-visitor)
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.
13 #include "qemu/osdep.h"
15 #include "qemu/config-file.h" /* qemu_add_opts() */
16 #include "qemu/option.h" /* qemu_opts_parse() */
17 #include "qapi/error.h"
18 #include "qapi/opts-visitor.h" /* opts_visitor_new() */
19 #include "test-qapi-visit.h" /* visit_type_UserDefOptions() */
21 static QemuOptsList userdef_opts
= {
23 .head
= QTAILQ_HEAD_INITIALIZER(userdef_opts
.head
),
24 .desc
= { { 0 } } /* validated with OptsVisitor */
27 /* fixture (= glib test case context) and test case manipulation */
29 typedef struct OptsVisitorFixture
{
30 UserDefOptions
*userdef
;
36 setup_fixture(OptsVisitorFixture
*f
, gconstpointer test_data
)
38 const char *opts_string
= test_data
;
42 opts
= qemu_opts_parse(qemu_find_opts("userdef"), opts_string
, false,
44 g_assert(opts
!= NULL
);
46 v
= opts_visitor_new(opts
);
47 visit_type_UserDefOptions(v
, NULL
, &f
->userdef
, &f
->err
);
54 teardown_fixture(OptsVisitorFixture
*f
, gconstpointer test_data
)
56 qapi_free_UserDefOptions(f
->userdef
);
62 add_test(const char *testpath
,
63 void (*test_func
)(OptsVisitorFixture
*f
, gconstpointer test_data
),
64 gconstpointer test_data
)
66 g_test_add(testpath
, OptsVisitorFixture
, test_data
, setup_fixture
,
67 test_func
, teardown_fixture
);
70 /* test output evaluation */
73 expect_ok(OptsVisitorFixture
*f
, gconstpointer test_data
)
75 g_assert(f
->err
== NULL
);
76 g_assert(f
->userdef
!= NULL
);
81 expect_fail(OptsVisitorFixture
*f
, gconstpointer test_data
)
83 g_assert(f
->err
!= NULL
);
85 /* The error message is printed when this test utility is invoked directly
86 * (ie. without gtester) and the --verbose flag is passed:
88 * tests/test-opts-visitor --verbose
90 g_test_message("'%s': %s", (const char *)test_data
,
91 error_get_pretty(f
->err
));
96 test_value(OptsVisitorFixture
*f
, gconstpointer test_data
)
98 uint64_t magic
, bitval
;
103 expect_ok(f
, test_data
);
106 for (i64
= f
->userdef
->i64
; i64
!= NULL
; i64
= i64
->next
) {
107 g_assert(-16 <= i64
->value
&& i64
->value
< 64-16);
108 bitval
= 1ull << (i64
->value
+ 16);
109 g_assert((magic
& bitval
) == 0);
112 g_assert(magic
== 0xDEADBEEF);
115 for (u64
= f
->userdef
->u64
; u64
!= NULL
; u64
= u64
->next
) {
116 g_assert(u64
->value
< 64);
117 bitval
= 1ull << u64
->value
;
118 g_assert((magic
& bitval
) == 0);
121 g_assert(magic
== 0xBADC0FFEE0DDF00DULL
);
124 for (u16
= f
->userdef
->u16
; u16
!= NULL
; u16
= u16
->next
) {
125 g_assert(u16
->value
< 64);
126 bitval
= 1ull << u16
->value
;
127 g_assert((magic
& bitval
) == 0);
130 g_assert(magic
== 0xD15EA5E);
135 expect_i64_min(OptsVisitorFixture
*f
, gconstpointer test_data
)
137 expect_ok(f
, test_data
);
138 g_assert(f
->userdef
->has_i64
);
139 g_assert(f
->userdef
->i64
->next
== NULL
);
140 g_assert(f
->userdef
->i64
->value
== INT64_MIN
);
145 expect_i64_max(OptsVisitorFixture
*f
, gconstpointer test_data
)
147 expect_ok(f
, test_data
);
148 g_assert(f
->userdef
->has_i64
);
149 g_assert(f
->userdef
->i64
->next
== NULL
);
150 g_assert(f
->userdef
->i64
->value
== INT64_MAX
);
155 expect_zero(OptsVisitorFixture
*f
, gconstpointer test_data
)
157 expect_ok(f
, test_data
);
158 g_assert(f
->userdef
->has_u64
);
159 g_assert(f
->userdef
->u64
->next
== NULL
);
160 g_assert(f
->userdef
->u64
->value
== 0);
165 expect_u64_max(OptsVisitorFixture
*f
, gconstpointer test_data
)
167 expect_ok(f
, test_data
);
168 g_assert(f
->userdef
->has_u64
);
169 g_assert(f
->userdef
->u64
->next
== NULL
);
170 g_assert(f
->userdef
->u64
->value
== UINT64_MAX
);
176 test_opts_range_unvisited(void)
179 intList
*list
= NULL
;
184 opts
= qemu_opts_parse(qemu_find_opts("userdef"), "ilist=0-2", false,
187 v
= opts_visitor_new(opts
);
189 visit_start_struct(v
, NULL
, NULL
, 0, &error_abort
);
191 /* Would be simpler if the visitor genuinely supported virtual walks */
192 visit_start_list(v
, "ilist", (GenericList
**)&list
, sizeof(*list
),
195 visit_type_int(v
, NULL
, &tail
->value
, &error_abort
);
196 g_assert_cmpint(tail
->value
, ==, 0);
197 tail
= (intList
*)visit_next_list(v
, (GenericList
*)tail
, sizeof(*list
));
199 visit_type_int(v
, NULL
, &tail
->value
, &error_abort
);
200 g_assert_cmpint(tail
->value
, ==, 1);
201 tail
= (intList
*)visit_next_list(v
, (GenericList
*)tail
, sizeof(*list
));
203 visit_check_list(v
, &error_abort
); /* unvisited tail ignored until... */
204 visit_end_list(v
, (void **)&list
);
206 visit_check_struct(v
, &err
); /* ...here */
207 error_free_or_abort(&err
);
208 visit_end_struct(v
, NULL
);
210 qapi_free_intList(list
);
216 test_opts_range_beyond(void)
219 intList
*list
= NULL
;
225 opts
= qemu_opts_parse(qemu_find_opts("userdef"), "ilist=0", false,
228 v
= opts_visitor_new(opts
);
230 visit_start_struct(v
, NULL
, NULL
, 0, &error_abort
);
232 /* Would be simpler if the visitor genuinely supported virtual walks */
233 visit_start_list(v
, "ilist", (GenericList
**)&list
, sizeof(*list
),
236 visit_type_int(v
, NULL
, &tail
->value
, &error_abort
);
237 g_assert_cmpint(tail
->value
, ==, 0);
238 tail
= (intList
*)visit_next_list(v
, (GenericList
*)tail
, sizeof(*tail
));
240 visit_type_int(v
, NULL
, &val
, &err
);
241 error_free_or_abort(&err
);
242 visit_end_list(v
, (void **)&list
);
244 visit_check_struct(v
, &error_abort
);
245 visit_end_struct(v
, NULL
);
247 qapi_free_intList(list
);
253 test_opts_dict_unvisited(void)
258 UserDefOptions
*userdef
;
260 opts
= qemu_opts_parse(qemu_find_opts("userdef"), "i64x=0,bogus=1", false,
263 v
= opts_visitor_new(opts
);
264 visit_type_UserDefOptions(v
, NULL
, &userdef
, &err
);
265 error_free_or_abort(&err
);
272 main(int argc
, char **argv
)
274 g_test_init(&argc
, &argv
, NULL
);
276 qemu_add_opts(&userdef_opts
);
278 /* Three hexadecimal magic numbers, "dead beef", "bad coffee, odd food" and
280 * <http://en.wikipedia.org/wiki/Magic_number_%28programming%29>, were
281 * converted to binary and dissected into bit ranges. Each magic number is
282 * going to be recomposed using the lists called "i64", "u64" and "u16",
285 * (Note that these types pertain to the individual bit shift counts, not
286 * the magic numbers themselves; the intent is to exercise opts_type_int()
287 * and opts_type_uint64().)
289 * The "i64" shift counts have been decreased by 16 (decimal) in order to
290 * test negative values as well. Finally, the full list of QemuOpt elements
291 * has been permuted with "shuf".
293 * Both "i64" and "u64" have some (distinct) single-element ranges
294 * represented as both "a" and "a-a". "u16" is a special case of "i64" (see
295 * visit_type_uint16()), so it wouldn't add a separate test in this regard.
298 add_test("/visitor/opts/flatten/value", &test_value
,
299 "i64=-1-0,u64=12-16,u64=2-3,i64=-11--9,u64=57,u16=9,i64=5-5,"
300 "u16=1-4,u16=20,u64=63-63,i64=-16--13,u64=50-52,i64=14-15,u16=11,"
301 "i64=7,u16=18,i64=2-3,u16=6,u64=54-55,u64=0,u64=18-20,u64=33-43,"
302 "i64=9-12,u16=26-27,u64=59-61,u16=13-16,u64=29-31,u64=22-23,"
305 add_test("/visitor/opts/i64/val1/errno", &expect_fail
,
306 "i64=0x8000000000000000");
307 add_test("/visitor/opts/i64/val1/empty", &expect_fail
, "i64=");
308 add_test("/visitor/opts/i64/val1/trailing", &expect_fail
, "i64=5z");
309 add_test("/visitor/opts/i64/nonlist", &expect_fail
, "i64x=5-6");
310 add_test("/visitor/opts/i64/val2/errno", &expect_fail
,
311 "i64=0x7fffffffffffffff-0x8000000000000000");
312 add_test("/visitor/opts/i64/val2/empty", &expect_fail
, "i64=5-");
313 add_test("/visitor/opts/i64/val2/trailing", &expect_fail
, "i64=5-6z");
314 add_test("/visitor/opts/i64/range/empty", &expect_fail
, "i64=6-5");
315 add_test("/visitor/opts/i64/range/minval", &expect_i64_min
,
316 "i64=-0x8000000000000000--0x8000000000000000");
317 add_test("/visitor/opts/i64/range/maxval", &expect_i64_max
,
318 "i64=0x7fffffffffffffff-0x7fffffffffffffff");
320 add_test("/visitor/opts/u64/val1/errno", &expect_fail
, "u64=-1");
321 add_test("/visitor/opts/u64/val1/empty", &expect_fail
, "u64=");
322 add_test("/visitor/opts/u64/val1/trailing", &expect_fail
, "u64=5z");
323 add_test("/visitor/opts/u64/nonlist", &expect_fail
, "u64x=5-6");
324 add_test("/visitor/opts/u64/val2/errno", &expect_fail
,
325 "u64=0xffffffffffffffff-0x10000000000000000");
326 add_test("/visitor/opts/u64/val2/empty", &expect_fail
, "u64=5-");
327 add_test("/visitor/opts/u64/val2/trailing", &expect_fail
, "u64=5-6z");
328 add_test("/visitor/opts/u64/range/empty", &expect_fail
, "u64=6-5");
329 add_test("/visitor/opts/u64/range/minval", &expect_zero
, "u64=0-0");
330 add_test("/visitor/opts/u64/range/maxval", &expect_u64_max
,
331 "u64=0xffffffffffffffff-0xffffffffffffffff");
333 /* Test maximum range sizes. The macro value is open-coded here
334 * *intentionally*; the test case must use concrete values by design. If
335 * OPTS_VISITOR_RANGE_MAX is changed, the following values need to be
336 * recalculated as well. The assert and this comment should help with it.
338 g_assert(OPTS_VISITOR_RANGE_MAX
== 65536);
340 /* The unsigned case is simple, a u64-u64 difference can always be
341 * represented as a u64.
343 add_test("/visitor/opts/u64/range/max", &expect_ok
, "u64=0-65535");
344 add_test("/visitor/opts/u64/range/2big", &expect_fail
, "u64=0-65536");
346 /* The same cannot be said about an i64-i64 difference. */
347 add_test("/visitor/opts/i64/range/max/pos/a", &expect_ok
,
348 "i64=0x7fffffffffff0000-0x7fffffffffffffff");
349 add_test("/visitor/opts/i64/range/max/pos/b", &expect_ok
,
350 "i64=0x7ffffffffffeffff-0x7ffffffffffffffe");
351 add_test("/visitor/opts/i64/range/2big/pos", &expect_fail
,
352 "i64=0x7ffffffffffeffff-0x7fffffffffffffff");
353 add_test("/visitor/opts/i64/range/max/neg/a", &expect_ok
,
354 "i64=-0x8000000000000000--0x7fffffffffff0001");
355 add_test("/visitor/opts/i64/range/max/neg/b", &expect_ok
,
356 "i64=-0x7fffffffffffffff--0x7fffffffffff0000");
357 add_test("/visitor/opts/i64/range/2big/neg", &expect_fail
,
358 "i64=-0x8000000000000000--0x7fffffffffff0000");
359 add_test("/visitor/opts/i64/range/2big/full", &expect_fail
,
360 "i64=-0x8000000000000000-0x7fffffffffffffff");
362 g_test_add_func("/visitor/opts/range/unvisited",
363 test_opts_range_unvisited
);
364 g_test_add_func("/visitor/opts/range/beyond",
365 test_opts_range_beyond
);
367 g_test_add_func("/visitor/opts/dict/unvisited", test_opts_dict_unvisited
);