Add tests for virUSBDeviceFind functions

Mock the /sys/bus/usb directory and test the finding
(and not finding) of some USB devices.

.gitignore

@@ -219,6 +219,7 @@
 /tests/virsystemdtest
 /tests/virtimetest
 /tests/viruritest
+/tests/virusbtest
 /tests/vmwarevertest
 /tests/vmx2xmltest
 /tests/xencapstest

cfg.mk

@@ -941,7 +941,8 @@ exclude_file_name_regexp--sc_bindtextdomain = ^(tests|examples)/
 exclude_file_name_regexp--sc_copyright_usage = \
   ^COPYING(|\.LESSER)$$
 
-exclude_file_name_regexp--sc_flags_usage = ^(docs/|src/util/virnetdevtap\.c$$|tests/vir(cgroup|pci)mock\.c$$)
+exclude_file_name_regexp--sc_flags_usage = \
+  ^(docs/|src/util/virnetdevtap\.c$$|tests/vir(cgroup|pci|usb)mock\.c$$)
 
 exclude_file_name_regexp--sc_libvirt_unmarked_diagnostics = \
   ^(src/rpc/gendispatch\.pl$$|tests/)

tests/Makefile.am

@@ -115,6 +115,7 @@ EXTRA_DIST =		\
 	virfiledata \
 	virpcitestdata \
 	virscsidata \
+	virusbtestdata \
 	vmx2xmldata \
 	xencapsdata \
 	xmconfigdata \
@@ -263,6 +264,10 @@ test_programs += metadatatest
 
 test_programs += secretxml2xmltest
 
+if WITH_LINUX
+test_programs += virusbtest
+endif WITH_LINUX
+
 test_scripts = \
 	capabilityschematest \
 	interfaceschematest \
@@ -344,6 +349,10 @@ if WITH_DBUS
 test_libraries += virsystemdmock.la
 endif WITH_DBUS
 
+if WITH_LINUX
+test_libraries += virusbmock.la
+endif WITH_LINUX
+
 if WITH_TESTS
 noinst_PROGRAMS = $(test_programs) $(test_helpers)
 noinst_LTLIBRARIES = $(test_libraries)
@@ -815,6 +824,19 @@ virpcimock_la_LIBADD = $(GNULIB_LIBS) \
 virpcimock_la_LDFLAGS = -module -avoid-version \
         -rpath /evil/libtool/hack/to/force/shared/lib/creation
 
+if WITH_LINUX
+virusbtest_SOURCES = \
+	virusbtest.c testutils.h testutils.c
+virusbtest_LDADD = $(LDADDS)
+
+virusbmock_la_SOURCES = virusbmock.c
+virusbmock_la_CFLAGS = $(AM_CFLAGS)
+virusbmock_la_LDFLAGS = -module -avoid-version \
+        -rpath /evil/libtool/hack/to/force/shared/lib/creation
+else ! WITH_LINUX
+	EXTRA_DIST += virusbtest.c virusbmock.c
+endif ! WITH_LINUX
+
 if WITH_DBUS
 virdbustest_SOURCES = \
 	virdbustest.c testutils.h testutils.c

tests/virusbmock.c

@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2014 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/>.
+ *
+ * Author: Jan Tomko <jtomko@redhat.com>
+ */
+
+#include <config.h>
+#include <stdlib.h>
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <dirent.h>
+#include <dlfcn.h>
+#include <fcntl.h>
+
+#include "viralloc.h"
+#include "virfile.h"
+#include "virstring.h"
+#include "virusb.h"
+
+#define USB_SYSFS "/sys/bus/usb"
+#define FAKE_USB_SYSFS "virusbtestdata/sys_bus_usb"
+
+static int (*realopen)(const char *pathname, int flags, ...);
+static DIR *(*realopendir)(const char *name);
+
+static void init_syms(void)
+{
+    if (realopen)
+        return;
+
+    realopen = dlsym(RTLD_NEXT, "open");
+    realopendir = dlsym(RTLD_NEXT, "opendir");
+    if (!realopen || !realopendir) {
+        fprintf(stderr, "Error getting symbols");
+        abort();
+    }
+}
+
+static char *get_fake_path(const char *real_path)
+{
+    const char *p = NULL;
+    char *path = NULL;
+
+    if ((p = STRSKIP(real_path, USB_SYSFS)) &&
+        virAsprintfQuiet(&path, "%s/%s/%s", abs_srcdir, FAKE_USB_SYSFS, p) < 0)
+        goto error;
+    else if (!p && VIR_STRDUP_QUIET(path, real_path) < 0)
+        goto error;
+
+    return path;
+
+error:
+    errno = ENOMEM;
+    return NULL;
+}
+
+DIR *opendir(const char *name)
+{
+    char *path;
+    DIR* ret;
+
+    init_syms();
+
+    path = get_fake_path(name);
+
+    ret = realopendir(path);
+    VIR_FREE(path);
+    return ret;
+}
+
+int open(const char *pathname, int flags, ...)
+{
+    char *path;
+    int ret;
+
+    init_syms();
+
+    path = get_fake_path(pathname);
+    if (!path)
+        return -1;
+    ret = realopen(path, flags);
+    VIR_FREE(path);
+    return ret;
+}

