Ce plugin est vraiment tr\u00e8s fun. Et tout le monde trouve fantastique une repr\u00e9sentation visuelle de son code sous forme d’une cit\u00e9. Aller \u00e0 l’essentiel est important lorsque vous devez r\u00e9guli\u00e8rement juger de la qualit\u00e9 d’une application. <\/p>\n
J’ai donc pens\u00e9 \u00e0 quelques cas simples mais fr\u00e9quents, o\u00fa son utilisation va s’av\u00e9rer pr\u00e9cieuse. Ce qui me donnera \u00e9galement l’opportunit\u00e9 de d\u00e9montrer \u00e0 quel point il est simple \u00e0 param\u00e9trer.<\/p>\n
Cit\u00e9 critique<\/strong><\/h3>\nUn client me demande un audit de deux de ses applications. Je creuse un peu pour savoir un peu plus pr\u00e9cis\u00e9ment le ‘pourquoi’ de cet audit. Il peut y avoir plusieurs raisons, et j’ai besoin d’en savoir un peu plus afin de r\u00e9pondre pr\u00e9cis\u00e9ment \u00e0 sa demande.<\/p>\n
Par exemple : il souhaite externaliser ces deux applications assez anciennes, et avant d’effectuer un appel d’offres aupr\u00e8s de diff\u00e9rents outsourcers, il aimerait savoir quel est leur niveau de qualit\u00e9. C’est effectivement une bonne id\u00e9e, qui va lui permettre de mieux juger les offres qu’on lui pr\u00e9sentera et de pr\u00e9ciser un co\u00fbt de maintenance. A l’heure actuelle, nombre de providers sont pr\u00eats \u00e0 n’importe quoi pour obtenir un contrat. Estimer la dette technique sur ces applications lui permettra d’\u00e9carter les offres ‘low-cost’, peu r\u00e9alistes.<\/p>\n
Autre cas : le responsable d’un centre de d\u00e9veloppement se voit demander de reprendre une application. Assez compliqu\u00e9e \u00e0 premi\u00e8re vue: plusieurs centaines de milliers de lignes de code .NET, frameworks propri\u00e9taires, aucune documentation, etc. De quoi \u00eatre un peu suspicieux. Il aimerait bien se donner un peu de visibilit\u00e9 sur la qualit\u00e9 de cette application et l’effort \u00e0 effectuer pour cette reprise de code, avant d’accepter. Ou que je lui fournisse quelques arguments bien sentis pour justifier un \u00e9ventuel refus.<\/p>\n
En fait, le client dont je vous parle avait justement fait appel \u00e0 un de ces outsourcers ‘low-cost’ pour d\u00e9velopper ses applications. Retards, budgets en d\u00e9passement, beaucoup de bugs et d’utilisateurs m\u00e9contents, quelques situations de crise, l’image de l’IT d\u00e9grad\u00e9e, … bref, il cherchait quelques raisons d’expliquer \u00e0 son provider qu’il ne voulait plus de lui.<\/p>\n
D\u00e9s lors, je savais comment aller au plus important. Violations critiques. Lui montrer quelques bons gros bugs.<\/p>\n
J’ai param\u00e9tr\u00e9 une analyse de code Sonar depuis Jenkins. Tr\u00e8s simple : Sonar \u2013 Jenkins plugin<\/a>. L’analyse fut tr\u00e8s rapide.<\/p>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_SonarAdmin_Login.jpg\" "\\"Qual_SonarAdmin_Login\\"")
<\/a>Puis j’ai lanc\u00e9 mon dashboard Sonar pr\u00e9f\u00e9r\u00e9, comme Admin :<\/p>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModelTop_Add.jpg\" "\\"Qual_Sonar_CityModelTop_Add\\"")
<\/a>Je suis entr\u00e9 dans la configuration des widgets et j’ai ajout\u00e9 un widget City Model Top de eXcentia.<\/p>\nEt j’ai entr\u00e9 les param\u00e8tres suivants :<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModelTop_params.jpg\" "\\"Qual_Sonar_CityModelTop_params\\"")
<\/a><\/p>\n\n- title : Blocker<\/li>\n
- topListLength : 5. Je ne veux voir que les 5 premi\u00e8res violations de type ‘bloquantes’.<\/li>\n
- formula : {blocker_violations}.<\/li>\n<\/ul>\n
La formule correspond au top 5 des composants avec le plus de violations de type ‘Blocker’. Celles qu’on ne veut voir dans aucune application. Celles qui pr\u00e9sentent le plus de risques pour les utilisateurs. Celles qui d\u00e9montrent que l’outsourcer produit du code de la pire qualit\u00e9 qui soit.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel_Add.jpg\" "\\"Qual_Sonar_CityModel_Add\\"")
<\/a> Puis je vais ajouter le widget City Model et modifier ses param\u00e8tres.
\nLe premier champ ‘heightExp’ contient une formule pour d\u00e9finir la hauteur de chaque \u00e9difice en fonction de la taille de chaque classe, exprim\u00e9e en nombre de lignes de code (Lines Of Code ou LOC).<\/p>\nCette mesure utilise une fonction logarithmique afin d’\u00e9viter une croissance trop rapide et donc une diff\u00e9rence de taille qui ferait que certains ‘gratte-ciels’ sortent du champ visuel et que les autres b\u00e2timents apparaissent minuscules.<\/p>\n
Je vais reprendre cette formule et la modifier afin d’utiliser une autre m\u00e9trique : le nombre de ‘violations’ de bonnes pratiques, c’est-\u00e0-dire le nombre de d\u00e9fauts rencontr\u00e9s dans le code :<\/p>\n
Math.pow(Math.E – 0.25, Math.log({violations}))<\/address>\n <\/address>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel_params.jpg\" "\\"Qual_Sonar_CityModel_params\\"")
<\/a>Les autres param\u00e8tres sont les suivants :<\/p>\n\n- title : Blocker<\/li>\n
- colorExp : num2col({blocker_violations}, 0, 1).<\/li>\n
- widthExp : {functions}.<\/li>\n<\/ul>\n
Je veux que les \u00e9difices repr\u00e9sentant chaque classe apparaissent en rouge d\u00e9s lors qu’existe au moins une violation critique, de type ‘Blocker’. Donc la formule ‘colorExp’ n’admet qu’un intervalle tr\u00e8s \u00e9troit de valeurs: vert pour 0 ‘blocker’ et rouge d\u00e8s lors qu’existe au moins un d\u00e9faut bloquant, mesur\u00e9e par la m\u00e9trique {blocker_violations}.<\/p>\n
La largeur de chaque building sera calcul\u00e9 en fonction du nombre de m\u00e9thodes avec la m\u00e9trique {functions}.<\/p>\n
Une fois sauv\u00e9s ces param\u00e8tres, voici \u00e0 quoi ressemble ma ‘Cit\u00e9 critique’ :<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel1.jpg\" "\\"Qual_Sonar_CityModel1\\"")
<\/a><\/p>\nN’oubliez pas que vous pouvez zoomer au sein de cette repr\u00e9sentation ou la faire pivoter horizontalement ou verticalement, ce qui va nous permettre d’identifier les classes avec un ou plusieurs ‘Blockers’.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel2.jpg\" "\\"Qual_Sonar_CityModel2\\"")
<\/a>Cette grande tour verte \u00e0 droite poss\u00e8de un grand nombre de d\u00e9fauts mais aucun critique. D’autres classes, m\u00eame avec un nombre plus important de m\u00e9thodes, pr\u00e9sentent un au moins une violation bloquante.<\/p>\nCes d\u00e9fauts doivent \u00eatre corrig\u00e9s imp\u00e9rativement avant m\u00eame que l’application ne soit test\u00e9e ou, a fortiori, soit install\u00e9e en environnement de production.<\/p>\n
En navigant au sein de cette repr\u00e9sentation 3D, on peut rencontrer des classes qui autrement seraient ind\u00e9tectables de par leurs petites dimensions, en nombre de lignes de code ou de m\u00e9thodes ou de complexit\u00e9, mais qui compte n\u00e9anmoins un bug bloquant.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel31.jpg\" "\\"Qual_Sonar_CityModel3\\"")
<\/a><\/p>\nNous pouvons voir dans le coin inf\u00e9rieur gauche trois petites classes avec seulement deux m\u00e9thodes et au moins 1 d\u00e9faut bloquant.<\/p>\n
Maintenant, nous voulons \u00e9galement identifier les classes avec un nombre \u00e9lev\u00e9 de d\u00e9fauts critiques ou majeurs. Voici les r\u00e8gles que j’ai d\u00e9finies en accord avec le client :<\/p>\n
\n- Une classe appara\u00eet en rouge si elle comporte au moins une violation ‘Blocker’.<\/li>\n
- Une classe appara\u00eet en rouge si elle comporte au moins quatre violations ‘Critical’. Sinon, sa couleur ira de verte \u00e0 rouge en fonction d’une \u00e9chelle de 1 \u00e0 4 de ces violations.<\/li>\n
- Sinon, la couleur de la classe sera d\u00e9finie selon le nombre de d\u00e9fauts ‘Major’ sur une \u00e9chelle de 1 \u00e0 100.<\/li>\n<\/ol>\n
Si je ram\u00e8ne ces trois r\u00e8gles sur une \u00e9chelle de 1 \u00e0 100 :<\/p>\n
\n- Une violation bloquante = 100.<\/li>\n
- 4 violations critiques = 100, 3 violations critiques = 75, 2 violations critiques = 50 et 1 violation critique = 25.<\/li>\n
- Les violations majeures sont mesur\u00e9es sans facteur multiplicatif.<\/li>\n<\/ul>\n
Et derni\u00e8re r\u00e8gle, la couleur de l’\u00e9difice sera d\u00e9finie en fonction de la plus haute de ces valeurs. Par exemple :<\/p>\n
\n- Une classe avec 30 violations majeures sans violation bloquante ou critique aura une couleur (de verte \u00e0 rouge) \u00e9gale \u00e0 30 sur une \u00e9chelle de 1 \u00e0 100.<\/li>\n
- Une classe avec 2 violations critiques sans violation bloquante ou majeure aura une couleur \u00e9gale \u00e0 50, soit 2 violations x 25.<\/li>\n
- Une classe avec 2 violations critiques et 30 violations majeures aura une valeur de 50 (plus haute des deux valeurs).<\/li>\n
- Une classe avec 2 violations critiques et 60 violations majeures aura une valeur de 60.<\/li>\n<\/ul>\n
Et voici la formule qui correspond \u00e0 ces r\u00e8gles :<\/p>\n
num2col(Math.max(({blocker_violations}*100), ({critical_violations}*25), {major_violations}), 0, 100)<\/address>\n <\/address>\nLe r\u00e9sultat :<\/p>\n
Et j’ai entr\u00e9 les param\u00e8tres suivants :<\/p>\n La formule correspond au top 5 des composants avec le plus de violations de type ‘Blocker’. Celles qu’on ne veut voir dans aucune application. Celles qui pr\u00e9sentent le plus de risques pour les utilisateurs. Celles qui d\u00e9montrent que l’outsourcer produit du code de la pire qualit\u00e9 qui soit.<\/p>\n Cette mesure utilise une fonction logarithmique afin d’\u00e9viter une croissance trop rapide et donc une diff\u00e9rence de taille qui ferait que certains ‘gratte-ciels’ sortent du champ visuel et que les autres b\u00e2timents apparaissent minuscules.<\/p>\n Je vais reprendre cette formule et la modifier afin d’utiliser une autre m\u00e9trique : le nombre de ‘violations’ de bonnes pratiques, c’est-\u00e0-dire le nombre de d\u00e9fauts rencontr\u00e9s dans le code :<\/p>\n Je veux que les \u00e9difices repr\u00e9sentant chaque classe apparaissent en rouge d\u00e9s lors qu’existe au moins une violation critique, de type ‘Blocker’. Donc la formule ‘colorExp’ n’admet qu’un intervalle tr\u00e8s \u00e9troit de valeurs: vert pour 0 ‘blocker’ et rouge d\u00e8s lors qu’existe au moins un d\u00e9faut bloquant, mesur\u00e9e par la m\u00e9trique {blocker_violations}.<\/p>\n La largeur de chaque building sera calcul\u00e9 en fonction du nombre de m\u00e9thodes avec la m\u00e9trique {functions}.<\/p>\n Une fois sauv\u00e9s ces param\u00e8tres, voici \u00e0 quoi ressemble ma ‘Cit\u00e9 critique’ :<\/p>\n N’oubliez pas que vous pouvez zoomer au sein de cette repr\u00e9sentation ou la faire pivoter horizontalement ou verticalement, ce qui va nous permettre d’identifier les classes avec un ou plusieurs ‘Blockers’.<\/p>\n Ces d\u00e9fauts doivent \u00eatre corrig\u00e9s imp\u00e9rativement avant m\u00eame que l’application ne soit test\u00e9e ou, a fortiori, soit install\u00e9e en environnement de production.<\/p>\n En navigant au sein de cette repr\u00e9sentation 3D, on peut rencontrer des classes qui autrement seraient ind\u00e9tectables de par leurs petites dimensions, en nombre de lignes de code ou de m\u00e9thodes ou de complexit\u00e9, mais qui compte n\u00e9anmoins un bug bloquant.<\/p>\n Nous pouvons voir dans le coin inf\u00e9rieur gauche trois petites classes avec seulement deux m\u00e9thodes et au moins 1 d\u00e9faut bloquant.<\/p>\n Maintenant, nous voulons \u00e9galement identifier les classes avec un nombre \u00e9lev\u00e9 de d\u00e9fauts critiques ou majeurs. Voici les r\u00e8gles que j’ai d\u00e9finies en accord avec le client :<\/p>\n Si je ram\u00e8ne ces trois r\u00e8gles sur une \u00e9chelle de 1 \u00e0 100 :<\/p>\n Et derni\u00e8re r\u00e8gle, la couleur de l’\u00e9difice sera d\u00e9finie en fonction de la plus haute de ces valeurs. Par exemple :<\/p>\n Et voici la formule qui correspond \u00e0 ces r\u00e8gles :<\/p>\n Le r\u00e9sultat :<\/p>\n<\/a>Puis j’ai lanc\u00e9 mon dashboard Sonar pr\u00e9f\u00e9r\u00e9, comme Admin :<\/p>\n<\/a>Je suis entr\u00e9 dans la configuration des widgets et j’ai ajout\u00e9 un widget City Model Top de eXcentia.<\/p>\n<\/a><\/p>\n\n
<\/a> Puis je vais ajouter le widget City Model et modifier ses param\u00e8tres.
\nLe premier champ ‘heightExp’ contient une formule pour d\u00e9finir la hauteur de chaque \u00e9difice en fonction de la taille de chaque classe, exprim\u00e9e en nombre de lignes de code (Lines Of Code ou LOC).<\/p>\n<\/a>Les autres param\u00e8tres sont les suivants :<\/p>\n\n
<\/a><\/p>\n<\/a>Cette grande tour verte \u00e0 droite poss\u00e8de un grand nombre de d\u00e9fauts mais aucun critique. D’autres classes, m\u00eame avec un nombre plus important de m\u00e9thodes, pr\u00e9sentent un au moins une violation bloquante.<\/p>\n<\/a><\/p>\n\n
\n
\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel41.jpg\" "\\"Qual_Sonar_CityModel4\\"")
<\/a><\/p>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/Qual_Sonar_CityModel5.jpg\" "\\"Qual_Sonar_CityModel5\\"")
<\/a><\/p>\n