7e386a10833541bb3ff4004c6b6e9a0a44e16fa0
[WebKit-https.git] / Tools / Scripts / webkitpy / layout_tests / 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
32 from webkitpy.layout_tests.port.server_process import ServerProcess
33 from webkitpy.layout_tests.port.driver import Driver
34
35 _log = logging.getLogger(__name__)
36
37
38 class XvfbDriver(Driver):
39     def _start(self, pixel_tests, per_test_args):
40
41         # Collect the number of X servers running already and make
42         # sure our Xvfb process doesn't clash with any of them.
43         def x_filter(process_name):
44             return process_name.find("Xorg") > -1
45
46         running_displays = len(self._port.host.executive.running_pids(x_filter))
47
48         # Use even displays for pixel tests and odd ones otherwise. When pixel tests are disabled,
49         # DriverProxy creates two drivers, one for normal and the other for ref tests. Both have
50         # the same worker number, so this prevents them from using the same Xvfb instance.
51         display_id = self._worker_number * 2 + running_displays
52         if pixel_tests:
53             display_id += 1
54         self._lock_file = "/tmp/.X%d-lock" % display_id
55
56         run_xvfb = ["Xvfb", ":%d" % display_id, "-screen",  "0", "800x600x24", "-nolisten", "tcp"]
57         with open(os.devnull, 'w') as devnull:
58             self._xvfb_process = self._port.host.executive.popen(run_xvfb, stderr=devnull)
59
60         server_name = self._port.driver_name()
61         environment = self._port.setup_environ_for_server(server_name)
62         # We must do this here because the DISPLAY number depends on _worker_number
63         environment['DISPLAY'] = ":%d" % display_id
64         # Drivers should use separate application cache locations
65         environment['XDG_CACHE_HOME'] = self._port.host.filesystem.join(self._port.results_directory(), '%s-appcache-%d' % (server_name, self._worker_number))
66
67         self._crashed_process_name = None
68         self._crashed_pid = None
69         self._server_process = self._port._server_process_constructor(self._port, server_name, self.cmd_line(pixel_tests, per_test_args), environment)
70         self._server_process.start()
71
72     def stop(self):
73         super(XvfbDriver, self).stop()
74         if getattr(self, '_xvfb_process', None):
75             self._port.host.executive.kill_process(self._xvfb_process.pid)
76             self._xvfb_process = None
77             if self._port.host.filesystem.exists(self._lock_file):
78                 self._port.host.filesystem.remove(self._lock_file)