Simulation et confirmation dans les scripts d'administration : -WhatIf/-Confirm en PowerShell et option --dry-run en shell

Objectif

Doter un script d'administration d'un mode qui indique ce qu'il ferait, et d'un moyen pour l'appelant d'exiger une confirmation explicite, avant l'exécution de toute action modifiant l'état du système.

Prérequis

Des fonctions PowerShell écrites comme fonctions avancées ([CmdletBinding()]) ; pour les scripts shell, aucun outil particulier, seulement une convention.

Étapes

1. En PowerShell, placez [CmdletBinding(SupportsShouldProcess)] directement au-dessus du bloc param() de la fonction. La page about_Functions_CmdletBindingAttribute décrit SupportsShouldProcess comme la propriété qui ajoute automatiquement à la fonction les paramètres communs -WhatIf et -Confirm : vous n'avez pas à implémenter ces commutateurs vous-même.
2. Avant chaque ligne qui modifie l'état, appelez if ($PSCmdlet.ShouldProcess($target, $action)) { <do the change> }. La page about_Functions_Advanced_Methods décrit ShouldProcess comme la méthode qui vérifie -WhatIf/-Confirm et indique si l'opération doit se poursuivre ; lorsque -WhatIf a été passé, ShouldProcess affiche la ligne « What if: » et renvoie $false, sans que vous ayez à écrire cette logique.
3. Toute cmdlet appelée par votre fonction et qui prend elle-même en charge -WhatIf doit le recevoir explicitement (Remove-Item @params -WhatIf:$WhatIfPreference), afin que la simulation de votre fonction soit aussi une simulation de tout ce qu'elle appelle ; la préférence ne se propage automatiquement qu'aux commandes de la même chaîne de portées, et pas de façon fiable vers d'autres modules.
4. Définissez ConfirmImpact = 'High' dans l'attribut CmdletBinding pour les actions destructrices, de sorte qu'une demande de confirmation apparaisse même si l'appelant n'a pas passé -Confirm (la valeur par défaut de $ConfirmPreference est High). Dans une session lancée avec -NonInteractive, cette demande échoue au lieu d'attendre ; les appelants non supervisés doivent donc passer -Confirm:$false de manière délibérée.
5. Dans un script shell, ajoutez une option explicite --dry-run (ou -n), analysée en début de script et stockée dans une variable, par exemple DRY_RUN=0. Enveloppez chaque commande qui modifie l'état : run() { if [ "$DRY_RUN" = 1 ]; then echo "DRY-RUN: $*"; else "$@"; fi; }, puis appelez chaque commande modifiante via run rm -f "$path", etc., sans jamais dupliquer la logique qui décide de ce qu'il faut exécuter.
6. Affichez le plan de la simulation sous la même forme que celle que l'exécution réelle journaliserait, afin que la comparaison entre la sortie d'une simulation et celle d'une exécution réelle constitue un contrôle pertinent.
7. Pour une confirmation sans TTY complet (contextes non interactifs, pilotés par un agent), faites en sorte que le comportement par défaut exige un --yes/-Confirm:$false explicite, plutôt que de « poursuivre silencieusement » ; exigez une option pour sauter la confirmation, et non une option pour la demander.

Résultat attendu

MyFunction -WhatIf et l'option --dry-run d'un script shell signalent tous deux chaque action qu'ils entreprendraient, sans rien modifier ; sans ces options, l'exécution réalise les mêmes actions que celles décrites par la simulation, sans logique dupliquée entre les deux chemins.

Limites et base de vérification

ShouldProcess ne contrôle que les chemins de code autour desquels vous le placez : une fonction peut déclarer SupportsShouldProcess et pourtant modifier l'état dans une branche qui n'appelle jamais ShouldProcess, d'où la nécessité de relire chaque ligne modifiante individuellement. L'enveloppe shell run() ne produit pas de sortie exacte pour les commandes dont l'effet réel dépend de données qu'on ne découvre qu'en les exécutant (par exemple une requête qui renvoie un nombre de lignes) ; la sortie de la simulation n'est alors forcément qu'une approximation. Les redirections sont effectuées par le shell appelant avant l'invocation de run : run cmd > file tronque donc encore file en mode simulation ; enveloppez ces étapes dans run sh -c '...' ou dans une fonction.