Merge lp:~pieq/checkbox/fix-1595380 into lp:checkbox

[Pierre Equoy]

checkbox-support: Adapt audio_settings script to Xenial

We use `pactl` output to store and restore several audio values, such as the volume. Unfortunately, `pactl` output format changes from one release to another. The version shipped with Xenial was breaking out scripts and some of our audio jobs, resulting in false positive issues when performing QA testing.

This commit fixes this while remaining compatible with the `pactl` versionshipping with Trusty.

To test, you can, on Xenial, run the audio jobs that call audio_settings to store and restore the volume (e.g. audio/playback_auto, audio/playback_headphones, audio/{index}_playback_hdmi_{product_slug} ... )

[Sylvain Pineau (sylvain-pineau)]

+1 for the fix and +1 for the additional unit tests.

review: Approve

=== modified file 'checkbox-support/checkbox_support/scripts/audio_settings.py'
--- checkbox-support/checkbox_support/scripts/audio_settings.py	2015-09-02 04:01:31 +0000
+++ checkbox-support/checkbox_support/scripts/audio_settings.py	2016-06-23 10:18:24 +0000
@@ -38,7 +38,7 @@
 default_pattern = "(?<=Default %s: ).*"
 index_regex = re.compile("(?<=index: )[0-9]*")
 muted_regex = re.compile("(?<=Mute: ).*")
-volume_regex = re.compile("Volume: (?:0|front-left):\s*([0-9]*)")
+volume_regex = re.compile("Volume: (?:0|front-left):[\s\/0-9]*\s([0-9]*)")
 name_regex = re.compile("(?<=Name:).*")
 
 entry_pattern = "Name: %s.*?(?=Properties)"

=== modified file 'checkbox-support/checkbox_support/scripts/tests/test_audio_settings.py'
--- checkbox-support/checkbox_support/scripts/tests/test_audio_settings.py	2014-05-20 18:54:24 +0000
+++ checkbox-support/checkbox_support/scripts/tests/test_audio_settings.py	2016-06-23 10:18:24 +0000
@@ -24,7 +24,7 @@
 import os
 import unittest
 
-from checkbox_support.scripts.audio_settings import _guess_hdmi_profile
+from checkbox_support.scripts.audio_settings import _guess_hdmi_profile, volume_regex
 from checkbox_support.parsers.tests.test_pactl import PactlDataMixIn
 
 
@@ -154,3 +154,18 @@
             _guess_hdmi_profile(self.get_text(
                 "desktop-raring-t430s-dp-available")),
             ('2', 'output:hdmi-stereo'))
+
+class RegexTest(unittest.TestCase):
+    
+    def test_volume_regex_trusty(self):
+        """Testing pactl 4.0 output"""
+        pactl_volume = "    Volume: 0:  47% 1:  47%"
+        volume = int(volume_regex.search(pactl_volume).group(1).strip())
+        self.assertEqual(volume, 47)
+
+    def test_volume_regex_xenial(self):
+        """Testing pactl 8.0 output"""
+        # See lp:1595380 for more info
+        pactl_volume = "    Volume: front-left: 65536 / 100% / 0.00 dB,   front-right: 65536 / 100% / 0.00 dB"
+        volume = int(volume_regex.search(pactl_volume).group(1).strip())
+        self.assertEqual(volume, 100)