Merge lp:~brendan-donegan/checkbox/bug916859_record_playback into lp:checkbox

[Brendan Donegan]

This branch introduces a script (written in Perl! Shock horror!) which manipulates the PulseAudio command line (pacmd) to ensure that when an audio test is run, the system is using the correct input and output, so that the test will be successful as long as the audio is working. I was careful to add functions to store and restore the users settings, so that these tests can still be used in Ubuntu Friendly.

Probably the nicest thing about this test is that all of the instructions in the usb_record_playback test are now superfluous, so I've removed them :)

Since the script is quite complex and the number of scenarios it can be used in numerous, I'd appreciate some independent testing of the script and the modified tests.

[lp:~brendan-donegan/checkbox/bug916859_record_playback]

1180. By Brendan Donegan on 2012-01-24

Remove Sound Settings instructions from usb_record_playback

[Marc Tardif (cr3)]

Any particular reason why the script is written in Perl? This makes it very difficult for most of the team to maintain, so I could volunteer to rewrite it in Python if you'd like.

review: Needs Information

[Brendan Donegan (brendan-donegan)]

I think for what it is, which is a script to basically glue together calls to the 'pacmd' tool, it's perfectly understandable. It basically does 3 things 'store', 'set' and 'restore'. Each of these functions constitutes only a handful of lines of code. Personally I think when you're heavily dependent on calling external commands like this, bash or perl is the way to go.

review: Needs Resubmitting

[Marc Tardif (cr3)]

In that case, since this seems to be the one and only Perl script in checkbox, we should at least add the corresponding package name to the Recommends line in the debian/control file. It doesn't strictly need to be in the Depends line because only a script depends on that package. By the way, I'm not sure whether the package should be expressed as just "perl" or something more esoteric like "${perl:Depends}".

review: Needs Fixing

[lp:~brendan-donegan/checkbox/bug916859_record_playback]

1181. By Brendan Donegan on 2012-01-25

Made audio_settings a bit more understandable and added a dependency on perl

1182. By Brendan Donegan on 2012-01-25

Updated debian changelog with entry for bug fix.

1183. By Brendan Donegan on 2012-01-25

Merged from trunk.

[Brendan Donegan (brendan-donegan)]

I added 'perl' to the list of dependencies. It seems {perl:Depends} would be replaced with whatever perl is a synonym for (like python is synonymous with python2.7 depending on the release). perl doesn't use this convention, so it seems just 'perl' will do.

review: Needs Resubmitting

[Marc Tardif (cr3)]

I've noticed some packages like slony1-bin uses the convention ${perl:Depends} whereas postgresql-8.4 just uses perl, so I'm easy either way. However, I would prefer that the dependency was added to Recommends rather than Depends because, as stated in my previous message, only the script has the dependency as opposed to the core.

review: Needs Fixing

[Brendan Donegan (brendan-donegan)]

Ok, hopefully should be better now. Sorry about that.

review: Needs Resubmitting

[lp:~brendan-donegan/checkbox/bug916859_record_playback]

1184. By Brendan Donegan on 2012-01-25

Put perl as a recommends instead of a depends

[Marc Tardif (cr3)]

Looks good and thanks for keeping the Recommends in alphabetical order! Merging...

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2012-01-25 15:03:00 +0000
+++ debian/changelog	2012-01-25 17:31:47 +0000
@@ -20,7 +20,9 @@
     output tests.
   * Added removable_storage_watcher script to replace watch_command to make
     testing USB, FireWire and MMC devices easier and more cohesive.
