Merge ~kissiel/checkbox-support:audio-settings-snappy into checkbox-support:master

[Maciej Kisielewski]

This MR makes audio_settings script from checkbox_support more snappy-aware.

By calling pulseaudio commands using `pulseaudio.` prefix when $SNAP envvar is found

[Maciej Kisielewski (kissiel)]

Let's use pactl everywhere and drop pacmd.

review: Needs Fixing

[Maciej Kisielewski (kissiel)]

Superseded by https://code.launchpad.net/~kissiel/checkbox-support/+git/checkbox-support/+merge/312665

review: Disapprove

Unmerged commits

b8736df... by Maciej Kisielewski on 2016-11-24

fix old pep8 issues in audio_settings.py

Signed-off-by: Maciej Kisielewski <email address hidden>

a049e9c... by Maciej Kisielewski on 2016-11-23

make audio_settings.py snappy-friendly

By replacing direct invocations to pactl and pacmd (PulseAudio control and
command), with pulseaudio.pactl if $SNAP is present in environ.

Signed-off-by: Maciej Kisielewski <email address hidden>

diff --git a/checkbox_support/scripts/audio_settings.py b/checkbox_support/scripts/audio_settings.py
index a4000b5..19bcad0 100644
--- a/checkbox_support/scripts/audio_settings.py
+++ b/checkbox_support/scripts/audio_settings.py
@@ -43,6 +43,17 @@ name_regex = re.compile("(?<=Name:).*")
 
 entry_pattern = "Name: %s.*?(?=Properties)"
 
+if 'SNAP' in os.environ:
+    commands = {
+        'pactl': 'pulseaudio.pactl',
+        'pacmd': 'pulseaudio.pactl',
+    }
+else:
+    commands = {
+        'pactl': 'pactl',
+        'pacmd': 'pacmd',
+    }
+
 
 def unlocalized_env(reset={"LANG": "POSIX.UTF-8"}):
     """
@@ -69,7 +80,7 @@ def _guess_hdmi_profile(pactl_list):
 
     # First parse all cards for HDMI / DisplayPort ports
     for record in parse_pactl_output(pactl_list).record_list:
-        if not 'Card' in record.name:
+        if 'Card' not in record.name:
             continue
         card = re.sub('.*#', '', record.name)  # save the card id
         ports = [
@@ -94,7 +105,7 @@ def _guess_hdmi_profile(pactl_list):
     def check_available_port():
         match_found = False
         for record in parse_pactl_output(pactl_list).record_list:
-            if not port_status_location in record.name:
+            if port_status_location not in record.name:
                 continue
             for sink_port in record.attribute_map['Ports'].value:
                 for card, ports in hdmi_ports.items():
@@ -128,7 +139,8 @@ def set_profile_hdmi():
     used as a fallback for setting HDMI / DisplayPort as the output device.
     """
     pactl_list = check_output(
-        ['pactl', 'list'], universal_newlines=True, env=unlocalized_env())
+        [commands['pactl'], 'list'], universal_newlines=True,
+        env=unlocalized_env())
 
     card, profile = _guess_hdmi_profile(pactl_list)
     if not profile:
@@ -137,7 +149,7 @@ def set_profile_hdmi():
 
     # Try and set device as default audio output
     try:
-        check_call(["pactl", "set-card-profile", card, profile])
+        check_call([commands["pactl"], "set-card-profile", card, profile])
     except CalledProcessError as error:
         logging.error("Failed setting audio output to:%s: %s" %
                       (profile, error))
@@ -146,7 +158,8 @@ def set_profile_hdmi():
 def get_current_profiles_settings(profiles_file):
     """Captures and Writes current audio profiles settings"""
     pactl_list = check_output(
-        ['pactl', 'list'], universal_newlines=True, env=unlocalized_env())
+        [commands['pactl'], 'list'], universal_newlines=True,
+        env=unlocalized_env())
 
     config = configparser.ConfigParser()
 
@@ -176,8 +189,8 @@ def restore_profiles_settings(profiles_file):
 
     for card in config.sections():
         try:
