Écrire un script POSIX sh portable entre Linux, BSD, macOS et AIX

Ce que c'est

POSIX.1-2017 définit le Shell Command Language indépendamment de toute implémentation. Selon le système, /bin/sh peut être dash (shell par défaut de Debian/Ubuntu, dont la page de manuel le décrit comme un interpréteur de commandes conforme à POSIX), bash en mode POSIX (Linux de la famille RHEL, macOS), ksh (AIX) ou un tout autre shell. Un script qui n'a jamais été exécuté qu'avec les extensions de bash peut échouer dès que /bin/sh pointe ailleurs.

Pourquoi c'est important

Deux problèmes de portabilité distincts apparaissent :

• Syntaxe du shell : les bashismes ([[ ]], tableaux, function name() {}, source, substitution de processus <(...), set -o pipefail et $'...') ne font pas partie de POSIX.1-2017 sh. Les deux derniers n'ont été intégrés à POSIX que dans l'édition 2024 ; dash 0.5.12 ne prend en charge ni l'un ni l'autre. dash rejette bon nombre de ces constructions ou les traite mal sans le signaler. local n'est pas non plus POSIX, mais dash l'accepte. L'outil checkbashisms de Debian, que sa page de manuel décrit comme un script pour « check for bashisms in /bin/sh scripts » (détecter les bashismes dans les scripts /bin/sh), est conçu précisément pour cela : il faut l'exécuter sur tout script qui déclare #!/bin/sh.
• Options de commandes différentes selon le système : le shell peut être portable alors que les outils externes qu'il appelle ne le sont pas. sed -i exige un argument d'extension obligatoire avec le sed BSD de FreeBSD/macOS (documenté comme modifiant les fichiers « in-place similarly to » -I, avec une extension à fournir même vide), alors que le sed GNU accepte un suffixe facultatif collé à l'option : sed -i '' -e ... est requis côté BSD et incorrect côté GNU (GNU traite '' comme un nom de fichier et se termine avec le code 2). sed -i.bak -e ... file && rm file.bak fonctionne des deux côtés. readlink -f est défini de la même façon (suivre tous les liens symboliques pour produire un chemin canonique) dans GNU coreutils et dans le manuel de FreeBSD ; macOS ne le propose que depuis la version 12.3. Il est absent des versions plus anciennes de macOS et de nombreuses plates-formes ni GNU ni BSD (par exemple AIX) tant qu'on n'installe pas coreutils. date (GNU date -d, BSD date -j -f/-v), stat (GNU stat -c, BSD stat -f) et find divergent de manière similaire entre les environnements utilisateur GNU et ceux dérivés de BSD.

Comment l'appliquer

• Déclarer honnêtement le shell : n'utiliser #!/bin/sh que pour les scripts qui passent checkbashisms sans avertissement ; utiliser #!/bin/bash et accepter le coût en portabilité lorsque les fonctionnalités de bash sont réellement nécessaires.
• Éviter les options propres à GNU dans les scripts portables, ou bien choisir la variante en fonction de uname -s ou de la sortie --version de l'outil et appeler la forme propre à chaque système (sed -i '' ... sous Darwin/FreeBSD, sed -i ... sous Linux).
• Préférer les options définies par POSIX lui-même (sed -e, printf plutôt que echo -e, command -v plutôt que which) lorsqu'un script doit s'exécuter sans modification sur le plus grand nombre possible d'implémentations de /bin/sh, y compris le shell d'AIX.
• Tester le /bin/sh réel de chaque cible, et pas seulement bash en mode POSIX : le « Bash POSIX Mode » de GNU Bash modifie de nombreux comportements par défaut, mais n'est pas identique au comportement de dash ou de ksh.

Pièges

• Croire que bash --posix, ou un shebang #!/bin/sh sur un système où /bin/sh est en réalité bash, prouve la conformité POSIX. Exécuter aussi le script sous dash détecte bien plus de problèmes, même si aucun shell pris isolément ne constitue une preuve.
• Coder en dur une seule forme de sed -i et livrer le script à la fois à un runner CI Linux et à la machine d'un développeur sous macOS.
• S'appuyer sur readlink -f sur une plate-forme où il n'est pas installé, sans solution de repli telle que (cd "$(dirname -- "$f")" && pwd -P), qui ne canonise que la partie répertoire et non un lien symbolique situé dans le dernier composant.