From 70050020699d9eab9b97bda342e0e928d1591de8 Mon Sep 17 00:00:00 2001
From: Fyorl <gaelreth@gmail.com>
Date: Sun, 8 Jul 2012 20:22:19 +0100
Subject: [PATCH 1/8] [ticket/10972] Added methods for creating and deleting
 basic users

Modified the login method to allow logging in of an arbitrary user.
Also added tests for the new functionality.

PHPBB3-10972
---
 tests/functional/new_user_test.php            | 45 +++++++++++++++++++
 .../phpbb_functional_test_case.php            | 45 ++++++++++++++++++-
 2 files changed, 88 insertions(+), 2 deletions(-)
 create mode 100644 tests/functional/new_user_test.php

diff --git a/tests/functional/new_user_test.php b/tests/functional/new_user_test.php
new file mode 100644
index 0000000000..db2f31f450
--- /dev/null
+++ b/tests/functional/new_user_test.php
@@ -0,0 +1,45 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2012 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @group functional
+*/
+class phpbb_functional_new_user_test extends phpbb_functional_test_case
+{
+	public function test_create_user()
+	{
+		$this->create_user('user');
+		$this->login();
+		$crawler = $this->request('GET', 'memberlist.php?sid=' . $this->sid);
+		$this->assertContains('user', $crawler->filter('#memberlist tr')->eq(1)->text());
+	}
+
+	/**
+	* @depends test_create_user
+	*/
+	public function test_delete_user()
+	{
+		$this->delete_user('user');
+		$this->login();
+		$crawler = $this->request('GET', 'memberlist.php?sid=' . $this->sid);
+		$this->assertEquals(2, $crawler->filter('#memberlist tr')->count());
+	}
+
+	/**
+	* @depends test_delete_user
+	*/
+	public function test_login_other()
+	{
+		$this->create_user('user');
+		$this->login('user');
+		$crawler = $this->request('GET', 'index.php');
+		$this->assertContains('user', $crawler->filter('.icon-logout')->text());
+		$this->delete_user('user');
+	}
+}
diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index 7c03f874e9..dfbfe2565e 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -194,7 +194,48 @@ class phpbb_functional_test_case extends phpbb_test_case
 		$db_conn_mgr->recreate_db();
 	}
 
-	protected function login()
+	/**
+	* Creates a new user with limited permissions
+	*
+	* @param string $username Also doubles up as the user's password
+	*/
+	protected function create_user($username)
+	{
+		// Required by unique_id
+		global $config;
+
+		if (!is_array($config))
+		{
+			$config = array();
+		}
+
+		$config['rand_seed'] = '';
+		$config['rand_seed_last_update'] = time() + 600;
+		
+		$db = $this->get_db();
+		$query = "
+			INSERT INTO " . self::$config['table_prefix'] . "users
+				(user_type, group_id, username, username_clean, user_regdate, user_password, user_email, user_lang, user_style, user_rank, user_colour, user_posts, user_permissions, user_ip, user_birthday, user_lastpage, user_last_confirm_key, user_post_sortby_type, user_post_sortby_dir, user_topic_sortby_type, user_topic_sortby_dir, user_avatar, user_sig, user_sig_bbcode_uid, user_from, user_icq, user_aim, user_yim, user_msnm, user_jabber, user_website, user_occ, user_interests, user_actkey, user_newpasswd)
+			VALUES
+				(0, 2, 'user', 'user', 0, '" . phpbb_hash($username) . "', 'nobody@example.com', 'en', 1, 0, '', 1, '', '', '', '', '', 't', 'a', 't', 'd', '', '', '', '', '', '', '', '', '', '', '', '', '', '')
+		";
+
+		$db->sql_query($query);
+	}
+
+	/**
+	* Deletes a user
+	*
+	* @param string $username The username of the user to delete
+	*/
+	protected function delete_user($username)
+	{
+		$db = $this->get_db();
+		$query = "DELETE FROM " . self::$config['table_prefix'] . "users WHERE username = '" . $db->sql_escape($username) . "'";
+		$db->sql_query($query);
+	}
+
+	protected function login($username = 'admin')
 	{
 		$this->add_lang('ucp');
 
@@ -202,7 +243,7 @@ class phpbb_functional_test_case extends phpbb_test_case
 		$this->assertContains($this->lang('LOGIN_EXPLAIN_UCP'), $crawler->filter('html')->text());
 
 		$form = $crawler->selectButton($this->lang('LOGIN'))->form();
-		$login = $this->client->submit($form, array('username' => 'admin', 'password' => 'admin'));
+		$login = $this->client->submit($form, array('username' => $username, 'password' => $username));
 
 		$cookies = $this->cookieJar->all();
 

From cafc7feca12730fce59091bd7a18fb5c3f7ecdc0 Mon Sep 17 00:00:00 2001
From: Fyorl <gaelreth@gmail.com>
Date: Mon, 9 Jul 2012 00:24:28 +0100
Subject: [PATCH 2/8] [ticket/10972] Moved tests into appropriate places and
 added comments

PHPBB3-10972
---
 tests/functional/auth_test.php                |  9 ++++
 tests/functional/new_user_test.php            | 45 -------------------
 .../phpbb_functional_test_case.php            |  4 ++
 3 files changed, 13 insertions(+), 45 deletions(-)
 delete mode 100644 tests/functional/new_user_test.php

diff --git a/tests/functional/auth_test.php b/tests/functional/auth_test.php
index e955dcb4df..e67118d8f9 100644
--- a/tests/functional/auth_test.php
+++ b/tests/functional/auth_test.php
@@ -21,6 +21,15 @@ class phpbb_functional_auth_test extends phpbb_functional_test_case
 		$this->assertContains($this->lang('LOGOUT_USER', 'admin'), $crawler->filter('.navbar')->text());
 	}
 
