Bonnes Pratiques de Développement PHP. Pascal MARTIN SQLI Forum PHP 2009, Paris

Transcription

1 Bonnes Pratiques de Développement PHP Pascal MARTIN SQLI Forum PHP 2009, Paris

2 Quelques mots Environnement de travail Contrôle de source Développer [en PHP] Normes de codage Tests Automatisés Documentation Intégration continue Déploiement Encore un peu?

3 Bonnes pratiques de développement PHP Pascal MARTIN 3 A Propos de moi Pascal MARTIN Expert Technique PHP chez SQLI Membre de la Cellule Architecture PHP Capitalisation Veille Technologique Interventions au lancement de projets Blog Perso

4 Bonnes pratiques de développement PHP Pascal MARTIN 4 A Propos de vous? Développeurs PHP Curieux / Passionnés Voulant / pouvant améliorer les processus Vos / Nos Projets? Maintenables? Organisés? Documentés? Et si vous partez en vacances?

5 Bonnes pratiques de développement PHP Pascal MARTIN 5 A Propos de cette présentation Quelques notes Expérience pro / perso Retours d'autres projets Pas une vérité absolue! Ni un ensemble de solutions toute prêtes! Plein d'autres choses fantastiques à découvrir ;-)

6 Bonnes pratiques de développement PHP Pascal MARTIN 6 Plusieurs niveaux Bonnes pratiques : plusieurs niveaux Sur tout le projet Relation avec le client Configuration des serveurs Code PHP Processus de développement Environnement de travail

7 Environnement de travail

8 «Ton fichier PHP est pourri, notepad m'affiche tout sur une seule ligne!»

9 Bonnes pratiques de développement PHP Pascal MARTIN 9 Utiliser un IDE 1 J'admets Machine puissante Temps d'adaptation / prise en main «Trop» dans certains cas

10 Bonnes pratiques de développement PHP Pascal MARTIN 10 Utiliser un IDE 2 Mais Gros projet, en équipe Framework / bibliothèques Plein de code peu connu Quels IDE? Eclipse PDT / Zend Studio Netbeans Débugger intégré ;-)

11 Bonnes pratiques de développement PHP Pascal MARTIN 11 Linux 1 LAMP => Linux Serveurs de production Ligne de commande «Heu... Je clique où???» «WTF???» Différences de comportement de PHP!

12 Bonnes pratiques de développement PHP Pascal MARTIN 12 Linux «Heu??? Au secours!»

13 Bonnes pratiques de développement PHP Pascal MARTIN 13 Linux 3 Quelques notions Peut être salvateur Incident sur un serveur de production «Gars qui connait» absent? Mais aussi pour du développement Suivi logs Notions de configuration Solution possible : Virtualisation Développement sous Windows Serveur LAMP : machine virtuelle

14 Contrôle de source

15 «Quand quelqu'un veut commencer à modifier un fichier, il le «réserve» sur MSN»

16 Bonnes pratiques de développement PHP Pascal MARTIN 16 Contrôle de source Quelques questions Est-ce que quelqu'un a modifié quelque chose? Comment synchroniser entre développeurs? Comment obtenir la version du 14 avril 2008? Qu'est-ce qui a changé entre le 19 mai et le 23 juillet? Deux types de contrôles de source Centralisés Distribués

17 Bonnes pratiques de développement PHP Pascal MARTIN 17 VCS Centralisé Subversion SVN Principe Travail local sur checkout du repository Automatisations basées sur les commits Mais Serveur nécessaire! Peu de travail sans connexion Excellent support! Forte intégration

18 Bonnes pratiques de développement PHP Pascal MARTIN 18 VCS Décentralisé Git, Bazaar, Mercurial, Darcs, Principe Travail sur une branche / copie locale Partage des modifications entre repositories Quelques avantages Pas besoin de serveur centralisé Facilite le fork local Moins intégré? Moins répandu? Moins de processus d'automatisation?

