From c6c85df11be5374c7beb7dac89b2c9933194c7ee Mon Sep 17 00:00:00 2001
From: Priyanka Dhanda <pdhanda@users.mediawiki.org>
Date: Wed, 22 Sep 2010 21:23:21 +0000
Subject: [PATCH] Followup to r73500. SeleniumTestConfig renamed to
 SeleniumConfig. Make sure SELENIUMTEST is defined to use it. Fixed some
 indents and pass by reference warnings

---
 includes/AutoLoader.php                       |  2 +-
 maintenance/tests/RunSeleniumTests.php        | 22 +++---
 .../includes/SeleniumConfigurationTest.php    | 74 ++++++++++++++-----
 ...eniumTestConfig.php => SeleniumConfig.php} | 18 +++--
 4 files changed, 79 insertions(+), 37 deletions(-)
 rename maintenance/tests/selenium/{SeleniumTestConfig.php => SeleniumConfig.php} (78%)

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index 90399c759e..1805d7de12 100644
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -710,7 +710,7 @@ $wgAutoloadLocalClasses = array(
 	'SeleniumTestHTMLLogger' => 'maintenance/tests/selenium/SeleniumTestHTMLLogger.php',
 	'SeleniumTestListener' => 'maintenance/tests/selenium/SeleniumTestListener.php',
 	'SeleniumTestSuite' => 'maintenance/tests/selenium/SeleniumTestSuite.php',
-	'SeleniumTestConfig' => 'maintenance/tests/selenium/SeleniumTestConfig.php',
+	'SeleniumConfig' => 'maintenance/tests/selenium/SeleniumConfig.php',
 
 	# maintenance/language
 	'csvStatsOutput' => 'maintenance/language/StatOutputs.php',
diff --git a/maintenance/tests/RunSeleniumTests.php b/maintenance/tests/RunSeleniumTests.php
index 4aa8800e41..261a0405cc 100644
--- a/maintenance/tests/RunSeleniumTests.php
+++ b/maintenance/tests/RunSeleniumTests.php
@@ -90,21 +90,21 @@ class SeleniumTester extends Maintenance {
 		$configFile = $this->getOption( 'seleniumConfig', '' );
 		if ( strlen( $configFile ) > 0 ) {
 			$this->output("Using Selenium Configuration file: " . $configFile . "\n");
-			SeleniumTestConfig::getSeleniumSettings( 	&$seleniumSettings, 
-										  				&$seleniumBrowsers, 
-										  				&$seleniumTestSuites,
-										  				$configFile );
+			SeleniumConfig::getSeleniumSettings( $seleniumSettings, 
+				$seleniumBrowsers,
+				$seleniumTestSuites,
+				$configFile );
 		} else if ( !isset( $wgHooks['SeleniumSettings'] ) ) {
-			$this->output("Using default Selenium Configuration file: selenium_settings.ini in the root directory.\n");
-			SeleniumTestConfig::getSeleniumSettings( 	&$seleniumSettings, 
-										  				&$seleniumBrowsers, 
-										  				&$seleniumTestSuites
+			$this->output("No command line configuration file or configuration hook found.\n");
+			SeleniumConfig::getSeleniumSettings( $seleniumSettings, 
+				$seleniumBrowsers,
+				$seleniumTestSuites
 										  			);
 		} else {
 			$this->output("Using 'SeleniumSettings' hook for configuration.\n");
-			wfRunHooks('SeleniumSettings', array( 	&$seleniumSettings, 
-										  			&$seleniumBrowsers, 
-										  			&$seleniumTestSuites ) );
+			wfRunHooks('SeleniumSettings', array( $seleniumSettings, 
+				$seleniumBrowsers,
+				$seleniumTestSuites ) );
 		}
 		
 
diff --git a/maintenance/tests/phpunit/includes/SeleniumConfigurationTest.php b/maintenance/tests/phpunit/includes/SeleniumConfigurationTest.php
index 052d630503..ae2445bc40 100644
--- a/maintenance/tests/phpunit/includes/SeleniumConfigurationTest.php
+++ b/maintenance/tests/phpunit/includes/SeleniumConfigurationTest.php
@@ -1,7 +1,7 @@
 <?php
 
 class SeleniumConfigurationTest extends PHPUnit_Framework_TestCase {
-	
+
 	/*
 	 * The file where the test temporarity stores the selenium config.
 	 * This should be cleaned up as part of teardown. 
@@ -84,6 +84,12 @@ testBrowser 		= "firefox"
 	 */
 	private $testSuites1 = null;		
 	
+	
+	public function setUp() {
+		if ( !defined( 'SELENIUMTEST' ) ) {
+			define( 'SELENIUMTEST', true );
+		}
+	}
 	 
 	/*
 	 * Clean up the temporary file used to sore the selenium settings.
@@ -99,39 +105,73 @@ testBrowser 		= "firefox"
 	/**
      * @expectedException MWException
      * @group SeleniumFramework
-     * This test will throw warnings unless you have the following setting in your php.ini
-	 * allow_call_time_pass_reference = On
      */
-	public function testErrorOnMissingConfigFile() {		
+	public function testErrorOnIncorrectConfigFile() {		
 		$seleniumSettings;
 		$seleniumBrowsers;
 		$seleniumTestSuites;
 
-		SeleniumTestConfig::getSeleniumSettings($seleniumSettings, 
-										  		$seleniumBrowsers, 
-										  		$seleniumTestSuites,
-										  		"Some_fake_settings_file.ini" );
+		SeleniumConfig::getSeleniumSettings($seleniumSettings, 
+			$seleniumBrowsers, 
+			$seleniumTestSuites,
+			"Some_fake_settings_file.ini" );
+
+	}
+	
+	/**
+     * @expectedException MWException
+     * @group SeleniumFramework
+     */
+	public function testErrorOnMissingConfigFile() {		
+		$seleniumSettings;
+		$seleniumBrowsers;
+		$seleniumTestSuites;
+		global $wgSeleniumConfigFile;
+		$wgSeleniumConfigFile = '';
+		SeleniumConfig::getSeleniumSettings($seleniumSettings, 
+			$seleniumBrowsers, 
+			$seleniumTestSuites);
+	}
+	
+	/**
+     * @group SeleniumFramework
+     */
+	public function testUsesGlobalVarForConfigFile() {		
+		$seleniumSettings;
+		$seleniumBrowsers;
+		$seleniumTestSuites;
+		global $wgSeleniumConfigFile;
+		$this->writeToTempFile( $this->testConfig0 );
+		$wgSeleniumConfigFile = $this->tempFileName;
+		SeleniumConfig::getSeleniumSettings($seleniumSettings, 
+			$seleniumBrowsers, 
+			$seleniumTestSuites);
+		$this->assertEquals($seleniumSettings, $this->testSettings0 ,
+		'The selenium settings should have been read from the file defined in $wgSeleniumConfigFile'
+		);
+		$this->assertEquals($seleniumBrowsers, $this->testBrowsers0, 
+		'The available browsers should have been read from the file defined in $wgSeleniumConfigFile'
+		);
+		$this->assertEquals($seleniumTestSuites, $this->testSuites0, 
+		'The test suites should have been read from the file defined in $wgSeleniumConfigFile'
+		);								  		
 	}
 	
 	/**
      * @group SeleniumFramework
      * @dataProvider sampleConfigs
-	 * This test will throw warnings unless you have the following setting in your php.ini
-	 * allow_call_time_pass_reference = On
      */
 	public function testgetSeleniumSettings($sampleConfig, $expectedSettings, $expectedBrowsers, $expectedSuites ) {	
-		//print "SAMPLE_CONFIG " . $sampleConfig . "\n\n";	
 		$this->writeToTempFile( $sampleConfig );
 		$seleniumSettings;
 		$seleniumBrowsers;
 		$seleniumTestSuites;
 
-		SeleniumTestConfig::getSeleniumSettings($seleniumSettings, 
-										  		$seleniumBrowsers, 
-										  		$seleniumTestSuites,
-										  		$this->tempFileName );
-
-		 			
+		SeleniumConfig::getSeleniumSettings($seleniumSettings, 
+			$seleniumBrowsers, 
+			$seleniumTestSuites,
+			$this->tempFileName );
+					
 		$this->assertEquals($seleniumSettings, $expectedSettings, 
 		"The selenium settings for the following test configuration was not retrieved correctly" . $sampleConfig
 		);
diff --git a/maintenance/tests/selenium/SeleniumTestConfig.php b/maintenance/tests/selenium/SeleniumConfig.php
similarity index 78%
rename from maintenance/tests/selenium/SeleniumTestConfig.php
rename to maintenance/tests/selenium/SeleniumConfig.php
index d3f0e4a7e1..881dfd4ef4 100644
--- a/maintenance/tests/selenium/SeleniumTestConfig.php
+++ b/maintenance/tests/selenium/SeleniumConfig.php
@@ -1,6 +1,9 @@
 <?php
+if ( !defined( 'SELENIUMTEST' ) ) {
+	die( 1 );
+}
 
-class SeleniumTestConfig {
+class SeleniumConfig {
 	
 	/*
 	 * Retreives the Selenium configuration values from an ini file.
@@ -8,16 +11,15 @@ class SeleniumTestConfig {
 	 * 
 	 */
 	public static function getSeleniumSettings ( &$seleniumSettings, 
-										  		 &$seleniumBrowsers, 
-										  		 &$seleniumTestSuites, 
-										  		 $seleniumConfigFile = null ) {
-		if ( $seleniumConfigFile == null ) {
+			&$seleniumBrowsers, 
+			&$seleniumTestSuites, 
+			$seleniumConfigFile = null ) {
+		if ( strlen( $seleniumConfigFile ) == 0 ) {
 			global $wgSeleniumConfigFile;
-			$seleniumConfigFile =  ( isset( $wgSeleniumConfigFile ) ) ? 
-									$wgSeleniumConfigFile : dirname( __FILE__ ) . "/../../../selenium_settings.ini";
+			if ( isset( $wgSeleniumConfigFile ) ) $seleniumConfigFile =  $wgSeleniumConfigFile ;
 		}
 
-		if ( !file_exists( $seleniumConfigFile ) ) {
+		if ( strlen( $seleniumConfigFile ) == 0 || !file_exists( $seleniumConfigFile ) ) {
 			throw new MWException( "Unable to read local Selenium Settings from " . $seleniumConfigFile . "\n" );
 		}
 		
-- 
2.20.1