+	public function test_login_other()
+	{
+		$this->create_user('user');
+		$this->login('user');
+		$crawler = $this->request('GET', 'index.php');
+		$this->assertContains('user', $crawler->filter('.icon-logout')->text());
+		$this->delete_user('user');
+	}
+
 	/**
 	* @depends test_login
 	*/
diff --git a/tests/functional/new_user_test.php b/tests/functional/new_user_test.php
deleted file mode 100644
index db2f31f450..0000000000
--- a/tests/functional/new_user_test.php
+++ /dev/null
@@ -1,45 +0,0 @@
-<?php
-/**
-*
-* @package testing
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
-*
-*/
-
-/**
-* @group functional
-*/
-class phpbb_functional_new_user_test extends phpbb_functional_test_case
-{
-	public function test_create_user()
-	{
-		$this->create_user('user');
-		$this->login();
-		$crawler = $this->request('GET', 'memberlist.php?sid=' . $this->sid);
-		$this->assertContains('user', $crawler->filter('#memberlist tr')->eq(1)->text());
-	}
-
-	/**
-	* @depends test_create_user
-	*/
-	public function test_delete_user()
-	{
-		$this->delete_user('user');
-		$this->login();
-		$crawler = $this->request('GET', 'memberlist.php?sid=' . $this->sid);
-		$this->assertEquals(2, $crawler->filter('#memberlist tr')->count());
-	}
-
-	/**
-	* @depends test_delete_user
-	*/
-	public function test_login_other()
-	{
-		$this->create_user('user');
-		$this->login('user');
-		$crawler = $this->request('GET', 'index.php');
-		$this->assertContains('user', $crawler->filter('.icon-logout')->text());
-		$this->delete_user('user');
-	}
-}
diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index dfbfe2565e..a72c0940ab 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -197,6 +197,10 @@ class phpbb_functional_test_case extends phpbb_test_case
 	/**
 	* Creates a new user with limited permissions
 	*
+	* Note that creating two users with the same name results in undefined
+	* login behaviour. Always call delete_user after running a test that
+	* requires create_user.
+	*
 	* @param string $username Also doubles up as the user's password
 	*/
 	protected function create_user($username)

From d33accb687ab4266559c12a356e121f3634d780b Mon Sep 17 00:00:00 2001
From: Fyorl <gaelreth@gmail.com>
Date: Fri, 10 Aug 2012 12:31:53 +0100
Subject: [PATCH 3/8] [ticket/10972] Added explicit checks for creating
 duplicate users.

PHPBB3-10972
---
 .../phpbb_functional_test_case.php            | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index a72c0940ab..9bc2c96753 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -30,6 +30,11 @@ class phpbb_functional_test_case extends phpbb_test_case
 	*/
 	protected $lang = array();
 
+	/**
+	* @var array
+	*/
+	protected $created_users = array();
+
 	static protected $config = array();
 	static protected $already_installed = false;
 
