PHPSpec BDD for PHP

Marcello Duarte
@_md

PHPSpec Lead Developer
Head of Training @
Agile guy

What is PHPSpec?
BDD Framework

What is PHPSpec?
BDD Framework

Created by Pádraic Brady

What is PHPSpec?
BDD Framework

Created by Pádraic Brady

DSL based on RSpec

BDD?
Better way to explain TDD

TDD?
Write a failing test

Make it fail for the right reasons

TDD?

Make it pass (just about)

TDD?
Make it pass (just about)

Refactor

Unit Testing
XP: test everything that can possibly break

Unit Testing
Unit: vague and structural 1:1

Unit Testing
Unit: vague and structural 1:1
Focus on code not behaviour

It’s all in the mind
It’s soo simple, it does not need tests

I’ve done this millions of times

I’ve done this millions of times
I will write my code rst and test if I have time

class CalculatorTest

becomes
class DescribeCalculator

class CalculatorTest extends
SomeTestFramework_TestCase

becomes
class DescribeCalculator extends
PHPSpecContext

testAddWithNoArguments()

becomes
itReturnsZeroWithNoArguments()

$this->assertEquals(0, $result);

becomes
$result->should->be(0);

Installing
PEAR (soon...)

# pear channel-discover pear.phpspec.net
Adding Channel "pear.phpspec.net" succeeded
Discovery of channel "pear.phpspec.net" succeeded
# pear config-set preferred_state beta
# pear install --alldeps phpspec/PHPSpec

GITHUB

$ git clone git://github.com/phpspec/phpspec.git

Set initial state
# StringCalculatorSpec.php
<?php

class DescribeStringCalculator extends PHPSpecContext
{
function before()
{
$this->calculator = $this->spec(new StringCalculator);
}
}

PHPSpec DSL

class DescribeStringCalculator extends PHPSpecContext
{
...

function itReturnsZeroWithNoArguments()
{
$this->calculator->add()->should->be(0);
}
}

Lets run our specs
$ phpspec StringCalculatorSpec.php -c
..

Finished in 0.055689 seconds

2 examples, 0 failures

Pending examples

function itReturnsTheBareNumber()
{
$this->pending('Waiting to clarify the spec');
}

..*

Pending:
String Calculator returns the bare number
# Waiting to clarify the spec
# ./spec/StringCalculatorSpec.php:19

2 examples, 0 failures, 1 pending
$

Failing examples

public function itReturnsTheSumOfSpaceSeparatedString()
{
$this->calculator->add('4 2')->should->be(6);
}

// this will fail because it’s not yet implemented

.*.F

Pending:

Failures:
1) String Calculator returns the sum of space separate string
expected 6, got NULL (using be())
# .spec/StringCalculatorSpec.php:28

4 examples, 1 failure, 1 pending
$

$result->should->be(0)
$result->shouldNot->be(42)

.*.F

Pending:

Failures:
expected 42, not to be 24 (using be())

$

Deliberate fail

public function itReturnsTheBareNumber()
{
$this->fail('Just because');
}

.*.F

Pending:

Failures:
expected 42, got 0 (using be())

2) StringCalculator returns the sum of any white space
separated string
Failure/Error:
Just because


be($match)
equal($match)
beEqualTo($match)
beAnInstanceOf($match)
beEmpty()
beFalse()
beGreaterThan($match)
beGreaterThanOrEqualTo($match)

beInteger()
beLessThan($match)
beLessThanOrEqualTo($match)
beNull()
beString()
beTrue()

throwException($match)

beInteger()
beLessThan($match)
beLessThanOrEqualTo($match)
beNull()
beString()
beTrue()

w
throwException($match) ne

Predicate Matcher

$cell = $this->spec(new Cell);
$cell->should->beAlive();

class Cell
{
protected $alive = true;

public function isAlive() {
return $this->alive;
}
...
}

Predicate Matcher

$newNode = $this->spec(new Node);
$newNode->shouldNot->haveChildren();

class Node
{
protected $children = array();

public function hasChildren() {
return count($this->children) > 0;
}
...
}

User De ned Matcher
class DescribeRapture extends PHPSpecContext
{
...
function itIsNotTheEndOfTheWorldAsWeKnowIt()
{
$today = new DateTime('2011-05-20');
$this->rapture->setDate($today)
$this->rapture->shouldNot->happenToday();
}
}

