Continuous Quality Assurance

Con$nuous QA Michelangelo van Dam Macq NV

Michelangelo van Dam• independent contractor• president PHPBenelux• conference speaker• community animal ZEND FRAMEWORK PHP . 2

Overview• introduc$on• overview of tools• con$nuous integra$on -‐ interpreta$on of reports• roundup 3

Introduc$on 4

What is quality assurance?• safeguarding source code• applica$on behaves as expected• bugs discovered before becoming an issue• tracking progress of a project -‐ development of features -‐ health of the codebase 5

Why invest in QA?• improving development code• improving development team• saving $me in aJer sales maintenance• con$nuous repor$ng• ready to deploy code (“builds”) 6

Overview of tools 7

php -‐l (lint)hPp://www.php.net/manual/en/features.commandline.op$ons.php 8

PHP Lint TIP: pre-‐commit hook• 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 9

Execu$on 10

Parse error 11

Fatal error 12

PHPUnithPp://www.phpunit.de/manual/current/en/ 13

PHPUnit• tes$ng framework for PHP projects• port of xUnit unit test frameworks -‐ compa$ble with JUnit, NUnit, etc...• produces generic test results -‐ compa$ble with the other xUnit frameworks• produces code coverage reports -‐ to indicate what part of code is tested 14

Execu$on of phpunit 15

PHPDocumentor hPp://www.phpdoc.org 16

PHPDoc• uses in code docblocks• parses API documenta$on 17

PHPDoc in ac$on 18

API documenta$on 19

PHP_CodeSniﬀer hPp://pear.php.net/package/PHP_CodeSniﬀer/ 20

PHP_CodeSniﬀer• checks source code on coding standards• reports viola$ons on a given standard• ensures a consistent way code is wriPen -‐ as though one developer wrote all the code 21

Report types• full: all details of viola$ons• summary: total of errors and warnings• source: targeted sources with viola$ons• xml: a full report in XML format• checkstyle: XML report on style viola$ons• csv: a full report in CSV format• emacs: a full report in EMACS format• blame: a list of responsible viola$ng devs 22

Example Full reportFILE: /path/to/file.php-------------------------------------------------------------------------------FOUND 2 ERROR(S) AND 4 WARNING(S) AFFECTING 4 LINE(S)------------------------------------------------------------------------------- 111 | ERROR | Arguments with default values must be at the end of the | | argument list 111 | WARNING | Line exceeds 80 characters; contains 88 characters 118 | WARNING | Line exceeds 80 characters; contains 89 characters 121 | WARNING | Line exceeds 80 characters; contains 84 characters 130 | WARNING | Line exceeds 80 characters; contains 94 characters 176 | ERROR | Spaces must be used to indent lines; tabs are not allowed------------------------------------------------------------------------------- 23

Example Summary reportPHP CODE SNIFFER REPORT SUMMARY--------------------------------------------------------------------------------FILE ERRORS WARNINGS--------------------------------------------------------------------------------/path/to/file.php 1 4--------------------------------------------------------------------------------A TOTAL OF 1 ERROR(S) AND 4 WARNING(S) WERE FOUND IN 1 FILE(S)-------------------------------------------------------------------------------- 24

Example Source reportPHP CODE SNIFFER VIOLATION SOURCE SUMMARY--------------------------------------------------------------------------------STANDARD CATEGORY SNIFF COUNT--------------------------------------------------------------------------------Generic Files Line length too long 4PEAR Functions Valid default value not at end 1--------------------------------------------------------------------------------A TOTAL OF 5 SNIFF VIOLATION(S) WERE FOUND IN 2 SOURCE(S)-------------------------------------------------------------------------------- Although specified Zend as coding standard, there’s a relation to underlying standards like PEAR and the General coding standards 25

