grep, diff, cmp et test/[ : le code de sortie 1 signifie « non trouvé », pas « échec »

Ce que c'est

Quatre des outils les plus courants qu'un agent appelle en ligne de commande partagent une convention facile à mal interpréter : un code de sortie non nul ne signifie pas toujours que l'outil a échoué.

Outil	0	1	2 (ou >1)
grep	une ligne a été sélectionnée	aucune ligne n'a été sélectionnée	une erreur s'est produite
diff	les entrées sont identiques	les entrées diffèrent	problème (chemin invalide, fichier illisible)
cmp	les fichiers sont identiques	les fichiers diffèrent	problème
test / [	l'expression est vraie	l'expression est fausse ou absente	une erreur s'est produite

Le manuel de GNU grep indique que le code de sortie vaut « 0 if a line is selected, 1 if no lines were selected, and 2 if an error occurred » (0 si une ligne est sélectionnée, 1 si aucune ligne ne l'est, 2 en cas d'erreur). Le manuel de diffutils applique la même répartition en trois cas à diff et cmp : « 0 if inputs are the same, 1 if different, 2 if trouble » (0 si les entrées sont identiques, 1 si elles diffèrent, 2 en cas de problème). POSIX définit test/[ de la même façon : 0 pour vrai, 1 pour faux (ou pour une expression manquante), et toute valeur supérieure à 1 pour une véritable erreur.

Pourquoi c'est important

Pour ces quatre outils, le code de sortie 1 est le résultat attendu d'une grande partie des appels : une recherche sans résultat, deux fichiers différents, une condition fausse. Un agent qui assimile « non nul » à « commande en échec » signalera à tort un résultat négatif normal comme une étape de pipeline défaillante. Pire, il risque de ne pas remarquer que le code est en réalité 2 (ou plus), c'est-à-dire que l'outil n'a même pas pu mener la comparaison à son terme : syntaxe de motif erronée, fichier illisible, répertoire à la place d'un fichier.

Comment l'appliquer

• Testez la valeur précise plutôt que « zéro ou non » : traitez 1 comme une réponse négative normale et réservez la gestion d'échec à 2 (grep/diff/cmp) ou à toute valeur supérieure à 1 (test).
• Avec grep -q/--quiet, tenez compte de la réserve du manuel : une correspondance trouvée renvoie 0 même si une erreur sans rapport est survenue à la lecture d'un autre fichier. Le seul code de sortie de -q ne prouve donc pas que toutes les entrées étaient lisibles.
• Pour diff/cmp dans un pipeline qui doit échouer bruyamment sur une vraie erreur mais tolérer les différences, vérifiez $? -gt 1 (ou -eq 2) plutôt que $? -ne 0.
• Pour [ … ] en bash, rappelez-vous qu'une expression mal formée (« unary operator expected », un ] manquant) renvoie 2 et non 1 ; mettre les variables entre guillemets ("$var") évite la plupart de ces cas.

Pièges

• Encadrer l'un de ces outils par une gestion d'erreur du type command || exit 1 fait disparaître la distinction utile entre « non » et « cassé ».
• Supposer que d'autres implémentations (grep de busybox, certaines réimplémentations de diff) respectent exactement les codes 0/1/2 : les textes POSIX et GNU cités décrivent la base commune, pas chaque clone.