Merge ~andch/plainbox-provider-pc-sanity:check-fingerprint-device into plainbox-provider-pc-sanity:master

[Andy Chi]

Add test case to check if USB fingerprint device is supported in upstream and ubuntu release libfprint or not.

Test on Synaptics DUT.

Case 1: Upstream supported but not in ubuntu release package
Category: com.canonical.plainbox::miscellanea
... 8< -------------------------------------------------------------------------
--2022-03-01 22:56:41-- https://raw.githubusercontent.com/freedesktop/libfprint/master/data/autosuspend.hwdb
Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.108.133, 2606:50c0:8003::154, 2606:50c0:8002::154, ...
Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.108.133|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 5720 (5.6K) [text/plain]
Saving to: ‘/tmp/autosuspend.hwdb’

     0K ..... 100% 37.4M=0s

2022-03-01 22:56:41 (37.4 MB/s) - ‘/tmp/autosuspend.hwdb’ saved [5720/5720]

Device ID 06cbp00f0 is supported in upstream
Please start SRU process to land the ID into current Release version
------------------------------------------------------------------------- >8 ---
Outcome: job failed
Finalizing session that hasn't been submitted anywhere: checkbox-run-2022-03-01T14.56.41
==================================[ Results ]===================================
 ☑ : Collect information about installed software packages
 ☒ : Check USB fingerprint device is supported or not.

Case 2: upstream supported and also ubuntu release package
--2022-03-01 22:58:20-- https://raw.githubusercontent.com/freedesktop/libfprint/master/data/autosuspend.hwdb
Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.110.133, 185.199.108.133, 185.199.109.133, ...
Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.110.133|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 5720 (5.6K) [text/plain]
Saving to: ‘/tmp/autosuspend.hwdb’

     0K ..... 100% 36.8M=0s

2022-03-01 22:58:21 (36.8 MB/s) - ‘/tmp/autosuspend.hwdb’ saved [5720/5720]

Device ID 27c6p63ac is supported in upstream
ID is supported in current libfprint
------------------------------------------------------------------------- >8 ---
Outcome: job passed
Finalizing session that hasn't been submitted anywhere: checkbox-run-2022-03-01T14.58.20
==================================[ Results ]===================================
 ☑ : Collect information about installed software packages
 ☑ : Check USB fingerprint device is supported or not.

[jeremyszu (os369510)]

Please also ensure the variable is there before use.

review: Needs Fixing

[OEM Taipei Bot (oem-taipei-bot)]

[autopkgtest]
help PASS
checkbox-cli-list PASS
bootstrap-pc-sanity PASS
cvescan PASS

https://oem-share.canonical.com/partners/lyoncore/share/artifacts/plainbox-provider-pc-sanity/plainbox-provider-pc-sanity-1.0.1ubuntu1-a96897f-in-linux-container-focal

[OEM Taipei Bot (oem-taipei-bot)]

[autopkgtest]
help PASS
checkbox-cli-list PASS
bootstrap-pc-sanity PASS
cvescan PASS

https://oem-share.canonical.com/partners/lyoncore/share/artifacts/plainbox-provider-pc-sanity/plainbox-provider-pc-sanity-1.0.1ubuntu1-b2d8b91-in-linux-container-focal

[OEM Taipei Bot (oem-taipei-bot)]

[autopkgtest]
blame: .
badpkg: rules build failed with exit code 2
erroneous package: rules build failed with exit code 2

https://oem-share.canonical.com/partners/lyoncore/share/artifacts/plainbox-provider-pc-sanity/plainbox-provider-pc-sanity-1.0.1ubuntu1-b2d8b91-in-linux-container-jammy

Unmerged commits

b2d8b91... by Andy Chi on 2022-03-01

Add test case to check if device support fingerprint or not.

