summaryrefslogtreecommitdiff
path: root/tests/phpunit/includes/SeleniumConfigurationTest.php
blob: 3422c90c42296f509e3997b02077f41863d2a681 (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

class SeleniumConfigurationTest extends MediaWikiTestCase {

	/**
	 * The file where the test temporarity stores the selenium config.
	 * This should be cleaned up as part of teardown.
	 */
	private $tempFileName;

	/**
	 * String containing the a sample selenium settings
	 */
	private $testConfig0 = '
[SeleniumSettings]
browsers[firefox] 	= "*firefox"
browsers[iexplorer] = "*iexploreproxy"
browsers[chrome] 	= "*chrome"
host 				= "localhost"
port 				= "foobarr"
wikiUrl 			= "http://localhost/deployment"
username 			= "xxxxxxx"
userPassword 		= ""
testBrowser 		= "chrome"
startserver		=
stopserver		=
jUnitLogFile	=
runAgainstGrid	= false

[SeleniumTests]
testSuite[SimpleSeleniumTestSuite] = "tests/selenium/SimpleSeleniumTestSuite.php"
testSuite[TestSuiteName] = "testSuitePath"
';
	/**
	 * Array of expected browsers from $testConfig0
	 */
	private $testBrowsers0 = array( 'firefox' => '*firefox',
		'iexplorer' => '*iexploreproxy',
		'chrome' => '*chrome'
	);
	/**
	 * Array of expected selenium settings from $testConfig0
	 */
	private $testSettings0 = array(
		'host' => 'localhost',
		'port' => 'foobarr',
		'wikiUrl' => 'http://localhost/deployment',
		'username' => 'xxxxxxx',
		'userPassword' => '',
		'testBrowser' => 'chrome',
		'startserver' => null,
		'stopserver' => null,
		'seleniumserverexecpath' => null,
		'jUnitLogFile' => null,
		'runAgainstGrid' => null
	);
	/**
	 * Array of expected testSuites from $testConfig0
	 */
	private $testSuites0 = array(
		'SimpleSeleniumTestSuite' => 'tests/selenium/SimpleSeleniumTestSuite.php',
		'TestSuiteName' => 'testSuitePath'
	);

	/**
	 * Another sample selenium settings file contents
	 */
	private $testConfig1 =
		'
[SeleniumSettings]
host 				= "localhost"
testBrowser 		= "firefox"
';
	/**
	 * Expected browsers from $testConfig1
	 */
	private $testBrowsers1 = null;
	/**
	 * Expected selenium settings from $testConfig1
	 */
	private $testSettings1 = array(
		'host' => 'localhost',
		'port' => null,
		'wikiUrl' => null,
		'username' => null,
		'userPassword' => null,
		'testBrowser' => 'firefox',
		'startserver' => null,
		'stopserver' => null,
		'seleniumserverexecpath' => null,
		'jUnitLogFile' => null,
		'runAgainstGrid' => null
	);
	/**
	 * Expected test suites from $testConfig1
	 */
	private $testSuites1 = null;


	protected function setUp() {
		parent::setUp();
		if ( !defined( 'SELENIUMTEST' ) ) {
			define( 'SELENIUMTEST', true );
		}
	}

	/**
	 * Clean up the temporary file used to store the selenium settings.
	 */
	protected function tearDown() {
		if ( strlen( $this->tempFileName ) > 0 ) {
			unlink( $this->tempFileName );
			unset( $this->tempFileName );
		}
		parent::tearDown();
	}

	/**
	 * @expectedException MWException
	 * @group SeleniumFramework
	 */
	public function testErrorOnIncorrectConfigFile() {
		$seleniumSettings = array();
		$seleniumBrowsers = array();
		$seleniumTestSuites = array();

		SeleniumConfig::getSeleniumSettings( $seleniumSettings,
			$seleniumBrowsers,
			$seleniumTestSuites,
			"Some_fake_settings_file.ini" );
	}

	/**
	 * @expectedException MWException
	 * @group SeleniumFramework
	 */
	public function testErrorOnMissingConfigFile() {
		$seleniumSettings = array();
		$seleniumBrowsers = array();
		$seleniumTestSuites = array();
		global $wgSeleniumConfigFile;
		$wgSeleniumConfigFile = '';
		SeleniumConfig::getSeleniumSettings( $seleniumSettings,
			$seleniumBrowsers,
			$seleniumTestSuites );
	}

	/**
	 * @group SeleniumFramework
	 */
	public function testUsesGlobalVarForConfigFile() {
		$seleniumSettings = array();
		$seleniumBrowsers = array();
		$seleniumTestSuites = array();
		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
	 */
	public function testgetSeleniumSettings( $sampleConfig, $expectedSettings, $expectedBrowsers, $expectedSuites ) {
		$this->writeToTempFile( $sampleConfig );
		$seleniumSettings = array();
		$seleniumBrowsers = array();
		$seleniumTestSuites = null;

		SeleniumConfig::getSeleniumSettings( $seleniumSettings,
			$seleniumBrowsers,
			$seleniumTestSuites,
			$this->tempFileName );

		$this->assertEquals( $seleniumSettings, $expectedSettings,
			"The selenium settings for the following test configuration was not retrieved correctly" . $sampleConfig
		);
		$this->assertEquals( $seleniumBrowsers, $expectedBrowsers,
			"The available browsers for the following test configuration was not retrieved correctly" . $sampleConfig
		);
		$this->assertEquals( $seleniumTestSuites, $expectedSuites,
			"The test suites for the following test configuration was not retrieved correctly" . $sampleConfig
		);
	}

	/**
	 * create a temp file and write text to it.
	 * @param $testToWrite the text to write to the temp file
	 */
	private function writeToTempFile( $textToWrite ) {
		$this->tempFileName = tempnam( sys_get_temp_dir(), 'test_settings.' );
		$tempFile = fopen( $this->tempFileName, "w" );
		fwrite( $tempFile, $textToWrite );
		fclose( $tempFile );
	}

	/**
	 * Returns an array containing:
	 *     The contents of the selenium cingiguration ini file
	 *  The expected selenium configuration array that getSeleniumSettings should return
	 *  The expected available browsers array that getSeleniumSettings should return
	 *  The expected test suites arrya that getSeleniumSettings should return
	 */
	public function sampleConfigs() {
		return array(
			array( $this->testConfig0, $this->testSettings0, $this->testBrowsers0, $this->testSuites0 ),
			array( $this->testConfig1, $this->testSettings1, $this->testBrowsers1, $this->testSuites1 )
		);
	}
}