c42bad3b1df3f07bf819b6c384ba4bc9f5812acf
[WebKit-https.git] / Tools / Scripts / webkitpy / port / xvfbdriver.py
1 # Copyright (C) 2010 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the Google name nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 import logging
30 import os
31 import re
32 import time
33
34 from webkitpy.port.server_process import ServerProcess
35 from webkitpy.port.driver import Driver
36 from webkitpy.common.system.file_lock import FileLock
37
38 _log = logging.getLogger(__name__)
39
40
41 class XvfbDriver(Driver):
42     @staticmethod
43     def check_driver(port):
44         xvfb_found = port.host.executive.run_command(['which', 'Xvfb'], return_exit_code=True) is 0
45         if not xvfb_found:
46             _log.error("No Xvfb found. Cannot run layout tests.")
47         return xvfb_found
48
49     def __init__(self, *args, **kwargs):
50         Driver.__init__(self, *args, **kwargs)
51         self._guard_lock = None
52         self._startup_delay_secs = 1.0
53
54     def _next_free_display(self):
55         running_pids = self._port.host.executive.run_command(['ps', '-eo', 'comm,command'])
56         reserved_screens = set()
57         for pid in running_pids.split('\n'):
58             match = re.match('(X|Xvfb|Xorg)\s+.*\s:(?P<screen_number>\d+)', pid)
59             if match:
60                 reserved_screens.add(int(match.group('screen_number')))
61         for i in range(99):
62             if i not in reserved_screens:
63                 _guard_lock_file = self._port.host.filesystem.join('/tmp', 'WebKitXvfb.lock.%i' % i)
64                 self._guard_lock = self._port.host.make_file_lock(_guard_lock_file)
65                 if self._guard_lock.acquire_lock():
66                     return i
67
68     def _xvfb_screen_depth(self):
69         return os.environ.get('XVFB_SCREEN_DEPTH', '24')
70
71     def _start(self, pixel_tests, per_test_args):
72         self.stop()
73
74         # Use even displays for pixel tests and odd ones otherwise. When pixel tests are disabled,
75         # DriverProxy creates two drivers, one for normal and the other for ref tests. Both have
76         # the same worker number, so this prevents them from using the same Xvfb instance.
77         display_id = self._next_free_display()
78         self._lock_file = "/tmp/.X%d-lock" % display_id
79
80         server_name = self._port.driver_name()
81         environment = self._port.setup_environ_for_server(server_name)
82
83         llvmpipe_libgl_path = os.environ.get('LLVMPIPE_LIBGL_PATH')
84         if llvmpipe_libgl_path:
85             environment['LD_LIBRARY_PATH'] = '%s:%s' % (llvmpipe_libgl_path, os.environ.get('LD_LIBRARY_PATH', ''))
86
87         run_xvfb = ["Xvfb", ":%d" % display_id, "-screen",  "0", "800x600x%s" % self._xvfb_screen_depth(), "-nolisten", "tcp"]
88         with open(os.devnull, 'w') as devnull:
89             self._xvfb_process = self._port.host.executive.popen(run_xvfb, stderr=devnull)
90
91         # Crashes intend to occur occasionally in the first few tests that are run through each
92         # worker because the Xvfb display isn't ready yet. Halting execution a bit should avoid that.
93         time.sleep(self._startup_delay_secs)
94
95         # We must do this here because the DISPLAY number depends on _worker_number
96         environment['DISPLAY'] = ":%d" % display_id
97         self._driver_tempdir = self._port.host.filesystem.mkdtemp(prefix='%s-' % self._port.driver_name())
98         environment['DUMPRENDERTREE_TEMP'] = str(self._driver_tempdir)
99         environment['LOCAL_RESOURCE_ROOT'] = self._port.layout_tests_dir()
100
101         # Currently on WebKit2, there is no API for setting the application
102         # cache directory. Each worker should have it's own and it should be
103         # cleaned afterwards, so we set it to inside the temporary folder by
104         # prepending XDG_CACHE_HOME with DUMPRENDERTREE_TEMP.
105         environment['XDG_CACHE_HOME'] = self._port.host.filesystem.join(str(self._driver_tempdir), 'appcache')
106
107         self._crashed_process_name = None
108         self._crashed_pid = None
109         self._server_process = self._port._server_process_constructor(self._port, server_name, self.cmd_line(pixel_tests, per_test_args), environment)
110         self._server_process.start()
111
112     def stop(self):
113         super(XvfbDriver, self).stop()
114         if self._guard_lock:
115             self._guard_lock.release_lock()
116             self._guard_lock = None
117         if getattr(self, '_xvfb_process', None):
118             self._port.host.executive.kill_process(self._xvfb_process.pid)
119             self._xvfb_process = None
120             if self._port.host.filesystem.exists(self._lock_file):
121                 self._port.host.filesystem.remove(self._lock_file)