-  * Added memory_compare script to automate the memory/info job
+  * Added memory_compare script to automate the memory/info job 
+  * Switch audio settings to correct device before running audio tests
+    (LP: #916859)
 
   [Gabor Kelemen]
   * Fixed last two remaining strings with backslashes (LP: #868571)

=== modified file 'debian/control'
--- debian/control	2011-12-07 04:34:49 +0000
+++ debian/control	2012-01-25 17:31:47 +0000
@@ -14,7 +14,7 @@
 Replaces: hwtest (<< 0.1-0ubuntu12)
 Provides: hwtest
 Depends: ${misc:Depends}, ${python:Depends}, debconf, python-libxml2, udev
-Recommends: dpkg (>= 1.13), lsb-release, pm-utils, python-apport, python-apt, python-dateutil, python-gst0.10
+Recommends: dpkg (>= 1.13), lsb-release, perl, pm-utils, python-apport, python-apt, python-dateutil, python-gst0.10
 Suggests: checkbox-cli | checkbox-gtk, bonnie++, bootchart, bzr, cvs, ethtool, flex, fwts, git-core, hdparm, lshw, make, nmap, obexd-client, python-pexpect, smartmontools, sox, stress, wodim
 Conflicts: hwtest (<< 0.1-0ubuntu12)
 Description: System testing application 

=== modified file 'jobs/audio.txt.in'
--- jobs/audio.txt.in	2011-11-25 18:07:15 +0000
+++ jobs/audio.txt.in	2012-01-25 17:31:47 +0000
@@ -12,7 +12,7 @@
 requires:
  device.category == 'AUDIO'
  package.name == 'alsa-base' and package.name == 'python-gst0.10'
-command: gst_pipeline_test -t 2 'audiotestsrc wave=sine freq=512 ! audioconvert ! audioresample ! gconfaudiosink'
+command: audio_settings store $CHECKBOX_SHARE/pulseaudio_settings; audio_settings set --device=pci --volume=50; gst_pipeline_test -t 2 'audiotestsrc wave=sine freq=512 ! audioconvert ! audioresample ! gconfaudiosink'; audio_settings restore --file=$CHECKBOX_SHARE/pulseaudio_settings
 _description:
  PURPOSE:
      This test will check that internal speakers work correctly
@@ -29,7 +29,7 @@
 requires:
  device.category == 'AUDIO'
  package.name == 'alsa-base' and package.name == 'python-gst0.10'
-command: gst_pipeline_test -t 2 'audiotestsrc wave=sine freq=512 ! audioconvert ! audioresample ! gconfaudiosink'
+command: audio_settings store $CHECKBOX_SHARE/pulseaudio_settings; audio_settings set --device=pci --volume=50; gst_pipeline_test -t 2 'audiotestsrc wave=sine freq=512 ! audioconvert ! audioresample ! gconfaudiosink'; audio_settings restore --file=$CHECKBOX_SHARE/pulseaudio_settings
 _description:
  PURPOSE:
      This test will check that headphones connector works correctly
@@ -45,7 +45,7 @@
 requires:
  device.category == 'AUDIO'
  package.name == 'alsa-base'
-command: alsa_record_playback
+command: audio_settings store $CHECKBOX_SHARE/pulseaudio_settings; audio_settings set --device=pci --volume=50; alsa_record_playback; audio_settings restore --file=$CHECKBOX_SHARE/pulseaudio_settings
 _description:
  PURPOSE:
      This test will check that recording sound using the onboard microphone works correctly
@@ -62,7 +62,7 @@
 requires:
  device.category == 'AUDIO'
  package.name == 'alsa-base'
-command: alsa_record_playback
+command: audio_settings store $CHECKBOX_SHARE/pulseaudio_settings; audio_settings set --device=pci --volume=50; alsa_record_playback; audio_settings restore --file=$CHECKBOX_SHARE/pulseaudio_settings
 _description:
  PURPOSE:
      This test will check that recording sound using an external microphone works correctly
@@ -78,17 +78,14 @@
 requires:
  device.category == 'AUDIO'
  package.name == 'alsa-base'
-command: alsa_record_playback
+command: audio_settings store > $CHECKBOX_SHARE/pulseaudio_settings; audio_settings set --device=usb --volume=50; alsa_record_playback; audio_settings restore --file=$CHECKBOX_SHARE/pulseaudio_settings
 _description:
  PURPOSE:
      This test will check that a USB audio device works correctly
  STEPS:
      1. Connect a USB audio device to your system
-     2. Open the volume control application by left-clicking on the speaker icon in the panel and selecting "Sound Settings"
-     3. Select the "Input" tab and choose your USB device
-     4. Select the "Output" tab and choose your USB device
-     5. Click "Test", then speak into the microphone
-     6. After a few seconds, your speech will be played back to you
+     2. Click "Test", then speak into the microphone
+     3. After a few seconds, your speech will be played back to you
  VERIFICATION:
      Did you hear your speech played back through the USB headphones?
 

=== added file 'scripts/audio_settings'
--- scripts/audio_settings	1970-01-01 00:00:00 +0000
+++ scripts/audio_settings	2012-01-25 17:31:47 +0000
@@ -0,0 +1,108 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+
+use Getopt::Long;
+
+my $action = shift @ARGV;
+my @types = ('sink','source');
+
+if ($action eq "store") {
+    # Find the current sink and and its mute/volume settings
+    foreach my $type (@types) {
+         my $index = `pacmd list-${type}s | grep '* index' | awk -F': ' '{print \$2}'`;
+         chomp $index;
+         print "${type}_index: ${index}\n";
+
+         my $muted = `pacmd list-${type}s | grep -A15 '* index' | grep 'muted:' | awk -F': ' '{print \$2}'`;
+         chomp $muted;
+         print "${type}_muted: ${muted}\n";
+
+         my $volume = `pacmd list-${type}s | grep -A10 '* index' | grep 'volume: 0:' | awk '{print \$3}'`;
+         chomp $volume; chop $volume; # Strip off the trailing %
+         print "${type}_volume: ${volume}\n";
+    }
+}
+elsif ($action eq "set") {
+    print "Updating audio settings\n";
+    
+    my ($device, $mute, $volume);
+    $mute = 0;
+    $volume = 100;
+    GetOptions( 'device=s' => \$device,
+                'mute' => \$mute,
+                'volume=s' => \$volume);
+
+    if ($device) {
+        foreach my $type (@types) {
+            my $direction = ($type eq 'sink') ? 'out' : 'in';
+            my $index = `pacmd list-${type}s | grep -B4 alsa_${direction}put[.]$device | grep index | awk -F': ' '{print \$2}'`;
+            chomp $index;
+            system("pacmd set-default-$type $index");
+
+            if ($type eq 'sink') {
+                foreach my $input (`pacmd list-sink-inputs | grep index | awk -F': ' '{print \$2}'`) {
+                    chomp($input);
+                    system("pacmd move-sink-input $input $index");
+                }
+            }
+
+            system("pacmd set-${type}-mute $index $mute");
+
+            # Set the volume as requested
+            my $base_volume = `pacmd list-${type}s | grep -A15 alsa_${direction}put[.]$device | grep 'volume steps:' | awk -F': ' '{print \$2}'`;
+            chomp $base_volume;
+            my $new_volume = int($base_volume / 100 * $volume);
+            system("pacmd set-${type}-volume $index $new_volume");
+        }
+    }
+    else {
+        print "No device specified\n";
+    }
+}
+elsif ($action eq "restore") {
+    
+    my $file;
+    GetOptions( 'file=s' => \$file);
+
+    open PACMD_FILE, $file;
+
+    my $index;
+    foreach (<PACMD_FILE>) {
+        chomp;
+
+        foreach my $type (@types) {
+            if (/($type)_index/) {
+                $index = (split(/: /, $_))[-1];
+
+                system("pacmd set-default-$type $index");
+
+                if ($type eq 'sink') {
+                    foreach my $input (`pacmd list-sink-inputs | grep index | awk -F': ' '{print \$2}'`) {
+                        chomp($input);
+                        system("pacmd move-sink-input $input $index");
+                    }
+                }
+            }
+            elsif (/($type)_muted/) {
+                my $muted = (split(/: /, $_))[-1];
+
+                system("pacmd set-${type}-mute $index $muted");
+            }
+            elsif(/($type)_volume/) {
+                my $volume = (split(/: /, $_))[-1];
+
+                # Calculate volume from base volume
+                my $base_volume = `pacmd list-${type}s | grep -A15 'index: ${index}' | grep 'volume steps:' | awk -F': ' '{print \$2}'`;
+                chomp $base_volume;
+
+                my $new_volume = int($base_volume / 100 * $volume);
+                system("pacmd set-${type}-volume $index $new_volume");
+            }
+        }
+    }
+}
+else {
+    print "Invalid action!\n";
+}