summaryrefslogtreecommitdiff
path: root/includes/SeleniumWebSettings.php
blob: 7b98568d7459fa99f7679ed9a57e7f7f04f56f7e (plain)
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
<?php
/**
 * Dynamically change configuration variables based on the test suite name and a cookie value.
 *
 * For details on how to configure a wiki for a Selenium test, see:
 * http://www.mediawiki.org/wiki/SeleniumFramework#Test_Wiki_configuration
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

if ( !defined( 'MEDIAWIKI' ) ) {
	die( 1 );
}

require_once( "$IP/includes/GlobalFunctions.php" );

$fname = 'SeleniumWebSettings.php';
wfProfileIn( $fname );

$cookiePrefix = $wgSitename . '-';
$cookieName = $cookiePrefix . 'Selenium';

// this is a fallback SQL file
$testSqlFile = false;
$testImageZip = false;
	
// if we find a request parameter containing the test name, set a cookie with the test name
if ( isset( $_GET['setupTestSuite'] ) ) {
	$setupTestSuiteName = $_GET['setupTestSuite'];

	if (
		preg_match( '/[^a-zA-Z0-9_-]/', $setupTestSuiteName ) ||
		!isset( $wgSeleniumTestConfigs[$setupTestSuiteName] )
	)
	{
		return;
	}
	if ( strlen( $setupTestSuiteName ) > 0 ) {
		$expire = time() + 600;
		setcookie(
			$cookieName,
			$setupTestSuiteName,
			$expire,
			$wgCookiePath,
			$wgCookieDomain,
			$wgCookieSecure,
			true
		);
	}
	
	$testIncludes = array(); // array containing all the includes needed for this test
	$testGlobalConfigs = array(); // an array containg all the global configs needed for this test
	$testResourceFiles = array(); // an array containing all the resource files needed for this test
	$callback = $wgSeleniumTestConfigs[$setupTestSuiteName];
	call_user_func_array( $callback, array( &$testIncludes, &$testGlobalConfigs, &$testResourceFiles));

	if ( isset( $testResourceFiles['images'] ) ) {
		$testImageZip = $testResourceFiles['images'];
	}
	
	if ( isset( $testResourceFiles['db'] ) ) {
		$testSqlFile = $testResourceFiles['db'];
		$testResourceName = getTestResourceNameFromTestSuiteName( $setupTestSuiteName );
	
		switchToTestResources( $testResourceName, false ); // false means do not switch database yet
		setupTestResources( $testResourceName, $testSqlFile, $testImageZip );
	}
}

// clear the cookie based on a request param
if ( isset( $_GET['clearTestSuite'] ) ) {
	$testSuiteName = getTestSuiteNameFromCookie( $cookieName );

	$expire = time() - 600; 
	setcookie(
		$cookieName,
		'',
		$expire,
		$wgCookiePath,
		$wgCookieDomain,
		$wgCookieSecure,
		true
	);
	
	$testResourceName = getTestResourceNameFromTestSuiteName( $testSuiteName );
	teardownTestResources( $testResourceName );
}

// if a cookie is found, run the appropriate callback to get the config params.
if ( isset( $_COOKIE[$cookieName] ) ) {		
	$testSuiteName = getTestSuiteNameFromCookie( $cookieName );
	if ( !isset( $wgSeleniumTestConfigs[$testSuiteName] ) ) {
		return;
	}
	
	$testIncludes = array(); // array containing all the includes needed for this test
	$testGlobalConfigs = array(); // an array containg all the global configs needed for this test
	$testResourceFiles = array(); // an array containing all the resource files needed for this test
	$callback = $wgSeleniumTestConfigs[$testSuiteName]; 
	call_user_func_array( $callback, array( &$testIncludes, &$testGlobalConfigs, &$testResourceFiles));

	if ( isset( $testResourceFiles['db'] ) ) {
		$testResourceName = getTestResourceNameFromTestSuiteName( $testSuiteName );
		switchToTestResources( $testResourceName );
	}
	foreach ( $testIncludes as $includeFile ) {
		$file = $IP . '/' . $includeFile;
		require_once( $file );
	}
	foreach ( $testGlobalConfigs as $key => $value ) {
		if ( is_array( $value ) ) {		
			$GLOBALS[$key] = array_merge( $GLOBALS[$key], $value );
			
		} else {
			$GLOBALS[$key] = $value;
		}
	}
}

wfProfileOut( $fname );

function getTestSuiteNameFromCookie( $cookieName ) {
	$testSuiteName = null;
	if ( isset( $_COOKIE[$cookieName] ) ) {
		$testSuiteName = $_COOKIE[$cookieName];
	}
	return $testSuiteName;
}

function getTestResourceNameFromTestSuiteName( $testSuiteName ) {
	$testResourceName = null;
	if ( isset( $testSuiteName ) ) {
		$testResourceName = $testSuiteName;
	}
	return $testResourceName;
}

function getTestUploadPathFromResourceName( $testResourceName ) {
	global $IP;
	$testUploadPath = "$IP/images/$testResourceName";
	return $testUploadPath;
}

function setupTestResources( $testResourceName, $testSqlFile, $testImageZip ) {
	global $wgDBname;

	// Basic security. Do not allow to drop productive database.
	if ( $testResourceName == $wgDBname ) {
		die( 'Cannot override productive database.' );
	}
	if ( $testResourceName == '' ) {
		die( 'Cannot identify a test the resources should be installed for.' );
	}
	
	// create tables
	$dbw = wfGetDB( DB_MASTER );
	$dbw->query( 'DROP DATABASE IF EXISTS ' . $testResourceName );
	$dbw->query( 'CREATE DATABASE ' . $testResourceName );

	// do not set the new DB name before database is setup
	$wgDBname = $testResourceName;
	$dbw->selectDB( $testResourceName );
	// populate from SQL file
	if ( $testSqlFile ) {
		$dbw->sourceFile( $testSqlFile );
	}

	// create test image dir
	$testUploadPath = getTestUploadPathFromResourceName( $testResourceName );
	if ( !file_exists( $testUploadPath ) ) {
		mkdir( $testUploadPath );
	}

	if ( $testImageZip ) {
		$zip = new ZipArchive();
		$zip->open( $testImageZip );
		$zip->extractTo( $testUploadPath );
		$zip->close();
	}
}

function teardownTestResources( $testResourceName ) {
	// remove test database
	$dbw = wfGetDB( DB_MASTER );
	$dbw->query( 'DROP DATABASE IF EXISTS ' . $testResourceName );

	$testUploadPath = getTestUploadPathFromResourceName( $testResourceName );
	// remove test image dir
	if ( file_exists( $testUploadPath ) ) {
		wfRecursiveRemoveDir( $testUploadPath );
	}
}

function switchToTestResources( $testResourceName, $switchDB = true ) {
	global $wgDBuser, $wgDBpassword, $wgDBname;
	global $wgDBtestuser, $wgDBtestpassword;
	global $wgUploadPath;

	if ( $switchDB ) {
		$wgDBname = $testResourceName;
	}
	$wgDBuser = $wgDBtestuser;
	$wgDBpassword = $wgDBtestpassword;

	$testUploadPath = getTestUploadPathFromResourceName( $testResourceName );
	$wgUploadPath = $testUploadPath;
}