$ phpspec RaptureSpec.php -c
E

Exceptions:
1) Rapture is not the end of the world as we know it
Failure/Error: $this->rapture->shouldNot->happenToday();
PHPSpecException: unknown method call
# ./RaptureSpec.php:19
# /usr/share/pear/PHPSpec/Runner/Example.php:168

1 examples, 1 exception
$

PHPSpecMatcherdefine('happenToday', function() {
return array (
'match' => function($rapture) {
return $rapture->happensToday();
},
'failure_message_for_should_not' =>
function($rapture) {
return sprintf("expected %s not to mean kaput",
$rapture->getDate());
}
);
});

class DescribeRapture extends PHPSpecContext
{ ...
function itIsNotTheEndOfTheWorldAsWeKnowIt() {
$today = new DateTime('2011-05-20');
$this->rapture->setDate($today)
$this->rapture->shouldNot->happenToday();
}
}

http://farm5.static.ﬂickr.com/4140/4926597784_4392361eb6_b_d.jpg

PHPSpecMatcherdefine('contain', function($course) {
return array (
'match' => function($repository) use ($course) {
return $repository->has($course);
},
'failure_message_for_should' =>
function($repository) use ($course) {
return "expected $course to be in repository";
}
);
});

class DescribeCourseRepository extends PHPSpecContext
{ ...
function itAddsNewCourses() {
$course = new Course("BDD with PHPSpec");
$this->courses->add($course);
$this->courses->should->contain(course);
}
}

$ phpspec CourseRepositorySpec.php -c
F

Failures:
1) Course Repository adds new courses
Failure/Error: $this->courses->should->contain(course);
expected 'BDD with PHPSpec' to be in repository
# ./CourseRepository.php:19

1 examples, 1 failure
$

Hooks

before()
after()
beforeAll()
afterAll()

Mocks

mock()
stub()
double()

Stub Example
$greeter = stub('Greeter');
$greeter->stub('greet')->andReturn('Hello Mocks!');

$hello = $this->spec(new HelloWorld($greeter));
$hello->sayHello()->should->equal('Hello Mocks!');

Partial Stub
$greeter = mock('Greeter');
$greeter ->stub('greet')
->shouldReceive('Chuck')
->andReturn('Hello Chuck!');

$hello->sayHello()->should->equal('Hello Chuck!');

Shortcut
$greeter = stub('Greeter', array('greet' => 'Hello World!'));

$hello->sayHello()->should->equal('Hello World!');

Mocks and hinted type
class HelloWorld
{
public function __construct(Greeter $greeter) // <-- type
{
...
}
}

$greeter = mock('Greeter'); // <-- we are covered

Empty doubles
class HelloWorld
{
public function __construct($greeter) // <-- no type
{
...
}
}

$greeter = mock(); // <-- no need for types

Counters
$greeter ->stub('greet')->andReturn('Hello Chuck!')
->exactly(42);

->never();

Coming soon (more counters)
->atLeast(2);

->atMost(5);

->between('2..5');

Coming soon (stub chain)
Instead of

$frontController = double();
$dispatcher = double();
$route = double();
$request = double();
$request->stub('frontController')
->andReturn($frontController);
$frontController->stub('dispatcher')->andReturn($dispatcher);
$dispatcher->stub('route')->andReturn($route);
$route->stub('request')->andReturn($request);

Coming soon (stub chain)
You can have

$request->stubChain('frontController', 'dispatcher', 'route',
'request');

More to come

CI friendly reports
functional approach
backtrace
fail fast
autorun
run single examples
integration with ZF and Kohana

Links
http://github.com/phpspec/phpspec
http://github/phpspec/phpspec-mocks
http://www.phpspec.net

http://dannorth.net/introducing-bdd

http://twitter.com/_md
http://twitter.com/phpspec

Thank you!

Marcello Duarte
@_md

http://joind.in/talk/view/3469

is hiring. Come talk to me.

PHPSpec BDD for PHP

More Related Content

What's hot

Viewers also liked

Similar to PHPSpec BDD for PHP

More from Marcello Duarte

Recently uploaded

PHPSpec BDD for PHP

Editor's Notes