Merge tag 'v1.90.2' into tod

Tag 1.90.2

tests/README.md

@@ -0,0 +1,94 @@
+`umockdev` Tests
+================
+`umockdev` tests use fingerprint devices mocked by [`umockdev`
+toolchain][umockdev].
+
+This document describes how to create a 'capture' test: a test that
+captures a picture of a fingerprint from the device (mocked by
+`umockdev`) and compares it with the standard one.
+
+Other kinds of `umockdev` tests could be created in a similar manner.
+
+
+'Capture' Test Creation
+-----------------------
+A new 'capture' test is created by means of `capture.py` script:
+
+1. Create (if needed) a directory for the driver under `tests`
+   directory:
+
+   `mkdir DRIVER`
+
+2. Prepare your execution environment.
+
+   In the next step a working and up to date libfprint is needed. This can be
+   achieved by installing it into your system. Alternatively, you can set
+   the following environment variables to run a local build:
+   - `export LD_PRELOAD=<meson-build-dir>/libfprint/libfprint-2.so`
+   - `export GI_TYPELIB_PATH=<meson-build-dir>/libfprint`
+
+   Also, sometimes the driver must be adopted to the emulated environment
+   (mainly if it uses random numbers, see `synaptics.c` for an example).
+   Set the following environment variable to enable this adaptation:
+   - `export FP_DEVICE_EMULATION=1`
+
+   Run the next steps in the same terminal.
+
+3. Find the real USB fingerprint device with `lsusb`, e.g.:
+
+   `Bus 001 Device 005: ID 138a:0090 Validity Sensors, Inc. VFS7500 Touch Fingerprint Sensor`
+
+   The following USB device is used in the example above:
+   `/dev/bus/usb/001/005`.
+
+4. Record information about this device:
+
+   `umockdev-record /dev/bus/usb/001/005 > DRIVER/device`
+
+5. Record interaction of `capture.py` (or other test) with the device:
+
+   `umockdev-record -i /dev/bus/usb/001/005=DRIVER/capture.ioctl -- python3 ./capture.py DRIVER/capture.png`
+
+   Files `capture.ioctl` and `capture.png` will be created as the
+   result of this command.
+
+6. Add driver's name to `drivers_tests` in the `meson.build`.
+7. Check whether everything works as expected.
+
+**Note.** To avoid submitting a real fingerprint, the side of finger,
+arm, or anything else producing an image with the device can be used.
+
+
+Possible Issues
+---------------
+`umockdev-record` aggressively groups URBs. In most cases, manual
+intervention is unfortunately required. Often, drivers do a chain of
+commands like: A then B each with a different reply. However,
+`umockdev-record` could create a file like this:
+
+    A
+     reply 1
+     reply 2
+    B
+     reply 1
+     reply 2
+
+In that case, records must be re-ordered:
+
+    A
+     reply 1
+    B
+     reply 1
+    A
+     reply 2
+    B
+     reply 2
+
+Other changes may be needed to get everything working. For example the
+`elan` driver relies on a timeout that is not reported correctly. In
+this case the driver works around it by interpreting the protocol
+error differently in the virtual environment (by means of
+`FP_DEVICE_EMULATION` environment variable).
+
+
+[umockdev]: https://github.com/martinpitt/umockdev

tests/meson.build

@@ -18,8 +18,9 @@ envs.set('NO_AT_BRIDGE', '1')
 
 drivers_tests = [
     'elan',
-    'vfs5011',
     'synaptics',
+    'vfs0050',
+    'vfs5011',
 ]
 
 if get_option('introspection')

tests/test-device-fake.c

@@ -100,7 +100,10 @@ fpi_device_fake_enroll (FpDevice *device)
   fpi_device_get_enroll_data (device, (FpPrint **) &fake_dev->action_data);
 
   if (!print && !fake_dev->ret_error)
