Comment assurer le suivi qualite du code source d'une application web? Ce n'est pas une tache aisée ! C’est d’autant plus vrai que PHP est encore considéré aujourd'hui comme un langage peu professionnel. PHP est pourtant un langage dont l'outillage n'a rien a envier a l'ensemble de ses concurrents. L'objectif de cette conférence est de présenter les bonnes pratiques à adopter ainsi que les différents outils a mettre en oeuvre afin de contrôler la qualité d'un projet PHP au quotidien. Un focus particulier sera porté sur la plateforme d'intégration continue Jenkins, les tests unitaires ou bien encore la récupération et l'interprétation des métriques collectées.

2. Comment surveiller la
qualité de vos projets PHP
au quotidien ?

3. « L'intégration continue est un ensemble de
pratiques qui consistent à véri er à chaque
changement du code source que le résultat
des modi cations ne produit pas de
régression de l'application en cours de
développement » Wikipedia

4. Quels avantages ?

5. Quelles pratiques au
quotidien ?

6. q Maintenir un dépôt unique de code versionné
q Tous les développeurs committent quotidiennement
q Automatiser les compilations (builds)
q Tout commit doit compiler le tronc du code versionné
q Maintenir une compilation courte en permanence
q Rendre disponible le résultat du build à tout le monde
q Automatiser le déploiement

7. Alice
Build
Successful
SCM Server
Bob
Carlos
CI Server

8. Alice
Build Failed
SCM Server
Bob
Carlos Alerter l’équipe CI Server

9. Alice
Build
Successful
SCM Server
Bob
Carlos
CI Server

10. Quelles PIC sur le
marché ?

12. Mettre en œuvre
une PIC pour PHP

13. q Exécution de la suite de tests unitaires (PHPUnit)
q Génération du rapport de couverture de code (PHPUnit)
q Génération de la documentation d’API (PHPDocumentor)
q Génération du rapport des dépendances (PDepend)
q Analyse statique du code source (PMD)
q Détection des violations de codage (PHP_CodeSniffer)
q Détection du code dupliqué (PHPCPD)
q Génération du navigateur de code (PHP Code Browser)

15. q Hudson rebaptisé Jenkins en février 2011
q Ecrit en Java
q Exécute des tâches Ant, Maven, Shell et Windows
q +300 plugins
q Analyse des rapports de compilation
q Génération de statistiques et de graphiques (métriques)

17. http://jenkins-ci.org

18. $ java –jar jenkins.war

19. http://localhost:8080

20. q XDebug q PHPUnit 3.6.x
q PDepend q PHPCPD
q PHP Mess Detector q PHP Documentor
q PHP CodeSniffer q PHP CodeBrowser

21. $ pecl install xdebug
$ pear channel-discover pear.pdepend.org
$ pear channel-discover pear.phpmd.org
$ pear channel-discover pear.phpunit.de
$ pear channel-discover components.ez.no
$ pear channel-discover pear.symfony-project.com
$ pear channel-discover pear.phing.info
$ pear install phing/phing
$ pear install pdepend/PHP_Depend-beta
$ pear install phpmd/PHP_PMD-alpha
$ pear install phpunit/phpcpd
$ pear install PHPDocumentor
$ pear install PHP_CodeSniffer
$ pear install --alldeps phpunit/PHP_CodeBrowser-alpha
$ pear install --alldeps phpunit/PHPUnit

22. Plugins Jenkins

23. q Subversion q JDepend
q Git q PMD
q Checkstyle q Violations
q Dry q xUnit
q HTML Publisher q Clover
q Green Balls

24. Démarrer un projet

25. Projet free-style

26. Con guration du projet

27. Con guration du dépôt Subversion

28. Dé nition des droits d’accès au SVN

29. Con guration du dépôt Git

30. Con guration des builds

31. Exécution et contrôle du build

32. Exécution et contrôle du build

33. Phing

