1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
|
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved
# Copyright (C) 2006 Alexey Proskuryakov (ap@nypop.com)
# Copyright (C) 2010 Andras Becsi (abecsi@inf.u-szeged.hu), University of Szeged
# Copyright (C) 2011 Research In Motion Limited. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
# its contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# Module to share code to start and stop the Apache daemon.
use strict;
use warnings;
use File::Copy;
use File::Path;
use File::Spec;
use File::Spec::Functions;
use Fcntl ':flock';
use IPC::Open2;
use webkitdirs;
BEGIN {
use Exporter ();
our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
$VERSION = 1.00;
@ISA = qw(Exporter);
@EXPORT = qw(&getHTTPDPath
&hasHTTPD
&getHTTPDConfigPathForTestDirectory
&getDefaultConfigForTestDirectory
&openHTTPD
&closeHTTPD
&setShouldWaitForUserInterrupt
&waitForHTTPDLock
&getWaitTime);
%EXPORT_TAGS = ( );
@EXPORT_OK = ();
}
my $tmpDir = "/tmp";
my $httpdLockPrefix = "WebKitHttpd.lock.";
my $myLockFile;
my $exclusiveLockFile = File::Spec->catfile($tmpDir, "WebKit.lock");
my $httpdPidDir = File::Spec->catfile($tmpDir, "WebKit");
my $httpdPidFile = File::Spec->catfile($httpdPidDir, "httpd.pid");
my $httpdPid;
my $waitForUserInterrupt = 0;
my $waitBeginTime;
my $waitEndTime;
$SIG{'INT'} = 'handleInterrupt';
$SIG{'TERM'} = 'handleInterrupt';
sub getHTTPDPath
{
my $httpdPath;
if (isDebianBased()) {
$httpdPath = "/usr/sbin/apache2";
} else {
$httpdPath = "/usr/sbin/httpd";
}
return $httpdPath;
}
sub hasHTTPD
{
my @command = (getHTTPDPath(), "-v");
return system(@command) == 0;
}
sub getApacheVersion
{
my $httpdPath = getHTTPDPath();
my $version = `$httpdPath -v`;
$version =~ s/.*Server version: Apache\/(\d+\.\d+).*/$1/s;
return $version;
}
sub getDefaultConfigForTestDirectory
{
my ($testDirectory) = @_;
die "No test directory has been specified." unless ($testDirectory);
my $httpdConfig = getHTTPDConfigPathForTestDirectory($testDirectory);
my $documentRoot = "$testDirectory/http/tests";
my $jsTestResourcesDirectory = $testDirectory . "/fast/js/resources";
my $mediaResourcesDirectory = $testDirectory . "/media";
my $typesConfig = "$testDirectory/http/conf/mime.types";
my $httpdLockFile = File::Spec->catfile($httpdPidDir, "httpd.lock");
my $httpdScoreBoardFile = File::Spec->catfile($httpdPidDir, "httpd.scoreboard");
my @httpdArgs = (
"-f", "$httpdConfig",
"-C", "DocumentRoot \"$documentRoot\"",
# Setup a link to where the js test templates are stored, use -c so that mod_alias will already be loaded.
"-c", "Alias /js-test-resources \"$jsTestResourcesDirectory\"",
"-c", "Alias /media-resources \"$mediaResourcesDirectory\"",
"-c", "TypesConfig \"$typesConfig\"",
# Apache wouldn't run CGIs with permissions==700 otherwise
"-c", "User \"#$<\"",
"-c", "PidFile \"$httpdPidFile\"",
"-c", "ScoreBoardFile \"$httpdScoreBoardFile\"",
);
if (getApacheVersion() eq "2.2") {
push(@httpdArgs, "-c", "LockFile \"$httpdLockFile\"");
}
# FIXME: Enable this on Windows once <rdar://problem/5345985> is fixed
# The version of Apache we use with Cygwin does not support SSL
my $sslCertificate = "$testDirectory/http/conf/webkit-httpd.pem";
push(@httpdArgs, "-c", "SSLCertificateFile \"$sslCertificate\"") unless isCygwin();
return @httpdArgs;
}
sub getHTTPDConfigPathForTestDirectory
{
my ($testDirectory) = @_;
die "No test directory has been specified." unless ($testDirectory);
my $httpdConfig;
my $httpdPath = getHTTPDPath();
my $httpdConfDirectory = "$testDirectory/http/conf/";
my $apacheVersion = getApacheVersion();
if (isCygwin()) {
my $libPHP4DllPath = "/usr/lib/apache/libphp4.dll";
# FIXME: run-webkit-tests should not modify the user's system, especially not in this method!
unless (-x $libPHP4DllPath) {
copy("$httpdConfDirectory/libphp4.dll", $libPHP4DllPath);
chmod(0755, $libPHP4DllPath);
}
$httpdConfig = "cygwin-httpd.conf"; # This is an apache 1.3 config.
} elsif (isDebianBased()) {
$httpdConfig = "debian-httpd-$apacheVersion.conf";
} elsif (isFedoraBased()) {
$httpdConfig = "fedora-httpd-$apacheVersion.conf";
} else {
# All other ports use apache2, so just use our default apache2 config.
$httpdConfig = "apache2-httpd.conf";
}
return "$httpdConfDirectory/$httpdConfig";
}
sub openHTTPD(@)
{
my (@args) = @_;
die "No HTTPD configuration has been specified" unless (@args);
mkdir($httpdPidDir, 0755);
die "No write permissions to $httpdPidDir" unless (-w $httpdPidDir);
if (-f $httpdPidFile) {
open (PIDFILE, $httpdPidFile);
my $oldPid = <PIDFILE>;
chomp $oldPid;
close PIDFILE;
if (0 != kill 0, $oldPid) {
print "\nhttpd is already running: pid $oldPid, killing...\n";
if (!killHTTPD($oldPid)) {
cleanUp();
die "Timed out waiting for httpd to quit";
}
}
unlink $httpdPidFile;
}
my $httpdPath = getHTTPDPath();
open2(">&1", \*HTTPDIN, $httpdPath, @args);
my $retryCount = 20;
while (!-f $httpdPidFile && $retryCount) {
sleep 1;
--$retryCount;
}
if (!$retryCount) {
cleanUp();
die "Timed out waiting for httpd to start";
}
$httpdPid = <PIDFILE> if open(PIDFILE, $httpdPidFile);
chomp $httpdPid if $httpdPid;
close PIDFILE;
waitpid($httpdPid, 0) if ($waitForUserInterrupt && $httpdPid);
return 1;
}
sub closeHTTPD
{
close HTTPDIN;
my $succeeded = killHTTPD($httpdPid);
cleanUp();
unless ($succeeded) {
print STDERR "Timed out waiting for httpd to terminate!\n" unless $succeeded;
return 0;
}
return 1;
}
sub killHTTPD
{
my ($pid) = @_;
return 1 unless $pid;
kill 15, $pid;
my $retryCount = 20;
while (kill(0, $pid) && $retryCount) {
sleep 1;
--$retryCount;
}
return $retryCount != 0;
}
sub setShouldWaitForUserInterrupt
{
$waitForUserInterrupt = 1;
}
sub handleInterrupt
{
# On Cygwin, when we receive a signal Apache is still running, so we need
# to kill it. On other platforms (at least Mac OS X), Apache will have
# already been killed, and trying to kill it again will cause us to hang.
# All we need to do in this case is clean up our own files.
if (isCygwin()) {
closeHTTPD();
} else {
cleanUp();
}
print "\n";
exit(1);
}
sub cleanUp
{
rmdir $httpdPidDir;
unlink $exclusiveLockFile;
unlink $myLockFile if $myLockFile;
}
sub extractLockNumber
{
my ($lockFile) = @_;
return -1 unless $lockFile;
return substr($lockFile, length($httpdLockPrefix));
}
sub getLockFiles
{
opendir(TMPDIR, $tmpDir) or die "Could not open " . $tmpDir . ".";
my @lockFiles = grep {m/^$httpdLockPrefix\d+$/} readdir(TMPDIR);
@lockFiles = sort { extractLockNumber($a) <=> extractLockNumber($b) } @lockFiles;
closedir(TMPDIR);
return @lockFiles;
}
sub getNextAvailableLockNumber
{
my @lockFiles = getLockFiles();
return 0 unless @lockFiles;
return extractLockNumber($lockFiles[-1]) + 1;
}
sub getLockNumberForCurrentRunning
{
my @lockFiles = getLockFiles();
return 0 unless @lockFiles;
return extractLockNumber($lockFiles[0]);
}
sub waitForHTTPDLock
{
$waitBeginTime = time;
scheduleHttpTesting();
# If we are the only one waiting for Apache just run the tests without any further checking
if (scalar getLockFiles() > 1) {
my $currentLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getLockNumberForCurrentRunning());
my $currentLockPid = <SCHEDULER_LOCK> if (-f $currentLockFile && open(SCHEDULER_LOCK, "<$currentLockFile"));
# Wait until we are allowed to run the http tests
while ($currentLockPid && $currentLockPid != $$) {
$currentLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getLockNumberForCurrentRunning());
if ($currentLockFile eq $myLockFile) {
$currentLockPid = <SCHEDULER_LOCK> if open(SCHEDULER_LOCK, "<$currentLockFile");
if ($currentLockPid != $$) {
print STDERR "\nPID mismatch.\n";
last;
}
} else {
sleep 1;
}
}
}
$waitEndTime = time;
}
sub scheduleHttpTesting
{
# We need an exclusive lock file to avoid deadlocks and starvation and ensure that the scheduler lock numbers are sequential.
# The scheduler locks are used to schedule the running test sessions in first come first served order.
while (!(open(SEQUENTIAL_GUARD_LOCK, ">$exclusiveLockFile") && flock(SEQUENTIAL_GUARD_LOCK, LOCK_EX|LOCK_NB))) {}
$myLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getNextAvailableLockNumber());
open(SCHEDULER_LOCK, ">$myLockFile");
print SCHEDULER_LOCK "$$";
print SEQUENTIAL_GUARD_LOCK "$$";
close(SCHEDULER_LOCK);
close(SEQUENTIAL_GUARD_LOCK);
unlink $exclusiveLockFile;
}
sub getWaitTime
{
my $waitTime = 0;
if ($waitBeginTime && $waitEndTime) {
$waitTime = $waitEndTime - $waitBeginTime;
}
return $waitTime;
}
|