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

Marcello Duarte

Head of Training @ Ibuildings UK

Lead developer @ PHPSpec

Twitter @_md


In the beginningthere was...

TDD

credits: http://www.flickr.com/photos/improveit/1574023621


http://www.flickr.com/photos/improveit/1574023621

http://www.flickr.com/photos/improveit/1574023621

They saw that it was good


$thou->shalt->test$thou->shalt->test

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


http://www.flickr.com/photos/36829113@N05/3392940179/

http://www.flickr.com/photos/36829113@N05/3392940179/

BDD

credits: http://www.flickr.com/photos/psd/424257767/


http://www.flickr.com/photos/psd/424257767/


BDD

A way of teaching TDD





What to test?

Where to begin?

How do I name my test?

How much to test in one go?

What to call my test??Saturday, 29 October 2011


BDD




Offers a common language


BDD




user developer

business


behavior

user developer

business


Sapir-Whorf hypothesis

© M

anusc

ripts

and A

rchiv

es,

Yale

Univ

ersi

ty L

ibra

ry.


Language to express truth

vs...


Language to discover truth


Language influence thought



BDD




A way to discoverwhat is useful to deliver


BDD




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


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

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


phpspec.net


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

Installing


“Specification, not verification” (Uncle Bob)

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

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


class CalculatorTest

becomesclass DescribeCalculator

class CalculatorTest

becomesclass DescribeCalculator


function testAddWithNoArguments()

becomesfunction itReturnsZeroWithNoArguments()


All together

class DescribeStringCalculator extends \PHPSpec\Context{

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

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

}


Hooks

before()after()

beforeAll()afterAll()


Setting initial state with before hook

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

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


class DescribeStringCalculator extends \PHPSpec\Context{ private $calculator;

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

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

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


Formatters

progressdocumentation

html

coming soon:junit


$ 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 seconds4 examples, 1 failure, 1 pending

Progress Formatter


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; } ...}

$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; } ...}

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

class Node{ protected $children = array();

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


Custom Matchers


\PHPSpec\Matcher\define('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 \PHPSpec\Context{ ... function itAddsNewCourses() { $john = new Supervisor("John Smith"); $john->addToTeam($this->supportEngineer); $this->supportEngineer->should->reportTo($john); }}

\PHPSpec\Matcher\define('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 \PHPSpec\Context{ ... function itAddsNewCourses() { $john = new Supervisor("John Smith"); $john->addToTeam($this->supportEngineer); $this->supportEngineer->should->reportTo($john); }}


PHPSpec &


Tool

framework.zend.com


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

Installing


.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"

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"


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

create a project


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

initialize PHPSpec


$ 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

initialize Behat


Views


why specify the view?


Controller and model to the point

Ensure we are focused on what matters

Sustainable pace


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.phtmlCreating a spec at /var/www/callconf/spec/views/call-for-papers/AddSpec.php

create a view spec


Spec created by default<?php

namespace CallForPapers;

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

use \PHPSpec\Context\Zend\View as ViewContext;

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

<?php





<?php






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,createCreating a controller at /private/var/www/callconf/application/controllers/CallForPapersController.phpCreating an add action method in controller CallForPapersCreating an create action method in controller CallForPapersCreating a spec at /private/var/www/callconf/spec/controllers/CallForPapersSpec.php



Spec created by default

<?php

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

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

}

<?php


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

}


what behaviors do we want todescribe 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' ); }

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


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

create a model spec


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

create a model spec


Spec created by default<?php


use Application_Model_Speaker as Speaker;

class DescribeSpeaker extends \PHPSpec\Context{ 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(); }}Saturday, 29 October 2011

what behaviors can wedescribe in the model spec?


Business logic

Validation

Spying results from data source operations


Business Logic

class DescribeSpeaker extends \PHPSpec\Context{ function before() { $this->validAttributes = array( 'name' => 'Marcello Duarte', 'email' => '[email protected]', 'diet_restriction' => 'vegetarian', ); $this->speaker = $this->spec(Speaker::create($this->validAttributes)); } function itGetsExtraRatingPointsForTalkIfVegetarian() { $this->speaker->should->haveExtraPoints(); }}

class DescribeSpeaker extends \PHPSpec\Context{ function before() { $this->validAttributes = array( 'name' => 'Marcello Duarte', 'email' => '[email protected]', 'diet_restriction' => 'vegetarian', ); $this->speaker = $this->spec(Speaker::create($this->validAttributes)); } function itGetsExtraRatingPointsForTalkIfVegetarian() { $this->speaker->should->haveExtraPoints(); }}


mailto:[email protected]


Business Logic

class Speaker{ //... other methods

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

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 \PHPSpec\Context{ 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



class DescribeEvent extends \PHPSpec\Context{ function itDoesSomethingWhenYouHaveSpeakerAllocated() { $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



class DescribeEvent extends \PHPSpec\Context{ function itDoesSomethingWhenYouHaveSpeakerAllocated() { $eventBuilder = new EventBuilder(); $organizerBuilder = new OrganizerBuilder();

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

// specify expected event behavior }}


phactory.org


installing


$ sudo pear channel-discover pearhub.org

installing


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

installing


Needs a Pdo connection

Get from default adapter


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

Create a connection


// spec/factories.php

Phactory::define('speaker', array( 'name' => 'John Smith', 'email' => '[email protected]'));

Define table blueprints




// in one of my specs

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

// Phactory_Row objectsecho $ben->name // prints Ben

Create objects


Questions?

223


224

Thank you!

http://joind.in/4318

http://slidesha.re/tcGM93

Marcello Duarte

@_md

is hiring. Come talk to me.






BDD For Zend Framework With PHPSpec

Technology

Transcript of BDD For Zend Framework With PHPSpec