34. q Phing est un portage de Ant en PHP
q Outil d’automatisation de tâches
q Phing exécute des tâches à la suite
q Les tâches sont décrites dans un chier build.xml
q Supporte les dépendances entre les tâches
q Tâches prédé nies pour PHPUnit, Code Sniffer, PMD…

35. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<property name="builddir" value="${ws}/build" />
<property name="srcdir" value="${project.basedir}" override="true" />
<property name="package" value="Syndication" override="true" />
<target name="clean" description="Clean the build environment">
<delete dir="${builddir}" />
<delete dir="generatedJUnitFiles" />
</target>
<target name="prepare" depends="clean" description="Clean the build
environment">
<mkdir dir="${builddir}" />
<mkdir dir="${builddir}/logs" />
<mkdir dir="${builddir}/logs/coverage" />
<mkdir dir="${builddir}/docs" />
<mkdir dir="${builddir}/browser" />
</target>
<target name="build" depends="prepare" description="Build the project">
<!-- build target commands here -->
</target>
</project>

36. phing –f $WORKSPACE/build.xml build –Dws=$WORKSPACE

37. PHPUnit
http://phpunit.de/

38. q Exécuter les tests unitaires
q Générer un rapport JUnit
q Générer un rapport Clover XML
q Générer un rapport de couverture HTML

39. <?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false" backupStaticAttributes="false"
colors="true" convertErrorsToExceptions="true"
convertNoticesToExceptions="true" convertWarningsToExceptions="true"
processIsolation="true" stopOnFailure="false"
syntaxCheck="false" bootstrap="src/autoload.php">
<testsuites>
<testsuite name="Syndication Component Test Suite">
<directory>./tests/Syndication/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory>./src/Syndication/</directory>
</whitelist>
</filter>
</phpunit>

40. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<!-- ... -->
<target name="build" depends="prepare"
description="Building the project">
<phingcall target="phpunit" />
</target>
<target name="phpunit"
description="Running unit tests and coverage analysis">
<exec command="phpunit
--log-junit ${builddir}/logs/phpunit.xml
--coverage-clover ${builddir}/logs/coverage/clover.xml
--coverage-html ${builddir}/logs/coverage/ ${ws}/tests"
/>
</target>
</project>

41. Con gurer la suite de tests unitaires

42. Con gurer la couverture de code

43. Analyse de la couverture de code

44. Analyse des rapports de tests unitaires

45. Analyse des rapports de tests unitaires

46. Publication de la couverture de code

47. Publication de la couverture de code

48. PHPDocumentor
http://www.phpdoc.org/

49. Générer la documentation d’API

50. <project name="Syndication Component" basedir="." default="main">
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
</target>
<!-- Generating API Documentation -->
<target name="phpdoc" description="Generating api doc">
<phpdoc title="Syndication API Documentation"
destdir="${builddir}/docs" sourcecode="true"
parseprivate="true" output="HTML:Smarty:PHP">
<fileset dir="./src">
<include name="**/*.php" />
</fileset>
</phpdoc>
</target>
</project>

51. Publication de la documentation d’API

52. Publication de la documentation d’API

53. PHPCPD
Copy Paste Detector
https://github.com/sebastianbergmann/phpcpd

54. Rechercher les duplications de code

55. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<!-- ... -->
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
<phingcall target="phpcpd" />
</target>
<!-- Detecting duplicated code -->
<target name="phpcpd" description="Detecting duplicated code">
<exec command="phpcpd
--min-lines 5
--min-tokens 5
--log-pmd ${builddir}/logs/pmd-cpd.xml src/" />
</target>
</project>

58. Ce graphique montre que le
code dupliqué a bien été
retiré dans le nouveau
commit qui a donné lieu au
dernier build.
Le graphique ci-contre
montre l’évolution du nombre
de tests unitaires réussis au
dernier build.

59. PHP Depend
http://pdepend.org/

60. Analyse statique du code
q Complexité cyclomatique
q Qualité globale du code
q Nombre de classes / méthodes / fonctions / interfaces
q Nombre d’appels d’une méthode
q Nombre de propriétés / méthodes publiques vs privées
q Nombre de lignes de code en commentaires….

