PhockitoUnit PHP-DI exists to marry PHP Unit with the Phockito mocking framework and the PHP-DI dependency injection framework in an everlasting love praised by PHP developers everywhere. It is a PHP-DI specific enhancement to the PhockitoUnit libary. It's features are rather simple:
- Automatically generate mocks that your tests require
- Automatically generate spys that your tests require
- Automatically turn on hamcrest matching
- Automatically register your mocks in the DI Container
That's it!
Here is a classic PHP Unit test that uses Phockito to mock a dependency
class SomeTest extends PHPUnit_Framework_TestCase
{
public function setUp(){
Phockito::include_hamcrest();
}
public function testSomeMethod(){
/** @var SomeDependency $mockDependency **/
$mockDependency = Phockito::mock('SomeDependency');
Phockito::when($mockDependency->dependentMethod(anything()))->return("value");
$instance = new ThingThatNeedsDependency($mockDependency);
$this->assertEquals("value", $instance->methodThatUsesDependency());
}
public function testSomeMethodWhenSomeDependencyThrows(){
/** @var SomeDependency $mockDependency **/
$mockDependency = Phockito::mock('SomeDependency');
Phockito::when($mockDependency->dependentMethod(anything()))->throw(new Exception("Some error"));
$instance = new ThingThatNeedsDependency($mockDependency);
try{
$instance->methodThatUsesDependency());
$this->fail("Expected exception not thrown");
} catch(Exception $ex) {
$this->assertEquals("Some error", $ex->getMessage());
}
}
}Certainly you have encoutnered or written a unit tests that is at least similar to this structure. PhockitoUnit simplifies this structure by eliminating some common boilerplate, here it is:
class SomeTest extends \PhockitoUnit\PhockitoUnitTestCase
{
/** @var SomeDependency **/
protected $mockDependency;
public function testSomeMethod(){
Phockito::when($this->mockDependency->dependentMethod(anything()))->return("value");
$instance = new ThingThatNeedsDependency($mockDependency);
$this->assertEquals("value", $instance->methodThatUsesDependency());
}
public function testSomeMethodWhenSomeDependencyThrows(){
Phockito::when($this->mockDependency->dependentMethod(anything()))->throw(new Exception("Some error"));
$instance = new ThingThatNeedsDependency($mockDependency);
try{
$instance->methodThatUsesDependency());
$this->fail("Expected exception not thrown");
} catch(Exception $ex) {
$this->assertEquals("Some error", $ex->getMessage());
}
}
}It's not a monsterous change, but it helps quite a bit, eliminating the chance of class name typos, class rename refactorings, etc. And in more advanced scenarios where you are mocking an domain object graph it can make it easier to write more tests. More tests means more coverage of intent. Here's an example that sets up a graph and uses a spy:
class FamilyTest extends \PhockitoUnit\PhockitoUnitTestCase
{
/** @var Child **/
protected $mockChild1;
/** @var Child **/
protected $spyChild2;
/** @var Parent **/
protected $mockParent;
public function setUp(){
parent::setUp();
Phockito::when($this->mockParent->getEledestChild())->return($this->mockChild1);
Phockito::when($this->mockParent->getYoungestChild())->return($this->spyChild1);
}
public function testGetEldestChildNickName(){
Phockito::when($this->mockChild1->getNickName())->return("Oldie");
$family = new Family(array($this->mockParent));
$this->assertEquals("Oldie", $family->getElestChildNickName());
}
public function testGetYoungestchildFullName(){
Phockito::when($this->spyChild2->getFirstName())->return("Youngy");
Phockito::when($this->spyChild2->getLastName())->return("McYoung");
$family = new Family(array($this->mockParent));
$this->assertEquals("Youngy McYoung", $family->testGetYoungestchildFullName());
}
}