[GTK][EFL] Layout tests abort with PulseAudioSanitizer instance has no attribute...
[WebKit.git] / Tools / Scripts / webkitpy / port / pulseaudio_sanitizer.py
1 # Copyright (C) 2010 Google Inc. All rights reserved.
2 # Copyrigth (C) 2012 Intel Corporation
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the Google name nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 import logging
31 import os
32 import subprocess
33
34
35 _log = logging.getLogger(__name__)
36
37
38 # Shared by GTK and EFL for pulseaudio sanitizing before running tests.
39 class PulseAudioSanitizer:
40     def __init__(self):
41         self._pa_module_index = -1
42
43     def unload_pulseaudio_module(self):
44         # Unload pulseaudio's module-stream-restore, since it remembers
45         # volume settings from different runs, and could affect
46         # multimedia tests results
47         self._pa_module_index = -1
48         with open(os.devnull, 'w') as devnull:
49             try:
50                 pactl_process = subprocess.Popen(["pactl", "list", "short", "modules"], stdout=subprocess.PIPE, stderr=devnull)
51                 pactl_process.wait()
52             except OSError:
53                 # pactl might not be available.
54                 _log.debug('pactl not found. Please install pulseaudio-utils to avoid some potential media test failures.')
55                 return
56         modules_list = pactl_process.communicate()[0]
57         for module in modules_list.splitlines():
58             if module.find("module-stream-restore") >= 0:
59                 # Some pulseaudio-utils versions don't provide
60                 # the index, just an empty string
61                 self._pa_module_index = module.split('\t')[0] or -1
62                 try:
63                     # Since they could provide other stuff (not an index
64                     # nor an empty string, let's make sure this is an int.
65                     if int(self._pa_module_index) != -1:
66                         pactl_process = subprocess.Popen(["pactl", "unload-module", self._pa_module_index])
67                         pactl_process.wait()
68                         if pactl_process.returncode == 0:
69                             _log.debug('Unloaded module-stream-restore successfully')
70                         else:
71                             _log.debug('Unloading module-stream-restore failed')
72                 except ValueError:
73                         # pactl should have returned an index if the module is found
74                         _log.debug('Unable to parse module index. Please check if your pulseaudio-utils version is too old.')
75                 return
76
77     def restore_pulseaudio_module(self):
78         # If pulseaudio's module-stream-restore was previously unloaded,
79         # restore it back. We shouldn't need extra checks here, since an
80         # index != -1 here means we successfully unloaded it previously.
81         if self._pa_module_index != -1:
82             with open(os.devnull, 'w') as devnull:
83                 pactl_process = subprocess.Popen(["pactl", "load-module", "module-stream-restore"], stdout=devnull, stderr=devnull)
84                 pactl_process.wait()
85                 if pactl_process.returncode == 0:
86                     _log.debug('Restored module-stream-restore successfully')
87                 else:
88                     _log.debug('Restoring module-stream-restore failed')