-            check_call(["pactl", "set-card-profile", config[card]['name'],
-                       config[card]['profile']])
+            check_call([commands["pactl"], "set-card-profile",
+                       config[card]['name'], config[card]['profile']])
         except CalledProcessError as error:
             logging.error("Failed setting card <%s> profile to <%s>: %s" %
                           (config[card]['name'],
@@ -185,7 +198,7 @@ def restore_profiles_settings(profiles_file):
 
 
 def move_sinks(name):
-    sink_inputs = check_output(["pacmd", "list-sink-inputs"],
+    sink_inputs = check_output([commands["pacmd"], "list-sink-inputs"],
                                universal_newlines=True,
                                env=unlocalized_env())
     input_indexes = index_regex.findall(sink_inputs)
@@ -193,8 +206,8 @@ def move_sinks(name):
     for input_index in input_indexes:
         try:
             with open(os.devnull, 'wb') as DEVNULL:
-                check_call(["pacmd", "move-sink-input", input_index, name],
-                           stdout=DEVNULL)
+                check_call([commands["pacmd"], "move-sink-input", input_index,
+                           name], stdout=DEVNULL)
         except CalledProcessError:
             logging.error("Failed to move input %d to sink %d" %
                           (input_index, name))
@@ -210,7 +223,7 @@ def store_audio_settings(file):
         sys.exit(1)
 
     for type in TYPES:
-        pactl_status = check_output(["pactl", "info"],
+        pactl_status = check_output([commands["pactl"], "info"],
                                     universal_newlines=True,
                                     env=unlocalized_env())
         default_regex = re.compile(default_pattern % type.title())
@@ -218,7 +231,7 @@ def store_audio_settings(file):
 
         print("default_%s: %s" % (type, default), file=settings_file)
 
-        pactl_list = check_output(["pactl", "list", type + 's'],
+        pactl_list = check_output([commands["pactl"], "list", type + 's'],
                                   universal_newlines=True,
                                   env=unlocalized_env())
 
@@ -238,7 +251,7 @@ def store_audio_settings(file):
 
 def set_audio_settings(device, mute, volume):
     for type in TYPES:
-        pactl_entries = check_output(["pactl", "list", type + 's'],
+        pactl_entries = check_output([commands["pactl"], "list", type + 's'],
                                      universal_newlines=True,
                                      env=unlocalized_env())
 
@@ -252,8 +265,8 @@ def set_audio_settings(device, mute, volume):
                     logging.info("[ Fallback sink ]".center(80, '='))
                     logging.info("Name: {}".format(name))
                     with open(os.devnull, 'wb') as DEVNULL:
-                        check_call(["pacmd", "set-default-%s" % type, name],
-                                   stdout=DEVNULL)
+                        check_call([commands["pacmd"], "set-default-%s" % type,
+                                   name], stdout=DEVNULL)
                 except CalledProcessError:
                     logging.error("Failed to set default %s" % type)
                     sys.exit(1)
@@ -262,14 +275,14 @@ def set_audio_settings(device, mute, volume):
                     move_sinks(name)
 
                 try:
-                    check_call(["pactl",
+                    check_call([commands["pactl"],
                                 "set-%s-mute" % type, name, str(int(mute))])
                 except:
                     logging.error("Failed to set mute for %s" % name)
                     sys.exit(1)
 
                 try:
-                    check_call(["pactl", "set-%s-volume" % type,
+                    check_call([commands["pactl"], "set-%s-volume" % type,
                                name, str(volume) + '%'])
                 except:
                     logging.error("Failed to set volume for %s" % name)
@@ -303,7 +316,7 @@ def restore_audio_settings(file):
 
         try:
             with open(os.devnull, 'wb') as DEVNULL:
-                check_call(["pacmd", "set-default-%s" % type, name],
+                check_call([commands["pacmd"], "set-default-%s" % type, name],
                            stdout=DEVNULL)
         except CalledProcessError:
             logging.error("Failed to restore default %s" % name)
@@ -313,13 +326,14 @@ def restore_audio_settings(file):
             move_sinks(name)
 
         try:
-            check_call(["pactl", "set-%s-mute" % type, name, muted])
+            check_call([commands["pactl"], "set-%s-mute" % type, name, muted])
         except:
             logging.error("Failed to restore mute for %s" % name)
             return 1
 
         try:
-            check_call(["pactl", "set-%s-volume" % type, name, volume])
+            check_call([commands["pactl"], "set-%s-volume" % type, name,
+                       volume])
         except:
             logging.error("Failed to restore volume for %s" % name)
             return 1