Advanced PHPUnit Topics

Welcome! Advanced PHPUnit Topics Sebastian Bergmann http://sebastian-bergmann.de/ September 14 th 2007

Who I am

Sebastian Bergmann

Computer Scientist

Involved in the PHP Project since 2000

Author, Consultant, Coach, Trainer

Developer for eZ Systems AS

Who are you?

Your experience with

PHP 5?

OOP?

PHPUnit?

PHPUnit

Test Framework

Member of the xUnit family of test frameworks

Mock Objects

DbUnit

Integration

Selenium RC

Bamboo, Bitten, CruiseControl, ...

Even More Cool Stuff :-)

Code Coverage and Software Metrics

Test Database

Mutation Testing (GSoC07 project)

Annotations @assert <?php class Calculator { /** * @assert (1, 2) == 3 */ public function add ( $a , $b ) { return $a + $b ; } /** * @assert (2, 1) == 1 */ public function sub ( $a , $b ) { return $a - $b ; } }

Annotations @assert [email_address] ~ % phpunit Calculator PHPUnit 3.2.0 by Sebastian Bergmann. .. Time: 0 seconds OK (2 tests)

Annotations @group <?php class SomeTest extends PHPUnit_Framework_TestCase { /** * @group specification */ public function testSomething () { } /** * @group regresssion * @group bug2204 */ public function testSomethingElse () { } }

Annotations @group [email_address] ~ % phpunit SomeTest PHPUnit 3.2.0 by Sebastian Bergmann. .. Time: 0 seconds OK (2 tests) [email_address] ~ % phpunit --group bug2204 SomeTest PHPUnit 3.2.0 by Sebastian Bergmann. . Time: 0 seconds OK (1 test)

Annotations @test <?php class Specification extends PHPUnit_Framework_TestCase { /** * @test */ public function shouldDoSomething () { } /** * @test */ public function shouldDoSomethingElse () { } }

Annotations @test [email_address] ~ % phpunit --testdox Specification PHPUnit 3.2.0 by Sebastian Bergmann. Specification - Should do something - Should do something else

Test-Level Setup <?php class MyTest extends PHPUnit_Framework_TestCase { protected function setUp () { print " MyTest::setUp()" ; } protected function tearDown () { print " MyTest::tearDown()" ; } public function testOne () { print " MyTest::testOne()" ; } public function testTwo () { print " MyTest::testTwo()" ; } } MyTest::setUp() MyTest::testOne() MyTest::tearDown() MyTest::setUp() MyTest::testTwo() MyTest::tearDown()

Suite-Level Setup <?php require_once 'MyTest.php' ; class MySuite extends PHPUnit_Framework_TestSuite { public static function suite () { return new MySuite ( 'MyTest' ); } protected function setUp () { print " MySuite::setUp()" ; } protected function tearDown () { print " MySuite::tearDown()" ; } } MySuite::setUp() MyTest::setUp() MyTest::testOne() MyTest::tearDown() MyTest::setUp() MyTest::testTwo() MyTest::tearDown() MySuite::tearDown()

Suite-Level Setup <?php require_once 'MyTest.php' ; class MySuite extends PHPUnit_Framework_TestSuite { public static function suite () { return new MySuite ( 'MyTest' ); } protected function setUp () { $this -> sharedFixture = 'something' ; } } Setting up a shared fixture

Suite-Level Setup <?php class MyTest extends PHPUnit_Framework_TestCase { public function testOne () { $this -> assertEquals ( 'something' , $this -> sharedFixture ); } } Using a shared fixture

Testing Object Interaction

Tests that only test one thing are more informative than tests where failure can come from many sources

How can you isolate your tests from external influences?

Simply put, by replacing the expensive, messy, unreliable, slow, complicated resources with stubs that are automatically generated for the purpose of your tests

For example, you can replace what is in reality a complicated computation with a constant, at least for the purposes of a single test

Stubs

Dummy

Not the real object

Fake

Usable for testing but not for real job

Stub

Fake that returns canned data

Spy

Stub that records called methods, etc.

Mock

Spy with expectations