tests/virusbtest.c

@@ -0,0 +1,190 @@
+/*
+ * Copyright (C) 2013-2014 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/>.
+ *
+ * Author: Jan Tomko <jtomko@redhat.com>
+ */
+
+#include <config.h>
+#include <stdlib.h>
+
+#include "viralloc.h"
+#include "virerror.h"
+#include "virfile.h"
+#include "virusb.h"
+
+#include "testutils.h"
+
+#define VIR_FROM_THIS VIR_FROM_NONE
+
+typedef enum {
+    FIND_BY_ALL,
+    FIND_BY_VENDOR,
+    FIND_BY_BUS
+} testUSBFindFlags;
+
+struct findTestInfo {
+    const char *name;
+    unsigned int vendor;
+    unsigned int product;
+    unsigned int bus;
+    unsigned int devno;
+    const char *vroot;
+    bool mandatory;
+    int how;
+    bool expectFailure;
+};
+
+static int testDeviceFileActor(virUSBDevicePtr dev,
+                               const char *path,
+                               void *opaque ATTRIBUTE_UNUSED)
+{
+    char *str = NULL;
+    int ret = 0;
+
+    if (virAsprintf(&str, USB_DEVFS "%03d/%03d",
+                    virUSBDeviceGetBus(dev),
+                    virUSBDeviceGetDevno(dev)) < 0)
+        return -1;
+
+    if (STRNEQ(path, str)) {
+        virReportError(VIR_ERR_INTERNAL_ERROR,
+                       "Device path '%s' does not match expected '%s'",
+                       path, str);
+        ret = -1;
+    }
+    VIR_FREE(str);
+    return ret;
+}
+
+static int testDeviceFind(const void *opaque)
+{
+    const struct findTestInfo *info = opaque;
+    int ret = -1;
+    virUSBDevicePtr dev = NULL;
+    virUSBDeviceListPtr devs = NULL;
+    int rv = 0;
+    size_t i, ndevs = 0;
+
+    switch (info->how) {
+    case FIND_BY_ALL:
+        rv = virUSBDeviceFind(info->vendor, info->product,
+                              info->bus, info->devno,
+                              info->vroot, info->mandatory, &dev);
+        break;
+    case FIND_BY_VENDOR:
+        rv = virUSBDeviceFindByVendor(info->vendor, info->product,
+                                      info->vroot, info->mandatory, &devs);
+        break;
+    case FIND_BY_BUS:
+        rv = virUSBDeviceFindByBus(info->bus, info->devno,
+                                   info->vroot, info->mandatory, &dev);
+        break;
+    }
+
+    if (info->expectFailure) {
+        if (rv == 0) {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           "unexpected success");
+        } else {
+            ret = 0;
+        }
+        goto cleanup;
+    } else if (rv < 0) {
+        goto cleanup;
+    }
+
+    switch (info->how) {
+    case FIND_BY_ALL:
+    case FIND_BY_BUS:
+        if (virUSBDeviceFileIterate(dev, testDeviceFileActor, NULL) < 0)
+            goto cleanup;
+        break;
+
+    case FIND_BY_VENDOR:
+        ndevs = virUSBDeviceListCount(devs);
+
+        for (i = 0; i < ndevs; i++) {
+            virUSBDevicePtr device = virUSBDeviceListGet(devs, i);
+            if (virUSBDeviceFileIterate(device, testDeviceFileActor, NULL) < 0)
+                goto cleanup;
+        }
+        break;
+    }
+
+    ret = 0;
+
+cleanup:
+    virObjectUnref(devs);
+    virUSBDeviceFree(dev);
+    return ret;
+}
+
+
+static int
+mymain(void)
+{
+    int rv = 0;
+
+#define DO_TEST_FIND_FULL(name, vend, prod, bus, devno, vroot, mand, how, fail) \
+    do {                                                                    \
+        struct findTestInfo data = { name, vend, prod, bus,                 \
+            devno, vroot, mand, how, fail                                   \
+        };                                                                  \
+        if (virtTestRun("USBDeviceFind " name, testDeviceFind, &data) < 0)  \
+            rv = -1;                                                        \
+    } while (0)
+
+#define DO_TEST_FIND(name, vend, prod, bus, devno)                          \
+    DO_TEST_FIND_FULL(name, vend, prod, bus, devno, NULL, true,             \
+                      FIND_BY_ALL, false)
+#define DO_TEST_FIND_FAIL(name, vend, prod, bus, devno)                     \
+    DO_TEST_FIND_FULL(name, vend, prod, bus, devno, NULL, true,             \
+                      FIND_BY_ALL, true)
+
+#define DO_TEST_FIND_BY_BUS(name, bus, devno)                               \
+    DO_TEST_FIND_FULL(name, 101, 202, bus, devno, NULL, true,               \
+                      FIND_BY_BUS, false)
+#define DO_TEST_FIND_BY_BUS_FAIL(name, bus, devno)                          \
+    DO_TEST_FIND_FULL(name, 101, 202, bus, devno, NULL, true,               \
+                      FIND_BY_BUS, true)
+
+#define DO_TEST_FIND_BY_VENDOR(name, vend, prod)                            \
+    DO_TEST_FIND_FULL(name, vend, prod, 123, 456, NULL, true,               \
+                      FIND_BY_VENDOR, false)
+#define DO_TEST_FIND_BY_VENDOR_FAIL(name, vend, prod)                       \
+    DO_TEST_FIND_FULL(name, vend, prod, 123, 456, NULL, true,               \
+                      FIND_BY_VENDOR, true)
+
+    DO_TEST_FIND("Nexus", 0x18d1, 0x4e22, 1, 20);
+    DO_TEST_FIND_FAIL("Nexus wrong devnum", 0x18d1, 0x4e22, 1, 25);
+    DO_TEST_FIND_FAIL("Bogus", 0xf00d, 0xbeef, 1024, 768);
+
+    DO_TEST_FIND_BY_BUS("integrated camera", 1, 5);
+    DO_TEST_FIND_BY_BUS_FAIL("wrong bus/devno combination", 2, 20);
+    DO_TEST_FIND_BY_BUS_FAIL("missing bus", 5, 20);
+    DO_TEST_FIND_BY_BUS_FAIL("missing devnum", 1, 158);
+
+    DO_TEST_FIND_BY_VENDOR("Nexus (multiple results)", 0x18d1, 0x4e22);
+    DO_TEST_FIND_BY_VENDOR_FAIL("Bogus vendor and product", 0xf00d, 0xbeef);
+    DO_TEST_FIND_BY_VENDOR_FAIL("Valid vendor", 0x1d6b, 0xbeef);
+
+    if (rv < 0)
+        return EXIT_FAILURE;
+    return EXIT_SUCCESS;
+}
+
+VIRT_TEST_MAIN_PRELOAD(mymain, abs_builddir "/.libs/virusbmock.so")

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.1/devnum