-    fpi_device_get_enroll_data (device, &print);
+    {
+      fpi_device_get_enroll_data (device, &print);
+      fpi_print_set_type (print, FPI_PRINT_RAW);
+    }
 
   fpi_device_enroll_complete (device,
                               print ? g_object_ref (print) : NULL,
@@ -189,6 +192,7 @@ static void
 fpi_device_fake_capture (FpDevice *device)
 {
   FpiDeviceFake *fake_dev = FPI_DEVICE_FAKE (device);
+  gboolean wait_for_finger;
 
   fake_dev->last_called_function = fpi_device_fake_capture;
   g_assert_cmpuint (fpi_device_get_current_action (device), ==, FPI_DEVICE_ACTION_CAPTURE);
@@ -199,7 +203,8 @@ fpi_device_fake_capture (FpDevice *device)
       return;
     }
 
-  fpi_device_get_capture_data (device, (gboolean *) &fake_dev->action_data);
+  fpi_device_get_capture_data (device, &wait_for_finger);
+  fake_dev->action_data = GINT_TO_POINTER (wait_for_finger);
   fpi_device_capture_complete (device, fake_dev->ret_image, fake_dev->ret_error);
 }
 
@@ -234,7 +239,7 @@ fpi_device_fake_delete (FpDevice *device)
       return;
     }
 
-  fpi_device_get_delete_data (device, (gpointer) (&fake_dev->action_data));
+  fpi_device_get_delete_data (device, (FpPrint **) (&fake_dev->action_data));
   fpi_device_delete_complete (device, fake_dev->ret_error);
 }
 

tests/test-fpi-assembling.c

@@ -81,6 +81,8 @@ test_frame_assembling (void)
   ctx.frame_height = 20;
   ctx.image_width = width;
 
+  g_assert (height > ctx.frame_height);
+
   offset = 10;
   test_height = height - (height - ctx.frame_height) % offset;
 

tests/test-fpi-device.c

@@ -541,6 +541,24 @@ test_driver_enroll_error_no_print (void)
   g_assert_true (error == g_steal_pointer (&fake_dev->ret_error));
   g_assert_null (out_print);
   g_assert_null (fake_dev->ret_print);
+  g_clear_error (&error);
+
+  g_test_expect_message (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING,
+                         "*Driver did not set the type on the returned print*");
+
+  fake_dev->ret_error = NULL;
+  fake_dev->ret_print = fp_print_new (device); /* Type not set. */
+  g_object_add_weak_pointer (G_OBJECT (fake_dev->ret_print),
+                             (gpointer) (&fake_dev->ret_print));
+  out_print =
+    fp_device_enroll_sync (device, fp_print_new (device), NULL, NULL, NULL, &error);
+
+  g_test_assert_expected_messages ();
+  g_assert (fake_dev->last_called_function == dev_class->enroll);
+  g_assert_error (error, FP_DEVICE_ERROR, FP_DEVICE_ERROR_GENERAL);
+  g_assert_null (out_print);
+  g_assert_null (fake_dev->ret_print);
+  g_clear_error (&error);
 }
 
 typedef struct