19 Développer [en PHP]

20 «Votre citation, ici ;-)»

21 Bonnes pratiques de développement PHP Pascal MARTIN 21 Ne développez pas! Utilisez ce qui existe déjà Vous n'êtes pas le seul à vouloir une application qui fasse X, Y, et Z Applications entières CMS, CRM, E-Commerce, Libres? Adaptez Ne développez que des modules Là où vos besoins sont spécifiques

22 Bonnes pratiques de développement PHP Pascal MARTIN 22 Framework Grand sujet de débat Ne pas réinventer la roue Framework perso Zend Framework, symfony, Cake,... Bibliothèques Composants de Frameworks PEAR Ou pas?

23 Normes de codage

24 «Il est illisible, son code, je comprends rien!»

25 Bonnes pratiques de développement PHP Pascal MARTIN 25 Pourquoi une norme de codage? Uniformité Consistance Lisibilité Se concentrer sur le code Ne pas perdre du temps à le formater mentalement Facilite la collaboration

26 Bonnes pratiques de développement PHP Pascal MARTIN 26 Quoi? Comment? Indentation Position des parenthèses / accolades Retours à la ligne Nommage de variables / classes / méthodes Nommages / organisation des fichiers Longueurs de lignes Documentation...

27 Bonnes pratiques de développement PHP Pascal MARTIN 27 Quelques exemples 1 Classes MonNomDeClasse Méthodes, variables, propriétés monnomdemethode Propriétés privées / protégées _monnomdepropriete Constantes MA_CONSTANTE

28 Bonnes pratiques de développement PHP Pascal MARTIN 28 Quelques exemples 2 Fichiers et répertoires Classe Societe_Generateur_Document_Pdf Répertoires / Fichier Societe/Generateur/Document/Pdf.php Une classe par fichier Conversion des «_» en «/» Facilite l'autoload PHP 5.3 : Généralisable aux namespaces

