Git Bisect pour le débogage

Le débogage peut être difficile. Parfois, un bogue apparaît sans que vous sachiez quelle modification l'a provoqué.

git bisect est une commande Git puissante qui vous aide à déterminer précisément quel commit a introduit un bogue. Elle utilise un algorithme de recherche binaire pour réduire rapidement un ensemble de milliers de commits.

Imaginez que votre projet comporte 100 commits et qu'un bogue soit apparu quelque part entre le premier et le dernier. Les vérifier un par un serait très lent !

git bisect fonctionne comme un jeu où il faut « deviner le nombre » :

• Vous indiquez à Git un commit « bon » (où le bogue n'était pas présent).
• Vous indiquez à Git un commit « mauvais » (où le bogue est présent).
• Git choisit un commit situé approximativement au milieu et vous demande de le tester.
• Vous le marquez comme « bon » ou « mauvais », et Git divise par deux l'espace de recherche.

Pour commencer, vous devez indiquer à Git que vous démarrez une session de recherche dichotomique. Cette commande initialise le processus :

git bisect start

Après le démarrage, vous indiquerez un commit « mauvais » connu (où le bogue existe) et un commit « bon » connu (où le bogue n'existait définitivement pas).

Souvent, le commit « mauvais » est votre HEAD actuel, et le commit « bon » peut être une ancienne étiquette de version ou un commit datant de quelques jours.

Une fois git bisect démarré, vous définissez votre plage de recherche :

• Commit mauvais : il s'agit d'un commit dans lequel vous savez que le bogue existe. Utilisez git bisect bad <commit-hash> ou simplement git bisect bad s'il s'agit de votre HEAD actuel.
• Commit bon : il s'agit d'un commit dans lequel vous savez que le bogue n'existait PAS. Utilisez git bisect good <commit-hash>.

Git extraira ensuite automatiquement un commit situé au milieu de cette plage.

Après avoir marqué vos commits bon et mauvais, Git extraira automatiquement un commit situé au milieu de la plage. Votre rôle consiste à tester le code de ce commit extrait.

• Si le bogue IS présent, saisissez git bisect bad.
• Si le bogue IS NOT présent, saisissez git bisect good.

Git choisira ensuite un autre commit central dans la plage restante. Vous répéterez cette opération jusqu'à ce que Git trouve le premier commit « mauvais ».

Imaginons un « bogue » simple dans un script. Nous allons simuler l'historique d'un projet dans lequel une petite erreur a été introduite.

Voici notre script initial « bon » :

main.sh

Supposons maintenant qu'un commit ultérieur ait modifié par erreur la boucle en seq 1 4, ce qui rend la somme incorrecte (10 au lieu de 6).

Nous commencerions par :

git bisect start

Puis nous marquerions notre HEAD actuel (où le bogue existe) comme mauvais :

git bisect bad HEAD

Et un commit plus ancien, dont le bon fonctionnement est connu, comme bon :

git bisect good <old_good_commit_hash>

Git vous guidera ensuite en extrayant des commits. Vous exécuteriez ./main.sh, vérifieriez si la somme vaut 6 ou 10, puis saisiriez git bisect good ou git bisect bad en conséquence.

Tester chaque commit manuellement peut rester chronophage si le test est complexe. git bisect run vous permet d'automatiser cette tâche !

Vous fournissez un script qui se termine avec :

• 0 (zéro) si le commit est bon.
• 125 si le commit doit être ignoré.
• Toute autre valeur non nulle (par exemple, 1) si le commit est mauvais.

Git exécutera ce script sur chaque commit testé jusqu'à ce que le bogue soit trouvé.

Une fois que git bisect a identifié avec succès le premier commit mauvais, il vous indiquera le hachage du commit et son message.

Après avoir trouvé le responsable et compris le problème, il est essentiel de réinitialiser votre dépôt à son état d'origine, avant le début de la recherche dichotomique :

git bisect reset

Cette commande vous ramène au commit sur lequel vous vous trouviez lorsque vous avez lancé la recherche dichotomique et nettoie son état temporaire.

Vous venez d'exécuter git bisect start, de marquer votre HEAD actuel comme mauvais et un commit plus ancien comme bon. Git extrait un commit situé au milieu.

Vous exécutez vos tests et le bogue IS PRESENT dans ce commit central.

Félicitations ! Vous avez appris à utiliser git bisect :

• C'est un outil puissant pour trouver précisément le commit qui a introduit un bogue.
• Il utilise une recherche binaire pour gagner en efficacité.
• Vous définissez des commits « bons » (sans bogue) et « mauvais » (avec bogue).
• Vous pouvez automatiser le processus de test avec git bisect run <script>.
• N'oubliez jamais d'exécuter git bisect reset pour nettoyer la recherche une fois terminée !