Example XML report<?xml version="1.0" encoding="UTF-8"?><phpcs version="1.3.0"> <file name="/path/to/file.php" errors="1" warnings="4"> <error line="111" column="83" source="PEAR.Functions.ValidDefaultValue.NotAtEnd" s everity="5">Arguments with default values must be at the end of the argumentlist</error> <warning line="111" column="89" source="Generic.Files.LineLength.TooLong" severity="5">Line exceeds 80 characters; contains 88 characters</warning> <warning line="118" column="90" source="Generic.Files.LineLength.TooLong" severity="5">Line exceeds 80 characters; contains 89 characters</warning> <warning line="121" column="85" source="Generic.Files.LineLength.TooLong" severity="5">Line exceeds 80 characters; contains 84 characters</warning> <warning line="130" column="95" source="Generic.Files.LineLength.TooLong" severity="5">Line exceeds 80 characters; contains 94 characters</warning> </file></phpcs> 26

Example CheckStyle report<?xml version="1.0" encoding="UTF-8"?><checkstyle version="1.3.0"> <file name="/path/to/file.php"> <error line="111" column="83" severity="error" message="Arguments with default values must be at the end of the argument list" source="PEAR.Functions.ValidDefaultValue.NotAtEnd"/> <error line="111" column="89" severity="warning" message="Line exceeds 80 characters; contains 88 characters" source="Generic.Files.LineLength.TooLong"/> <error line="118" column="90" severity="warning" message="Line exceeds 80 characters; contains 89 characters" source="Generic.Files.LineLength.TooLong"/> <error line="121" column="85" severity="warning" message="Line exceeds 80 characters; contains 84 characters" source="Generic.Files.LineLength.TooLong"/> <error line="130" column="95" severity="warning" message="Line exceeds 80 characters; contains 94 characters" source="Generic.Files.LineLength.TooLong"/> </file></checkstyle> 27

Example CSV reportFile,Line,Column,Type,Message,Source,Severity"/path/to/file.php",111,83,error,"Arguments with default values must be at the endof the argument list",PEAR.Functions.ValidDefaultValue.NotAtEnd,5"/path/to/file.php",111,89,warning,"Line exceeds 80 characters; contains 88characters",Generic.Files.LineLength.TooLong,5"/path/to/file.php",118,90,warning,"Line exceeds 80 characters; contains 89characters",Generic.Files.LineLength.TooLong,5"/path/to/file.php",121,85,warning,"Line exceeds 80 characters; contains 84characters",Generic.Files.LineLength.TooLong,5"/path/to/file.php",130,95,warning,"Line exceeds 80 characters; contains 94characters",Generic.Files.LineLength.TooLong,5 28

Example Blame reportPHP CODE SNIFFER SVN BLAME SUMMARY--------------------------------------------------------------------------------AUTHOR (Author %) (Overall %) COUNT--------------------------------------------------------------------------------michelangelo (2.26) (100) 5--------------------------------------------------------------------------------A TOTAL OF 5 SNIFF VIOLATION(S) WERE COMMITTED BY 1 AUTHOR(S)-------------------------------------------------------------------------------- 29

Execu$on of phpcs 30

PHPCPDhPps://github.com/sebas$anbergmann/phpcpd 31

Copy/Paste Detec$on TIP: pre-‐commit hook• detects duplicate or similar lines of code -‐ copied code -‐ code that’s similar 32

phpcpd in ac$on 33

Pdepend hPp://pdepend.org 34

Pdepend in ac$on 35

pdepend pyramid 36

• CYCLO: Cycloma$c 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 Opera$on Calls 37

Cycloma$c Complexity• metric calcula$on• execu$on paths• independent control structures -‐ if, else, for, foreach, switch case, while, do, …• within a single method or func$on• more info -‐ hPp://en.wikipedia.org/wiki/Cycloma$c_complexity 38

Average Hierarchy HeightThe average of the maximum length from a root class to its deepest subclass 39

pdepend pyramid 40

pdepend-‐graphgraph about stability: a mix between abstract and concrete classes 41

PHPMD (Mess detec$on) hPp://phpmd.org 44

PHPMD• iden$fy poten$al problems in source code -‐ possible bugs -‐ subop$mal code -‐ overcomplicated expressions -‐ unused parameters, methods, proper$es 45

PHPMD in ac$on 46

PHPMD repor$ng 47

PHP Code Browser hPps://github.com/mayﬂowergmbh/PHP_CodeBrowser 48

