Mot-clé - clean code

Fil des billets - Fil des commentaires

Session : comment écrire du code testable

 J'ai eu le plaisir d'animer la session "Comment écrire du code testable" à la conférence Agile France 2010. C'est l'heure de mettre les slides à disposition et de faire une rétrospective !

Connaître les symptômes d'un code intestable vous permettra de mieux vous en débarrasser :
  1. Un constructeur cher
  2. Des instanciations directes
  3. Des blocs statiques
  4. Une dynastie de classes
  5. Des états globaux
  6. Annuaire de service
  7. Interroger des collaborateurs
  8. Des classes hyperactives
  9. Des méthodes trop chargées
  10. Mélanger les objets valeurs et les objets services

Lire la suite

Soat à l'agile conférence

Agile Conference 2010

Nous tiendrons deux sessions à l'agile conférence (ex-XPDays) les 31 Mai et 1er Juin : un atelier fun et une conférence geek. Survivre sur la lune avec la NASA ou l’importance de travailler en groupe L'idée de l'atelier est de démontrer que pour résoudre un problème, 1111 est bien plus fort que  […]

Lire la suite

Don't Look For Things, de M. Hevery

J'entends assez souvent "il faut", "il ne faut pas", comme si c'était une loi venant d'une instance suprême. Ce n'est pas un reflexe de remettre les choses en cause et de se demander pourquoi on fait quelque chose. Questionner n'est pas forcément bien vu non plus et peut heurter. C'est la force de l'habitude.

Si un projet plante, et que le manager n'a rien fait de "spécial", on se dira que c'est la faute à pas de chance. S'il a eu le malheur d'innover, en mettant en place des méthodes agiles par exemple, alors il y a de grandes chances pour que ce soit cette innovation qui soit pointée du doigt. Quelque part, suivre sans interroger se comprend, nous supposons que d'autres gens se sont déjà penchés sur la question. Heureusement que nous avons un minimum confiance en notre passé.

Extrait d'une conversation :

Bonnie : On devrait regrouper les imports statiques des matchers JUnit que l'on utilise dans une librairie à part, et ne faire qu'un seul import.

Clyde, hésitant : S'ils sont amenés à être utilisés ensemble, pourquoi le framework ne met pas directement tout dans un seul import ou dans le même package? Plutot que pousser chacun à tout repackager?

Bonnie : C'est une bonne pratique, même sur Xebia ils le disent. Si tu ne me crois pas, tu peux demander aux architectes, ils te diront la même chose.

Ah bah s'ils le disent... Autant vous dire que l'argument qui tue "c'est Jacques que tout le monde respecte qui l'a dit" a beaucoup aidé Clyde.

Cela n'empêche pas Bonnie d'avoir raison. Un argument est évoqué dans Clean Code, elle concerne les API externes en général. L'idée est de réduire le couplage de notre code avec les API externes tout bêtement. Si elles changent, il n'y aura qu'un endroit à changer. Depuis, j'ai cette "note pour moi-même" : même si les raisons me paraissent évidentes, elles ne le sont pas pour tout le monde, il vaut mieux dire d'emblée pourquoi je pense qu'il vaut mieux faire ci que cela.

Je m'égare, je m'égare. Là où je voulais en venir, c'était qu'on m'avait fait remarquer un jour "qu'il ne faut pas faire travailler un constructeur, même pas en appelant une méthode init()". Je savais cela, mais honnêtement, je ne savais pas très bien pourquoi. Du coup, quand un petit travail dans le constructeur me facilitait la vie, je le faisais quand même...

Et bien voici une raison, citée par Misko Hevery dans Don't Look For Things : pour poser un test sur un objet, l'opération que l'on ne peut absolument pas éviter est d'instancier l'objet et donc d'invoquer le constructeur. S'il y a des opérations compliquées dans le constructeur, nous sommes obligés de faire avec dans les tests. Et tous les tests utilisant cet objet en tant que collaborateur auront le même boulet à trainer (à moins d'avoir un framework magique qui permette de mocker les constructeurs).

Lire la suite

Inheritance, Polymorphism & Testing de Misko Hevery

Il était une fois un bout de code que je voulais refactorer car il me semblait très redondant. Le hic est que les parties similaires étaient en "sandwich", ce qui m'a fait utiliser le polymorphisme. J'étais assez contente de moi mais un doute subsistait.... est ce que je me faisais plaisir pour la beauté du code ou est ce que mon refactoring avait un réel intérêt, autre qu'économiser quelques lignes redondantes?

La présentation "Inheritance, Polymorphism, & Testing" aborde justement le sujet du polymorphisme par rapport aux conditions.

Pourquoi le polymorphisme plutot que des conditions?

Misko part du principe où tous les ifs pourraient être remplacés par du polymorphisme. Les avantages sont que :

  • les fonctions sans if sont plus faciles à lire
  • et plus faciles à tester
  • les systèmes polymorphiques sont plus simples à maintenir. Il est aisé d'ajouter des nouvelles méthodes : il suffit de les rajouter aux sous classes, pas la peine de parcourir le code à la recherche des blocks ifs.

Lire la suite

Recours aux méthodes privées

Je suis en train de lire Clean Code de Robert Martin et je me rends compte que ma facon de coder est beaucoup plus sale que je ne le pensais, en dépit de tous mes efforts. C'est un peu comme la musique : c'est facile de sentir que quelqu'un chante faux, c'est une autre histoire de savoir chanter juste. Ce livre apporte également beaucoup de réponses à des problématiques que j'avais rencontré, qui me génaient mais que je ne savais pas comment résoudre.

Le billet d'aujourd'hui concerne le recours aux méthodes privées. Ma facon de procéder était la suivante : je code, et s'il y a deux fois le meme code, je crée une méthode privée pour factoriser. J'aimais bien aussi tout avoir sous les yeux, dans la même méthode, plutot qu'éparpillée dans la classe.

L'approche de Martin est différente : le code propre doit se lire comme un roman. Les méthodes privées ont, de fait, un autre role : donner du sens au code. C'est seulement si nous souhaitons connaitre le détail que l'on rentre dans la méthode privée.

Lire la suite

Unit Testing de Misko Hevery

Misko Hevery est un développeur chez Google et aborde de nombreux aspects des tests unitaires sur son blog et lors de Google TechTalks.

Je vous fais un petit topo sur la conférence Unit Testing qu'il a donné, la présentation originale est disponible sur youtube.

Le code réellement difficile à tester est caractérisé par

  • un mélange de new et de la logique
  • le fait de chercher des choses (<=> par des lookups notamment)
  • du traitement dans le constructeur
  • des états globaux

plus que par des méthodes longues et/ou privées.

Il y a 3 types de tests, du moins au plus nombreux :

  • les tests par scénario : un cas d'utilisation de l'utilisateur, tel qu'il le percoit et de bout en bout. Exemple : l'utilisateur se connecte sur l'application et saisit un mauvais mot de passe.
  • les tests fonctionnels : une fonctionnalité de l'application testé de facon isolée. Exemple : un autoradio d'une voiture.
  • les tests unitaires : une methode d'une classe. Exemple : Service.hello().

Lire la suite

Haut de page