MSTEST0025 : utilisez « Assert.Fail » au lieu d’un assert toujours défaillant
| Propriété | Value |
|---|---|
| Identificateur de la règle | MSTEST0025 |
| Titre | Utilisez « Assert.Fail » au lieu d’un assert toujours défaillant |
| Catégorie | Concevoir |
| Le correctif est cassant ou non cassant | Sans rupture |
| Activé par défaut | Oui |
| Gravité par défaut | Infos |
| Introduite dans la version | 3.4.0 |
| Existe-t-il une correction de code | Oui |
Cause
Cette règle déclenche un diagnostic lorsqu’un appel à une assertion produit une condition toujours fausse.
Description de la règle
L’utilisation de Assert.Fail sur un appel d’assertion toujours défaillant fournit une intention plus claire et une meilleure documentation pour le code.
Lorsque vous rencontrez une assertion toujours défaillante (par exemple, Assert.IsTrue(false)), il peut ne pas être immédiatement évident pour quelqu’un qui lit le code de comprendre pourquoi l’assertion est là ou quelle condition elle tente de vérifier. Cela peut entraîner une confusion et un temps perdu pour les développeurs qui trouvent le code plus tard.
En revanche, l’utilisation de Assert.Fail vous permet de fournir un message d’échec personnalisé, ce qui explique clairement pourquoi l’assertion échoue et quelle condition ou scénario spécifique elle traite. Ce message sert de documentation pour l’intention derrière l’assertion, aidant d’autres développeurs à comprendre l’objectif de l’assertion sans avoir à approfondir le code.
Dans l’ensemble, l’utilisation de Assert.Fail favorise la clarté, la documentation et la facilité de maintenance dans votre codebase, ce qui en fait un meilleur choix sur un appel d’assertion toujours défaillant.
Comment corriger les violations
Vérifiez que les appels à Assert.IsTrue, Assert.IsFalse, Assert.AreEqual, Assert.AreNotEqual, Assert.IsNull ou Assert.IsNotNull ne produisent pas de conditions toujours défaillantes.
Quand supprimer les avertissements
Nous vous déconseillons de supprimer les avertissements de cette règle.
Supprimer un avertissement
Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.
#pragma warning disable MSTEST0025
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0025
Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.
[*.{cs,vb}]
dotnet_diagnostic.MSTEST0025.severity = none
Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.