Terminology

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class StubTest extends PHPUnit_Framework_TestCase { public function testStub () { } } ?> Stubs

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class StubTest extends PHPUnit_Framework_TestCase { public function testStub () { $stub = $this -> getMock ( 'SomeClass' ); } } ?> Stubs

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class StubTest extends PHPUnit_Framework_TestCase { public function testStub () { $stub = $this -> getMock ( 'SomeClass' ); $stub -> expects ( $this -> any ()) -> method ( 'doSomething' ) -> will ( $this -> returnValue ( 'foo' )); } } ?> Stubs

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class StubTest extends PHPUnit_Framework_TestCase { public function testStub () { $stub = $this -> getMock ( 'SomeClass' ); $stub -> expects ( $this -> any ()) -> method ( 'doSomething' ) -> will ( $this -> returnValue ( 'foo' )); // Calling $stub->doSomething() will now return // 'foo'. } } ?> Stubs

Mock Objects are simulated objects that mimic the behavior of real objects in controlled ways

We can create a mock object to test the behavior of some other object

The Mock Objects system that is integrated in PHPUnit provides a fluent interface to specify the behavior of and the expectations for the mock

Mock Objects

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class ObserverTest extends PHPUnit_Framework_TestCase { public function testUpdateIsCalledOnce () { } } ?> Mock Objects

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class ObserverTest extends PHPUnit_Framework_TestCase { public function testUpdateIsCalledOnce () { $observer = $this -> getMock ( 'Observer' , array( 'update' ) ); } } ?> Mock Objects

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class ObserverTest extends PHPUnit_Framework_TestCase { public function testUpdateIsCalledOnce () { $observer = $this -> getMock ( 'Observer' , array( 'update' ) ); $observer -> expects ( $this -> once ()) -> method ( 'update' ) -> with ( $this -> equalTo ( 'something' )); } } ?> Mock Objects

Testing Object Interaction <?php require_once 'PHPUnit/Framework.php' ; class ObserverTest extends PHPUnit_Framework_TestCase { public function testUpdateIsCalledOnce () { $observer = $this -> getMock ( 'Observer' , array( 'update' ) ); $observer -> expects ( $this -> once ()) -> method ( 'update' ) -> with ( $this -> equalTo ( 'something' )); $subject = new Subject ; $subject -> attach ( $observer ); $subject -> doSomething (); } } ?> Mock Objects

Database Testing

Michael Lively Jr. has ported the DbUnit extension for JUnit to PHPUnit

PHPUnit_Extensions_Database_TestCase

is used to test database-driven projects and

puts your database into a known state between test runs

This avoids problems with one test corrupting the database for other tests

has the ability to export and import your database data to and from XML datasets

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { protected $pdo ; public function __construct () { $this -> pdo = new PDO ( 'sqlite::memory:' ); BankAccount :: createTable ( $this->pdo ); } } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { protected $pdo ; public function __construct () { $this -> pdo = new PDO ( 'sqlite::memory:' ); BankAccount :: createTable ( $this->pdo ); } protected function getConnection () { return $this -> createDefaultDBConnection ( $this -> pdo , 'sqlite' ); } } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { protected $pdo ; public function __construct () { $this -> pdo = new PDO ( 'sqlite::memory:' ); BankAccount :: createTable ( $this->pdo ); } protected function getConnection () { return $this -> createDefaultDBConnection ( $this -> pdo , 'sqlite' ); } protected function getDataSet () { return $this -> createFlatXMLDataSet ( '/path/to/seed.xml' ); } } The BankAccountDB example

Database Testing <dataset> <account account_number= "15934903649620486" balance= "100.00" /> <account account_number= "15936487230215067" balance= "1216.00" /> <account account_number= "12348612357236185" balance= "89.00" /> <account account_number= "15936487230215067" balance= "1216.00" /> </dataset> The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { // ... public function testNewAccount () { } } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { // ... public function testNewAccount () { $ba = new BankAccount ( '12345678912345678' , $this -> pdo ); } } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { // ... public function testNewAccount () { $ba = new BankAccount ( '12345678912345678' , $this -> pdo ); $set = $this -> createFlatXMLDataSet ( '/path/to/after-new-account.xml' ); } } The BankAccountDB example

Database Testing <?php require_once 'PHPUnit/Extensions/Database/TestCase.php' ; class BankAccountDBTest extends PHPUnit_Extensions_Database_TestCase { // ... public function testNewAccount () { $ba = new BankAccount ( '12345678912345678' , $this -> pdo ); $set = $this -> createFlatXMLDataSet ( '/path/to/after-new-account.xml' ); $this -> assertTablesEqual ( $set -> getTable ( 'account' ), $this -> getConnection () -> createDataSet () -> getTable ( 'account' ) ); } } The BankAccountDB example

Database Testing <dataset> <account account_number= "15934903649620486" balance= "100.00" /> <account account_number= "15936487230215067" balance= "1216.00" /> <account account_number= "12348612357236185" balance= "89.00" /> <account account_number= "15936487230215067" balance= "1216.00" /> <account account_number= "12345678912345678" balance= "0.00" /> </dataset> The BankAccountDB example

The End

Thank you for your interest!

These slides will be available shortly on http://sebastian-bergmann.de/talks/.

License

This presentation material is published under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported license.

You are free:

to Share – to copy, distribute and transmit the work.

Under the following conditions:

Attribution. You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).