Merge ~clairlin/plainbox-provider-checkbox:add_BT_record_case into plainbox-provider-checkbox:master

[Clair Lin]

Add Bluetooth microphone recording test which is covered with HSP/HFP profile.

The Bluetooth test case only has a2dp profile test for now, we need to make sure the input function on bluetooth headset device and this also covers the HSP/HFP profile test.

22.04 pactl list cards: https://pastebin.canonical.com/p/pDGDY6s8XW/
20.04 pactl list cards: https://pastebin.canonical.com/p/3fYwD94nVJ/

[YANG, ZHI-HAO (isaacyang)]

Can test pass, need to use the good Bluetooth earphone, and one of my Bluetooth earphone, can't switch the correct HFP profile (either manual switch on GUI).

review: Approve

[Scott Hu (huntu207)]

review: Needs Fixing

[StanleyHuang (stanley31)]

I have some inline comments for this MR.
Are we going to perform tests if one of audio variable is not available?

review: Needs Information

[Clair Lin (clairlin)]

> I have some inline comments for this MR.
> Are we going to perform tests if one of audio variable is not available?

Add the bt_source variable to check the condition

[PeiYao Chang (baconyao)]

LGTM +1

review: Approve

[Pierre Equoy (pieq)]

Function tested OK on 22.04.

I added a few inline comments below. It would be good to address them before landing this.

review: Needs Fixing

[Pierre Equoy (pieq)]

Thanks for the changes!

There is one minor thing to be fixed (see below, inline).

Once this is done, you can approve it!

review: Needs Fixing

[Clair Lin (clairlin)]

10/11 remove '_description:'

[StanleyHuang (stanley31)]

LGTM

review: Approve

[Pierre Equoy (pieq)]

This PR was moved to Github:

https://github.com/canonical/checkbox/pull/15

I'll close this one on Launchpad and people can add comments on Github instead.

Unmerged commits

3e5ec3f... by Clair Lin on 2022-09-15

Add Bluetooth microphone recording test which is covered with HSP/HFP profile.

The Bluetooth test case only has a2dp profile test for now,
we need to make sure the input function on bluetooth headset device
and this also covers the HSP/HFP profile test.

diff --git a/units/bluetooth/jobs.pxu b/units/bluetooth/jobs.pxu
index d001dba..daeede6 100644
--- a/units/bluetooth/jobs.pxu
+++ b/units/bluetooth/jobs.pxu
@@ -415,4 +415,41 @@ command:
 flags: also-after-suspend
 _summary: Bluetooth OBEX send
 _description:
- This is an automated Bluetooth file transfer test. It sends an image to the device specified by the BTDEVADDR environment variable
\ No newline at end of file
+ This is an automated Bluetooth file transfer test. It sends an image to the device specified by the BTDEVADDR environment variable
+
+plugin: user-interact-verify
+category_id: com.canonical.plainbox::bluetooth
+id: bluetooth/audio_record_playback
+depends: bluetooth/detect-output
+estimated_duration: 120.0
+flags: also-after-suspend
+command:
+  audio_settings.py store --file="$PLAINBOX_SESSION_SHARE"/pulseaudio_settings
+  idx=$(pactl list cards short | awk '/bluez/{print $1}')
+  if [ "$idx" = "" ]; then
+    echo "Please enable and pair the bluetooth headset device"
+    exit 1
+  fi
+  bt_sink=$(pactl list sinks short | awk '/bluez/{print $2}')
+  bt_profile=$(pactl list cards | awk -v RS='' '/bluez/' | awk -F':' '{print $1}' | awk '/head_unit/{print $1}')
+  pactl set-card-profile "$idx" "$bt_profile"
+  pactl set-default-sink "$bt_sink"
+  bt_source=$(pactl list sources short | awk '/bluez_source/{print $2}')
+  if [ "$bt_source" = "" ]; then
+    echo "Please check your bluetooth support HSP/HFP profile"
+    exit 1
+  fi
+  pactl set-default-source "$bt_source"
+  alsa_record_playback.sh
+  EXIT_CODE=$?
+  audio_settings.py restore --file="$PLAINBOX_SESSION_SHARE"/pulseaudio_settings
+  exit $EXIT_CODE
+_purpose:
+     This test will check the Headset Head Unit (HSP/HFP) capability of your Bluetooth device,
+     to check if you can recording sounds
+_steps:
+     1. Enable and pair the bluetooth headset
+     2. Click "Test", then speak into your Bluetooth microphone.
+     3. After a few seconds, your speech will be played back to you.
+_verification:
+     Did you hear your speech played back?
\ No newline at end of file
diff --git a/units/bluetooth/test-plan.pxu b/units/bluetooth/test-plan.pxu
index b0301da..7953773 100644
--- a/units/bluetooth/test-plan.pxu
+++ b/units/bluetooth/test-plan.pxu
@@ -17,6 +17,7 @@ include:
  bluetooth/audio-a2dp                           certification-status=blocker
  bluetooth4/HOGP-mouse                          certification-status=blocker
  bluetooth4/HOGP-keyboard                       certification-status=blocker
+ bluetooth/audio_record_playback                certification-status=blocker
 
 id: bluetooth-cert-automated
 unit: test plan
@@ -37,6 +38,7 @@ include:
  bluetooth4/HOGP-mouse                          certification-status=blocker
  bluetooth4/HOGP-keyboard                       certification-status=blocker
  bluetooth/audio-a2dp                           certification-status=blocker
+ bluetooth/audio_record_playback                certification-status=blocker
 
 id: bluetooth-full
 unit: test plan
@@ -173,6 +175,7 @@ include:
  after-suspend-bluetooth/audio-a2dp                           certification-status=blocker
  after-suspend-bluetooth4/HOGP-mouse                          certification-status=blocker
  after-suspend-bluetooth4/HOGP-keyboard                       certification-status=blocker
+ after-suspend-bluetooth/audio_record_playback                certification-status=blocker
 
 id: after-suspend-bluetooth-cert-automated
 unit: test plan