10 files changed, 425 insertions, 198 deletions
diff --git a/tests/mock/cache.php b/tests/mock/cache.php
index 713f1ca817..7589c9908e 100644
--- a/tests/mock/cache.php
+++ b/tests/mock/cache.php
@@ -42,9 +42,16 @@ class phpbb_mock_cache implements phpbb_cache_driver_interface
 		$test->assertFalse(isset($this->data[$var_name]));
 	}
 
-	public function check(PHPUnit_Framework_Assert $test, $data)
+	public function check(PHPUnit_Framework_Assert $test, $data, $ignore_db_info = true)
 	{
-		$test->assertEquals($data, $this->data);
+		$cache_data = $this->data;
+
+		if ($ignore_db_info)
+		{
+			unset($cache_data['mysqli_version']);
+		}
+
+		$test->assertEquals($data, $cache_data);
 	}
 
 	function load()
diff --git a/tests/mock/request.php b/tests/mock/request.php
new file mode 100644
index 0000000000..da4015e78b
--- /dev/null
+++ b/tests/mock/request.php
@@ -0,0 +1,46 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+class phpbb_mock_request implements phpbb_request_interface
+{
+	protected $data;
+
+	public function __construct($get = array(), $post = array(), $cookie = array(), $request = false)
+	{
+		$this->data[phpbb_request_interface::GET] = $get;
+		$this->data[phpbb_request_interface::POST] = $post;
+		$this->data[phpbb_request_interface::COOKIE] = $cookie;
+		$this->data[phpbb_request_interface::REQUEST] = ($request === false) ? $post + $get : $request;
+	}
+
+	public function overwrite($var_name, $value, $super_global = phpbb_request_interface::REQUEST)
+	{
+		$this->data[$super_global][$var_name] = $value;
+	}
+
+	public function variable($var_name, $default, $multibyte = false, $super_global = phpbb_request_interface::REQUEST)
+	{
+		return isset($this->data[$super_global][$var_name]) ? $this->data[$super_global][$var_name] : $default;
+	}
+
+	public function is_set_post($name)
+	{
+		return $this->is_set($name, phpbb_request_interface::POST);
+	}
+
+	public function is_set($var, $super_global = phpbb_request_interface::REQUEST)
+	{
+		return isset($this->data[$super_global][$var]);
+	}
+
+	public function variable_names($super_global = phpbb_request_interface::REQUEST)
+	{
+		return array_keys($this->data[$super_global]);
+	}
+}
diff --git a/tests/mock/session_testable.php b/tests/mock/session_testable.php
index 2d7d42f82a..47089cb94b 100644
--- a/tests/mock/session_testable.php
+++ b/tests/mock/session_testable.php
@@ -7,9 +7,16 @@
 *
 */
 
-require_once '../phpBB/includes/functions.php';
-require_once '../phpBB/includes/session.php';
+require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php';
+require_once dirname(__FILE__) . '/../../phpBB/includes/session.php';
 
