CI PHPUnit Test for CodeIgniter 3.0

version: master | v0.5.0 | v0.4.0 | v0.3.0 | v0.2.0

Function/Class Reference

function reset_instance()
function set_is_cli($return)
function load_class_instance($classname, $instance)
class TestCase
class MonkeyPatch

function `reset_instance()`

Reset CodeIgniter instance. You must create new controller instance after calling this function.

reset_instance();
$controller = new Welcome();
$this->CI =& get_instance();

Normally, you don't have to use this function. Use TestCase::resetInstance() method instead.

function `set_is_cli($return)`

param	type	description
`$return`	bool	return value to set

Set return value of is_cli() function.

set_is_cli(FALSE);

function `load_class_instance($classname, $instance)`

param	type	description
`$classname`	string	class name
`$instance`	object	object instance

Inject an instance directly into load_class() function.

$email = $this->getMockBuilder('CI_Email')
	->setMethods(['send'])
	->getMock();
$email->method('send')
	->willReturn(TRUE);
load_class_instance('email', $email);

class TestCase

`TestCase::resetInstance()`

Reset CodeIgniter instance and assign new CodeIgniter instance as $this->CI.

public function setUp()
{
	$this->resetInstance();
	$this->CI->load->model('Category_model');
	$this->obj = $this->CI->Category_model;
}

Upgrade Note for v0.6.0

Before v0.6.0, we write setUp() method like this:

public function setUp()
{
	$this->CI =& get_instance();
	$this->CI->load->model('Category_model');
	$this->obj = $this->CI->Category_model;
}

When you use the way, you use the same CodeIgniter instance and the same Category_model instance in every test method.

In contrast, if you use $this->resetInstance(), it resets CodeIgniter instance and Category_model. So you use new CodeIgniter instance and new Category_model instance in every test method.

`TestCase::request($method, $argv, $params = [], $callable = null)`

param	type	description
`$method`	string	HTTP method
`$argv`	array/string	controller, method [, arg1, ...] / URI string
`$params`	array	POST parameters / Query string
`$callable`	callable	[Deprecated] function to run after controller instantiation

returns (string) output strings (view)

Run a controller method or make a request to URI string after reset_instance().

$output = $this->request('GET', ['Form', 'index']);

$output = $this->request('GET', 'products/shoes/show/123');

`request->setCallable()`

Set function to run after controller instantiation.

4th param $callable of $this->request() method is deprecated. Use $this->request->setCallable() method instead.

before:

$load_agent = function ($CI) {
	$CI->load->library('user_agent');
};
$output = $this->request('GET', ['Bbs', 'index'], [], $load_agent);

↓

after:

$this->request->setCallable(
	function ($CI) {
		$CI->load->library('user_agent');
	};
);
$output = $this->request('GET', ['Bbs', 'index']);

`request->setCallablePreConstructor()`

Set function to run before controller instantiation.

$this->request->setCallablePreConstructor(
	function () {
		// Get mock object
		$auth = $this->getDouble(
			'Ion_auth', ['logged_in' => TRUE]
		);
		// Inject mock object
		load_class_instance('ion_auth', $auth);
	}
);

`request->enableHooks()`

If you want to enable hooks, call $this->request->enableHooks() method. It enables only pre_controller, post_controller_constructor, post_controller hooks.

$this->request->enableHooks();
$output = $this->request('GET', 'products/shoes/show/123');

`TestCase::ajaxRequest($method, $argv, $params = [], $callable = null)`

param	type	description
`$method`	string	HTTP method
`$argv`	array/string	controller, method [, arg1, ...] / URI string
`$params`	array	POST parameters / Query string
`$callable`	callable	[Deprecated] function to run after controller instantiation

returns (string) output strings

The same as TestCase::request(), but this makes a Ajax request. This adds only $_SERVER['HTTP_X_REQUESTED_WITH'].

`TestCase::assertResponseCode($code)`

param	type	description
`$code`	int	HTTP status code

Check for a specific response code on your controller tests.

`TestCase::assertRedirect($uri, $code = null)`

param	type	description
`$uri`	string	URI to redirect
`$code`	int	HTTP status code

Check if redirect() is called on your controller tests.

`TestCase::getDouble($classname, $params)`

param	type	description
`$classname`	string	class name
`$params`	array	[method_name => return_value]

returns (object) PHPUnit mock object

Get PHPUnit mock object.

$email = $this->getMockBuilder('CI_Email')
	->setMethods(['send'])
	->getMock();
$email->method('send')
	->willReturn(TRUE);