Règles d’utilisation de MSTest

Les règles d’utilisation prennent en charge l’utilisation appropriée des attributs, méthodes et modèles MSTest. Ces règles interceptent les erreurs courantes et garantissent que vos tests suivent les exigences et conventions du cadre.

Règles dans cette catégorie

* Élevé au statut d'erreur dans les modes Recommended et All.

Scénarios courants

Validation de la structure de test

Vérifiez que vos classes, méthodes et appareils de test respectent les exigences MSTest :

• MSTEST0002 : exigences de disposition des classes de test (par exemple, publiques, non statiques).
• MSTEST0003 : exigences de disposition des méthodes de test (️⚠️ réaffectées à l’erreur).
• MSTEST0030 : les méthodes avec [TestMethod] doivent se trouver dans une [TestClass].
• MSTEST0063 : validation du constructeur de classe de test.
• MSTEST0069 : Appliquez [TestClass] directement afin que la découverte générée par la source recherche la classe.
• MSTEST0082 : conservez les classes de test de base et dérivées sur la même version principale MSTest.

Méthodes de cycle de vie

Valider les méthodes d’initialisation et de nettoyage :

• MSTEST0008 : TestInitialize validation.
• MSTEST0009 : validation de TestCleanup.
• MSTEST0010 : ClassInitialize Validation.
• MSTEST0011: Validation de ClassCleanup.
• MSTEST0012 : AssemblyInitialize validation.
• MSTEST0013 : validation de l'AssemblyCleanup.
• MSTEST0034 : définir ClassCleanupBehavior.EndOfClass.
• MSTEST0050 : validation globale des appareils de test.
• MSTEST0072 : n’utilisez pas de fournisseurs de montage partagés avec la compilation anticipée.
• MSTEST0082 : recompiler les méthodes de cycle de vie héritées par rapport à la version MSTest du projet de test.

Tests pilotés par les données

Vérifiez que les attributs de données sont utilisés correctement :

• MSTEST0007 : les attributs de données doivent être sur les méthodes de test.
• MSTEST0014 : validation de DataRow.
• MSTEST0018 : DynamicData validation.
• MSTEST0042 : détecter les dataRows dupliqués.
• MSTEST0052 : Utiliser AutoDetect pour DynamicDataSourceType.
• MSTEST0062 : Évitez les paramètres out/ref.

Écriture d’assertions meilleures

Règles d’utilisation correcte et efficace des assertions :

• MSTEST0017 : Passez la valeur attendue/réelle dans l’ordre correct.
• MSTEST0023 : ne pas nier les conditions (utilisez Assert.IsFalse directement).
• MSTEST0026 : évitez les opérateurs conditionnels Null dans les assertions.
• MSTEST0032 : passez en revue les conditions toujours vraies.
• MSTEST0037 : utilisez la méthode d’assertion la plus appropriée.
• MSTEST0038 : n’utilisez pas AreSame avec des types valeur.
• MSTEST0039 : Utilisez Assert.ThrowsExactly (API plus récente).
• MSTEST0046 : Préférer Assert sur StringAssert.
• MSTEST0051 : Assert.Throws doit tester une instruction unique.
• MSTEST0053 : utilisez l’interpolation de chaîne au lieu des paramètres de format.
• MSTEST0058 : ne placez pas d’assertions dans les blocs catch.
• MSTEST0064 : préférer les méthodes d’assertion asynchrones au blocage sur le code asynchrone.
• MSTEST0065 : Évitez d’utiliser Assert.AreEqual sur les types de collection.
• MSTEST0068 : Préférer Assert à CollectionAssert.

Utilisation de TestContext

Utilisation appropriée de l’objet TestContext :

• MSTEST0005 : validation de propriété TestContext.
• MSTEST0024 : ne stockez pas TestContext dans des champs statiques.
• MSTEST0048 : accès restreint aux propriétés dans les fixtures de test.
• MSTEST0049 : jetons d’annulation de flux de TestContext.
• MSTEST0054 : utilisez la propriété TestContext.CancellationToken.

Modèles asynchrones

Règles pour le code de test asynchrone :

• MSTEST0040 : Évitez les assertions dans les méthodes void asynchrones.
• MSTEST0067 : Évitez Thread.Sleep, Task.Waitet d’autres appels bloquants de manière synchrone dans le code de test (opt-in).

Sécurité des tests parallèles

Règles pour les tests qui s’exécutent en parallèle :

• MSTEST0073 : utilisez des constantes partagées pour les clés de verrouillage de ressources.
• MSTEST0074 : verrouiller les mutations à l’état global du processus.
• MSTEST0075 : verrouiller les modifications du répertoire actuel.
• MSTEST0076 : Évitez les mutations de culture à l’échelle du processus.
• MSTEST0077 : Évitez les chemins de système de fichiers partagés.

Configuration de test

• MSTEST0031 : Utilisez des attributs appropriés (et non System.ComponentModel.Description).
• MSTEST0035 : Utilisation de DeploymentItem.
• MSTEST0041 : les attributs de condition doivent être sur les classes de test.
• MSTEST0043 : les attributs de réessai doivent être sur les méthodes de test (️⚠️ escaladé à Erreur).
• MSTEST0055 : n’ignorez pas les valeurs de retour de la méthode de chaîne.
• MSTEST0056 : définissez DisplayName correctement sur TestMethodAttribute.
• MSTEST0057 : Propager l'information source dans un TestMethodAttribute personnalisé.
• MSTEST0059 : n’utilisez pas à la fois Parallelize et DoNotParallelize.
• MSTEST0060 : Évitez les doublons TestMethodAttribute.
• MSTEST0061 : utilisez l’attribut OSCondition pour les vérifications de plateforme.
• MSTEST0070 : [MemberCondition] les arguments doivent référencer des membres valides.
• MSTEST0071: Ne définissez pas un nom d’affichage identique au nom de la méthode de test.
• MSTEST0078 : Valider [DependsOn] les cibles et les graphiques de dépendance.
• MSTEST0079 : utilisez ArchitectureCondition plutôt que des vérifications d’architecture d’exécution.
• MSTEST0080 : utilisez CICondition plutôt que des vérifications d’environnement.
• MSTEST0081 : valider les inscriptions des fournisseurs de filtres de test.
• MSTEST0082 : détecter les tests hérités et les méthodes de cycle de vie compilées sur une autre version principale MSTest.
• MSTEST0083 : utilisez ExecutableCondition au lieu d’une vérification exécutable impérative.

Documentation connexe

• Écrire des tests avec MSTest
• Affirmations
• Cycle de vie
• TestContext