tests: add dbus-vmstate-test

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Marc-André Lureau 2019-09-27 12:39:08 +04:00
parent d77799ccda
commit 586ca6ba3c
5 changed files with 511 additions and 1 deletions

View File

@ -2210,6 +2210,7 @@ D-Bus
M: Marc-André Lureau <marcandre.lureau@redhat.com> M: Marc-André Lureau <marcandre.lureau@redhat.com>
S: Maintained S: Maintained
F: backends/dbus-vmstate.c F: backends/dbus-vmstate.c
F: tests/dbus-vmstate*
F: util/dbus.c F: util/dbus.c
F: include/qemu/dbus.h F: include/qemu/dbus.h
F: docs/interop/dbus.rst F: docs/interop/dbus.rst

View File

@ -158,12 +158,17 @@ check-qtest-generic-$(CONFIG_MODULES) += tests/modules-test$(EXESUF)
check-qtest-generic-y += tests/device-introspect-test$(EXESUF) check-qtest-generic-y += tests/device-introspect-test$(EXESUF)
check-qtest-generic-y += tests/cdrom-test$(EXESUF) check-qtest-generic-y += tests/cdrom-test$(EXESUF)
DBUS_DAEMON := $(shell which dbus-daemon 2>/dev/null)
ifneq ($(GDBUS_CODEGEN),)
ifneq ($(DBUS_DAEMON),)
check-qtest-pci-$(CONFIG_GIO) += tests/dbus-vmstate-test$(EXESUF)
endif
endif
check-qtest-pci-$(CONFIG_RTL8139_PCI) += tests/rtl8139-test$(EXESUF) check-qtest-pci-$(CONFIG_RTL8139_PCI) += tests/rtl8139-test$(EXESUF)
check-qtest-pci-$(CONFIG_VGA) += tests/display-vga-test$(EXESUF) check-qtest-pci-$(CONFIG_VGA) += tests/display-vga-test$(EXESUF)
check-qtest-pci-$(CONFIG_HDA) += tests/intel-hda-test$(EXESUF) check-qtest-pci-$(CONFIG_HDA) += tests/intel-hda-test$(EXESUF)
check-qtest-pci-$(CONFIG_IVSHMEM_DEVICE) += tests/ivshmem-test$(EXESUF) check-qtest-pci-$(CONFIG_IVSHMEM_DEVICE) += tests/ivshmem-test$(EXESUF)
check-qtest-i386-$(CONFIG_ISA_TESTDEV) = tests/endianness-test$(EXESUF) check-qtest-i386-$(CONFIG_ISA_TESTDEV) = tests/endianness-test$(EXESUF)
check-qtest-i386-y += tests/fdc-test$(EXESUF) check-qtest-i386-y += tests/fdc-test$(EXESUF)
check-qtest-i386-y += tests/ide-test$(EXESUF) check-qtest-i386-y += tests/ide-test$(EXESUF)
@ -634,6 +639,19 @@ tests/qapi-schema/doc-good.test.texi: $(SRC_PATH)/tests/qapi-schema/doc-good.jso
@mv tests/qapi-schema/doc-good-qapi-doc.texi $@ @mv tests/qapi-schema/doc-good-qapi-doc.texi $@
@rm -f tests/qapi-schema/doc-good-qapi-*.[ch] tests/qapi-schema/doc-good-qmp-*.[ch] @rm -f tests/qapi-schema/doc-good-qapi-*.[ch] tests/qapi-schema/doc-good-qmp-*.[ch]
tests/dbus-vmstate1.h tests/dbus-vmstate1.c: tests/dbus-vmstate1-gen-timestamp ;
tests/dbus-vmstate1-gen-timestamp: $(SRC_PATH)/tests/dbus-vmstate1.xml
$(call quiet-command,$(GDBUS_CODEGEN) $< \
--interface-prefix org.qemu --generate-c-code tests/dbus-vmstate1, \
"GEN","$(@:%-timestamp=%)")
@>$@
tests/dbus-vmstate-test.o-cflags := -DSRCDIR="$(SRC_PATH)"
tests/dbus-vmstate1.o-cflags := $(GIO_CFLAGS)
tests/dbus-vmstate1.o-libs := $(GIO_LIBS)
tests/dbus-vmstate-test.o: tests/dbus-vmstate1.h
tests/test-string-output-visitor$(EXESUF): tests/test-string-output-visitor.o $(test-qapi-obj-y) tests/test-string-output-visitor$(EXESUF): tests/test-string-output-visitor.o $(test-qapi-obj-y)
tests/test-string-input-visitor$(EXESUF): tests/test-string-input-visitor.o $(test-qapi-obj-y) tests/test-string-input-visitor$(EXESUF): tests/test-string-input-visitor.o $(test-qapi-obj-y)
tests/test-qmp-event$(EXESUF): tests/test-qmp-event.o $(test-qapi-obj-y) tests/test-qapi-events.o tests/test-qmp-event$(EXESUF): tests/test-qmp-event.o $(test-qapi-obj-y) tests/test-qapi-events.o
@ -837,6 +855,7 @@ tests/test-filter-mirror$(EXESUF): tests/test-filter-mirror.o $(qtest-obj-y)
tests/test-filter-redirector$(EXESUF): tests/test-filter-redirector.o $(qtest-obj-y) tests/test-filter-redirector$(EXESUF): tests/test-filter-redirector.o $(qtest-obj-y)
tests/test-x86-cpuid-compat$(EXESUF): tests/test-x86-cpuid-compat.o $(qtest-obj-y) tests/test-x86-cpuid-compat$(EXESUF): tests/test-x86-cpuid-compat.o $(qtest-obj-y)
tests/ivshmem-test$(EXESUF): tests/ivshmem-test.o contrib/ivshmem-server/ivshmem-server.o $(libqos-pc-obj-y) $(libqos-spapr-obj-y) tests/ivshmem-test$(EXESUF): tests/ivshmem-test.o contrib/ivshmem-server/ivshmem-server.o $(libqos-pc-obj-y) $(libqos-spapr-obj-y)
tests/dbus-vmstate-test$(EXESUF): tests/dbus-vmstate-test.o tests/migration-helpers.o tests/dbus-vmstate1.o $(libqos-pc-obj-y) $(libqos-spapr-obj-y)
tests/vhost-user-bridge$(EXESUF): tests/vhost-user-bridge.o $(test-util-obj-y) libvhost-user.a tests/vhost-user-bridge$(EXESUF): tests/vhost-user-bridge.o $(test-util-obj-y) libvhost-user.a
tests/test-uuid$(EXESUF): tests/test-uuid.o $(test-util-obj-y) tests/test-uuid$(EXESUF): tests/test-uuid.o $(test-util-obj-y)
tests/test-arm-mptimer$(EXESUF): tests/test-arm-mptimer.o tests/test-arm-mptimer$(EXESUF): tests/test-arm-mptimer.o
@ -1195,6 +1214,7 @@ check-clean:
rm -rf $(check-unit-y) tests/*.o $(QEMU_IOTESTS_HELPERS-y) rm -rf $(check-unit-y) tests/*.o $(QEMU_IOTESTS_HELPERS-y)
rm -rf $(sort $(foreach target,$(SYSEMU_TARGET_LIST), $(check-qtest-$(target)-y)) $(check-qtest-generic-y)) rm -rf $(sort $(foreach target,$(SYSEMU_TARGET_LIST), $(check-qtest-$(target)-y)) $(check-qtest-generic-y))
rm -f tests/test-qapi-gen-timestamp rm -f tests/test-qapi-gen-timestamp
rm -f tests/dbus-vmstate1-gen-timestamp
rm -rf $(TESTS_VENV_DIR) $(TESTS_RESULTS_DIR) rm -rf $(TESTS_VENV_DIR) $(TESTS_RESULTS_DIR)
clean: check-clean clean: check-clean

95
tests/dbus-vmstate-daemon.sh Executable file
View File

@ -0,0 +1,95 @@
#!/bin/sh
# dbus-daemon wrapper script for dbus-vmstate testing
#
# This script allows to tweak the dbus-daemon policy during the test
# to test different configurations.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.
#
# Copyright (C) 2019 Red Hat, Inc.
write_config()
{
CONF="$1"
cat > "$CONF" <<EOF
<busconfig>
<type>session</type>
<listen>unix:tmpdir=$DBUS_VMSTATE_TEST_TMPDIR</listen>
<policy context="default">
<!-- Holes must be punched in service configuration files for
name ownership and sending method calls -->
<deny own="*"/>
<deny send_type="method_call"/>
<!-- Signals and reply messages (method returns, errors) are allowed
by default -->
<allow send_type="signal"/>
<allow send_requested_reply="true" send_type="method_return"/>
<allow send_requested_reply="true" send_type="error"/>
<!-- All messages may be received by default -->
<allow receive_type="method_call"/>
<allow receive_type="method_return"/>
<allow receive_type="error"/>
<allow receive_type="signal"/>
<!-- Allow anyone to talk to the message bus -->
<allow send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.DBus" />
<allow send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.DBus.Introspectable"/>
<allow send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.DBus.Properties"/>
<!-- But disallow some specific bus services -->
<deny send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.DBus"
send_member="UpdateActivationEnvironment"/>
<deny send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.DBus.Debug.Stats"/>
<deny send_destination="org.freedesktop.DBus"
send_interface="org.freedesktop.systemd1.Activator"/>
<allow own="org.qemu.VMState1"/>
<allow send_destination="org.qemu.VMState1"/>
<allow receive_sender="org.qemu.VMState1"/>
</policy>
<include if_selinux_enabled="yes"
selinux_root_relative="yes">contexts/dbus_contexts</include>
</busconfig>
EOF
}
ARGS=
for arg in "$@"
do
case $arg in
--config-file=*)
CONF="${arg#*=}"
write_config "$CONF"
ARGS="$ARGS $1"
shift
;;
*)
ARGS="$ARGS $1"
shift
;;
esac
done
exec dbus-daemon $ARGS

382
tests/dbus-vmstate-test.c Normal file
View File

@ -0,0 +1,382 @@
#include "qemu/osdep.h"
#include <glib/gstdio.h>
#include <gio/gio.h>
#include "libqtest.h"
#include "qemu-common.h"
#include "dbus-vmstate1.h"
#include "migration-helpers.h"
static char *workdir;
typedef struct TestServerId {
const char *name;
const char *data;
size_t size;
} TestServerId;
static const TestServerId idA = {
"idA", "I'am\0idA!", sizeof("I'am\0idA!")
};
static const TestServerId idB = {
"idB", "I'am\0idB!", sizeof("I'am\0idB!")
};
typedef struct TestServer {
const TestServerId *id;
bool save_called;
bool load_called;
} TestServer;
typedef struct Test {
const char *id_list;
bool migrate_fail;
bool without_dst_b;
TestServer srcA;
TestServer dstA;
TestServer srcB;
TestServer dstB;
GMainLoop *loop;
QTestState *src_qemu;
} Test;
static gboolean
vmstate_load(VMState1 *object, GDBusMethodInvocation *invocation,
const gchar *arg_data, gpointer user_data)
{
TestServer *h = user_data;
g_autoptr(GVariant) var = NULL;
GVariant *args;
const uint8_t *data;
size_t size;
args = g_dbus_method_invocation_get_parameters(invocation);
var = g_variant_get_child_value(args, 0);
data = g_variant_get_fixed_array(var, &size, sizeof(char));
g_assert_cmpuint(size, ==, h->id->size);
g_assert(!memcmp(data, h->id->data, h->id->size));
h->load_called = true;
g_dbus_method_invocation_return_value(invocation, g_variant_new("()"));
return TRUE;
}
static gboolean
vmstate_save(VMState1 *object, GDBusMethodInvocation *invocation,
gpointer user_data)
{
TestServer *h = user_data;
GVariant *var;
var = g_variant_new_fixed_array(G_VARIANT_TYPE_BYTE,
h->id->data, h->id->size, sizeof(char));
g_dbus_method_invocation_return_value(invocation,
g_variant_new("(@ay)", var));
h->save_called = true;
return TRUE;
}
typedef struct WaitNamed {
GMainLoop *loop;
bool named;
} WaitNamed;
static void
named_cb(GDBusConnection *connection,
const gchar *name,
gpointer user_data)
{
WaitNamed *t = user_data;
t->named = true;
g_main_loop_quit(t->loop);
}
static GDBusConnection *
get_connection(Test *test, guint *ownid)
{
g_autofree gchar *addr = NULL;
WaitNamed *wait;
GError *err = NULL;
GDBusConnection *c;
wait = g_new0(WaitNamed, 1);
wait->loop = test->loop;
addr = g_dbus_address_get_for_bus_sync(G_BUS_TYPE_SESSION, NULL, &err);
g_assert_no_error(err);
c = g_dbus_connection_new_for_address_sync(
addr,
G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION |
G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT,
NULL, NULL, &err);
g_assert_no_error(err);
*ownid = g_bus_own_name_on_connection(c, "org.qemu.VMState1",
G_BUS_NAME_OWNER_FLAGS_NONE,
named_cb, named_cb, wait, g_free);
if (!wait->named) {
g_main_loop_run(wait->loop);
}
return c;
}
static GDBusObjectManagerServer *
get_server(GDBusConnection *conn, TestServer *s, const TestServerId *id)
{
g_autoptr(GDBusObjectSkeleton) sk = NULL;
g_autoptr(VMState1Skeleton) v = NULL;
GDBusObjectManagerServer *os;
s->id = id;
os = g_dbus_object_manager_server_new("/org/qemu");
sk = g_dbus_object_skeleton_new("/org/qemu/VMState1");
v = VMSTATE1_SKELETON(vmstate1_skeleton_new());
g_object_set(v, "id", id->name, NULL);
g_signal_connect(v, "handle-load", G_CALLBACK(vmstate_load), s);
g_signal_connect(v, "handle-save", G_CALLBACK(vmstate_save), s);
g_dbus_object_skeleton_add_interface(sk, G_DBUS_INTERFACE_SKELETON(v));
g_dbus_object_manager_server_export(os, sk);
g_dbus_object_manager_server_set_connection(os, conn);
return os;
}
static void
set_id_list(Test *test, QTestState *s)
{
if (!test->id_list) {
return;
}
g_assert(!qmp_rsp_is_err(qtest_qmp(s,
"{ 'execute': 'qom-set', 'arguments': "
"{ 'path': '/objects/dv', 'property': 'id-list', 'value': %s } }",
test->id_list)));
}
static gpointer
dbus_vmstate_thread(gpointer data)
{
GMainLoop *loop = data;
g_main_loop_run(loop);
return NULL;
}
static void
test_dbus_vmstate(Test *test)
{
g_autofree char *src_qemu_args = NULL;
g_autofree char *dst_qemu_args = NULL;
g_autoptr(GTestDBus) srcbus = NULL;
g_autoptr(GTestDBus) dstbus = NULL;
g_autoptr(GDBusConnection) srcconnA = NULL;
g_autoptr(GDBusConnection) srcconnB = NULL;
g_autoptr(GDBusConnection) dstconnA = NULL;
g_autoptr(GDBusConnection) dstconnB = NULL;
g_autoptr(GDBusObjectManagerServer) srcserverA = NULL;
g_autoptr(GDBusObjectManagerServer) srcserverB = NULL;
g_autoptr(GDBusObjectManagerServer) dstserverA = NULL;
g_autoptr(GDBusObjectManagerServer) dstserverB = NULL;
g_auto(GStrv) srcaddr = NULL;
g_auto(GStrv) dstaddr = NULL;
g_autoptr(GThread) thread = NULL;
g_autoptr(GMainLoop) loop = NULL;
g_autofree char *uri = NULL;
QTestState *src_qemu = NULL, *dst_qemu = NULL;
guint ownsrcA, ownsrcB, owndstA, owndstB;
uri = g_strdup_printf("unix:%s/migsocket", workdir);
loop = g_main_loop_new(NULL, FALSE);
test->loop = loop;
srcbus = g_test_dbus_new(G_TEST_DBUS_NONE);
g_test_dbus_up(srcbus);
srcconnA = get_connection(test, &ownsrcA);
srcserverA = get_server(srcconnA, &test->srcA, &idA);
srcconnB = get_connection(test, &ownsrcB);
srcserverB = get_server(srcconnB, &test->srcB, &idB);
/* remove ,guid=foo part */
srcaddr = g_strsplit(g_test_dbus_get_bus_address(srcbus), ",", 2);
src_qemu_args =
g_strdup_printf("-object dbus-vmstate,id=dv,addr=%s", srcaddr[0]);
dstbus = g_test_dbus_new(G_TEST_DBUS_NONE);
g_test_dbus_up(dstbus);
dstconnA = get_connection(test, &owndstA);
dstserverA = get_server(dstconnA, &test->dstA, &idA);
if (!test->without_dst_b) {
dstconnB = get_connection(test, &owndstB);
dstserverB = get_server(dstconnB, &test->dstB, &idB);
}
dstaddr = g_strsplit(g_test_dbus_get_bus_address(dstbus), ",", 2);
dst_qemu_args =
g_strdup_printf("-object dbus-vmstate,id=dv,addr=%s -incoming %s",
dstaddr[0], uri);
src_qemu = qtest_init(src_qemu_args);
dst_qemu = qtest_init(dst_qemu_args);
set_id_list(test, src_qemu);
set_id_list(test, dst_qemu);
thread = g_thread_new("dbus-vmstate-thread", dbus_vmstate_thread, loop);
migrate_qmp(src_qemu, uri, "{}");
test->src_qemu = src_qemu;
if (test->migrate_fail) {
wait_for_migration_fail(src_qemu, true);
qtest_set_expected_status(dst_qemu, 1);
} else {
wait_for_migration_complete(src_qemu);
}
qtest_quit(dst_qemu);
qtest_quit(src_qemu);
g_bus_unown_name(ownsrcA);
g_bus_unown_name(ownsrcB);
g_bus_unown_name(owndstA);
if (!test->without_dst_b) {
g_bus_unown_name(owndstB);
}
g_main_loop_quit(test->loop);
}
static void
check_not_migrated(TestServer *s, TestServer *d)
{
assert(!s->save_called);
assert(!s->load_called);
assert(!d->save_called);
assert(!d->load_called);
}
static void
check_migrated(TestServer *s, TestServer *d)
{
assert(s->save_called);
assert(!s->load_called);
assert(!d->save_called);
assert(d->load_called);
}
static void
test_dbus_vmstate_without_list(void)
{
Test test = { 0, };
test_dbus_vmstate(&test);
check_migrated(&test.srcA, &test.dstA);
check_migrated(&test.srcB, &test.dstB);
}
static void
test_dbus_vmstate_with_list(void)
{
Test test = { .id_list = "idA,idB" };
test_dbus_vmstate(&test);
check_migrated(&test.srcA, &test.dstA);
check_migrated(&test.srcB, &test.dstB);
}
static void
test_dbus_vmstate_only_a(void)
{
Test test = { .id_list = "idA" };
test_dbus_vmstate(&test);
check_migrated(&test.srcA, &test.dstA);
check_not_migrated(&test.srcB, &test.dstB);
}
static void
test_dbus_vmstate_missing_src(void)
{
Test test = { .id_list = "idA,idC", .migrate_fail = true };
/* run in subprocess to silence QEMU error reporting */
if (g_test_subprocess()) {
test_dbus_vmstate(&test);
check_not_migrated(&test.srcA, &test.dstA);
check_not_migrated(&test.srcB, &test.dstB);
return;
}
g_test_trap_subprocess(NULL, 0, 0);
g_test_trap_assert_passed();
}
static void
test_dbus_vmstate_missing_dst(void)
{
Test test = { .id_list = "idA,idB",
.without_dst_b = true,
.migrate_fail = true };
/* run in subprocess to silence QEMU error reporting */
if (g_test_subprocess()) {
test_dbus_vmstate(&test);
assert(test.srcA.save_called);
assert(test.srcB.save_called);
assert(!test.dstB.save_called);
return;
}
g_test_trap_subprocess(NULL, 0, 0);
g_test_trap_assert_passed();
}
int
main(int argc, char **argv)
{
GError *err = NULL;
g_autofree char *dbus_daemon = NULL;
int ret;
dbus_daemon = g_build_filename(G_STRINGIFY(SRCDIR),
"tests",
"dbus-vmstate-daemon.sh",
NULL);
g_setenv("G_TEST_DBUS_DAEMON", dbus_daemon, true);
g_test_init(&argc, &argv, NULL);
workdir = g_dir_make_tmp("dbus-vmstate-test-XXXXXX", &err);
if (!workdir) {
g_error("Unable to create temporary dir: %s\n", err->message);
exit(1);
}
g_setenv("DBUS_VMSTATE_TEST_TMPDIR", workdir, true);
qtest_add_func("/dbus-vmstate/without-list",
test_dbus_vmstate_without_list);
qtest_add_func("/dbus-vmstate/with-list",
test_dbus_vmstate_with_list);
qtest_add_func("/dbus-vmstate/only-a",
test_dbus_vmstate_only_a);
qtest_add_func("/dbus-vmstate/missing-src",
test_dbus_vmstate_missing_src);
qtest_add_func("/dbus-vmstate/missing-dst",
test_dbus_vmstate_missing_dst);
ret = g_test_run();
rmdir(workdir);
g_free(workdir);
return ret;
}

12
tests/dbus-vmstate1.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0"?>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.qemu.VMState1">
<property name="Id" type="s" access="read"/>
<method name="Load">
<arg type="ay" name="data" direction="in"/>
</method>
<method name="Save">
<arg type="ay" name="data" direction="out"/>
</method>
</interface>
</node>