Traductions: English - Italiano - Français



Comment utiliser le Système de Suivi de Bug (BTS)

Session d'entraînement IRC Debian Women conduite par Gerfried Fuchs, le 09 Décembre 2010

Voici un tutoriel sur l'utilisation du système de suivi de bug.

L'acronyme BTS signifie Bug Tracking System (ou Système de suivi de bugs en français). Il s'agit du système ou le projet Debian réalise l'enregistrement et le suivi des rapports de bug (y compris les demandes d'amélioration, pas uniquement les "véritables" bugs). Il s'agit en majorité d'un système basé sur le courrier électronique - car on peut modifier ou effectuer des manipulations uniquement en envoyant un courrier électronique. Les courriers doivent être envoyés en format texte et non en HTML.

Prérequis

Prérequis techniques:

Interroger les rapports de bug: l'interface web du BTS

L'interface Web du BTS se consulte sur http://bugs.debian.org/. A travers cette interface, vous pouvez lancer des recherches, assez rapidement (si le serveur n'est pas trop chargé) et assez facilement, sur les rapports de bug.

Si vous allez sur http://bugs.debian.org, vous serez redirigé sur une page affichant un formulaire de recherche. Mais la partie la plus utile représente les nombreuses redirections que ce formulaire permet:

Sur les pages d'aperçu, une liste des rapports indiqués dans la présente page est affichée en haut. A la fin de cette page, un formulaire vous permet de sélectionner les rapports qui vous intéressent selon différentes options.

Vous vous rendrez compte que sur cette page d'aperçu, il y a souvent des caractères mystérieux à côté de chaque résumé de bug. Vous pouvez mettre le pointeur de souris dessus afin d'obtenir la signification du caractère. En cliquant dessus, vous ouvrez une fenêtre pop-up avec davantage d'information sur le rapport de bug.

Il s'agissait d'une courte introduction à l'interface web du BTS. Encore une fois, retenez qu'il s'agit seulement d'une interface de recherche et n'hésitez pas à cliquer à droite et à gauche: rien de mauvais ne peut en sortir.

Créer des rapports de bug: reportbug

Pour signaler des bugs, vous aurez besoin d'un client de courrier électronique ou, mieux encore, du paquet reportbug. reportbug est un outil principalement en mode texte (mais il existe deux interfaces graphiques: une basée sur urwid, l'autre sur GTK+). Il existe également reportbug-ng qui est une interface graphique dont l'objectif est identique à reportbug mais qui est un outil bien distinct.

Les deux outils imposent l'utilisation d'un MTA (Mail Transport Agent) comme postfix, exim ou ssmtp. Je ne détaillerai pas comment les configurer. Retenez qu'il est utile pour certains de disposer d'un MTA en local de manière à pouvoir écrire son courrier électronique sur son portable lorsqu'on est déconnecté et pouvoir l'envoyer ensuite, lorsqu'on est à nouveau connecté.

Même lorsque vous ne disposez pas d'un MTA local, reportbug reste extrèmement utile car il dispose d'une option --template. Cette dernière vous aide à produire de l'information qui vous sera de toute manière demandée par le mainteneur du paquet, directement dans le rapport de bug (par exemple, l'information sur les dépendances).

Lancez dans un terminal:

reportbug --template paquet

avec un nom de paquet que vous avez installé. N'ayez pas peur: cela ne fait rien de mal ! Ca permet juste d'afficher quelques lignes de texte. :)

Dans ces lignes, plusieurs éléments importants vous donneront des indications pour la suite, comme où envoyer le courrier électronique:

To: Debian Bug Tracking System <submit@bugs.debian.org>

L'adresse submit@bugs est l'adresse à laquelle les nouveaux rapports de bug sont envoyés. Bien entendu vous devrez utiliser un titre compréhensible et bien descriptif qui permettra au mainteneur du paquet de voir quel est le problème.

Ensuite, il y a un autre bloc qui commence avec Package::, où il y a une ligne Version: et une autre Severity:

Severity indique différents niveaux de sévérité depuis grave, critical, serious, à important, normal, ou minor ou encore whishlist.

Les trois premiers niveaux (grave, critical et serious) sont considérés comme critique pour la version et définissent un groupe spécial de rapports de bug. Dans le doute, il ne faut pas les utiliser à moins de comprendre vraiment leur signification: certaines personnes peuvent réagir vivement lorsqu'ils sont employés dans le cas d'un rapport qui ne serait pas vraiment si grave. Je vous indiquerai la signification de ces rapports spéciaux un peu plus tard.