diff --git a/bin/detect-fingerprint.sh b/bin/detect-fingerprint.sh
new file mode 100755
index 0000000..0e314e4
--- /dev/null
+++ b/bin/detect-fingerprint.sh
@@ -0,0 +1,46 @@
+#!/bin/bash
+
+UPSTREAM_SUPPORT=0
+UBUNTU_RELEASE_SUPPORT=0
+FINGERPRINT_ID=$(lsusb | grep -E "Goodix|Synaptics|Elan" | cut -d " " -f 6 | tr ':' 'p')
+LIBFPRINT_VERSION=$(dpkg -l | grep libfprint-2-2 | awk '{print $3}')
+
+# Clone get device list from libfprint upstream
+wget --tries=5 --timeout=60 https://raw.githubusercontent.com/freedesktop/libfprint/master/data/autosuspend.hwdb -P /tmp
+[ ! -f /tmp/autosuspend.hwdb ] && echo "No upstream file" && exit 0
+
+if [[ "$LIBFPRINT_VERSION" =~ "1:1.90.2+tod1-0ubuntu1".* ]]; then
+    LIBFPRINT_SUPPORT_LIST=$(< /lib/udev/rules.d/60-libfprint-2.rules grep "ENV{LIBFPRINT_DRIVER}" | cut -d ',' -f 3 | cut -d '=' -f 3 | sed 's/"//g' | tr '[:upper:]' '[:lower:]')
+else
+    LIBFPRINT_SUPPORT_LIST=$(< /lib/udev/hwdb.d/60-autosuspend-libfprint-2.hwdb grep usb | cut -d ":" -f 2 | cut -d "p" -f 2 | sed 's/*$//g' | tr '[:upper:]' '[:lower:]')
+fi
+
+for upstream_support_id in $(< /tmp/autosuspend.hwdb grep usb | cut -d ":" -f 2 | tr '[:upper:]' '[:lower:]')
+do
+    if [ "${upstream_support_id:1:9}" = "${FINGERPRINT_ID}" ]; then
+        UPSTREAM_SUPPORT=1
+		echo "Device ID ${FINGERPRINT_ID} is supported in upstream"
+    fi
+done
+
+for local_support_id in ${LIBFPRINT_SUPPORT_LIST}
+do
+    if [ "${local_support_id}" = "${FINGERPRINT_ID:5:4}" ]; then
+        UBUNTU_RELEASE_SUPPORT=1
+        echo "ID is supported in current libfprint"
+    fi
+done
+
+rm -rf /tmp/autosuspend.hwdb
+
+if [ $UPSTREAM_SUPPORT -eq 1 ] && [ $UBUNTU_RELEASE_SUPPORT -eq 1 ]; then
+    exit 0
+
+elif [ $UPSTREAM_SUPPORT -eq 1 ] && [ $UBUNTU_RELEASE_SUPPORT -eq 0 ]; then
+    echo "Please start SRU process to land the ID into current Release version"
+    exit 1
+
+elif [ $UPSTREAM_SUPPORT -eq 0 ]; then
+    echo "Please ask ODM to request fingerprint vendor to support in upstream"
+    exit 1
+fi
diff --git a/units/pc-sanity/pc-sanity-fingerprint.pxu b/units/pc-sanity/pc-sanity-fingerprint.pxu
new file mode 100644
index 0000000..f25bc9c
--- /dev/null
+++ b/units/pc-sanity/pc-sanity-fingerprint.pxu
@@ -0,0 +1,11 @@
+plugin: shell
+category_id: com.canonical.plainbox::miscellanea
+id: miscellanea/fingerprint-id-support
+requires:
+  package.name == 'libfprint-2-2'
+  package.name == 'wget'
+command: detect-fingerprint.sh
+_summary: Check USB fingerprint device is supported or not.
+_description:
+ Check USB fingerprint device is supported or not. Start SRU process or need
+ ODM to ask vendor to upstream their device.
diff --git a/units/pc-sanity/pc-sanity.pxu b/units/pc-sanity/pc-sanity.pxu
index bdf203d..db0546c 100644
--- a/units/pc-sanity/pc-sanity.pxu
+++ b/units/pc-sanity/pc-sanity.pxu
@@ -48,6 +48,7 @@ include:
     com.canonical.certification::miscellanea/check_.*_start_rt_ucode_failed
     com.canonical.certification::miscellanea/check_.*_start_wm_firmware_failed
     com.canonical.certification::miscellanea/check_.*_wifi6e_enabled
+    com.canonical.certification::miscellanea/fingerprint-id-support
 exclude:
     com.canonical.certification::suspend/bluetooth_obex_send_before_suspend
     com.canonical.certification::suspend/bluetooth_obex_send_after_suspend_auto
@@ -111,6 +112,7 @@ include:
     com.canonical.certification::miscellanea/check_.*_start_rt_ucode_failed
     com.canonical.certification::miscellanea/check_.*_start_wm_firmware_failed
     com.canonical.certification::miscellanea/check_.*_wifi6e_enabled
+    com.canonical.certification::miscellanea/fingerprint-id-support
 exclude:
     com.canonical.certification::after-suspend-bluetooth4/beacon_.*
     com.canonical.certification::bluetooth4/beacon_eddystone.*