phpcb• code browser for php sources -‐ syntax highligh$ng -‐ colored error sec$ons• designed for usage of QA tools -‐ PHPUnit -‐ PHP_CodeSniﬀer 49

phpcb example 50

PHPLOChPps://github.com/sebas$anbergmann/phploc 51

Lines of Code• calculates the size of a project -‐ gives a brief detail on quality of source code -‐ comparable to sumaries of ‣ phpcs ‣ phpmd ‣ pdepend 52

phploc in ac$on 53

Overview of outputphploc 1.6.1 by Sebastian Bergmann.Directories: 547Files: 2503Lines of Code (LOC): 482423 Cyclomatic Complexity / Lines of Code: 0.11Comment Lines of Code (CLOC): 224721Non-Comment Lines of Code (NCLOC): 257702Namespaces: 0Interfaces: 124Classes: 2352 Abstract: 199 (8.46%) Concrete: 2153 (91.54%) Average Class Length (NCLOC): 112Methods: 16121 Scope: Non-Static: 15016 (93.15%) Static: 1105 (6.85%) Visibility: Public: 12712 (78.85%) Non-Public: 3409 (21.15%) Average Method Length (NCLOC): 16 Cyclomatic Complexity / Number of Methods: 2.78Anonymous Functions: 2Functions: 0Constants: 3802 Global constants: 8 Class constants: 3794Tests: Classes: 22 Methods: 43 54

PhinghPp://www.phing.info/docs/guide/stable 55

Phing’s purpose• build tool wriPen in PHP -‐ comparable to Ant or make• used to automate build process -‐ build = all steps to produce reports• provides targets and variable proper$es -‐ for targeted execu$on of tools (e.g. only unit tes$ng) 56

Loca$on of build reports/path/to/project /application /library /public /tests /build /api -> location for API documentation /cache -> used by CI for caching /code-browser -> browsable source code /coverage -> unit test code coverage /logs -> location for all report logs /junit.xml /jdepend.xml /pmd.xml /pmd-cpd.xml /phploc.csv /checkstyle.xml /pdepend -> dependency graphics and pyramid 58

Integra$on of tools 59

Ini$al Phing build script<?xml version=”1.0” encoding=”UTF-8”?><project name=”My Project” default=”build”>  <property file=”jenkins.properties” /> </project> 60

