Eclipse


Intégrer Mantis à Eclipse grâce à Mylyn

Eclipse devient un environnement de développement -de plus en plus- intégré. Il est clair que depuis longtemps maintenant, le but de la fondation est de créer un outil capable d'être utilisé dans toutes les étapes de l'ALM (Application Lifecycle Management). Exemples :

  • Modeling : UML avec Papyrus
  • Configuration Management : SVN avec Subclipse
  • Build management : Maven avec m2eclipse
  • Software Testing : Test unitaires avec le support de JUnit et fonctionnels avec Jubula/SWTBot
  • Release Management : Maven avec m2eclipse
  • Workflow : implémentations avec MWE

Mais cette liste peut encore être complétée par la prise en compte de "Change Management" et "Issue Management" grâce à Mylyn. En effet, ce projet a pour but d'ajouter à Eclipse la capacité de gérer de manière plus approfondie les changements réalisés sur un projet, en s'interfaçant avec les outils les plus courants dans ce domaine : Jira, Mantis... Il est intégré de base dans la majorité des distributions.

Cet article a donc pour but de présenter Mylyn et tente de montrer comment être plus efficace avec sa nouvelle manière de gérer les tickets Mantis.

Tout d'abord, à quoi sert Mylyn? Sa vocation principale est d'apporter une nouvelle façon de traiter les modifications : au sein de l'IDE, un ticket est représenté sous la forme d'une tâche, planifiable dans le temps (l'avancement du travail effectué est donc matérialisé) mais aussi contextualisable (il est possible de lier directement des modifications de code à un ticket). L'IDE est en lien direct et permanent avec le serveur Mantis afin de récupérer toutes les anomalies saisies et de les mettre à jour sans avoir à ouvrir un navigateur. La présentation complète des fonctionnalités est disponible sur cette page.

Voyons donc, avec un exemple, comment traiter un ticket uniquement depuis Eclipse.

Tout commence par la configuration de l'accès au serveur. Dans la vue "Task Repositories", il faut créer un nouveau serveur :

Mantis fournit par défaut un webservice SOAP utilisable pour interagir avec ses données, généralement à l'adresse "http:///api/soap/mantisconnect.php". Il faut donc indiquer à Mylyn l'adresse de ce webservice pour se connecter :

Le serveur apparaît alors dans la vue. Pendant la configuration, Mylyn a récupéré la liste des projets et des utilisateurs créés dans Mantis. Il est donc possible de récupérer les tickets en indiquant la requête à utiliser, autrement dit le filtre enregistré sur le serveur. Par exemple, j'ai créé un filtre dans Mantis pour ne voir que les tickets qui me sont affectés, appelé "All Mine" :

Dans Eclipse, il faut indiquer la requête à utiliser pour télécharger les tickets, avec la fonction "New Query" :

Après avoir sélectionné le projet, il est possible de choisir le filtre "All Mine" :

Pour finaliser la récupération des tâches, il faut se rendre dans la vue "Task List" et synchroniser avec le serveur :

On peut donc voir les tickets rapatriés sous forme de tâches, comprenant l'ensemble des informations saisie sous Mantis. A partir de ce moment, la tâche est consultable hors-ligne et modifiable à volonté. Il est par la suite possible de mettre à jour Mantis avec le bouton "Submit" dans l'éditeur :

Voyons donc comment traiter le bug illustré ici et contextualiser dans Mantis la tâche avec le code mis en jeu au moment du commit. Tout d'abord, il possible de planifier la réalisation dans le temps afin de connaitre le travail effectué dans la journée. Pour ceci, il est possible de définir la date attendue et le temps nécessaire estimé pour la réalisation :

La progression sera ainsi visible en survolant la catégorie regroupant les tâches :

Afin de lier le contexte à la tâche, il faut d'abord l'activer, autrement dit indiquer qu'elle est la tâche courante (point gris à gauche de la tâche sur l'image plus haut). Dès lors, de nouvelles actions sont disponibles comme l'accès direct au code depuis la description de la tâche, grâce à la trace de l'exception :

Ensuite, une fois la correction effectuée, c'est lors de la synchronisation avec le serveur SVN (avant le commit) que l'on indique le contexte (série de modifications) de la tâche courante :

Ainsi, dans l'éditeur de la tâche, sous l'onglet "Context", apparaissent désormais les classes mises en jeu :

Revenons maintenant au commit. Mylyn ajoute par défaut dans le commentaire la référence au Mantis de la tâche. Il est vivement conseillé de conserver au moins ces informations dans le commentaire, nous verrons par la suite pourquoi :

Il faut maintenant mettre à jour le ticket Mantis pour indiquer sa résolution. Pour cela, il suffit de modifier les champs de la section "Action" dans l'éditeur de la tâche et soumettre au serveur :

La mise à jour terminée, la progression du travail est actualisée et le bug est maintenant clos dans Mantis :

Un fichier ZIP a été lié, contenant les informations nécessaires à Mylyn pour récupérer le contexte de la tâche dans l'IDE si nécessaire. A propos de contexte, qu'est devenu le commentaire si important lors du commit? Pour le savoir, il faut éditer la classe qui a été modifiée puis afficher les annotations serveur grâce à "Team"->"Show annotation" :

Affichées en mod "diff", il est possible de voir le commentaire spécifié lors du commit qui a modifié la ligne en question, et donc de retrouver directement le lien vers le ticket Mantis traité :

Comme on peut le voir, le traitement des bugs devient donc bien plus pratique et pragmatique avec Mylyn : le déroulement des corrections se fait entièrement depuis l'IDE, sans avoir à manipuler un navigateur externe (il est même possible de pousser le vice l'outil jusqu'à ouvrir les tickets Mantis correspondants aux tâches dans le navigateur intégré d'Eclipse...).

Il existe encore bien d'autres possibilités d'utilisation, mais j'espère que cette présentation aura éveillé les curiosités!

Sources :


Fichier(s) joint(s) :

0 commentaires: