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

• function reset_instance()
• function set_is_cli($return)
• function load_class_instance($classname, $instance)
• class TestCase
  • TestCase::resetInstance()
  • TestCase::request($method, $argv, $params = [], $callable = null)
    • request->setCallable()
    • request->setCallablePreConstructor()
    • request->enableHooks()
  • TestCase::ajaxRequest($method, $argv, $params = [], $callable = null)
  • TestCase::assertResponseCode($code)
  • TestCase::assertRedirect($uri, $code = null)
  • TestCase::getDouble($classname, $params)
  • TestCase::verifyInvoked($mock, $method, $params)
  • TestCase::verifyInvokedOnce($mock, $method, $params)
  • TestCase::verifyInvokedMultipleTimes($mock, $method, $times, $params)
  • TestCase::verifyNeverInvoked($mock, $method, $params)
  • TestCase::warningOff()
  • TestCase::warningOn()
• class MonkeyPatch
  • MonkeyPatch::patchFunction($function, $return_value, $class_method)
  • MonkeyPatch::resetFunctions()
  • MonkeyPatch::patchMethod($classname, $params)
  • MonkeyPatch::resetMethods()
  • MonkeyPatch::verifyInvoked($class_method, $params)
  • MonkeyPatch::verifyInvokedOnce($class_method, $params)
  • MonkeyPatch::verifyInvokedMultipleTimes($class_method, $times, $params)
  • MonkeyPatch::verifyNeverInvoked($class_method, $params)

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.

Set return value of is_cli() function.

set_is_cli(FALSE);

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);

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;
}

Note: When you call $this->request(), you don't have to use this method. Because $this->request() resets CodeIgniter instance internally.

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.

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');

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']);

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);
	}
);

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');

returns (string) output strings

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

Check for a specific response code on your controller tests.

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

returns (object) PHPUnit mock object

Get PHPUnit mock object.

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

You could write code above like below:

$email = $this->getDouble('CI_Email', ['send' => TRUE]);

Verifies a method was invoked at least once.

$loader->expects($this->atLeastOnce())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyInvoked(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

Verifies that method was invoked only once.

$loader->expects($this->once())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyInvokedOnce(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

Verifies that method was called exactly $times times.

$loader->expects($this->exactly(2))
	->method('view')
	->withConsecutive(
		['shop_confirm', $this->anything(), TRUE],
		['shop_tmpl_checkout', $this->anything()]
	);

You could write code above like below:

$this->verifyInvokedMultipleTimes(
	$loader,
	'view',
	2,
	[
		['shop_confirm', $this->anything(), TRUE],
		['shop_tmpl_checkout', $this->anything()]
	]
);

Verifies that method was not called.

$loader->expects($this->never())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyNeverInvoked(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

Turn off WARNING in error reporting.

Restore error reporting.

To use this class, you have to enable monkey patching. See How to Write Tests.

Replace function on the fly.

If $class_method is present, the patch is applied to the functions only in the class method or in the class.

There are some known limitations. See How to Write Tests for details.

Reset all patched functions.

This method is called on TestCase::tearDown() by default. So you don't have to call it normally.

Replace method in user-defined class on the fly.

Reset all patched class methods.

This method is called on TestCase::tearDown() by default. So you don't have to call it normally.

Verifies a patched class method or a patched function was invoked at least once.

MonkeyPatch::verifyInvoked(
	'Ion_auth_model::login', ['foo', 'bar']
);

Verifies that patched class method or a patched function was invoked only once.

MonkeyPatch::verifyInvokedOnce(
	'CI_Input::post', ['id']
);

Verifies that patched method or a patched function was called exactly $times times.

MonkeyPatch::verifyInvokedMultipleTimes(
	'CI_Input::post', 2
);

Verifies that patched method or a patched function was not called.

MonkeyPatch::verifyNeverInvoked(
	'Ion_auth_model::login', ['username', 'PHS/DL1m6OMYg']
);