@@ -197,14 +202,18 @@ class phpbb_functional_test_case extends phpbb_test_case
 	/**
 	* Creates a new user with limited permissions
 	*
-	* Note that creating two users with the same name results in undefined
-	* login behaviour. Always call delete_user after running a test that
+	* Always call delete_user after running a test that
 	* requires create_user.
 	*
 	* @param string $username Also doubles up as the user's password
 	*/
 	protected function create_user($username)
 	{
+		if (isset($this->created_users[$username]))
+		{
+			return;
+		}
+		
 		// Required by unique_id
 		global $config;
 
@@ -225,6 +234,7 @@ class phpbb_functional_test_case extends phpbb_test_case
 		";
 
 		$db->sql_query($query);
+		$this->created_users[$username] = 1;
 	}
 
 	/**
@@ -234,6 +244,11 @@ class phpbb_functional_test_case extends phpbb_test_case
 	*/
 	protected function delete_user($username)
 	{
+		if (isset($this->created_users[$username]))
+		{
+			unset($this->created_users[$username]);
+		}
+
 		$db = $this->get_db();
 		$query = "DELETE FROM " . self::$config['table_prefix'] . "users WHERE username = '" . $db->sql_escape($username) . "'";
 		$db->sql_query($query);

From ebdd96592a100139c48204ef133e706c0ac465d1 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Thu, 6 Dec 2012 22:45:12 -0500
Subject: [PATCH 4/8] [ticket/10972] Backport get_db from develop.

PHPBB3-10972
---
 .../phpbb_functional_test_case.php            | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index 9bc2c96753..3b6232d091 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -16,7 +16,9 @@ class phpbb_functional_test_case extends phpbb_test_case
 {
 	protected $client;
 	protected $root_url;
+
 	protected $cache = null;
+	protected $db = null;
 
 	/**
 	* Session ID for current test's session (each test makes its own)
@@ -70,6 +72,23 @@ class phpbb_functional_test_case extends phpbb_test_case
 	{
 	}
 
+	protected function get_db()
+	{
+		global $phpbb_root_path, $phpEx;
+		// so we don't reopen an open connection
+		if (!($this->db instanceof dbal))
+		{
+			if (!class_exists('dbal_' . self::$config['dbms']))
+			{
+				include($phpbb_root_path . 'includes/db/' . self::$config['dbms'] . ".$phpEx");
+			}
+			$sql_db = 'dbal_' . self::$config['dbms'];
+			$this->db = new $sql_db();
+			$this->db->sql_connect(self::$config['dbhost'], self::$config['dbuser'], self::$config['dbpasswd'], self::$config['dbname'], self::$config['dbport']);
+		}
+		return $this->db;
+	}
+
 	protected function get_cache_driver()
 	{
 		if (!$this->cache)

From 771bb957ab4dee865ce1678eb675c37874d04e98 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Thu, 6 Dec 2012 23:41:02 -0500
Subject: [PATCH 5/8] [ticket/10972] Add mock null cache.

The mock cache has instrumentation methods and therefore is non-trivial
to implement. For those times when we don't care that the cache caches,
null cache is a simpler implementation.

PHPBB3-10972
---
 tests/mock/null_cache.php | 42 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 tests/mock/null_cache.php

diff --git a/tests/mock/null_cache.php b/tests/mock/null_cache.php
new file mode 100644
index 0000000000..aca20ca77b
--- /dev/null
+++ b/tests/mock/null_cache.php
@@ -0,0 +1,42 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2012 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+class phpbb_mock_null_cache
+{
+	public function __construct()
+	{
+	}
+
+	public function get($var_name)
+	{
+		return false;
+	}
+
+	public function put($var_name, $var, $ttl = 0)
+	{
+	}
+
+	public function destroy($var_name, $table = '')
+	{
+	}
+
+	public function obtain_bots()
+	{
+		return array();
+	}
+
+	public function obtain_word_list()
+	{
+		return array();
+	}
+
+	public function set_bots($bots)
+	{
+	}
+}

From 1285bdff00ecf928783698b86205888a2bd8bee7 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Thu, 6 Dec 2012 23:42:13 -0500
Subject: [PATCH 6/8] [ticket/10972] Add destroy method to mock cache.

I actually needed the version that destroys tables, therefore
I ended up writing a mock null cache. This code is currently unused
but will probably be handy at some point.

PHPBB3-10972
---
 tests/mock/cache.php | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/tests/mock/cache.php b/tests/mock/cache.php
index 650545c3d6..aa0db5ab20 100644
--- a/tests/mock/cache.php
+++ b/tests/mock/cache.php
@@ -34,6 +34,16 @@ class phpbb_mock_cache
 		$this->data[$var_name] = $var;
 	}
 
+	public function destroy($var_name, $table = '')
+	{
+		if ($table)
+		{
+			throw new Exception('Destroying tables is not implemented yet');
+		}
+
+		unset($this->data[$var_name]);
+	}
+
 	/**
 	* Obtain active bots
 	*/
@@ -41,7 +51,7 @@ class phpbb_mock_cache
 	{
 		return $this->data['_bots'];
 	}
-	
+
 	/**
 	 * Obtain list of word censors. We don't need to parse them here,
 	 * that is tested elsewhere.

From fb5c4440e598f2a775a52299a06e903d3cee5398 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Thu, 6 Dec 2012 23:43:22 -0500
Subject: [PATCH 7/8] [ticket/10972] Tweak user addition.

Always add users, do not keep track of which users have been added.
The tests should know whether users they want exist or not.

Use more unique user names in tests for robustness.

Added some more assertions here and there.

PHPBB3-10972
---
 tests/functional/auth_test.php                | 12 ++--
 .../phpbb_functional_test_case.php            | 59 +++++++++++--------
 2 files changed, 41 insertions(+), 30 deletions(-)

diff --git a/tests/functional/auth_test.php b/tests/functional/auth_test.php
index e67118d8f9..3e218ebd77 100644
--- a/tests/functional/auth_test.php
+++ b/tests/functional/auth_test.php
@@ -18,16 +18,18 @@ class phpbb_functional_auth_test extends phpbb_functional_test_case
 
 		// check for logout link
 		$crawler = $this->request('GET', 'index.php');
+		$this->assert_response_success();
 		$this->assertContains($this->lang('LOGOUT_USER', 'admin'), $crawler->filter('.navbar')->text());
 	}
 
 	public function test_login_other()
 	{
-		$this->create_user('user');
-		$this->login('user');
+		$this->create_user('anothertestuser');
+		$this->login('anothertestuser');
 		$crawler = $this->request('GET', 'index.php');
-		$this->assertContains('user', $crawler->filter('.icon-logout')->text());
-		$this->delete_user('user');
+		$this->assert_response_success();
+		$this->assertContains('anothertestuser', $crawler->filter('.icon-logout')->text());
+		$this->delete_user('anothertestuser');
 	}
 
 	/**
@@ -40,10 +42,12 @@ class phpbb_functional_auth_test extends phpbb_functional_test_case
 
 		// logout
 		$crawler = $this->request('GET', 'ucp.php?sid=' . $this->sid . '&mode=logout');
+		$this->assert_response_success();
 		$this->assertContains($this->lang('LOGOUT_REDIRECT'), $crawler->filter('#message')->text());
 
 		// look for a register link, which should be visible only when logged out
 		$crawler = $this->request('GET', 'index.php');
+		$this->assert_response_success();
 		$this->assertContains($this->lang('REGISTER'), $crawler->filter('.navbar')->text());
 	}
 }
diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index 3b6232d091..b17b2dcd5f 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -32,11 +32,6 @@ class phpbb_functional_test_case extends phpbb_test_case
 	*/
 	protected $lang = array();
 
-	/**
-	* @var array
-	*/
-	protected $created_users = array();
-
 	static protected $config = array();
 	static protected $already_installed = false;
 
@@ -225,14 +220,10 @@ class phpbb_functional_test_case extends phpbb_test_case
 	* requires create_user.
 	*
 	* @param string $username Also doubles up as the user's password
+	* @return int ID of created user
 	*/
 	protected function create_user($username)
 	{
-		if (isset($this->created_users[$username]))
-		{
-			return;
-		}
-		
 		// Required by unique_id
 		global $config;
 
@@ -243,17 +234,36 @@ class phpbb_functional_test_case extends phpbb_test_case
 
 		$config['rand_seed'] = '';
 		$config['rand_seed_last_update'] = time() + 600;
-		
-		$db = $this->get_db();
-		$query = "
-			INSERT INTO " . self::$config['table_prefix'] . "users
-				(user_type, group_id, username, username_clean, user_regdate, user_password, user_email, user_lang, user_style, user_rank, user_colour, user_posts, user_permissions, user_ip, user_birthday, user_lastpage, user_last_confirm_key, user_post_sortby_type, user_post_sortby_dir, user_topic_sortby_type, user_topic_sortby_dir, user_avatar, user_sig, user_sig_bbcode_uid, user_from, user_icq, user_aim, user_yim, user_msnm, user_jabber, user_website, user_occ, user_interests, user_actkey, user_newpasswd)
-			VALUES
-				(0, 2, 'user', 'user', 0, '" . phpbb_hash($username) . "', 'nobody@example.com', 'en', 1, 0, '', 1, '', '', '', '', '', 't', 'a', 't', 'd', '', '', '', '', '', '', '', '', '', '', '', '', '', '')
-		";
 
-		$db->sql_query($query);
-		$this->created_users[$username] = 1;
+		// Required by user_add
+		global $db, $cache;
+		$db = $this->get_db();
+		if (!function_exists('phpbb_mock_null_cache'))
+		{
+			require_once(__DIR__ . '/../mock/null_cache.php');
+		}
+		$cache = new phpbb_mock_null_cache;
+
+		if (!function_exists('utf_clean_string'))
+		{
+			require_once(__DIR__ . '/../../phpBB/includes/utf/utf_tools.php');
+		}
+		if (!function_exists('user_add'))
+		{
+			require_once(__DIR__ . '/../../phpBB/includes/functions_user.php');
+		}
+
+		$user_row = array(
+			'username' => $username,
+			'group_id' => 2,
+			'user_email' => 'nobody@example.com',
+			'user_type' => 0,
+			'user_lang' => 'en',
+			'user_timezone' => 0,
+			'user_dateformat' => '',
+			'user_password' => phpbb_hash($username),
+		);
+		return user_add($user_row);
 	}
 
 	/**
@@ -263,11 +273,6 @@ class phpbb_functional_test_case extends phpbb_test_case
 	*/
 	protected function delete_user($username)
 	{
-		if (isset($this->created_users[$username]))
-		{
-			unset($this->created_users[$username]);
-		}
-
 		$db = $this->get_db();
 		$query = "DELETE FROM " . self::$config['table_prefix'] . "users WHERE username = '" . $db->sql_escape($username) . "'";
 		$db->sql_query($query);
@@ -281,7 +286,9 @@ class phpbb_functional_test_case extends phpbb_test_case
 		$this->assertContains($this->lang('LOGIN_EXPLAIN_UCP'), $crawler->filter('html')->text());
 
 		$form = $crawler->selectButton($this->lang('LOGIN'))->form();
-		$login = $this->client->submit($form, array('username' => $username, 'password' => $username));
+		$crawler = $this->client->submit($form, array('username' => $username, 'password' => $username));
+		$this->assert_response_success();
+		$this->assertContains($this->lang('LOGIN_REDIRECT'), $crawler->filter('html')->text());
 
 		$cookies = $this->cookieJar->all();
 

From ff993ba9d30f5de49e5231647c5bb76d95c357f8 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Thu, 6 Dec 2012 23:47:19 -0500
Subject: [PATCH 8/8] [ticket/10972] Drop user deletion.

Users should not be deleted in tests that test user creation.
Tests should use unique user names to avoid collisions.

User deletion should use user_remove anyway.

PHPBB3-10972
---
 tests/functional/auth_test.php                    |  1 -
 .../test_framework/phpbb_functional_test_case.php | 15 ---------------
 2 files changed, 16 deletions(-)

diff --git a/tests/functional/auth_test.php b/tests/functional/auth_test.php
index 3e218ebd77..662b1bd38b 100644
--- a/tests/functional/auth_test.php
+++ b/tests/functional/auth_test.php
@@ -29,7 +29,6 @@ class phpbb_functional_auth_test extends phpbb_functional_test_case
 		$crawler = $this->request('GET', 'index.php');
 		$this->assert_response_success();
 		$this->assertContains('anothertestuser', $crawler->filter('.icon-logout')->text());
-		$this->delete_user('anothertestuser');
 	}
 
 	/**
diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php
index b17b2dcd5f..71e88fbcf6 100644
--- a/tests/test_framework/phpbb_functional_test_case.php
+++ b/tests/test_framework/phpbb_functional_test_case.php
@@ -216,9 +216,6 @@ class phpbb_functional_test_case extends phpbb_test_case
 	/**
 	* Creates a new user with limited permissions
 	*
-	* Always call delete_user after running a test that
-	* requires create_user.
-	*
 	* @param string $username Also doubles up as the user's password
 	* @return int ID of created user
 	*/
@@ -266,18 +263,6 @@ class phpbb_functional_test_case extends phpbb_test_case
 		return user_add($user_row);
 	}
 
-	/**
-	* Deletes a user
-	*
-	* @param string $username The username of the user to delete
-	*/
-	protected function delete_user($username)
-	{
-		$db = $this->get_db();
-		$query = "DELETE FROM " . self::$config['table_prefix'] . "users WHERE username = '" . $db->sql_escape($username) . "'";
-		$db->sql_query($query);
-	}
-
 	protected function login($username = 'admin')
 	{
 		$this->add_lang('ucp');