29 Bonnes pratiques de développement PHP Pascal MARTIN 29 Quelques exemples 3 Indentation Espaces vs tabulations 2 ou 4 espaces Position des accolades? public static function delete($idaccount) { try { $db->begintransaction(); if (...) { throw new Exception("..."); } //... $db->commit(); } catch (Exception $e) { $db->rollback(); } } // delete

30 Bonnes pratiques de développement PHP Pascal MARTIN 30 Quelques plus qu'exemples Soyons raisonnables Classes : méthodes Méthodes : lignes Fichiers : pas lignes! Respect de la structuration MVC : ne pas mélanger les couches Pas de requête SQL dans les templates

31 Bonnes pratiques de développement PHP Pascal MARTIN 31 Standards connus et reconnus N'inventez pas votre propre standard Utilisez un standard connu, répandu, accepté Celui de votre Framework / Application Normes de codage PEAR Configurez votre IDE

32 Bonnes pratiques de développement PHP Pascal MARTIN 32 Moyen de contrôle? Une norme de codage C'est bien Qu'elle soit respectée C'est mieux! Toute l'équipe doit utiliser le même standard Moyen de contrôle nécessaire (semi) Automatisé

33 Bonnes pratiques de développement PHP Pascal MARTIN 33 PHP_CodeSniffer PHP_CodeSniffer Analyse d'un code source + rapport $ phpcs -s /path/to/code/myfile.php FILE: /path/to/code/myfile.php FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S) ERROR Missing file doc comment (PEAR.Commenting.FileComment) 20 ERROR PHP keywords must be lowercase; expected "false" but found "FALSE" (Generic.PHP.LowerCaseConstant) 47 ERROR Line not indented correctly; expected 4 spaces but found 1 (PEAR.WhiteSpace.ScopeIndent) 47 WARNING Equals sign not aligned with surrounding assignments (Generic.Formatting.MultipleStatementAlignment) 51 ERROR Missing function doc comment (PEAR.Commenting.FunctionComment) 88 ERROR Line not indented correctly; expected 9 spaces but found 6 (PEAR.WhiteSpace.ScopeIndent)

34 Bonnes pratiques de développement PHP Pascal MARTIN 34 Mise en place Dès le début du projet Sinon : énormément de travail Accepté / reconnu Par toute l'équipe Y compris le management Qualité! Et si le code est horrible?

35 Tests Automatisés

36 «On a testé il y a 6 mois, quand on a mis en prod ; depuis, on n'a pas le temps» «Des fois, ça plante»

37 Bonnes pratiques de développement PHP Pascal MARTIN 37 Fatal Error on line X Code peut casser Changement dans un fichier... Quel impact sur le reste de l'application? Nécessité de tester! «Pas le temps» Tester manuellement = long! Rarement fait Uniquement sur quelques pages Tests automatiques

38 Bonnes pratiques de développement PHP Pascal MARTIN 38 Tests Unitaires Tester une «unité» Un module / Une classe / Une méthode Indépendamment de tout le reste Tests Automatisés Détection de régressions Joués après chaque modification Rapides quelques secondes Code Coverage

39 Bonnes pratiques de développement PHP Pascal MARTIN 39 Tests Unitaires PHPUnit Framework de Tests Unitaires Difficultés? Temps / coût Code existant «non testable» Avantages Facilite le rework, les évolutions Confiance!

40 Bonnes pratiques de développement PHP Pascal MARTIN 40 Test Driven Development Écriture d'un test qui échoue Car implémentation non écrite Définit le comportement attendu Puis, écriture du code Qui passe le test Éventuellement Rework du code Sécurité : il est testé

41 Bonnes pratiques de développement PHP Pascal MARTIN 41 Tests d'intégration Tester Non plus des composants unitaires Mais l'assemblage des briques Voire toutes les couches de l'application Deux possibilités «Pseudo» requêtes HTTP Rapide, facile à mettre en place Utilisation d'un «vrai» navigateur Teste aussi l'interface utilisateur Support Javascript

42 Bonnes pratiques de développement PHP Pascal MARTIN 42 Zend_Test Classe Zend Framework Test via le MVC sans navigateur public function testlogginginshouldbeok() { $this->dispatch('/login/login'); $csrf = $this->_getloginformcsrf(); $this->resetresponse(); $this->request->setpost(array( 'login' => 'pmartin', 'password' => '123456', 'csrflogin' => $csrf, 'ok' => 'Login', )); $this->request->setmethod('post'); $this->dispatch('/login/login'); $this->assertredirectto('/'); $this->asserttrue(zend_auth::getinstance()->hasidentity()); }

43 Bonnes pratiques de développement PHP Pascal MARTIN 43 Selenium RC Pilotage d'un navigateur Intégré à PHPUnit! class functionnal_front_selenium_archivetest extends functionnal_testsutils_seleniumtestcase { public function testnavigationarchive() { $this->open("/"); $this- >click("//div[@id='archivewidget']/ul/li[1]/a/span[1]"); $this->waitforpagetoload("30000"); $this->assertequals("juin Mon premier blog", $this->gettitle()); $this->asserttrue($this->istextpresent("septième post")); $this- >click("//div[@id='archivewidget']/ul/li[2]/a/span[1]"); $this->waitforpagetoload("30000"); $this->asserttrue($this->iselementpresent("link=troisième post")); } }

44 Bonnes pratiques de développement PHP Pascal MARTIN 44 Quoi tester? Écrire des tests prend du temps Tout ne peut pas être testé Il n'est pas utile / indispensable de tout tester Ne pas (re-) tester le Framework! Tester Ce qui est important Ce qui risque de casser Ce qu'on modifie souvent? Ce que l'on va re-worker?

45 Bonnes pratiques de développement PHP Pascal MARTIN 45 Maintenir les Tests Suivre le déroulement des tests Tests non maintenus Inutiles Dangereux : «fausse sécurité» Maintenance Au fil de l'eau Quand modifications du comportement Requiert du temps

46 Documentation

47 «Comment ça marche?» «Heu...Vas voir dans le code»

48 Bonnes pratiques de développement PHP Pascal MARTIN 48 Plusieurs documentations Documentation d'api Technique : comment développer Classes, méthodes, paramètres, retours,... Documentation d'application Fonctionnel : comment utiliser l'application Scénarios d'utilisation, captures d'écrans,... Procédures Comment déployer en production Reprise sur incident

49 Bonnes pratiques de développement PHP Pascal MARTIN 49 Documentation d'api Docblocks Fichiers, Classes, Méthodes Quelques Génération PhpDocumentor Doxygen

50 Bonnes pratiques de développement PHP Pascal MARTIN 50 Exemple code /** * Some description here * Service Pascal MARTIN Use some real templating mecanism */ class Service_User { /** * Sends an to the user to inform him that his informations * have been created or updated * boolean $iscreate int $iduser string $password optionnal ; if not null, the new password of the user void */ public static function sendmailuserhasbeenmodified($iscreate, $iduser, $password=null) { //... } // sendmailuserhasbeenmodified }

51 Bonnes pratiques de développement PHP Pascal MARTIN 51 Exemple doc générée

52 Bonnes pratiques de développement PHP Pascal MARTIN 52 Pourquoi une doc d'api? Intégration IDE Documentation Technique Utilisable en PHP Mais N'empêche pas d'écrire du code «autodocumenté» Noms de méthodes / classes / variables clairs Significatifs Facilite la compréhension

53 Bonnes pratiques de développement PHP Pascal MARTIN 53 Doc d'api et IDE

54 Bonnes pratiques de développement PHP Pascal MARTIN 54 Documentation utilisateurs Pensez-y! Dépend Du type d'application Du public visé Comment est-ce que votre logiciel sera utilisé, sinon? Vous êtes aussi utilisateurs ;-)

55 Bonnes pratiques de développement PHP Pascal MARTIN 55 Doc utilisateur : Docbook Format XML Fréquemment utilisé pour les logiciels OSS Documentation de PHP! Plusieurs formats de sortie HTML, PDF, WYSIWYG XMLmind XML Editor Gratuit en version personnelle

56 Bonnes pratiques de développement PHP Pascal MARTIN 56 Docbook exemple <?xml version="1.0" encoding="utf-8"?> <chapter xml:id="language.functions" xmlns=" <title>les fonctions</title> <sect1 xml:id="functions.user-defined"> <title>les fonctions définies par l'utilisateur</title> <para> Une fonction peut être définie en utilisant la syntaxe suivante : </para> <para> <example> <title>pseudo code pour illustrer l'usage d'une fonction</title> <programlisting role="php"> <![CDATA[ <?php function foo($arg_1, $arg_2, /*..., */ $arg_n) { echo "Exemple de fonction.\n"; return $retval; }?> ]]> </programlisting> </example> </para>

57 Bonnes pratiques de développement PHP Pascal MARTIN 57 Procédures Documentation «technique» Procédure d'installation Procédure de mise à jour Doivent être Connues de tous Maintenues à jour! Quelle forme? Fiches wiki?

58 Intégration continue

59 «Ça fait une semaine qu'on essaye de scotcher les composants ensemble ; y'a rien qui marche ;-(»

60 Bonnes pratiques de développement PHP Pascal MARTIN 60 Intégration Continue? Intégration fréquente Du travail de tous les membres de l'équipe Au moins une fois par jour Build automatique Tests Automatisés Vérifications Normes de codage Construction Documentation Archives

61 Bonnes pratiques de développement PHP Pascal MARTIN 61 Pourquoi de l'ic? Environnement stable Savoir où en est le projet Qualité / Quantité Composants développés Diminution des risques liés à l'intégration Devient un «non-événement» Détection de régressions Facilitée par les Tests Automatisés

62 Bonnes pratiques de développement PHP Pascal MARTIN 62 Plateforme d'ic Outil réalisant le build Interface «user-friendly» Historisation De tous les builds Y compris documentation, rapports,... Reporting Via l'interface Par mails Pas besoin de «tout» mettre en place!

63 Bonnes pratiques de développement PHP Pascal MARTIN 63 phpundercontrol phpundercontrol Basé sur CruiseControl / Ant Intégration des outils communs en PHP SVN PHPUnit + Xdebug PhpDocumentor PHP_CodeSniffer

64 Bonnes pratiques de développement PHP Pascal MARTIN 64 phpuc screenshot

65 Bonnes pratiques de développement PHP Pascal MARTIN 65 phpuc screenshot

66 Bonnes pratiques de développement PHP Pascal MARTIN 66 phpuc screenshot

67 Bonnes pratiques de développement PHP Pascal MARTIN 67 phpuc screenshot

68 Bonnes pratiques de développement PHP Pascal MARTIN 68 PIC chez SQLI Un des projets présentés au Forum cette année Allez faire un tour sur le stand! Basée sur phpundercontrol Avec plus de fonctionnalités Intégration des rapports de Zend Platform Utilisée sur les projets au Forfait à Paris Et composants utilisés sur certains projets dans d'autres agences

69 Bonnes pratiques de développement PHP Pascal MARTIN 69 Autres solutions? Liberté de choix ;-) Xinc Hudson Sismo

70 Déploiement

71 «Pierre est en vacances ; on ne peut pas livrer, on ne sait pas comment il fait d'habitude»

72 Bonnes pratiques de développement PHP Pascal MARTIN 72 Avant de commencer Suivez une procédure de déploiement clairement définie Ne bossez pas directement en production! Utilisez un serveur de tests, proche de la production Mêmes versions de logiciels, Même OS. Gardez trace de ce que vous livrez Contrôle de sources : «tag»

73 Bonnes pratiques de développement PHP Pascal MARTIN 73 Exemple de processus Développements Tests interne sur serveur d'intégration Tests + Validation interne Tag «production» Déploiement sur serveur de tests client Tests + Validation client Déploiement sur serveur de production Tests

74 Bonnes pratiques de développement PHP Pascal MARTIN 74 Automatiser le déploiement Déploiement automatique Moins de risque d'erreur de manipulation Genre «oubli d'une étape» Réalisable par n'importe qui Évite d'être bloqué en cas d'absence Documenté! Tests Automatiques aussi! Simples, rapides mais nécessaires

75 Bonnes pratiques de développement PHP Pascal MARTIN 75 Outils? Simples shell-scripts Ant / phing Package pear.deb /.rpm Lien symbolique Qui pointe sur la version actuelle Objectif : retour arrière facilité Ne pas écraser l'ancienne version

76 Bonnes pratiques de développement PHP Pascal MARTIN 76 Et après? Application en production Mais ce n'est pas fini! Monitorer Les serveurs Le fonctionnement de l'application Les logs

77 Encore un peu?

78 «WTF???»

79 Bonnes pratiques de développement PHP Pascal MARTIN 79 Veille Techno / curiosité Nous ne sommes pas seuls au monde Suivre l'actualité De PHP Des composants / logiciels Internet = source de savoir Flux RSS Twitter Événements Participez!

80 Bonnes pratiques de développement PHP Pascal MARTIN 80 Formation / Explications Plein de bonnes pratique C'est bien! Expliquer comment / pourquoi C'est mieux! Malgré «la crise» Investissement Qualité des projets Gain à moyen / long terme

81 Bonnes pratiques de développement PHP Pascal MARTIN 81 A Vous! Qualité processus continu Mise en place : progressive! Quelques bases Puis d'autres Et encore d'autres Laisser le temps De se familiariser D'apprécier

82 Pascal MARTIN SQLI Merci!