@@ -635,7 +653,7 @@ test_driver_enroll_progress (void)
 {
   g_autoptr(FpAutoResetClass) dev_class = auto_reset_device_class ();
   g_autoptr(FpAutoCloseDevice) device = NULL;
-  g_autoptr(FpPrint) enrolled_print = NULL;
+  G_GNUC_UNUSED g_autoptr(FpPrint) enrolled_print = NULL;
   ExpectedEnrollData expected_enroll_data = {0};
   FpiDeviceFake *fake_dev;
 
@@ -959,7 +977,7 @@ test_driver_verify_complete_retry (void)
 
   g_test_assert_expected_messages ();
   g_assert_true (error != g_steal_pointer (&fake_dev->ret_error));
-  g_assert_true (error != g_steal_pointer (&fake_dev->user_data));
+  g_steal_pointer (&fake_dev->user_data);
   g_assert_error (error, FP_DEVICE_ERROR, FP_DEVICE_ERROR_GENERAL);
   g_assert_true (match_data->called);
   g_assert_error (match_data->error, FP_DEVICE_RETRY, FP_DEVICE_RETRY_TOO_SHORT);
@@ -981,7 +999,7 @@ test_driver_verify_complete_retry (void)
   g_test_assert_expected_messages ();
 
   g_assert_true (error != g_steal_pointer (&fake_dev->ret_error));
-  g_assert_true (error != g_steal_pointer (&fake_dev->user_data));
+  g_steal_pointer (&fake_dev->user_data);
   g_assert_error (error, FP_DEVICE_ERROR, FP_DEVICE_ERROR_GENERAL);
   g_assert_true (match_data->called);
   g_assert_error (match_data->error, FP_DEVICE_RETRY, FP_DEVICE_RETRY_TOO_SHORT);
@@ -1001,7 +1019,7 @@ test_driver_verify_complete_retry (void)
   g_test_assert_expected_messages ();
 
   g_assert_true (error != g_steal_pointer (&fake_dev->ret_error));
-  g_assert_true (error != g_steal_pointer (&fake_dev->user_data));
+  g_steal_pointer (&fake_dev->user_data);
   g_assert_error (error, FP_DEVICE_RETRY, FP_DEVICE_RETRY_GENERAL);
   g_assert_true (match_data->called);
   g_assert_error (match_data->error, FP_DEVICE_RETRY, FP_DEVICE_RETRY_GENERAL);
@@ -1296,7 +1314,7 @@ test_driver_identify_complete_retry (void)
   g_test_assert_expected_messages ();
 
   g_assert_true (error != g_steal_pointer (&fake_dev->ret_error));
-  g_assert_true (error != g_steal_pointer (&fake_dev->user_data));
+  g_steal_pointer (&fake_dev->user_data);
   g_assert_error (error, FP_DEVICE_ERROR, FP_DEVICE_ERROR_GENERAL);
   g_assert_true (match_data->called);
   g_assert_error (match_data->error, FP_DEVICE_RETRY, FP_DEVICE_RETRY_TOO_SHORT);
@@ -1355,7 +1373,7 @@ test_driver_identify_report_no_callback (void)
   g_autoptr(MatchCbData) match_data = g_new0 (MatchCbData, 1);
   g_autoptr(GPtrArray) prints = g_ptr_array_new_with_free_func (g_object_unref);
   g_autoptr(FpAutoCloseDevice) device = NULL;
-  g_autoptr(FpPrint) enrolled_print = NULL;
+  G_GNUC_UNUSED g_autoptr(FpPrint) enrolled_print = NULL;
   g_autoptr(FpPrint) print = NULL;
   g_autoptr(FpPrint) match = NULL;
   g_autoptr(GError) error = NULL;
@@ -1493,6 +1511,7 @@ test_driver_list (void)
   g_autoptr(FpAutoCloseDevice) device = auto_close_fake_device_new ();
   FpDeviceClass *dev_class = FP_DEVICE_GET_CLASS (device);
   FpiDeviceFake *fake_dev = FPI_DEVICE_FAKE (device);
+
   g_autoptr(GPtrArray) prints = g_ptr_array_new_with_free_func (g_object_unref);
   unsigned int i;
 
@@ -1515,6 +1534,7 @@ test_driver_list_error (void)
   g_autoptr(FpAutoCloseDevice) device = auto_close_fake_device_new ();
   FpDeviceClass *dev_class = FP_DEVICE_GET_CLASS (device);
   FpiDeviceFake *fake_dev = FPI_DEVICE_FAKE (device);
+
   g_autoptr(GPtrArray) prints = NULL;
 
   fake_dev->ret_error = fpi_device_error_new (FP_DEVICE_ERROR_GENERAL);
@@ -1891,7 +1911,7 @@ test_driver_action_error_all (void)
   g_autoptr(GPtrArray) prints = g_ptr_array_new_with_free_func (g_object_unref);
   g_autoptr(GError) error = NULL;
   FpDeviceClass *dev_class = FP_DEVICE_GET_CLASS (device);
-  FpiDeviceFake *fake_dev = FPI_DEVICE_FAKE (device);
+  FpiDeviceFake *fake_dev;
 
   fake_dev = FPI_DEVICE_FAKE (device);
   fake_dev->return_action_error = TRUE;
@@ -1962,7 +1982,7 @@ test_driver_action_error_fallback_all (void)
   g_autoptr(GPtrArray) prints = g_ptr_array_new_with_free_func (g_object_unref);
   g_autoptr(GError) error = NULL;
   FpDeviceClass *dev_class = FP_DEVICE_GET_CLASS (device);
-  FpiDeviceFake *fake_dev = FPI_DEVICE_FAKE (device);
+  FpiDeviceFake *fake_dev;
 
   fake_dev = FPI_DEVICE_FAKE (device);
   fake_dev->return_action_error = TRUE;

tests/test-fpi-ssm.c

@@ -200,7 +200,7 @@ test_ssm_new_full (void)
 static void
 test_ssm_new_no_handler (void)
 {
-  g_autoptr(FpiSsm) ssm = NULL;
+  G_GNUC_UNUSED g_autoptr(FpiSsm) ssm = NULL;
 
   g_test_expect_message (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,
                          "*BUG:*handler*");
@@ -211,7 +211,7 @@ test_ssm_new_no_handler (void)
 static void
 test_ssm_new_wrong_states (void)
 {
-  g_autoptr(FpiSsm) ssm = NULL;
+  G_GNUC_UNUSED g_autoptr(FpiSsm) ssm = NULL;
 
   g_test_expect_message (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,
                          "*BUG:*nr_states*");
@@ -1172,6 +1172,7 @@ test_ssm_subssm_start (void)
   g_autoptr(FpiSsm) subssm =
     ssm_test_new_full (FPI_TEST_SSM_STATE_NUM, "FPI_TEST_SUB_SSM");
   FpiSsmTestData *data = fpi_ssm_get_data (ssm);
+
   g_autoptr(FpiSsmTestData) subdata =
     fpi_ssm_test_data_ref (fpi_ssm_get_data (subssm));
 
@@ -1262,6 +1263,7 @@ test_ssm_subssm_start_with_started (void)
   g_autoptr(FpiSsm) subssm =
     ssm_test_new_full (FPI_TEST_SSM_STATE_NUM, "FPI_TEST_SUB_SSM");
   FpiSsmTestData *data = fpi_ssm_get_data (ssm);
+
   g_autoptr(FpiSsmTestData) subdata =
     fpi_ssm_test_data_ref (fpi_ssm_get_data (subssm));
 
@@ -1305,6 +1307,7 @@ test_ssm_subssm_start_with_delayed (void)
   g_autoptr(FpiSsm) subssm =
     ssm_test_new_full (FPI_TEST_SSM_STATE_NUM, "FPI_TEST_SUB_SSM");
   FpiSsmTestData *data = fpi_ssm_get_data (ssm);
+
   g_autoptr(FpiSsmTestData) subdata =
     fpi_ssm_test_data_ref (fpi_ssm_get_data (subssm));
   gpointer timeout_tracker = GUINT_TO_POINTER (TRUE);

tests/vfs0050/device

@@ -0,0 +1,83 @@
+P: /devices/pci0000:00/0000:00:14.0/usb1/1-9
+N: bus/usb/001/004=12011001FF10FF088A13500060000000010109022E00010100A0320904000004FF00000007050102400000070581024000000705820240000007058303080004
+E: DEVNAME=/dev/bus/usb/001/004
+E: DEVTYPE=usb_device
+E: DRIVER=usb
+E: PRODUCT=138a/50/60
+E: TYPE=255/16/255
+E: BUSNUM=001
+E: DEVNUM=004
+E: MAJOR=189
+E: MINOR=3
+E: SUBSYSTEM=usb
+E: ID_VENDOR=138a
+E: ID_VENDOR_ENC=138a
+E: ID_VENDOR_ID=138a
+E: ID_MODEL=0050
+E: ID_MODEL_ENC=0050
+E: ID_MODEL_ID=0050
+E: ID_REVISION=0060
+E: ID_SERIAL=138a_0050_6d1900a1a0c0
+E: ID_SERIAL_SHORT=6d1900a1a0c0
+E: ID_BUS=usb
+E: ID_USB_INTERFACES=:ff0000:
+E: ID_VENDOR_FROM_DATABASE=Validity Sensors, Inc.
+E: ID_MODEL_FROM_DATABASE=Swipe Fingerprint Sensor
+E: ID_PATH=pci-0000:00:14.0-usb-0:9
+E: ID_PATH_TAG=pci-0000_00_14_0-usb-0_9
+E: LIBFPRINT_DRIVER=Validity VFS0050
+A: authorized=1
+A: avoid_reset_quirk=0
+A: bConfigurationValue=1
+A: bDeviceClass=ff
+A: bDeviceProtocol=ff
+A: bDeviceSubClass=10
+A: bMaxPacketSize0=8
+A: bMaxPower=100mA
+A: bNumConfigurations=1
+A: bNumInterfaces= 1
+A: bcdDevice=0060
+A: bmAttributes=a0
+A: busnum=1
+A: configuration=
+H: descriptors=12011001FF10FF088A13500060000000010109022E00010100A0320904000004FF00000007050102400000070581024000000705820240000007058303080004
+A: dev=189:3
+A: devnum=4
+A: devpath=9
+L: driver=../../../../../bus/usb/drivers/usb
+A: idProduct=0050
+A: idVendor=138a
+A: ltm_capable=no
+A: maxchild=0
+L: port=../1-0:1.0/usb1-port9
+A: power/active_duration=19312
+A: power/async=enabled
+A: power/autosuspend=2
+A: power/autosuspend_delay_ms=2000
+A: power/connected_duration=1037732
+A: power/control=auto
+A: power/level=auto
+A: power/persist=1
+A: power/runtime_active_kids=0
+A: power/runtime_active_time=19151
+A: power/runtime_enabled=enabled
+A: power/runtime_status=active
+A: power/runtime_suspended_time=1018305
+A: power/runtime_usage=0
+A: power/wakeup=disabled
+A: power/wakeup_abort_count=
+A: power/wakeup_active=
+A: power/wakeup_active_count=
+A: power/wakeup_count=
+A: power/wakeup_expire_count=
+A: power/wakeup_last_time_ms=
+A: power/wakeup_max_time_ms=
+A: power/wakeup_total_time_ms=
+A: quirks=0x0
+A: removable=fixed
+A: rx_lanes=1
+A: serial=6d1900a1a0c0
+A: speed=12
+A: tx_lanes=1
+A: urbnum=8
+A: version= 1.10

tests/virtual-image.py

@@ -3,11 +3,10 @@
 import sys
 try:
     import gi
-    gi.require_version('FPrint', '2.0')
-    from gi.repository import FPrint, GLib, Gio
-
     import os
-    import sys
+
+    from gi.repository import GLib, Gio
+
     import unittest
     import socket
     import struct
@@ -20,6 +19,8 @@ except Exception as e:
     print("Missing dependencies: %s" % str(e))
     sys.exit(77)
 
+FPrint = None
+
 # Re-run the test with the passed wrapper if set
 wrapper = os.getenv('LIBFPRINT_TEST_WRAPPER')
 if wrapper:
@@ -101,12 +102,14 @@ class VirtualImage(unittest.TestCase):
         del self.con
         self.dev.close_sync()
 
-    def send_retry(self, retry_error=FPrint.DeviceRetry.TOO_SHORT, iterate=True):
+    def send_retry(self, retry_error=None, iterate=True):
+        retry_error = retry_error if retry_error else FPrint.DeviceRetry.TOO_SHORT
         self.con.sendall(struct.pack('ii', -1, retry_error))
         while iterate and ctx.pending():
             ctx.iteration(False)
 
-    def send_error(self, device_error=FPrint.DeviceError.GENERAL, iterate=True):
+    def send_error(self, device_error=None, iterate=True):
+        device_error = device_error if device_error else FPrint.DeviceError.GENERAL
         self.con.sendall(struct.pack('ii', -2, device_error))
         while iterate and ctx.pending():
             ctx.iteration(False)
@@ -346,5 +349,12 @@ class VirtualImage(unittest.TestCase):
         assert(not self._verify_match)
 
 if __name__ == '__main__':
+    try:
+        gi.require_version('FPrint', '2.0')
+        from gi.repository import FPrint
+    except Exception as e:
+        print("Missing dependencies: %s" % str(e))
+        sys.exit(77)
+
     # avoid writing to stderr
     unittest.main(testRunner=unittest.TextTestRunner(stream=sys.stdout, verbosity=2))