@@ -0,0 +1 @@
+17

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.1/idProduct

@@ -0,0 +1 @@
+301b

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.1/idVendor

@@ -0,0 +1 @@
+04b3

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.3/devnum

@@ -0,0 +1 @@
+18

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.3/idProduct

@@ -0,0 +1 @@
+c069

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3.3/idVendor

@@ -0,0 +1 @@
+046d

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3/devnum

@@ -0,0 +1 @@
+16

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3/idProduct

@@ -0,0 +1 @@
+301a

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.3/idVendor

@@ -0,0 +1 @@
+04b3

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.4/devnum

@@ -0,0 +1 @@
+33

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.4/idProduct

@@ -0,0 +1 @@
+4e22

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.4/idVendor

@@ -0,0 +1 @@
+18d1

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.5/devnum

@@ -0,0 +1 @@
+29

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.5/idProduct

@@ -0,0 +1 @@
+4e22

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.5/idVendor

@@ -0,0 +1 @@
+18d1

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.6/devnum

@@ -0,0 +1 @@
+20

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.6/idProduct

@@ -0,0 +1 @@
+4e22

tests/virusbtestdata/sys_bus_usb/devices/1-1.5.6/idVendor

@@ -0,0 +1 @@
+18d1

tests/virusbtestdata/sys_bus_usb/devices/1-1.5/devnum

