We were testing the arguments that were being passed to qemu when a disk
was being served by nbdkit, but the arguments used to start nbdkit
itself were not testable. This adds a test to ensure that we're invoking
nbdkit correctly for various disk source definitions.
For now, expect failure for tests that use sensitive data such as
passwords and cookies.
Signed-off-by: Jonathon Jongsma <jjongsma@xxxxxxxxxx>
---
src/qemu/qemu_nbdkit.c | 4 +-
src/qemu/qemu_nbdkitpriv.h | 31 +++
tests/meson.build | 1 +
.../disk-network-ssh.args.disk0 | 7 +
tests/qemunbdkittest.c | 239 ++++++++++++++++++
5 files changed, 281 insertions(+), 1 deletion(-)
create mode 100644 src/qemu/qemu_nbdkitpriv.h
create mode 100644 tests/qemunbdkitdata/disk-network-ssh.args.disk0
create mode 100644 tests/qemunbdkittest.c
diff --git a/src/qemu/qemu_nbdkit.c b/src/qemu/qemu_nbdkit.c
index 8cb9e0e604..882a074211 100644
--- a/src/qemu/qemu_nbdkit.c
+++ b/src/qemu/qemu_nbdkit.c
@@ -34,6 +34,8 @@
#include "qemu_driver.h"
#include "qemu_extdevice.h"
#include "qemu_nbdkit.h"
+#define LIBVIRT_QEMU_NBDKITPRIV_H_ALLOW
+#include "qemu_nbdkitpriv.h"
#include "qemu_security.h"
#include <fcntl.h>
@@ -830,7 +832,7 @@ qemuNbdkitProcessBuildCommandSSH(qemuNbdkitProcess *proc,
}
-static virCommand *
+virCommand *
qemuNbdkitProcessBuildCommand(qemuNbdkitProcess *proc)
{
g_autoptr(virCommand) cmd = virCommandNewArgList(proc->caps->path,
diff --git a/src/qemu/qemu_nbdkitpriv.h b/src/qemu/qemu_nbdkitpriv.h
new file mode 100644
index 0000000000..64f9bb99d8
--- /dev/null
+++ b/src/qemu/qemu_nbdkitpriv.h
@@ -0,0 +1,31 @@
+/*
+ * qemu_nbdkitpriv.h: exposing some functions for testing
+ *
+ * Copyright (C) 2021 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef LIBVIRT_QEMU_NBDKITPRIV_H_ALLOW
+# error "qemu_nbdkitpriv.h may only be included by qemu_nbdkit.c or test suites"
+#endif /* LIBVIRT_QEMU_NBDKITPRIV_H_ALLOW */
+
+#pragma once
+
+#include "qemu_nbdkit.h"
+
+virCommand *
+qemuNbdkitProcessBuildCommand(qemuNbdkitProcess *proc);
diff --git a/tests/meson.build b/tests/meson.build
index 1149211756..87b29ab5b4 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -451,6 +451,7 @@ if conf.has('WITH_QEMU')
{ 'name': 'qemuvhostusertest', 'link_with': [ test_qemu_driver_lib ], 'link_whole': [ test_file_wrapper_lib ] },
{ 'name': 'qemuxml2argvtest', 'link_with': [ test_qemu_driver_lib, test_utils_qemu_monitor_lib ], 'link_whole': [ test_utils_qemu_lib, test_file_wrapper_lib ] },
{ 'name': 'qemuxml2xmltest', 'link_with': [ test_qemu_driver_lib ], 'link_whole': [ test_utils_qemu_lib, test_file_wrapper_lib ] },
+ { 'name': 'qemunbdkittest', 'link_with': [ test_qemu_driver_lib ], 'link_whole': [ test_utils_qemu_lib, test_file_wrapper_lib ] },
]
endif
diff --git a/tests/qemunbdkitdata/disk-network-ssh.args.disk0 b/tests/qemunbdkitdata/disk-network-ssh.args.disk0
new file mode 100644
index 0000000000..e0020dff6a
--- /dev/null
+++ b/tests/qemunbdkitdata/disk-network-ssh.args.disk0
@@ -0,0 +1,7 @@
+nbdkit \
+--exit-with-parent \
+--unix /tmp/statedir-0/nbdkit-test-disk-0.socket \
+--foreground ssh \
+host=example.org \
+port=2222 \
+path=test.img
diff --git a/tests/qemunbdkittest.c b/tests/qemunbdkittest.c
new file mode 100644
index 0000000000..c7fa80b9c5
--- /dev/null
+++ b/tests/qemunbdkittest.c
@@ -0,0 +1,239 @@
+#include <config.h>
+
+#include "internal.h"
+#include "testutils.h"
+#include "testutilsqemu.h"
+#include "qemu/qemu_domain.h"
+#include "qemu/qemu_nbdkit.h"
+#define LIBVIRT_QEMU_NBDKITPRIV_H_ALLOW
+#include "qemu/qemu_nbdkitpriv.h"
+#include "vircommand.h"
+#define LIBVIRT_VIRCOMMANDPRIV_H_ALLOW
+#include "vircommandpriv.h"
+#include "virutil.h"
+#include "virsecret.h"
+#include "datatypes.h"
+
+#define VIR_FROM_THIS VIR_FROM_QEMU
+
+static virQEMUDriver driver;
+
+
+/* Some mock implementations for testing */
+int
+virSecretGetSecretString(virConnectPtr conn G_GNUC_UNUSED,
+ virSecretLookupTypeDef *seclookupdef,
+ virSecretUsageType secretUsageType,
+ uint8_t **secret,
+ size_t *secret_size)
+{
+ char uuidstr[VIR_UUID_BUFLEN];
+ const char *secretname = NULL;
+ char *tmp = NULL;
+
+ switch (seclookupdef->type) {
+ case VIR_SECRET_LOOKUP_TYPE_UUID:
+ virUUIDFormat(seclookupdef->u.uuid, uuidstr);
+ secretname = uuidstr;
+ break;
+ case VIR_SECRET_LOOKUP_TYPE_USAGE:
+ secretname = seclookupdef->u.usage;
+ break;
+ case VIR_SECRET_LOOKUP_TYPE_NONE:
+ case VIR_SECRET_LOOKUP_TYPE_LAST:
+ default:
+ virReportEnumRangeError(virSecretLookupType, seclookupdef->type);
+ return -1;
+ };
+
+ /* For testing, just generate a value for the secret that includes the type
+ * and the id of the secret */
+ tmp = g_strdup_printf("%s-%s-secret", virSecretUsageTypeToString(secretUsageType), secretname);
+ *secret = (uint8_t*)tmp;
+ *secret_size = strlen(tmp) + 1;
+
+ return 0;
+}
+
+virConnectPtr virGetConnectSecret(void)
+{
+ return virGetConnect();
+}
+
+/* end of mock implementations */
+
+
+typedef struct {
+ const char *name;
+ char* infile;
+ char* outtemplate;
+ qemuNbdkitCaps *nbdkitcaps;
+ bool expectFail;
+} TestInfo;
+
+
+typedef enum {
+ NBDKIT_ARG_CAPS,
+ NBDKIT_ARG_EXPECT_FAIL,
+ NBDKIT_ARG_END
+} NbdkitArgName;
+
+
+static void
+testInfoSetPaths(TestInfo *info)
+{
+ info->infile = g_strdup_printf("%s/qemuxml2argvdata/%s.xml",
+ abs_srcdir, info->name);
+ info->outtemplate = g_strdup_printf("%s/qemunbdkitdata/%s",
+ abs_srcdir, info->name);
+}
+
+static void
+testInfoClear(TestInfo *info)
+{
+ g_free(info->infile);
+ g_free(info->outtemplate);
+ g_clear_object(&info->nbdkitcaps);
+}
+
+static void
+testInfoSetArgs(TestInfo *info, ...)
+{
+ va_list argptr;
+ NbdkitArgName argname;
+ unsigned int cap;
+
+ va_start(argptr, info);
+ while ((argname = va_arg(argptr, NbdkitArgName)) != NBDKIT_ARG_END) {
+ switch (argname) {
+ case NBDKIT_ARG_CAPS:
+ while ((cap = va_arg(argptr, unsigned int)) < QEMU_NBDKIT_CAPS_LAST)
+ qemuNbdkitCapsSet(info->nbdkitcaps, cap);
+ break;
+ case NBDKIT_ARG_EXPECT_FAIL:
+ info->expectFail = va_arg(argptr, unsigned int);
+ break;
+ case NBDKIT_ARG_END:
+ default:
+ break;
+ }
+ }
+}
+
+
+static int
+testNbdkit(const void *data)
+{
+ const TestInfo *info = data;
+ g_autoptr(virDomainDef) def = NULL;
+ size_t i;
+ int ret = 0;
+
+ if (!virFileExists(info->infile)) {
+ virReportError(VIR_ERR_INTERNAL_ERROR,
+ "Test input file '%s' is missing", info->infile);
+ return -1;
+ }
+
+ if (!(def = virDomainDefParseFile(info->infile, driver.xmlopt, NULL,
+ VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE)))
+ return -1;
+
+ for (i = 0; i < def->ndisks; i++) {
+ virDomainDiskDef *disk = def->disks[i];
+ g_autofree char *statedir = g_strdup_printf("/tmp/statedir-%zi", i);
+ g_autofree char *alias = g_strdup_printf("test-disk-%zi", i);
+ g_autofree char *cmdfile = g_strdup_printf("%s.args.disk%zi",
+ info->outtemplate, i);
+
+ if (qemuNbdkitInitStorageSource(info->nbdkitcaps, disk->src, statedir,
+ alias, 101, 101)) {
+ qemuDomainStorageSourcePrivate *srcPriv =
+ qemuDomainStorageSourcePrivateFetch(disk->src);
+ g_autoptr(virCommand) cmd = NULL;
+ g_autoptr(virCommandDryRunToken) dryRunToken = virCommandDryRunTokenNew();
+ g_auto(virBuffer) buf = VIR_BUFFER_INITIALIZER;
+ const char *actualCmdline = NULL;
+
+ virCommandSetDryRun(dryRunToken, &buf, true, true, NULL, NULL);
+ cmd = qemuNbdkitProcessBuildCommand(srcPriv->nbdkitProcess);
+
+ if (virCommandRun(cmd, NULL) < 0) {
+ ret = -1;
+ continue;
+ }
+
+ if (!(actualCmdline = virBufferContentAndReset(&buf))) {
+ ret = -1;
+ continue;
+ }
+
+ if (virTestCompareToFileFull(actualCmdline, cmdfile, false) < 0) {
+ ret = -1;
+ continue;
+ }
+ } else {
+ if (virFileExists(cmdfile)) {
+ virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+ "qemuNbdkitInitStorageSource() was not expected to fail");
+ ret = -1;
+ }
+ }
+ }
+
+ if (info->expectFail) {
+ if (ret == 0) {
+ ret = -1;
+ VIR_TEST_DEBUG("Error expected but there wasn't any.");
+ } else {
+ ret = 0;
+ }
+ }
+ return ret;
+}
+
+static int
+mymain(void)
+{
+ int ret = 0;
+
+ if (qemuTestDriverInit(&driver) < 0)
+ return EXIT_FAILURE;
+
+
+#define DO_TEST_FULL(_name, ...) \
+ do { \
+ TestInfo info = { \
+ .name = _name, \
+ .nbdkitcaps = qemuNbdkitCapsNew(TEST_NBDKIT_PATH), \
+ }; \
+ testInfoSetPaths(&info); \
+ testInfoSetArgs(&info, __VA_ARGS__); \
+ virTestRunLog(&ret, "nbdkit " _name, testNbdkit, &info); \
+ testInfoClear(&info); \
+ } while (0)
+
+#define DO_TEST(_name, ...) \
+ DO_TEST_FULL(_name, NBDKIT_ARG_CAPS, __VA_ARGS__, QEMU_NBDKIT_CAPS_LAST, NBDKIT_ARG_END)
+
+#define DO_TEST_FAILURE(_name, ...) \
+ DO_TEST_FULL(_name, \
+ NBDKIT_ARG_EXPECT_FAIL, 1, \
+ NBDKIT_ARG_CAPS, __VA_ARGS__, QEMU_NBDKIT_CAPS_LAST, NBDKIT_ARG_END)
+
+#define DO_TEST_NOCAPS(_name) \
+ DO_TEST_FULL(_name, NBDKIT_ARG_END)
+
+ /* disks with cookies / passwords are not yet supported */
+ DO_TEST_FAILURE("disk-cdrom-network", QEMU_NBDKIT_CAPS_PLUGIN_CURL);
+ DO_TEST_FAILURE("disk-network-http", QEMU_NBDKIT_CAPS_PLUGIN_CURL);
+ DO_TEST_FAILURE("disk-network-source-curl-nbdkit-backing", QEMU_NBDKIT_CAPS_PLUGIN_CURL);
+ DO_TEST_FAILURE("disk-network-source-curl", QEMU_NBDKIT_CAPS_PLUGIN_CURL);
+ DO_TEST("disk-network-ssh", QEMU_NBDKIT_CAPS_PLUGIN_SSH);
+
+ qemuTestDriverFree(&driver);
+
+ return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+
+VIR_TEST_MAIN(mymain)
--
2.37.3
