Provides helper traits for PHPUnit.
- TestDouble ... Easy mock creation
- ReflectionHelper ... Easy private property/method testing
- DebugHelper ... Helper function
dd()andd()
- PHP 7.3 or later
Run:
$ composer require --dev kenjis/phpunit-helperThis trait provides helper methods to create mock objects and to verify invocations.
Import the Kenjis\PhpUnitHelper\TestDouble trait into your test class:
<?php declare(strict_types=1); namespace Foo\Bar\Test\Unit; use Kenjis\PhpUnitHelper\TestDouble; use PHPUnit\Framework; final class BazTest extends Framework\TestCase { use TestDouble; }| param | type | description |
|---|---|---|
$classname | string | class name |
$params | array | [method_name => return_value] |
| [[method_name => [return_value1, return_value2 [, ...]]] | ||
$constructor_params | false/array | false: disable constructor / array: constructor params |
returns (object) PHPUnit mock object.
Gets PHPUnit mock object.
$email = $this->getMockBuilder(CI_Email::class) ->disableOriginalConstructor() ->onlyMethods(['send']) ->getMock(); $email->method('send') ->willReturn(true);You could write code above like below:
$email = $this->getDouble(CI_Email::class, ['send' => true]);You can set Closure as the return value of a mocked method.
$ret = function () { throw new RuntimeException('Cannot send email!'); }; $mock = $this->getDouble(CI_Email::class, ['send' => $ret]);You can also set the mock itself as the return value of a mocked method with using $this->returnSelf().
$mock = $this->getDouble(CI_Email::class, [ 'to' => $this->returnSelf(), 'subject' => $this->returnSelf(), 'send' => true, ]);You can create mocks with consecutive calls.
$mock = $this->getMockBuilder(CI_Email::class) ->disableOriginalConstructor() ->onlyMethods(['method']) ->getMock(); $mock->expects($this->any())->method('method') ->will($this->onConsecutiveCalls('GET', 'POST' ,'DELETE'));You could write code above like below:
$mock = $this->getDouble( CI_Input::class, [ ['method' => ['GET', 'POST' ,'DELETE']], ] );| param | type | description |
|---|---|---|
$mock | object | PHPUnit mock object |
$method | string | method name |
$params | array | arguments |
Verifies a method was invoked at least once.
$loader->expects($this->atLeastOnce()) ->method('view') ->with( 'shopConfirm', $this->anything(), true );You could write code above like below:
$this->verifyInvoked( $loader, 'view', [ 'shopConfirm', $this->anything(), true ] );| param | type | description |
|---|---|---|
$mock | object | PHPUnit mock object |
$method | string | method name |
$params | array | arguments |
Verifies that method was invoked only once.
$loader->expects($this->once()) ->method('view') ->with( 'shopConfirm', $this->anything(), true );You could write code above like below:
$this->verifyInvokedOnce( $loader, 'view', [ 'shopConfirm', $this->anything(), true ] );| param | type | description |
|---|---|---|
$mock | object | PHPUnit mock object |
$method | string | method name |
$times | int | times |
$params | array | arguments |
Verifies that method was called exactly $times times.
$loader->expects($this->exactly(2)) ->method('view') ->withConsecutive( ['shopConfirm', $this->anything(), true], ['shopTmplCheckout', $this->anything()] );You could write code above like below:
$this->verifyInvokedMultipleTimes( $loader, 'view', 2, [ ['shopConfirm', $this->anything(), true], ['shopTmplCheckout', $this->anything()] ] );| param | type | description |
|---|---|---|
$mock | object | PHPUnit mock object |
$method | string | method name |
$params | array | arguments |
Verifies that method was not called.
$loader->expects($this->never()) ->method('view') ->with( 'shopConfirm', $this->anything(), true );You could write code above like below:
$this->verifyNeverInvoked( $loader, 'view', [ 'shopConfirm', $this->anything(), true ] );This trait provides helper methods to access private or protected properties and methods.
But generally it is not recommended testing non-public properties or methods, so think twice before you use the methods in this trait.
Import the Kenjis\PhpUnitHelper\ReflectionHelper trait into your test class:
<?php declare(strict_types=1); namespace Foo\Bar\Test\Unit; use Kenjis\PhpUnitHelper\ReflectionHelper; use PHPUnit\Framework; final class BazTest extends Framework\TestCase { use ReflectionHelper; }| param | type | description |
|---|---|---|
$obj | object/string | object / class name |
$property | string | property name |
returns (mixed) property value.
Gets private or protected property value.
$obj = new SomeClass(); $private_propery = $this->getPrivateProperty( $obj, 'privatePropery' );| param | type | description |
|---|---|---|
$obj | object/string | object / class name |
$property | string | property name |
$value | mixed | value |
Sets private or protected property value.
$obj = new SomeClass(); $this->setPrivateProperty( $obj, 'privatePropery', 'new value' );| param | type | description |
|---|---|---|
$obj | object/string | object / class name |
$method | string | method name |
returns (closure) method invoker.
Gets private or protected method invoker.
$obj = new SomeClass(); $method = $this->getPrivateMethodInvoker( $obj, 'privateMethod' ); $this->assertEquals( 'return value of the privateMethod() method', $method() );This trait provides helper functions, dd() and d() to dump variables.
Import the Kenjis\PhpUnitHelper\DebugHelper trait into your test class:
<?php declare(strict_types=1); namespace Foo\Bar\Test\Unit; use Kenjis\PhpUnitHelper\DebugHelper; use PHPUnit\Framework; final class BazTest extends Framework\TestCase { use DebugHelper; }This package is licensed using the MIT License.
Please have a look at LICENSE.