@@ -0,0 +1 @@
+15

tests/virusbtestdata/sys_bus_usb/devices/1-1.5/idProduct

@@ -0,0 +1 @@
+100a

tests/virusbtestdata/sys_bus_usb/devices/1-1.5/idVendor

@@ -0,0 +1 @@
+17ef

tests/virusbtestdata/sys_bus_usb/devices/1-1.6/devnum

@@ -0,0 +1 @@
+5

tests/virusbtestdata/sys_bus_usb/devices/1-1.6/idProduct

@@ -0,0 +1 @@
+b221

tests/virusbtestdata/sys_bus_usb/devices/1-1.6/idVendor

@@ -0,0 +1 @@
+04f2

tests/virusbtestdata/sys_bus_usb/devices/1-1/devnum

@@ -0,0 +1 @@
+2

tests/virusbtestdata/sys_bus_usb/devices/1-1/idProduct

@@ -0,0 +1 @@
+0024

tests/virusbtestdata/sys_bus_usb/devices/1-1/idVendor

@@ -0,0 +1 @@
+8087

tests/virusbtestdata/sys_bus_usb/devices/2-1.2/devnum

@@ -0,0 +1 @@
+4

tests/virusbtestdata/sys_bus_usb/devices/2-1.2/idProduct

@@ -0,0 +1 @@
+0011

tests/virusbtestdata/sys_bus_usb/devices/2-1.2/idVendor

@@ -0,0 +1 @@
+046a

tests/virusbtestdata/sys_bus_usb/devices/2-1/devnum

@@ -0,0 +1 @@
+2

tests/virusbtestdata/sys_bus_usb/devices/2-1/idProduct

@@ -0,0 +1 @@
+0024

tests/virusbtestdata/sys_bus_usb/devices/2-1/idVendor

@@ -0,0 +1 @@
+8087

tests/virusbtestdata/sys_bus_usb/devices/usb1/devnum

@@ -0,0 +1 @@
+1

tests/virusbtestdata/sys_bus_usb/devices/usb1/idProduct

@@ -0,0 +1 @@
+0002

tests/virusbtestdata/sys_bus_usb/devices/usb1/idVendor

@@ -0,0 +1 @@
+1d6b

tests/virusbtestdata/sys_bus_usb/devices/usb2/devnum

@@ -0,0 +1 @@
+1

tests/virusbtestdata/sys_bus_usb/devices/usb2/idProduct

@@ -0,0 +1 @@
+0002

tests/virusbtestdata/sys_bus_usb/devices/usb2/idVendor

@@ -0,0 +1 @@
+1d6b

tests/virusbtestdata/sys_bus_usb/devices/usb3/devnum

@@ -0,0 +1 @@
+1

tests/virusbtestdata/sys_bus_usb/devices/usb3/idProduct

@@ -0,0 +1 @@
+0002

tests/virusbtestdata/sys_bus_usb/devices/usb3/idVendor

@@ -0,0 +1 @@
+1d6b

tests/virusbtestdata/sys_bus_usb/devices/usb4/devnum

@@ -0,0 +1 @@
+1

tests/virusbtestdata/sys_bus_usb/devices/usb4/idProduct

@@ -0,0 +1 @@
+0003

tests/virusbtestdata/sys_bus_usb/devices/usb4/idVendor

@@ -0,0 +1 @@
+1d6b