61. Analyse statique du code
build/logs/jdepend.xml

62. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<!-- ... -->
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
<phingcall target="phpcpd" />
<phingcall target="pdepend" />
</target>
<target name="pdepend" description="Generating JDepend
report">
<exec command="pdepend
--jdepend-xml=${builddir}/logs/jdepend.xml src/" />
</target>
</project>

64. PHP Mess Detector
http://phpmd.org/

65. Analyse statique du code
q PHP Mess Detector est un portage en PHP de PMD (Java)
q Recherche de bugs potentiels
q Recherche de code mort (ie: méthodes non appelées)
q Code non optimisé
q Expressions trop complexes…

67. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<!-- ... -->
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
<phingcall target="phpcpd" />
<phingcall target="pdepend" />
<phingcall target="pmd" />
</target>
<target name="phpmd" description="Generating PHPMD report">
<exec command="phpmd src/ xml codesize,unusedcode --
reportfile ${builddir}/logs/pmd.xml" />
</target>
</project>

69. PHP Code Sniffer
http://pear.php.net/manual/en/package.php.php-codesniffer.php

70. q Analyse des violations de codage
q Nombreuses règles par défaut
q Standards prédé nis : PEAR, Zend, Squiz, PHPCS…
q Possibilité d’ajouter des règles supplémentaires

71. Installation du standard Symfony2
$ # Looking for the PEAR PHP directory
$ pear config-show | grep php_dir
$ # Move to the CodeSniffer standards folder
$ cd /path/to/pear/PHP/CodeSniffer/Standards
$ # Checkout the Symfony2 CodeSniffer standard from Github
$ git clone git://github.com/opensky/Symfony2-coding-standard.git Symfony2
$ # Eventually, set Symfony2 as your default CodeSniffer standard
$ phpcs --config-set default_standard Symfony2

72. Installation du standard Symfony2
build/logs/checkstyle.xml

73. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
<phingcall target="phpcpd" />
<phingcall target="pdepend" />
<phingcall target="phpmd" />
<phingcall target="checkstyle" />
</target>
<target name="checkstyle" description="Looking for violations">
<exec command="phpcs --standard=Symfony2 --report=checkstyle
${project.basedir}/src > ${builddir}/logs/checkstyle.xml"
escape="false" />
</target>
</project>

76. PHP Code Browser
https://github.com/mayflower/PHP_CodeBrowser

77. build/browser

78. <?xml version="1.0" encoding="UTF-8"?>
<project name="Syndication Component" basedir="." default="main">
<!-- ... -->
<target name="build" depends="prepare">
<phingcall target="phpunit" />
<phingcall target="phpdoc" />
<phingcall target="phpcpd" />
<phingcall target="pdepend" />
<phingcall target="phpmd" />
<phingcall target="checkstyle" />
<phingcall target="phpcb" />
</target>
<target name="phpcb" description="Generating code browser...">
<exec command="phpcb
--log ${builddir}/logs
--source ${project.basedir}/src
--output ${builddir}/browser" />
</target>
</project>

80. Prévenir plutôt que
guérir!

81. q Emails q RSS
q Twitter q SMS
q Jabber q …

82. Comment industrialiser la PIC
d’un projet PHP dans Jenkins ?

83. http://jenkins-php.org/

84. Aller plus loin avec Jenkins

85. q Générer des archives PHAR, PEAR, TAR ou ZIP
q Automatiser le déploiement des builds stables
q Faciliter les audits de code
q Intégration avec un bug tracker (Trac, Redmine, Jira)
q Exécution de tests Sélénium / Fitness
q …

86. Merci !

87. Ques%ons?
92-98, boulevard Victor Hugo
92 115 Clichy Cedex
trainings@sensio.com (+33 (0)1 40 99 82 11)
sensiolabs.com - symfony.com – trainings.sensiolabs.com