+/**
+* Extends the session class to overwrite the setting of cookies.
+*
+* The session class directly writes cookie headers making it impossible to
+* test it without warnings about sent headers. This class only stores cookie
+* data for later verification.
+*/
 class phpbb_mock_session_testable extends session
 {
 	private $_cookies = array();
diff --git a/tests/session/continue_test.php b/tests/session/continue_test.php
new file mode 100644
index 0000000000..3080121978
--- /dev/null
+++ b/tests/session/continue_test.php
@@ -0,0 +1,117 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+require_once dirname(__FILE__) . '/../mock/cache.php';
+require_once dirname(__FILE__) . '/testable_factory.php';
+
+class phpbb_session_continue_test extends phpbb_database_test_case
+{
+	public function getDataSet()
+	{
+		return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/sessions_full.xml');
+	}
+
+	static public function session_begin_attempts()
+	{
+		return array(
+			array(
+				'bar_session', '4', 'user agent', '127.0.0.1',
+				array(
+					array('session_id' => 'anon_session', 'session_user_id' => 1),
+					array('session_id' => 'bar_session', 'session_user_id' => 4),
+				),
+				array(),
+				'If a request comes with a valid session id with matching user agent and IP, no new session should be created.',
+			),
+			array(
+				'anon_session', '4', 'user agent', '127.0.0.1',
+				array(
+					array('session_id' => '__new_session_id__', 'session_user_id' => 1), // use generated SID
+					array('session_id' => 'bar_session', 'session_user_id' => 4),
+				),
+				array(
+					'u' => array('1', null),
+					'k' => array(null, null),
+					'sid' => array('__new_session_id__', null),
+				),
+				'If a request comes with a valid session id and IP but different user id and user agent, a new anonymous session is created and the session matching the supplied session id is deleted.',
+			),
+		);
+	}
+
+	/**
+	* @dataProvider session_begin_attempts
+	*/
+	public function test_session_begin_valid_session($session_id, $user_id, $user_agent, $ip, $expected_sessions, $expected_cookies, $message)
+	{
+		$db = $this->new_dbal();
+		$session_factory = new phpbb_session_testable_factory;
+		$session_factory->set_cookies(array(
+			'_sid' => $session_id,
+			'_u' => $user_id,
+		));
+		$session_factory->merge_config_data(array(
+			'session_length' => time(), // need to do this to allow sessions started at time 0
+		));
+		$session_factory->merge_server_data(array(
+			'HTTP_USER_AGENT' => $user_agent,
+			'REMOTE_ADDR' => $ip,
+		));
+
+		$session = $session_factory->get_session($db);
+		$session->page = array('page' => 'page', 'forum' => 0);
+
+		$session->session_begin();
+
+		$sql = 'SELECT session_id, session_user_id
+			FROM phpbb_sessions
+			ORDER BY session_user_id';
+
+		$expected_sessions = $this->replace_session($expected_sessions, $session->session_id);
+		$expected_cookies = $this->replace_session($expected_cookies, $session->session_id);
+
+		$this->assertSqlResultEquals(
+			$expected_sessions,
+			$sql,
+			$message
+		);
+
+		$session->check_cookies($this, $expected_cookies);
+
+		$session_factory->check($this);
+	}
+
+	/**
+	* Replaces recursively the value __new_session_id__ with the given session
+	* id.
+	*
+	* @param array $array An array of data
+	* @param string $session_id The new session id to use instead of the
+	*                           placeholder.
+	* @return array The input array with all occurances of __new_session_id__
+	*               replaced.
+	*/
+	public function replace_session($array, $session_id)
+	{
+		foreach ($array as $key => &$value)
+		{
+			if ($value === '__new_session_id__')
+			{
+				$value = $session_id;
+			}
+
+			if (is_array($value))
+			{
+				$value = $this->replace_session($value, $session_id);
+			}
+		}
+
+		return $array;
+	}
+}
diff --git a/tests/session/fixtures/sessions_empty.xml b/tests/session/fixtures/sessions_empty.xml
index 66fa585b18..f94337314e 100644
--- a/tests/session/fixtures/sessions_empty.xml
+++ b/tests/session/fixtures/sessions_empty.xml
@@ -16,4 +16,10 @@
 			<value>bar</value>
 		</row>
 	</table>
+	<table name="phpbb_sessions">
+		<column>session_id</column>
+		<column>session_user_id</column>
+		<column>session_ip</column>
+		<column>session_browser</column>
+	</table>
 </dataset>
diff --git a/tests/session/init_test.php b/tests/session/init_test.php
new file mode 100644
index 0000000000..1181fab636
--- /dev/null
+++ b/tests/session/init_test.php
@@ -0,0 +1,56 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+require_once dirname(__FILE__) . '/../mock/cache.php';
+require_once dirname(__FILE__) . '/testable_factory.php';
+
+class phpbb_session_init_test extends phpbb_database_test_case
+{
+	public function getDataSet()
+	{
+		return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/sessions_empty.xml');
+	}
+
+	// also see security/extract_current_page.php
+
+	public function test_login_session_create()
+	{
+		$db = $this->new_dbal();
+		$session_factory = new phpbb_session_testable_factory;
+
+		$session = $session_factory->get_session($db);
+		$session->page = array('page' => 'page', 'forum' => 0);
+
+		$session->session_create(3);
+
+		$sql = 'SELECT session_user_id
+			FROM phpbb_sessions';
+
+		$this->assertSqlResultEquals(
+			array(array('session_user_id' => 3)),
+			$sql,
+			'Check if exacly one session for user id 3 was created'
+		);
+
+		$cookie_expire = $session->time_now + 31536000; // default is one year
+
+		$session->check_cookies($this, array(
+			'u' => array(null, $cookie_expire),
+			'k' => array(null, $cookie_expire),
+			'sid' => array($session->session_id, $cookie_expire),
+		));
+
+		global $SID, $_SID;
+		$this->assertEquals($session->session_id, $_SID);
+		$this->assertEquals('?sid=' . $session->session_id, $SID);
+
+		$session_factory->check($this);
+	}
+}
+
diff --git a/tests/session/session_continue.php b/tests/session/session_continue.php
deleted file mode 100644
index 58956c18a9..0000000000
--- a/tests/session/session_continue.php
+++ /dev/null
@@ -1,117 +0,0 @@
-<?php
-/**
-*
-* @package testing
-* @copyright (c) 2008 phpBB Group
-* @license http://opensource.org/licenses/gpl-license.php GNU Public License
-*
-*/
-
-require_once 'test_framework/framework.php';
-require_once 'mock/cache.php';
-require_once 'mock/session_testable.php';
-
-class phpbb_session_continue_test extends phpbb_database_test_case
-{
-	public function getDataSet()
-	{
-		return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/sessions_full.xml');
-	}
-
-	static public function session_begin_attempts()
-	{
-		return array(
-			array(
-				'bar_session', '4', 'user agent',
-				array(
-					array('session_id' => 'anon_session', 'session_user_id' => 1),
-					array('session_id' => 'bar_session', 'session_user_id' => 4)
-				),
-				array(),
-				'Check if no new session was created',
-			),
-			array(
-				'anon_session', '4', 'user agent',
-				array(
-					array('session_id' => 'bar_session', 'session_user_id' => 4),
-					array('session_id' => null, 'session_user_id' => 1) // use generated SID
-				),
-				array(
-					'u' => array('1', null),
-					'k' => array(null, null),
-					'sid' => array($_SID, null),
-				),
-				'Check if an anonymous new session was created',
-			),
-		);
-	}
-
-	/**
-	* @dataProvider session_begin_attempts
-	*/
-	public function test_session_begin_valid_session($session_id, $user_id, $user_agent, $expected_sessions, $expected_cookies, $message)
-	{
-		$session = new phpbb_mock_session_testable;
-		$session->page = array('page' => 'page', 'forum' => 0);
-
-		// set up all the global variables used in session_create
-		global $SID, $_SID, $db, $config, $cache;
-
-		$config = $this->get_config();
-		$db = $this->new_dbal();
-		$cache_data = array(
-			'_bots' => array(),
-		);
-		$cache = new phpbb_mock_cache;
-		$SID = $_SID = null;
-
-		$_COOKIE['_sid'] = $session_id;
-		$_COOKIE['_u'] = $user_id;
-		$_SERVER['HTTP_USER_AGENT'] = $user_agent;
-
-		$config['session_length'] = time(); // need to do this to allow sessions started at time 0
-		$session->session_begin();
-
-		$sql = 'SELECT session_id, session_user_id
-			FROM phpbb_sessions';
-
-		// little tickery to allow using a dataProvider with dynamic expected result
-		foreach ($expected_sessions as $i => $s)
-		{
-			if (is_null($s['session_id']))
-			{
-				$expected_sessions[$i]['session_id'] = $session->session_id;
-			}
-		}
-
-		$this->assertResultEquals(
-			$sql,
-			$expected_sessions,
-			'Check if no new session was created'
-		);
-
-		$session->check_cookies($this, $expected_cookies);
-
-		$cache->check($this, $cache_data);
-	}
-	static public function get_config()
-	{
-		return array(
-			'allow_autologin' => false,
-			'auth_method' => 'db',
-			'forwarded_for_check' => true,
-			'active_sessions' => 0, // disable
-			'rand_seed' => 'foo',
-			'rand_seed_last_update' => 0,
-			'max_autologin_time' => 0,
-			'session_length' => 100,
-			'form_token_lifetime' => 100,
-			'cookie_name' => '',
-			'limit_load' => 0,
-			'limit_search_load' => 0,
-			'ip_check' => 3,
-			'browser_check' => 1,
-		);
-	}
-}
-
diff --git a/tests/session/session_init.php b/tests/session/session_init.php
deleted file mode 100644
index f6fa564880..0000000000
--- a/tests/session/session_init.php
+++ /dev/null
@@ -1,76 +0,0 @@
-<?php
-/**
-*
-* @package testing
-* @copyright (c) 2008 phpBB Group
-* @license http://opensource.org/licenses/gpl-license.php GNU Public License
-*
-*/
-
-require_once 'test_framework/framework.php';
-require_once 'mock/cache.php';
-require_once 'mock/session_testable.php';
-
-class phpbb_session_init_test extends phpbb_database_test_case
-{
-	public function getDataSet()
-	{
-		return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/sessions_empty.xml');
-	}
-
-	// also see security/extract_current_page.php
-
-	public function test_login_session_create()
-	{
-		$session = new phpbb_mock_session_testable;
-		$session->page = array('page' => 'page', 'forum' => 0);
-
-		// set up all the global variables used in session_create
-		global $SID, $_SID, $db, $config, $cache;
-
-		$config = $this->get_config();
-		$db = $this->new_dbal();
-		$cache_data = array(
-			'_bots' => array(),
-		);
-		$cache = new phpbb_mock_cache;
-		$SID = $_SID = null;
-
-		$session->session_create(3);
-
-		$sql = 'SELECT session_user_id
-			FROM phpbb_sessions';
-
-		$this->assertResultEquals(
-			$sql,
-			array(array('session_user_id' => 3)),
-			'Check if exacly one session for user id 3 was created'
-		);
-
-		$cookie_expire = $session->time_now + (($config['max_autologin_time']) ? 86400 * (int) $config['max_autologin_time'] : 31536000);
-
-		$session->check_cookies($this, array(
-			'u' => array(null, $cookie_expire),
-			'k' => array(null, $cookie_expire),
-			'sid' => array($_SID, $cookie_expire),
-		));
-
-		$cache->check($this, $cache_data);
-	}
-
-	static public function get_config()
-	{
-		return array(
-			'allow_autologin' => false,
-			'auth_method' => 'db',
-			'forwarded_for_check' => true,
-			'active_sessions' => 0, // disable
-			'rand_seed' => 'foo',
-			'rand_seed_last_update' => 0,
-			'max_autologin_time' => 0,
-			'session_length' => 100,
-			'form_token_lifetime' => 100,
-		);
-	}
-}
-
diff --git a/tests/session/testable_factory.php b/tests/session/testable_factory.php
new file mode 100644
index 0000000000..2b6a1683d3
--- /dev/null
+++ b/tests/session/testable_factory.php
@@ -0,0 +1,181 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+require_once dirname(__FILE__) . '/../mock/request.php';
+require_once dirname(__FILE__) . '/../mock/session_testable.php';
+
+/**
+* This class exists to setup an instance of phpbb's session class for testing.
+*
+* The session class has rather complex dependencies, so in order to make its
+* tests more * understandable and to make its dependencies more visible this
+* factory class sets up all the necessary global state & variable contents.
+*/
+class phpbb_session_testable_factory
+{
+	protected $config_data;
+	protected $cache_data;
+	protected $cookies;
+
+	protected $config;
+	protected $cache;
+	protected $request;
+
+	/**
+	* Initialises the factory with a set of default config and cache values.
+	*/
+	public function __construct()
+	{
+		// default configuration values
+		$this->config_data = array(
+			'allow_autologin' => false,
+			'auth_method' => 'db',
+			'forwarded_for_check' => true,
+			'active_sessions' => 0, // disable
+			'rand_seed' => 'foo',
+			'rand_seed_last_update' => 0,
+			'max_autologin_time' => 0,
+			'session_length' => 100,
+			'form_token_lifetime' => 100,
+			'cookie_name' => '',
+			'limit_load' => 0,
+			'limit_search_load' => 0,
+			'ip_check' => 3,
+			'browser_check' => 1,
+		);
+
+		$this->cache_data = array(
+			'_bots' => array(),
+		);
+
+		$this->cookies = array();
+
+		$this->server_data = $_SERVER;
+	}
+
+	/**
+	* Retrieve the configured session class instance
+	*
+	* @param dbal $dbal The database connection to use for session data
+	* @return phpbb_mock_session_testable A session instance
+	*/
+	public function get_session(dbal $dbal)
+	{
+		// set up all the global variables used by session
+		global $SID, $_SID, $db, $config, $cache, $request;
+
+		$request = $this->request = new phpbb_mock_request(
+			array(),
+			array(),
+			$this->cookies
+		);
+		request_var(null, null, null, null, $request);
+
+		$config = $this->config = new phpbb_config($this->get_config_data());
+		set_config(null, null, null, $config);
+
+		$db = $dbal;
+
+		$cache = $this->cache = new phpbb_mock_cache($this->get_cache_data());
+		$SID = $_SID = null;
+
+		$_SERVER = $this->server_data;
+
+		$session = new phpbb_mock_session_testable;
+		return $session;
+	}
+
+	/**
+	* Set the cookies which should be present in the request data.
+	*
+	* @param array $cookies The cookie data, structured like $_COOKIE contents.
+	*/
+	public function set_cookies(array $cookies)
+	{
+		$this->cookies = $cookies;
+	}
+
+	/**
+	* Check if the cache used for the generated session contains correct data.
+	*
+	* @param PHPUnit_Framework_Assert $test The test case to call assert methods
+	*                                       on
+	*/
+	public function check(PHPUnit_Framework_Assert $test)
+	{
+		$this->cache->check($test, $this->get_cache_data());
+	}
+
+	/**
+	* Merge config data with the current config data to be supplied to session.
+	*
+	* New values overwrite new ones.
+	*
+	* @param array $config_data The config data to merge with previous data
+	*/
+	public function merge_config_data(array $config_data)
+	{
+		$this->config_data = array_merge($this->config_data, $config_data);
+	}
+
+	/**
+	* Retrieve the entire config data to be passed to the session.
+	*
+	* @return array Configuration
+	*/
+	public function get_config_data()
+	{
+		return $this->config_data;
+	}
+
+	/**
+	* Merge the cache contents with more data.
+	*
+	* New values overwrite old ones.
+	*
+	* @param array $cache_data The additional cache data
+	*/
+	public function merge_cache_data(array $cache_data)
+	{
+		$this->cache_data = array_merge($this->cache_data, $cache_data);
+	}
+
+	/**
+	* Retrieve the entire cache data to be passed to the session.
+	*
+	* @return array Cache contents
+	*/
+	public function get_cache_data()
+	{
+		return $this->cache_data;
+	}
+
+	/**
+	* Merge the current server info ($_SERVER) with more data.
+	*
+	* New values overwrite old ones.
+	*
+	* @param array $server_data The additional server variables
+	*/
+	public function merge_server_data($server_data)
+	{
+		return $this->server_data = array_merge($this->server_data, $server_data);
+	}
+
+	/**
+	* Retrieve all server variables to be passed to the session.
+	*
+	* @return array Server variables
+	*/
+	public function get_server_data()
+	{
+		return $this->server_data;
+	}
+}
+
diff --git a/tests/test_framework/phpbb_database_test_connection_manager.php b/tests/test_framework/phpbb_database_test_connection_manager.php
index 6c06857fbc..a7559e2183 100644
--- a/tests/test_framework/phpbb_database_test_connection_manager.php
+++ b/tests/test_framework/phpbb_database_test_connection_manager.php
@@ -123,7 +123,7 @@ class phpbb_database_test_connection_manager
 
 				try
 				{
-					$this->pdo->exec('DROP DATABASE ' . $config['dbname']);
+					$this->pdo->exec('DROP DATABASE ' . $this->config['dbname']);
 				}
 				catch (PDOException $e)
 				{