deﬁne our ﬁlesets<fileset id=”php-files” dir=”${project.basedir}”> <include name=”**/*.php” /> <exclude name=”library/Zend/**” /> <exclude name=”library/ZendX/**” /> <exclude name=”tests/**” /></fileset> 61

clean build path<target name=”clean” description=”Clean build path”> <delete dir=”${project.basedir}/build” /> <mkdir dir=”${project.basedir}/build” /> <mkdir dir=”${project.basedir}/build/api” /> <mkdir dir=”${project.basedir}/build/cache” /> <mkdir dir=”${project.basedir}/build/code-browser” /> <mkdir dir=”${project.basedir}/build/coverage” /> <mkdir dir=”${project.basedir}/build/logs” /> <mkdir dir=”${project.basedir}/build/pdepend” /></target> 62

lint checking<target name=”phplint” description=”Syntax checking of code”> <phplint haltonfailure=”true”> <fileset refid=”php-files” /> </phplint></target> 63

unit tes$ng<target name=”PHPUnit” description=”Running unit tests”> <exec passthru=”${passthru}” dir=”${project.basedir}/tests” command=”phpunit --log-junit=${project.basedir}/build/logs/junit.xml --coverage-clover=${project.basedir}/build/logs/clover.xml --coverage-html=${project.basedir}/build/coverage --stop-on-error --stop-on-failure”/></target> 64

documenta$on<target name="phpdoc" description="Generate API documentation"> <phpdoc title="${project.name} API Documentation" target="${project.basedir}/build/api" output="HTML:frames:earthli" quiet="true"> <fileset refid="php-files"/> </phpdoc></target> 65

coding standards<target name="phpcs" description="Coding Standards Analysis"> <exec passthru="${passthru}" command="phpcs --report=checkstyle --report-file=${project.basedir}/build/logs/checkstyle.xml --standard=Zend --ignore=library/Zend,library/ZendX,tests,docs,scripts --extensions=php ${project.basedir}"/></target> 66

copy-‐paste detec$on<target name="phpcpd" description="Copy/Paste detection"> <phpcpd> <fileset refid="php-files"/> <formatter type="pmd" outfile="${project.basedir}/build/logs/pmd-cpd.xml"/> </phpcpd></target> 67

lines of code<target name="phploc" description="Generate phploc.csv"> <exec passthru="${passthru}" command="phploc --log-csv ${project.basedir}/build/logs/phploc.csv ${project.basedir}"/></target> 68

code browser<target name="phpcb" description="Source code browser" depends="phpunit, phpcs"> <exec passthru="${passthru}" command="phpcb --ignore build,library/Zend,library/ZendX,tests,docs --log ${project.basedir}/build/logs --source ${project.basedir} --output ${project.basedir}/build/code-browser"/></target> 69

depend metric calcula$ons<target name="pdepend" description="Calculate dependencies"> <exec passthru="${passthru}" dir="${project.basedir}" command="pdepend --configuration=${project.basedir}/pdepend.xml --jdepend-chart=${project.basedir}/build/pdepend/dependencies.svg --jdepend-xml=${project.basedir}/build/logs/jdepend.xml --overview-pyramid=${project.basedir}/build/pdepend/overview-pyramid.svg --suffix=php --ignore=library/Zend,library/ZendX,tests ${project.basedir}"/></target> 70

mess detec$on<target name="phpmd" description="Mess Detection"> <phpmd> <fileset refid="php-files"/> <formatter type="xml" outfile="${project.basedir}/build/logs/pmd.xml"/> </phpmd></target> 71

default target: build<target name="build" description="Start analyzing our app"> <phingCall target="clean" /> <phingCall target="phplint" /> <phingCall target="phpdoc" /> <phingCall target="phpcs" /> <phingCall target="phpunit" /> <phingCall target="phpcpd" /> <phingCall target="phpmd" /> <phingCall target="pdepend" /> <phingCall target="phploc" /> <phingCall target="phpcb" /></target> 72

phing in ac$on 73

build all 74

phing usage• developers can run at call -‐ all targets -‐ speciﬁc targets (like unit tests, style checking, …)• uniﬁed way of execu$ng processes 75

perfect for CI !!! 76

Con$nuous Integra$on 77

Con$nuous Integra$on?• automated process• tools for code -‐ test -‐ document -‐ validate -‐ package• triggered -‐ by code change in version control system -‐ on ﬁxed intervals (e.g. every weekday at 1am) 78

Jenkins-‐CI hPp://jenkins-‐ci.org/ 79

A project in CI 80

Overview of reports• unit tests• code coverage• coding standards viola$ons• mess detec$on• dependency calcula$ons• copy/paste detec$on• code analysis• API documenta$on 81

Unit Tests 82

Code Coverage 86

CheckStyle 90

Mess detec$on 95

Dependency Calcula$ons 102

API Documenta$on 106

Viola$ons 109

Round up 112

With CI• con$nuous inspec$on of code -‐ errors are detected early -‐ warnings are reported -‐ areas of improvement are pointed out 113

CI & PHP• all the tools -‐ to improve development skills -‐ to deliver quality code -‐ to detect issues early -‐ to document and analyze code base 114

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

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

Sources and Code• slides: hPp://www.slideshare.net/DragonBe• sources: hPp://github.com/DragonBe/wingz• contact: -‐ mail: michelangelo@in2it.be -‐ twiPer: @DragonBe -‐ facebook: DragonBe 117

http://in2itweb.local	238
http://in2it.be	228
http://in2itblog.local	22
http://localhost	19
http://mvandam.com	13
http://www.mvandam.com	7
http://www.slideshare.net	1
http://paper.li	1
url_unknown	1

Continuous Quality Assurance

by Michelangelo van Dam on Jun 17, 2011

Accessibility

Categories

Upload Details

Usage Rights

9 Embeds 530

Statistics

Continuous Quality Assurance Presentation Transcript