wishlist est le niveau de sévérité pour les demandes d'amélioration que vous voudriez voir intégrées au paquet. Certains mainteneurs vous suggéreront probablement de faire ces demandes dans le projet originel. Soyez préparé à cette réaction, même si personnellement, je considère qu'un mainteneur de paquet doit être un lien entre les utilisateurs Debian et les développeurs amont.

Enfin, essayez d'être le plus descriptif possible non seulement dans le titre du bug mais également dans le message du rapport. Il serait également appréciable si vous pouviez indiquer une méthode permettant de reproduire votre bug.

A propos de la création de rapports de bug, vous pouvez également consulter la documentation sur http://www.debian.org/Bugs/Reporting.

Modifier les rapports de bug: control@bugs.debian.org

Pour modifier les rapports de bug, vous devez utiliser l'adresse control@bugs.debian.org. L'intégralité du système de suivi de bug est ouvert à tous, comme cette adresse électronique. Cela signifie que techniquement tout le monde peut modifier un rapport de bug. L'adresse de contrôle est le début de l'aventure. Elle fonctionne comme l'adresse d'envoi sur les premières lignes du rapport de bug.

La documentation de l'adresse électronique de contrôle est située sur http://www.debian.org/Bugs/server-control.

La syntaxe est généralement la suivante:

 commande numéro_de_bug arguments

La quantité d'arguments varie selon la commande employée.

Ainsi, avec la commande retitle:

retitle 12345 nouveau-titre

vous modifiez le titre du rapport de bug 12345 en nouveau-titre.

N'ayez crainte, vous ne pouvez pas réaliser cette opération pour ce numéro de bug car il est archivé. Vous pouvez seulement agir sur les rapports de bug qui ne sont pas encore archivés.

Une commande souvent utilisée est la commande reassign qui permet d'indiquer que le rapport de bug concerne un paquet différent. Cette commande utilise un deuxième argument après le nom du paquet: un numéro de version. Si vous connaissez le numéro de version de l'autre paquet concerné par le bug, il est utile et important d'ajouter la version pour permettre au suivi de version de continuer à fonctionner. J'expliquerai le suivi des version un peu plus tard et je vous montrerai quelques cas d'utilisation. :)

La commande tag améliore la classification des bugs. Lorsque vous crééz un rapport de bug, vous pouvez également ajouter des Tags (étiquettes) aux pseudo en-têtes de votre message et affecter des étiquettes spécifiquement à un rapport de bug.

Voici quelques étiquettes qui sont souvent employées:

La liste des étiquettes peut être consultée sur http://www.debian.org/Bugs/Developer#tags.

Les courriers à destination de l'adresse de contrôle sont stockés dans le BTS mais ne sont pas renvoyés ailleurs. Ainsi, ces messages sont souvent accompagnés d'un champ Cc vers bugnumber@bugs.debian.org. Ces courriers sont alors envoyés vers le mainteneur de paquet (ainsi qu'aux autres personnes abonnées à cette adresse).

Si vous voulez vous abonner à un rapport de bug en particulier, envoyez simplement un courrier électronique à bugnumber-subscribe@bugs.debian.org. Vous recevrez un email de confirmation à la suite de laquelle, vous recevrez tous les messages envoyés à ce rapport de bug. Vous pouvez également souscrire à tous les rapports de bug d'un paquet en utilisant le PTS (Package Tracking System ou Système de Suivi de Paquets en français) en allant sur http://packages.qa.debian.org/nom_du_paquet (remplacer nom_du_paquet par le paquet auquel vous désirez vous abonner). En bas à gauche, vous trouverez le formulatire d'inscription.

Si les utilisateurs envoyent des courriers à la fois à control@bugs et à bugnumber@bugs, ils ne veulent pas déranger ou mettre en échec le programme de contrôle avec le texte à destination du mainteneur de paquet. La commande spéciale thanks que vous avez peut-être remarquée après les commandes de contrôle indique au programme de contrôle d'arrêter de traiter le message à partir de là. Merci de vous soucier de ce programme et d'utiliser thanks pour terminer vos messages de contrôle. :)

Merci de prendre note que j'ai toujours dit que les courriers envoyés à bugnumber@bugs sont envoyés au mainteneur du paquet (et aux personnes qui y sont abonnées). Ces courriers ne sont PAS envoyés à la personne qui a créé le rapport de bug ! C'est quelque-chose qui est en discussion et qui va peut-être changer. Toutefois, pour l'instant, vous devez penser à rechercher l'adresse du créateur du rapport et à l'ajouter en copie ou bien vous devez utiliser l'adresse email: bugnumber-submitter@bugs.debian.org.