BDD For Zend Framework With PHPSpec

BDD for with
PHPSpec

29th October 2011
Marcello Duarte

Saturday, 29 October 2011

whoami

Marcello Duarte

Head of Training @ Ibuildings UK
Lead developer @ PHPSpec
Twitter @_md


In the beginning
there was...

TDD
credits: http://www.ﬂickr.com/photos/improveit/1574023621

They saw that it was good


$thou->shalt->test

credits: http://www.ﬂickr.com/photos/36829113@N05/3392940179/

BDD

credits: http://www.ﬂickr.com/photos/psd/424257767/


BDD
A way of teaching TDD



What to test?

H
Where to begin?

ow m uch

to test i
?
What to call my test?
How do I name my test?
n one go?

BDD
Offers a common language



business

user developer


business

user developer

behavior


© Manuscripts and Archives, Yale University Library.
Sapir-Whorf hypothesis

Language to express truth
vs...


Language to discover truth


Language influence thought


BDD
A way to discover
what is useful to deliver



BDD Outside in
Gherkin
Behat

PHPSpec


Gherkin


behat.org


words matter


$this->assertTrue(...


$this->assertTrue(...

What am I going to test?


$report = new Report;
$this->assertTrue($report instanceof Report);


/ /
$report = new Report;
$this->assertTrue($report instanceof Report);


$employee->should->...


$employee->should->...

What is the expected behavior?


Use Gherkin and Behat
for specifying scenarios
∫
Use PHPSpec for
specifying classes

expressiveness


$this->assertTrue($employee->reportsTo($manager));

$employee->should->reportTo($manager);


phpspec.net


Installing

$ sudo pear channel-discover pear.phpspec.net
$ sudo pear install --alldeps phpspec/PHPSpec


“Specification, not
verification” (Uncle Bob)
$this->assertEquals(0, $result);

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


class CalculatorTest

becomes
class DescribeCalculator


function testAddWithNoArguments()

becomes
function itReturnsZeroWithNoArguments()


All together
class DescribeStringCalculator extends PHPSpecContext
{

{
$calculator = $this->spec(new StringCalculator);
$result = $calculator->add();

}

}


Hooks

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


Setting initial state with before hook
{
function before()
{
$this->calculator = $this->spec(new StringCalculator);
}

{
$result = $this->calculator->add();
}
}


{
private $calculator;

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

{
$this->calculator->add()->should->equal(0);
}

function itReturnsTheBareNumber()
{
$this->calculator->add('42')->should->equal(42);
}
}

Formatters
progress
documentation
html

coming soon:
junit


Progress Formatter
$ phpspec StringCalculatorSpec.php -c
.*.F

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

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

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

Finished in 0.056134 seconds
4 examples, 1 failure, 1 pending


HTML Formatter


Documentation Formatter


Matchers


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


And more matchers...


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


Predicate Matchers


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

class Cell
{
protected $alive = true;

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


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

class Node
{
protected $children = array();

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


Custom Matchers


PHPSpecMatcherdefine('reportTo', function($supervisor) {
return array (
'match' => function($supportEngineer) use ($supervisor) {
return $supportEngineer->reportsTo($supervisor);
},
'failure_message_for_should' =>
function($supportEngineer) use ($supervisor) {
return "expected " . $supervisor->getName() .
" to report to " . $supervisor->getName();
}
);
});

class DescribeSupportEngineer extends PHPSpecContext
{ ...
function itAddsNewCourses() {
$john = new Supervisor("John Smith");
$john->addToTeam($this->supportEngineer);
$this->supportEngineer->should->reportTo($john);
}
}


PHPSpec &


Tool
framework.zend.com


Installing
$ sudo pear channel-discover pear.zfcampus.org
$ sudo pear install zfcampus/zf
$ zf create config
$ vi ~/.zf.ini


.zf.ini

php.include_path = ".:/usr/share/pear"

basicloader.classes.1 = "Akrabat_Tool_DatabaseSchemaProvider"
basicloader.classes.2 = "PHPSpec_Context_Zend_Tool_Provider_Phpspec"
basicloader.classes.3 = "PHPSpec_Context_Zend_Tool_Provider_ModelSpec"
basicloader.classes.4 = "PHPSpec_Context_Zend_Tool_Provider_ViewSpec"
basicloader.classes.5 = "PHPSpec_Context_Zend_Tool_Provider_ControllerSpec"
basicloader.classes.6 = "PHPSpec_Context_Zend_Tool_Provider_ActionSpec"
basicloader.classes.7 = "PHPSpec_Context_Zend_Tool_Provider_Behat"


create a project
$ zf create project callconf
Creating project at /var/www/callconf
Note: This command created a web project, for more
information setting up your VHOST, please see docs/README


initialize PHPSpec
$ cd callconf
$ zf generate phpspec
create spec
create spec/SpecHelper.php
create spec/.phpspec
create spec/models
create spec/views
create spec/controllers


initialize Behat
$ zf generate behat
+d features - place your *.feature files here
+d features/bootstrap - place bootstrap scripts and static
files here
+f features/bootstrap/FeatureContext.php - place your feature
related code here


Views


why specify the view?


Controller and model to the point

Ensure we are focused on what matters

Sustainable pace


create a view spec


create a view spec
$ zf create view-spec add CallForPapers


create a view spec
$ zf create view-spec add CallForPapers
Creating a view script in location /var/www/callconf/
application/views/scripts/call-for-papers/add.phtml
Creating a spec at /var/www/callconf/spec/views/call-for-
papers/AddSpec.php


Spec created by default
<?php

namespace CallForPapers;

require_once __DIR__ . '/../../SpecHelper.php';

use PHPSpecContextZendView as ViewContext;

class DescribeAdd extends ViewContext
{
function itRendersTheDefaultContent()
{
$this->render();
$this->rendered->should->contain('CallForPapers');
$this->rendered->should->contain('add');
}
}


what behaviors can we
describe in the view spec?


Variables we need assigned

What content was rendered
(We can use selectors)


Assigning Variables

function itRendersTheTalkAbstract()
{
$marcello = $this->mock('Speaker', array('isVegetarian' => true));
$this->assign('speaker', $marcello);
$this->render();
$this->rendered->should->contain('diet restrictions: vegetarian');
}


Controllers


create a controller spec


$ zf create controller-spec CallForPapers add,create


$ zf create controller-spec CallForPapers add,create
Creating a controller at /private/var/www/callconf/
application/controllers/CallForPapersController.php
Creating an add action method in controller CallForPapers
Creating an create action method in controller CallForPapers
Creating a spec at /private/var/www/callconf/spec/
controllers/CallForPapersSpec.php


<?php

require_once __DIR__ . '/../SpecHelper.php';

class DescribeCallForPapers extends PHPSpecContextZendController
{
function itShouldBeSuccessfulToGetAdd()
{
$this->get('call-for-papers/add');
$this->response->should->beSuccess();
}

}


what behaviors do we want to
describe in the controller spec?


How do we want to route to its actions

What view variables we need assigned

What view we want rendered


Routing and assigning
function itShouldRouteToTheAddAction()
{
$this->routeFor(array(
'controller' => 'call-for-papers',
'action' => 'add'
))->should->be('/call-for-papers/add');
}

function itAssignsAddSubmissionFormVariable()
{
$this->get('/call-for-papers/add');
$this->assigns('addSubmissionForm')->should->beAnInstanceOf(
'Application_Form_AddSubmissionForm'
);
}


Models


create a model spec


create a model spec
$ zf create model-spec Speaker name:string,email:string


create a model spec
$ zf create model-spec Speaker name:string,email:string
Creating a model at /private/var/www/callconf/application/
models/Speaker.php
Creating a db table at /private/var/www/callconf/
application/models/DbTable/Speakers.php
Creating a mapper at /private/var/www/callconf/application/
models/SpeakerMapper.php
Creating a spec at /private/var/www/callconf/spec/models/
SpeakerSpec.php
Creating migration scripts at /private/var/www/callconf/db/
migrate/001-CreateSpeakersTable.php
Updating project profile '/private/var/www/
callconf/.zfproject.xml'


<?php

require_once __DIR__ . '/../SpecHelper.php';

use Application_Model_Speaker as Speaker;

class DescribeSpeaker extends PHPSpecContext
{
function before()
{
$this->validAttributes = array(
'name' => 'value for name',
'email' => 'value for email',
);
}

function itShouldCreateANewInstanceGivenValidAttributes()
{
$this->speaker = $this->spec(Speaker::create($this->validAttributes));
$this->speaker->should->beValid();
}
}

what behaviors can we
describe in the model spec?


Business logic

Validation

Spying results from data source operations


Business Logic

class DescribeSpeaker extends PHPSpecContext
{
function before()
{
$this->validAttributes = array(
'name' => 'Marcello Duarte',
'email' => 'marcello@ibuildings.com',
'diet_restriction' => 'vegetarian',
);
$this->speaker = $this->spec(Speaker::create($this->validAttributes));
}

function itGetsExtraRatingPointsForTalkIfVegetarian()
{
$this->speaker->should->haveExtraPoints();
}
}


Business Logic

class Speaker
{
//... other methods

function hasExtraPoints()
{
return stripos($this->getDietRestrictions(), 'vegetarian') !== false;
}
}


Real database hits?


Avoid

Sometimes, for confidence

When testing data access objects


Dependency chains


Dependencies can be hard to manage

class DescribeEvent extends PHPSpecContext
{
function itDoesSomethingWhenYouHaveSpeakerAllocated()
{
$event = new Event(
new Organizer('John Smith',
new Organization('Ibuildings')
)
);
$event->addSpeaker(new Speaker('Rowan'), new Slot(’10:30’),
new Room('A'));
$event->addSpeaker(new Speaker('Ben'), new Slot(’10:30’),
new Room('B'));
// specify expected behavior
}
}


Usually dependencies are replaced with
doubles when writing specs

We can use a framework like Mockery

But if you really need the real thing


Object Mother



{
{
$exampleEvent = ExampleEvent::newWithSimultaneousSpeakers();

// specify expected event behavior
}
}


Code duplication

Too many methods


Test Data Builder


Is created with save “empty” objects

Has a fluent interface

Has a build method



{
{
$eventBuilder = new EventBuilder();
$organizerBuilder = new OrganizerBuilder();

$event = $eventBuilder->withOrganizer(
$organizerBuilder->withOrganization()->build()
)->withConflictingSpeakers()
->build();

// specify expected event behavior
}
}


phactory.org


installing


installing
$ sudo pear channel-discover pearhub.org


installing
$ sudo pear channel-discover pearhub.org
$ sudo pear install pearhub/Phactory


Needs a Pdo connection

Get from default adapter


Create a connection

protected function _initPhactory()
{
Phactory::setConnection(
Zend_Db_Table_Abstract::getDefaultAdapter());
return Phactory::getConnection();
}


Define table blueprints

// spec/factories.php

Phactory::define('speaker', array(
'name' => 'John Smith',
'email' => 'john@smith.com'));


Create objects
// in one of my specs

$ben = Phactory::create('speaker', array('name' => 'Rowan'));
$rowan = Phactory::create('speaker', array('name' => 'Ben'));

// Phactory_Row objects
echo $ben->name // prints Ben


Questions?

223

Thank you!

http://joind.in/4318
http://slidesha.re/tcGM93
Marcello Duarte
@_md

is hiring. Come talk to me.

224

BDD For Zend Framework With PHPSpec

More Related Content

Similar to BDD For Zend Framework With PHPSpec

More from Marcello Duarte

Recently uploaded

BDD For Zend Framework With PHPSpec