From 935f67b7f1e433793fdcf4f4a66ab4a1c309afc8 Mon Sep 17 00:00:00 2001
From: Markus Glaser <mglaser@users.mediawiki.org>
Date: Sat, 1 Jan 2011 15:47:43 +0000
Subject: [PATCH] now uses separate database and images dir for selenium tests
 if $wgSeleniumUseTestResources is set

---
 includes/SeleniumWebSettings.php | 175 +++++++++++++++++++++++++++++--
 1 file changed, 164 insertions(+), 11 deletions(-)

diff --git a/includes/SeleniumWebSettings.php b/includes/SeleniumWebSettings.php
index 8afb26dab9..7a838e9a7a 100644
--- a/includes/SeleniumWebSettings.php
+++ b/includes/SeleniumWebSettings.php
@@ -8,16 +8,22 @@ 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;
 	}
@@ -31,29 +37,57 @@ if ( isset( $_GET['setupTestSuite'] ) ) {
 			$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['db'] ) ) {
+		$testSqlFile = $testResourceFiles['db'];
+	}
+	if ( isset($testResourceFiles['images']) ) {
+		$testImageZip = $testResourceFiles['images'];
+	}
+
+	$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'] ) ) {
-		$expire = time() - 600; 
-		setcookie( $cookieName,
-			'',
-			$expire,
-			$wgCookiePath,
-			$wgCookieDomain,
-			$wgCookieSecure,
-			true );
+	$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 = $_COOKIE[$cookieName];
+	$testSuiteName = getTestSuiteNameFromCookie( $cookieName );
 	if ( !isset( $wgSeleniumTestConfigs[$testSuiteName] ) ) {
 		return;
 	}
+	
+	$testResourceName = getTestResourceNameFromTestSuiteName( $testSuiteName );
+	switchToTestResources( $testResourceName );
+	
 	$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));
+	call_user_func_array( $callback, array( &$testIncludes, &$testGlobalConfigs, &$testResourceFiles));
       
 	foreach ( $testIncludes as $includeFile ) {
 		$file = $IP . '/' . $includeFile;
@@ -70,3 +104,122 @@ if ( isset( $_COOKIE[$cookieName] ) ) {
 }
 
 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, $wgSeleniumUseTestResources;
+	
+	if ( !$wgSeleniumUseTestResources ) {
+		return false;
+	}
+	// Basic security. Do not allow to drop productive database.
+	if ( $testResouceName == $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 ) {
+	global $wgSeleniumUseTestResources;
+	
+	if ( !$wgSeleniumUseTestResources ) {
+		return false;
+	}
+	// 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, $wgDBprefix;
+	global $wgDBtestuser, $wgDBtestpassword, $wgDBtestprefix;
+	global $wgUploadPath;
+	global $wgSeleniumUseTestResources;
+	
+	if ( !$wgSeleniumUseTestResources ) {
+		return false;
+	}
+
+	if ( $switchDB ) {
+		$wgDBname = $testResourceName;
+	}
+	$wgDBuser = $wgDBtestuser;
+	$wgDBpassword = $wgDBtestpassword;
+	//$wgDBprefix = $wgDBtestprefix;	
+
+	$testUploadPath =  getTestUploadPathFromResourceName( $testResourceName );
+	$wgUploadPath = $testUploadPath;
+}
+
+function wfRecursiveRemoveDir( $dir ) {
+	// taken from http://de3.php.net/manual/en/function.rmdir.php#98622
+	if ( is_dir( $dir ) ) {
+		$objects = scandir( $dir );
+		foreach ( $objects as $object ) {
+			if ( $object != "." && $object != ".." ) {
+				if ( filetype( $dir."/".$object ) == "dir" ) {
+					wfRecursiveRemoveDir( $dir."/".$object );
+				} else {
+					unlink( $dir."/".$object );
+				}
+			}
+		}
+		reset( $objects );
+		rmdir( $dir );
+	}
+}
\ No newline at end of file
-- 
2.20.1