[ticket/11620] Make testable_facade non-static, expand.

Make the class functions of testable_facade no longer static methods, but a class based one and expand the methods to be filled in, in later commits. PHPBB3-11620
author: Andy Chase <asperous2@gmail.com> 2013-07-01 15:16:22 -0700
committer: Andy Chase <asperous2@gmail.com> 2013-07-05 14:09:54 -0700
commit: 2f92c903e7f42978e01d09287e93d572f5e302c9 (patch)
tree: 996ed07008d5cdaf9bf04de4ec882fd0684bf618 /tests
parent: e8facfc735ccc10fd106a169e2508b4c335a0e9e (diff)
download: forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar
forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.gz
forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.bz2
forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.xz
forums-2f92c903e7f42978e01d09287e93d572f5e302c9.zip
3 files changed, 132 insertions, 25 deletions
diff --git a/tests/session/extract_hostname_test.php b/tests/session/extract_hostname_test.php
index ae12a027f7..6978b5286f 100644
--- a/tests/session/extract_hostname_test.php
+++ b/tests/session/extract_hostname_test.php
@@ -13,6 +13,7 @@ class phpbb_session_extract_hostname_test extends phpbb_database_test_case
 {
 	public $session_factory;
 	public $db;
+	public $session_facade;
 
 	public function getDataSet()
 	{
@@ -23,6 +24,8 @@ class phpbb_session_extract_hostname_test extends phpbb_database_test_case
 	{
 		$this->session_factory = new phpbb_session_testable_factory;
 		$this->db = $this->new_dbal();
+		$this->session_facade =
+			new phpbb_session_testable_facade($this->db, $this->session_factory);
 	}
 
 	static public function extract_current_hostname_data()
@@ -45,7 +48,7 @@ class phpbb_session_extract_hostname_test extends phpbb_database_test_case
 	/** @dataProvider extract_current_hostname_data */
 	function test_extract_current_hostname($host, $server_name_config, $cookie_domain_config, $expected)
 	{
-		$output = phpbb_session_testable_facade::extract_current_hostname(
+		$output = $this->session_facade->extract_current_hostname(
 			$this->db,
 			$this->session_factory,
 			$host,
diff --git a/tests/session/extract_page_test.php b/tests/session/extract_page_test.php
index 94ed96c6d2..f8883dc8c9 100644
--- a/tests/session/extract_page_test.php
+++ b/tests/session/extract_page_test.php
@@ -13,6 +13,7 @@ class phpbb_session_extract_page_test extends phpbb_database_test_case
 {
 	public $session_factory;
 	public $db;
+	public $session_facade;
 
 	static public function extract_current_page_data()
 	{
@@ -105,14 +106,14 @@ class phpbb_session_extract_page_test extends phpbb_database_test_case
 	{
 		$this->session_factory = new phpbb_session_testable_factory;
 		$this->db = $this->new_dbal();
+		$this->session_facade =
+			new phpbb_session_testable_facade($this->db, $this->session_factory);
 	}
 
 	/** @dataProvider extract_current_page_data */
 	function test_extract_current_page($root_path, $php_self, $query_string, $request_uri, $expected)
 	{
-		$output = phpbb_session_testable_facade::extract_current_page(
-			$this->db,
-			$this->session_factory,
+		$output = $this->session_facade->extract_current_page(
 			$root_path,
 			$php_self,
 			$query_string,
diff --git a/tests/session/testable_facade.php b/tests/session/testable_facade.php
index a4a3d63ed4..6d2c1408c9 100644
--- a/tests/session/testable_facade.php
+++ b/tests/session/testable_facade.php
@@ -14,16 +14,32 @@ require_once dirname(__FILE__) . '/../../phpBB/includes/session.php';
  * This class exists to expose session.php's functions in a more testable way.
  *
  * Since many functions in session.php have global variables inside the function,
- * this exposes those functions through a testable facade that uses testable_factory's
- * mock global variables to modify global variables used in the functions.
+ * this exposes those functions through a testable facade that uses 
+ * testable_factory's mock global variables to modify global variables used in 
+ * the functions.
  *
- * This is using the facade pattern to provide a testable "front" to the functions in sessions.php.
+ * This is using the facade pattern to provide a testable "front" to the 
+ * functions in sessions.php.
  *
  */
 class phpbb_session_testable_facade
 {
-	public static function extract_current_page($db, $session_factory, $root_path, $php_self, $query_string, $request_uri) {
-		$session_factory->get_session($db);
+	var $db;
+	var $session_factory;
+
+	function __construct($db, $session_factory) {
+		$this->db = $db;
+		$this->session_factory = $session_factory;
+	}
+
+	function extract_current_page (
+		$root_path,
+		$php_self, 
+		$query_string,
+		$request_uri
+	) 
+	{
+		$this->session_factory->get_session($this->db);
 		global $request;
 		$request->overwrite('PHP_SELF', $php_self, phpbb_request_interface::SERVER);
 		$request->overwrite('QUERY_STRING', $query_string, phpbb_request_interface::SERVER);
@@ -31,28 +47,115 @@ class phpbb_session_testable_facade
 		return phpbb_session::extract_current_page($root_path);
 	}
 
-	public static function extract_current_hostname($db, $session_factory, $host, $server_name_config, $cookie_domain_config) {
-		$session = $session_factory->get_session($db);
+	function extract_current_hostname (
+		$host,
+		$server_name_config,
+		$cookie_domain_config
+	)
+	{
+		$session = $this->session_factory->get_session($this->db);
 		global $config, $request;
 		$config['server_name'] = $server_name_config;
 		$config['cookie_domain'] = $cookie_domain_config;
 		$request->overwrite('SERVER_NAME', $host, phpbb_request_interface::SERVER);
 		$request->overwrite('Host', $host, phpbb_request_interface::SERVER);
-		// Note: There is a php_uname fallthrough in this method that this function doesn't override
+		// Note: There is a php_uname fallthrough in this method
+		//       that this function doesn't override
 		return $session->extract_current_hostname();
 	}
-	// [To be completed]
-	// public static function session_begin($update_session_page = true) {}
-	// public static function session_create($user_id = false, $set_admin = false, $persist_login = false, $viewonline = true) {}
-	// public static function session_kill($new_session = true) {}
-	// public static function session_gc() {}
-	// public static function set_cookie($name, $cookiedata, $cookietime) {}
-	// public static function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false) {}
-	// public static function check_dnsbl($mode, $ip = false) {}
-	// public static function set_login_key($user_id = false, $key = false, $user_ip = false) {}
-	// public static function reset_login_keys($user_id = false) {}
-	// public static function validate_referer($check_script_path = false) {}
-	// public static function update_session($session_data, $session_id = null) {}
-	// public static function unset_admin() {}
+
+
+	/** This function has a *lot* of dependencies, so instead of naming them all,
+	 * just ask for overrides */
+	function session_begin (
+		$update_session_page = true,
+		$config_overrides = array(),
+		$request_overrides = array()
+	)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		$request->merge(phpbb_request_interface::SERVER, $request_overrides);
+		$config = array_merge($config, $config_overrides);
+		return $session->session_begin($update_session_page);
+	}
+
+	function session_create (
+		$user_id = false,
+		$set_admin = false,
+		$persist_login = false,
+		$viewonline = true,
+		$config_overrides = array(),
+		$request_overrides = array(),
+		$bot_overrides = array(),
+		$uri_sid = ""
+	)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request, $cache;
+		$request->merge(phpbb_request_interface::SERVER, $request_overrides);
+		$config = array_merge($config, $config_overrides);
+		// Bots
+		$cache->merge_cache_data(array('_bots' => $bot_overrides));
+		// Uri sid
+		$_GET['sid'] = $uri_sid;
+		return $session->session_create($user_id, $set_admin, $persist_login, $viewonline);
+	}
+
+	function session_kill($new_session = true)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+	
+	function session_gc() 
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+
+	function set_cookie($name, $cookiedata, $cookietime) 
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+
+	function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false) 
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+
+	function check_dnsbl($mode, $ip = false)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+
+	function set_login_key($user_id = false, $key = false, $user_ip = false) 
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		
+	}
+	
+	function reset_login_keys($user_id = false)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+
+	}
+
+	function validate_referer($check_script_path = false)
+	{
+		$session = $this->session_factory->get_session($this->db);
+		global $config, $request;
+		return $session->validate_referer($check_script_path);
+	}
 }
author	Andy Chase <asperous2@gmail.com>	2013-07-01 15:16:22 -0700
committer	Andy Chase <asperous2@gmail.com>	2013-07-05 14:09:54 -0700
commit	2f92c903e7f42978e01d09287e93d572f5e302c9 (patch)
tree	996ed07008d5cdaf9bf04de4ec882fd0684bf618 /tests
parent	e8facfc735ccc10fd106a169e2508b4c335a0e9e (diff)
download	forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.gz forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.bz2 forums-2f92c903e7f42978e01d09287e93d572f5e302c9.tar.xz forums-2f92c903e7f42978e01d09287e93d572f5e302c9.zip