\u00c9tat des lieux<\/h2>\n\n\n\n
En pr\u00e9alable de cette \u00e9tape nous allons ajouter un nouveau module prestashop de mauvaise qualit\u00e9 et avec une erreur de syntaxe php. Dans ce module rajouter n’importe quelle erreur php, commiter et envoyer la modification dans git, puis faire une merge request comme nous l’avons vu dans l’\u00e9tape pr\u00e9c\u00e9dente. On voit bien qu’il n’y a aucun contr\u00f4le, et cela veut dire que m\u00eame si on s\u00e9curise qui peut livrer le code, nous ne sommes pas \u00e0 l’abri d’envoyer du code non fonctionnel. Afin de limiter ces erreurs on va donc mettre en place des outils d’analyse de la qualit\u00e9 de code. Pour ceux qui ne connaissent pas phpstan : Pour ne pas versionner le dossier vendor ajouter \u00e9galement un fichier .gitignore<\/em> dans ce dossier avec le contenu suivant : Pour aider Phpstan \u00e0 conna\u00eetre les classes de Prestashop rajoutez \u00e9galement le fichier class_stub.php<\/strong> , dans ce m\u00eame dossier<\/p>\n\n\n\n La structure du projet devrait \u00e0 pr\u00e9sent \u00eatre la suivante : <\/p>\n\n\n\n Et on devrait maintenant \u00eatre bon pour lancer phpstan en local et v\u00e9rifier si tout fonctionne comme pr\u00e9vu Parfait la v\u00e9rification locale est bien fonctionnelle ! Reste donc maintenant \u00e0 ajouter cette v\u00e9rification dans l'int\u00e9gration continue. La ligne importante est celle apr\u00e8s #SCRIPTS DE TESTS ICI<\/strong>
C’est volontairement ce qu’il ne faut pas faire \ud83d\ude42
Pour faire \u00e7a simplement vous pouvez utiliser l’outil prestashopConsole qui est disponible ici : https:\/\/github.com\/nenes25\/prestashop_console<\/a>
Et cr\u00e9er un module basique de test hhtestci\u00a0<\/em> via la commande suivante :
php prestashopConsole.phar module:generate:module hhtestci<\/p>\n
Dans le code de la merge request, rien ne nous indique qu’il y’a une erreur.
L’erreur n’est pas forc\u00e9ment tr\u00e8s visible et il est donc\u00a0 tout \u00e0 fait possible de passer \u00e0 c\u00f4t\u00e9 et d’envoyer une erreur en production.<\/p>\n\n\n\n![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/image-8-1024x494.png\")
<\/a><\/figure>\n\n\n\n
Il est donc temps de simplifier le travail de celui qui est charg\u00e9 de valider le code \ud83d\ude42
Le code prestashop, est majoritairement constitu\u00e9 de fichiers php ( mais aussi : javascript, css ,tpl …)
Lors de chaque livraison de code ces fichiers sont chang\u00e9s.
En fonction des intervenants, la qualit\u00e9 du d\u00e9veloppement pourra \u00eatre plus ou moins bonne et g\u00e9n\u00e9rer des erreurs.<\/p>\n
Ces outils vont se charger pour nous de v\u00e9rifier le code qu’on va envoy\u00e9 ne comporte pas d’erreurs.
Pour la v\u00e9rification des fichiers php dans un premier temps nous allons utliser Phpstan
<\/strong><\/p>\n\n\n\n![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/phpstan.png\")
<\/figure>\n\n\n\nConfiguration locale de phpstan<\/h2>\n\n\n\n
C’est un outil d’analyse statique pour PHP qui aide les d\u00e9veloppeurs \u00e0 d\u00e9tecter les erreurs de type, les probl\u00e8mes de coh\u00e9rence, et les violations des bonnes pratiques dans leur code PHP.
Il am\u00e9liore la qualit\u00e9 du code, favorise la maintenance et permet de gagner du temps lors du processus de d\u00e9veloppement en fournissant des informations sur les erreurs potentielles, les types de donn\u00e9es et les performances du code.
L’avantage des outils d’analyses statiques est donn\u00e9e dans leur nom, ils n’ont pas besoin d’ex\u00e9cuter le projet pour d\u00e9tecter les probl\u00e8mes potentiels.
Vous pouvez trouver plus d’information ( en anglais ) sur le site officiel : https:\/\/phpstan.org\/<\/a>
Pour commencer il va falloir faire fonctionner phpstan en local.
Cr\u00e9er une nouvelle branche depuis master
En fonction de la structuration du projet , cr\u00e9er un dossier tests<\/strong> soit \u00e0 la racine, au m\u00eame niveau que le dossier www
<\/strong>
Dans ce dossier, lancer la commande suivante pour r\u00e9cup\u00e9rer phpstan :<\/p>\n\n\n\n\ncomposer require phpstan\/phpstan\n<\/pre>\n\n\n\n
vendor
<\/strong>Ensuite vous pouvez cr\u00e9er le dossier suivant php\/phpstan<\/em> et mettre le contenu suivant dans le fichier phpstan.neon<\/strong>
Ce fichier permets de configurer phpstan, je mets volontairement tous les commentaires dans le fichiers pour ce que ce soit plus clair<\/p>\n\n\n\n\nparameters:\n scanFiles:\n - class_stub.php\n scanDirectories: #Listes des fichiers syst\u00e8mes de Prestashop auxquels votre module peut \u00eatre li\u00e9\n # Tous les chemins sont relatifs \u00e0 l'emplacement du fichier de ce fichier configuration phpstan.neon\n - ..\/..\/..\/www\/classes\n - ..\/..\/..\/www\/config\/\n - ..\/..\/..\/www\/controllers\n - ..\/..\/..\/www\/override\n - ..\/..\/..\/www\/src\n - ..\/..\/..\/www\/vendor\n level: 4 # Niveau de qualit\u00e9 du code, commencer (cf. https:\/\/phpstan.org\/user-guide\/rule-levels )\n paths: # Liste des modules sp\u00e9cifiques \u00e0 tester\n - ..\/..\/..\/www\/modules\/hhtestci #Notre module de d\u00e9mo\n excludePaths:\n - ..\/..\/..\/www\/modules\/*\/vendor\/* #On ne veut pas analyser les fichiers vendor des modules\n ignoreErrors: #Liste des erreurs \u00e0 ignorer\n #Pour les autres \u00e9l\u00e9ments je vous renvoie vers la documentation de phpstan\n reportUnmatchedIgnoredErrors: false\n checkMissingIterableValueType: false\n treatPhpDocTypesAsCertain: false\n parallel:\n maximumNumberOfProcesses: 1\n<\/pre>\n\n\n\n
\n\n\n\n\n
![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/image-12.png\")
<\/a><\/figure>\n\n\n\n
Via la commande suivante<\/p>\n\n\n\n\nphp vendor\/bin\/phpstan analyze -c php\/phpstan\/phpstan.neon \n<\/pre>\n\n\n\n
![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/image-9.png\")
<\/a><\/figure>\n\n\n\n
Place maintenant \u00e0 la configuration dans la CI<\/p>\n\n\n\nConfiguration de phpstan dans la CI<\/h2>\n\n\n\n
Pour cela il va donc falloir rajouter les informations suivantes dans le fichier .gitlab-ci.yml<\/p>\n\n\n\n\n#V\u00e9rification de la qualit\u00e9 du code\ntest:code_quality:\n stage: test\n image: php:7.4\n rules:\n - if: $CI_PIPELINE_SOURCE == \"merge_request_event\"\n before_script:\n - mv \"$PHP_INI_DIR\/php.ini-development\" \"$PHP_INI_DIR\/php.ini\"\n - apt-get update -yqq\n - apt install zip unzip\n - \"curl -sSLf -o \/usr\/local\/bin\/install-php-extensions https:\/\/github.com\/mlocati\/docker-php-extension-installer\/releases\/latest\/download\/install-php-extensions &&\n chmod +x \/usr\/local\/bin\/install-php-extensions &&\n install-php-extensions zip \"\n # Install and run Composer\n - cd tests\n - curl -sS https:\/\/getcomposer.org\/installer | php\n - php composer.phar install\n script:\n #SCRIPTS DE TESTS ICI\n - php -d memory_limit=512M vendor\/bin\/phpstan analyze -c php\/phpstan\/phpstan.neon\n<\/pre>\n\n\n\n
qui va lancer le test phpstan dans la CI \ud83d\ude42
Le reste du code permets de mettre en place une image docker et de pr\u00e9parer l'ex\u00e9cution des scripts.
Il ne nous reste plus qu'\u00e0 tester que tout fonctionne comme attendu.
Commitez et poussez votre code, puis cr\u00e9er une merge request dans gitlab.
Et le code de la merge request devrait maintenant g\u00e9n\u00e9rer une erreur.<\/p>\n\n\n\n![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/image-10-1024x598.png\")
<\/a><\/figure>\n\n\n\n
![\"\"](\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2023\/09\/image-11-1024x550.png\")
<\/a><\/figure>\n\n\n\n