2014-06-18 08:43:29 +02:00
|
|
|
/*
|
|
|
|
* qapi event unit-tests.
|
|
|
|
*
|
|
|
|
* Copyright (c) 2014 Wenchao Xia
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Wenchao Xia <wenchaoqemu@gmail.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2016-02-08 19:08:51 +01:00
|
|
|
#include "qemu/osdep.h"
|
2014-06-18 08:43:29 +02:00
|
|
|
|
2021-03-18 16:55:12 +01:00
|
|
|
#include "qapi/compat-policy.h"
|
2018-02-01 12:18:31 +01:00
|
|
|
#include "qapi/error.h"
|
2018-02-01 12:18:35 +01:00
|
|
|
#include "qapi/qmp/qbool.h"
|
2018-02-01 12:18:39 +01:00
|
|
|
#include "qapi/qmp/qdict.h"
|
2020-03-17 12:54:33 +01:00
|
|
|
#include "qapi/qmp/qjson.h"
|
2018-02-01 12:18:36 +01:00
|
|
|
#include "qapi/qmp/qnum.h"
|
2018-02-01 12:18:35 +01:00
|
|
|
#include "qapi/qmp/qstring.h"
|
2014-06-18 08:43:29 +02:00
|
|
|
#include "qapi/qmp-event.h"
|
2018-02-11 10:36:05 +01:00
|
|
|
#include "test-qapi-events.h"
|
2019-02-14 16:22:38 +01:00
|
|
|
#include "test-qapi-emit-events.h"
|
2014-06-18 08:43:29 +02:00
|
|
|
|
|
|
|
typedef struct TestEventData {
|
|
|
|
QDict *expect;
|
2020-03-17 12:54:35 +01:00
|
|
|
bool emitted;
|
2014-06-18 08:43:29 +02:00
|
|
|
} TestEventData;
|
|
|
|
|
|
|
|
TestEventData *test_event_data;
|
2018-05-04 16:34:46 +02:00
|
|
|
static GMutex test_event_lock;
|
2014-06-18 08:43:29 +02:00
|
|
|
|
qapi: Eliminate indirection through qmp_event_get_func_emit()
The qapi_event_send_FOO() functions emit events like this:
QMPEventFuncEmit emit;
emit = qmp_event_get_func_emit();
if (!emit) {
return;
}
qmp = qmp_event_build_dict("FOO");
[put event arguments into @qmp...]
emit(QAPI_EVENT_FOO, qmp);
The value of qmp_event_get_func_emit() depends only on the program:
* In qemu-system-FOO, it's always monitor_qapi_event_queue.
* In tests/test-qmp-event, it's always event_test_emit.
* In all other programs, it's always null.
This is exactly the kind of dependence the linker is supposed to
resolve; we don't actually need an indirection.
Note that things would fall apart if we linked more than one QAPI
schema into a single program: each set of qapi_event_send_FOO() uses
its own event enumeration, yet they share a single emit function.
Which takes the event enumeration as an argument. Which one if
there's more than one?
More seriously: how does this work even now? qemu-system-FOO wants
QAPIEvent, and passes a function taking that to
qmp_event_set_func_emit(). test-qmp-event wants test_QAPIEvent, and
passes a function taking that to qmp_event_set_func_emit().
It works by type trickery, of course:
typedef void (*QMPEventFuncEmit)(unsigned event, QDict *dict);
void qmp_event_set_func_emit(QMPEventFuncEmit emit);
QMPEventFuncEmit qmp_event_get_func_emit(void);
We use unsigned instead of the enumeration type. Relies on both
enumerations boiling down to unsigned, which happens to be true for
the compilers we use.
Clean this up as follows:
* Generate qapi_event_send_FOO() that call PREFIX_qapi_event_emit()
instead of the value of qmp_event_set_func_emit().
* Generate a prototype for PREFIX_qapi_event_emit() into
qapi-events.h.
* PREFIX_ is empty for qapi/qapi-schema.json, and test_ for
tests/qapi-schema/qapi-schema-test.json. It's qga_ for
qga/qapi-schema.json, and doc-good- for
tests/qapi-schema/doc-good.json, but those don't define any events.
* Rename monitor_qapi_event_queue() to qapi_event_emit() instead of
passing it to qmp_event_set_func_emit(). This takes care of
qemu-system-FOO.
* Rename event_test_emit() to test_qapi_event_emit() instead of
passing it to qmp_event_set_func_emit(). This takes care of
tests/test-qmp-event.
* Add a qapi_event_emit() that does nothing to stubs/monitor.c. This
takes care of all other programs that link code emitting QMP events.
* Drop qmp_event_set_func_emit(), qmp_event_get_func_emit().
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20181218182234.28876-3-armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
[Commit message typos fixed]
2018-12-18 19:22:21 +01:00
|
|
|
void test_qapi_event_emit(test_QAPIEvent event, QDict *d)
|
2014-06-18 08:43:29 +02:00
|
|
|
{
|
|
|
|
QDict *t;
|
|
|
|
int64_t s, ms;
|
|
|
|
|
|
|
|
/* Verify that we have timestamp, then remove it to compare other fields */
|
2017-02-17 21:38:17 +01:00
|
|
|
t = qdict_get_qdict(d, "timestamp");
|
2014-06-18 08:43:29 +02:00
|
|
|
g_assert(t);
|
2017-02-17 21:38:17 +01:00
|
|
|
s = qdict_get_try_int(t, "seconds", -2);
|
|
|
|
ms = qdict_get_try_int(t, "microseconds", -2);
|
2014-06-18 08:43:29 +02:00
|
|
|
if (s == -1) {
|
|
|
|
g_assert(ms == -1);
|
|
|
|
} else {
|
2017-02-17 21:38:17 +01:00
|
|
|
g_assert(s >= 0);
|
2014-06-18 08:43:29 +02:00
|
|
|
g_assert(ms >= 0 && ms <= 999999);
|
|
|
|
}
|
|
|
|
g_assert(qdict_size(t) == 2);
|
|
|
|
|
|
|
|
qdict_del(d, "timestamp");
|
|
|
|
|
2020-03-17 12:54:34 +01:00
|
|
|
g_assert(qobject_is_equal(QOBJECT(d), QOBJECT(test_event_data->expect)));
|
2020-03-17 12:54:35 +01:00
|
|
|
test_event_data->emitted = true;
|
2014-06-18 08:43:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static void event_prepare(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
|
|
|
/* Global variable test_event_data was used to pass the expectation, so
|
|
|
|
test cases can't be executed at same time. */
|
|
|
|
g_mutex_lock(&test_event_lock);
|
|
|
|
test_event_data = data;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void event_teardown(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
|
|
|
test_event_data = NULL;
|
|
|
|
g_mutex_unlock(&test_event_lock);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void event_test_add(const char *testpath,
|
|
|
|
void (*test_func)(TestEventData *data,
|
|
|
|
const void *user_data))
|
|
|
|
{
|
|
|
|
g_test_add(testpath, TestEventData, NULL, event_prepare, test_func,
|
|
|
|
event_teardown);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/* Test cases */
|
|
|
|
|
|
|
|
static void test_event_a(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
2020-03-17 12:54:33 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail("{ 'event': 'EVENT_A' }");
|
2018-08-15 15:37:37 +02:00
|
|
|
qapi_event_send_event_a();
|
2020-03-17 12:54:35 +01:00
|
|
|
g_assert(data->emitted);
|
2020-03-17 12:54:33 +01:00
|
|
|
qobject_unref(data->expect);
|
2014-06-18 08:43:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static void test_event_b(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
2020-03-17 12:54:33 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail("{ 'event': 'EVENT_B' }");
|
2018-08-15 15:37:37 +02:00
|
|
|
qapi_event_send_event_b();
|
2020-03-17 12:54:35 +01:00
|
|
|
g_assert(data->emitted);
|
2020-03-17 12:54:33 +01:00
|
|
|
qobject_unref(data->expect);
|
2014-06-18 08:43:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static void test_event_c(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
2020-03-17 12:54:33 +01:00
|
|
|
UserDefOne b = { .integer = 2, .string = (char *)"test1" };
|
2014-06-18 08:43:29 +02:00
|
|
|
|
2020-03-17 12:54:33 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail(
|
|
|
|
"{ 'event': 'EVENT_C', 'data': {"
|
|
|
|
" 'a': 1, 'b': { 'integer': 2, 'string': 'test1' }, 'c': 'test2' } }");
|
2018-08-15 15:37:37 +02:00
|
|
|
qapi_event_send_event_c(true, 1, true, &b, "test2");
|
2020-03-17 12:54:35 +01:00
|
|
|
g_assert(data->emitted);
|
2020-03-17 12:54:33 +01:00
|
|
|
qobject_unref(data->expect);
|
2014-06-18 08:43:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Complex type */
|
|
|
|
static void test_event_d(TestEventData *data,
|
|
|
|
const void *unused)
|
|
|
|
{
|
2020-03-17 12:54:33 +01:00
|
|
|
UserDefOne struct1 = {
|
|
|
|
.integer = 2, .string = (char *)"test1",
|
|
|
|
.has_enum1 = true, .enum1 = ENUM_ONE_VALUE1,
|
|
|
|
};
|
|
|
|
EventStructOne a = {
|
|
|
|
.struct1 = &struct1,
|
|
|
|
.string = (char *)"test2",
|
|
|
|
.has_enum2 = true,
|
|
|
|
.enum2 = ENUM_ONE_VALUE2,
|
|
|
|
};
|
|
|
|
|
|
|
|
data->expect = qdict_from_jsonf_nofail(
|
|
|
|
"{ 'event': 'EVENT_D', 'data': {"
|
|
|
|
" 'a': {"
|
|
|
|
" 'struct1': { 'integer': 2, 'string': 'test1', 'enum1': 'value1' },"
|
|
|
|
" 'string': 'test2', 'enum2': 'value2' },"
|
|
|
|
" 'b': 'test3', 'enum3': 'value3' } }");
|
2018-08-15 15:37:37 +02:00
|
|
|
qapi_event_send_event_d(&a, "test3", false, NULL, true, ENUM_ONE_VALUE3);
|
2020-03-17 12:54:35 +01:00
|
|
|
g_assert(data->emitted);
|
2020-03-17 12:54:33 +01:00
|
|
|
qobject_unref(data->expect);
|
2014-06-18 08:43:29 +02:00
|
|
|
}
|
|
|
|
|
2021-03-18 16:55:12 +01:00
|
|
|
static void test_event_deprecated(TestEventData *data, const void *unused)
|
|
|
|
{
|
2021-03-23 10:40:10 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES1' }");
|
2021-03-18 16:55:12 +01:00
|
|
|
|
|
|
|
memset(&compat_policy, 0, sizeof(compat_policy));
|
|
|
|
|
|
|
|
qapi_event_send_test_event_features1();
|
|
|
|
g_assert(data->emitted);
|
|
|
|
|
|
|
|
compat_policy.has_deprecated_output = true;
|
|
|
|
compat_policy.deprecated_output = COMPAT_POLICY_OUTPUT_HIDE;
|
|
|
|
data->emitted = false;
|
|
|
|
qapi_event_send_test_event_features1();
|
|
|
|
g_assert(!data->emitted);
|
|
|
|
|
|
|
|
qobject_unref(data->expect);
|
|
|
|
}
|
|
|
|
|
2021-03-18 16:55:13 +01:00
|
|
|
static void test_event_deprecated_data(TestEventData *data, const void *unused)
|
|
|
|
{
|
|
|
|
memset(&compat_policy, 0, sizeof(compat_policy));
|
|
|
|
|
2021-03-23 10:40:10 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES0',"
|
2021-03-18 16:55:13 +01:00
|
|
|
" 'data': { 'foo': 42 } }");
|
|
|
|
qapi_event_send_test_event_features0(42);
|
|
|
|
g_assert(data->emitted);
|
|
|
|
|
|
|
|
qobject_unref(data->expect);
|
|
|
|
|
|
|
|
compat_policy.has_deprecated_output = true;
|
|
|
|
compat_policy.deprecated_output = COMPAT_POLICY_OUTPUT_HIDE;
|
2021-03-23 10:40:10 +01:00
|
|
|
data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES0' }");
|
2021-03-18 16:55:13 +01:00
|
|
|
qapi_event_send_test_event_features0(42);
|
|
|
|
g_assert(data->emitted);
|
|
|
|
|
|
|
|
qobject_unref(data->expect);
|
|
|
|
}
|
|
|
|
|
2014-06-18 08:43:29 +02:00
|
|
|
int main(int argc, char **argv)
|
|
|
|
{
|
|
|
|
g_test_init(&argc, &argv, NULL);
|
|
|
|
|
|
|
|
event_test_add("/event/event_a", test_event_a);
|
|
|
|
event_test_add("/event/event_b", test_event_b);
|
|
|
|
event_test_add("/event/event_c", test_event_c);
|
|
|
|
event_test_add("/event/event_d", test_event_d);
|
2021-03-18 16:55:12 +01:00
|
|
|
event_test_add("/event/deprecated", test_event_deprecated);
|
2021-03-18 16:55:13 +01:00
|
|
|
event_test_add("/event/deprecated_data", test_event_deprecated_data);
|
2014-06-18 08:43:29 +02:00
|
|
|
g_test_run();
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|