Tester une bibliothèque de classes .NET à l’aide de Visual Studio
Important
Microsoft a annoncé la mise hors service de Visual Studio pour Mac. Visual Studio pour Mac ne sera plus pris en charge à compter du 31 août 2024. Il existe des alternatives :
- Visual Studio Code avec le Kit de développement C# et les extensions associées, telles que .NET MAUI et Unity.
- Visual Studio s’exécutant sur Windows dans une machine virtuelle sur Mac.
- Visual Studio s’exécutant sur Windows dans une machine virtuelle dans le cloud.
Pour plus d’informations, consultez l’annonce de mise hors service de Visual Studio pour Mac.
Ce tutoriel montre comment automatiser les tests unitaires en ajoutant un projet de test à une solution.
Prérequis
- Ce tutoriel fonctionne avec la solution que vous créez dans Créer une bibliothèque de classes .NET à l’aide de Visual Studio pour Mac.
Créer un projet de test unitaire
Les tests unitaires effectuent des tests logiciels automatisés pendant le développement et la publication. MSTest est l’une des trois infrastructures de test parmi lesquelles vous pouvez choisir. Les autres sont xUnit et nUnit.
Démarrez Visual Studio pour Mac.
Ouvrez la solution
ClassLibraryProjects
que vous avez créée dans Créer une bibliothèque de classes .NET à l’aide de Visual Studio pour Mac.Dans le panneau Solutions, effectuez un Ctrl + clic sur la solution
ClassLibraryProjects
et sélectionnez Ajouter>un nouveau projet.Dans la boîte de dialogue Nouveau projet, sélectionnez Tests depuis le nœud Web et console. Sélectionnez le Projet MSTest puis Suivant.
Sélectionnez .NET 5.0 comme Version cible de .Net Framework, puis sélectionnez Suivant.
Nommez le nouveau projet « StringLibraryTest », puis sélectionnez Créer.
Visual Studio crée un fichier de classe avec le code suivant :
using Microsoft.VisualStudio.TestTools.UnitTesting; namespace StringLibraryTest { [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { } } }
Le code source créé par le modèle de test unitaire effectue les opérations suivantes :
- Il importe l’espace de noms Microsoft.VisualStudio.TestTools.UnitTesting, qui contient les types utilisés pour les tests unitaires.
- Il applique l’attribut TestClassAttribute à la classe
UnitTest1
. - Il applique l’attribut TestMethodAttribute à
TestMethod1
.
Chaque méthode marquée avec [TestMethod] dans une classe de test marquée avec [TestClass] est exécutée automatiquement lorsque le test unitaire est exécuté.
Ajouter une référence au projet
Pour que le projet de test fonctionne avec la classe StringLibrary
, ajoutez une référence au projet StringLibrary
.
Dans le panneau Solutions, effectuez un Ctrl + clic sur Dépendances sous StringLibraryTest. Sélectionnez Ajouter une référence dans le menu contextuel.
Dans la boîte de dialogue Références, sélectionnez le projet StringLibrary. Sélectionnez OK.
Ajouter et exécuter des méthodes de test unitaire
Lorsque Visual Studio exécute un test unitaire, il exécute chaque méthode marquée avec l’attribut TestMethodAttribute dans une classe marquée avec l’attribut TestClassAttribute. Une méthode de test se termine quand la première défaillance survient, ou quand tous les tests contenus dans la méthode ont réussi.
Les tests les plus courants appellent des membres de la classe Assert. De nombreuses méthodes d’assertion incluent au moins deux paramètres, à savoir le résultat attendu pour le test et résultat réel du test. Certaines des méthodes les plus fréquemment appelées de la classe Assert
sont indiquées dans le tableau suivant :
Méthodes d’assertion | Fonction |
---|---|
Assert.AreEqual |
Vérifie que deux valeurs ou objets sont égaux. L’assertion échoue si les valeurs ou les objets ne sont pas égaux. |
Assert.AreSame |
Vérifie que deux variables d’objet référencent le même objet. L’assertion échoue si les variables font référence à des objets différents. |
Assert.IsFalse |
Vérifie qu’une condition est false . L’assertion échoue si la condition est true . |
Assert.IsNotNull |
Vérifie qu’un objet n’est pas null . L’assertion échouera si l’objet est null . |
Vous pouvez également utiliser la méthode Assert.ThrowsException dans une méthode de test pour indiquer le type d’exception qu’il est censé lever. Le test échoue si l’exception spécifiée n’est pas levée.
Dans le test de la méthode StringLibrary.StartsWithUpper
, vous voulez fournir une série de chaînes qui commencent par une majuscule. Vous attendez que la méthode retourne true
dans de tels cas, et vous pouvez donc appeler la méthode Assert.IsTrue. De même, vous voulez fournir des chaînes qui commencent par autre chose qu’un caractère majuscule. Vous attendez que la méthode retourne false
dans de tels cas, et vous pouvez donc appeler la méthode Assert.IsFalse.
Dans la mesure où votre méthode de bibliothèque gère les chaînes, vous voulez également vous assurer qu’elle gère correctement une chaîne vide (String.Empty
), une chaîne valide sans caractères et dont Length a la valeur 0 et une chaîne null
qui n’a pas été initialisée. Vous pouvez appeler StartsWithUpper
directement en tant que méthode statique et passer un seul argument String. Vous pouvez également appeler StartsWithUpper
en tant que méthode d’extension sur une variable string
affectée à null
.
Vous allez définir trois méthodes, chacune appelant une méthode Assert pour chaque élément d’un tableau de chaînes. Vous allez appeler une surcharge de méthode qui vous permet de spécifier un message d’erreur à afficher en cas d’échec du test. Le message identifie la chaîne qui a provoqué l’échec.
Pour créer les méthodes de test:
Ouvrez le fichier UnitTest1.cs et remplacez le code par le code suivant :
using Microsoft.VisualStudio.TestTools.UnitTesting; using UtilityLibraries; namespace StringLibraryTest { [TestClass] public class UnitTest1 { [TestMethod] public void TestStartsWithUpper() { // Tests that we expect to return true. string[] words = { "Alphabet", "Zebra", "ABC", "Αθήνα", "Москва" }; foreach (var word in words) { bool result = word.StartsWithUpper(); Assert.IsTrue(result, string.Format("Expected for '{0}': true; Actual: {1}", word, result)); } } [TestMethod] public void TestDoesNotStartWithUpper() { // Tests that we expect to return false. string[] words = { "alphabet", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство", "1234", ".", ";", " " }; foreach (var word in words) { bool result = word.StartsWithUpper(); Assert.IsFalse(result, string.Format("Expected for '{0}': false; Actual: {1}", word, result)); } } [TestMethod] public void DirectCallWithNullOrEmpty() { // Tests that we expect to return false. string?[] words = { string.Empty, null }; foreach (var word in words) { bool result = StringLibrary.StartsWithUpper(word); Assert.IsFalse(result, string.Format("Expected for '{0}': false; Actual: {1}", word == null ? "<null>" : word, result)); } } } }
Le test des caractères majuscules de la méthode
TestStartsWithUpper
inclut la lettre majuscule grecque alpha (U+0391) et la lettre majuscule cyrillique EM (U+041C). Le test des caractères minuscules dans la méthodeTestDoesNotStartWithUpper
inclut la lettre minuscule grecque alpha (U+03B1) et la lettre minuscule cyrillique Ghe (U+0433).Dans la barre de menus, sélectionnez Fichier>Enregistrer sous . Dans la boîte de dialogue, vérifiez qu’Encodage est défini sur Unicode (UTF-8).
Lorsque vous êtes invité à remplacer le fichier existant, sélectionnez Remplacer.
Si vous ne parvenez pas à enregistrer votre code source dans un fichier encodé en UTF-8, Visual Studio peut l’enregistrer en tant que fichier ASCII. Dans ce cas, le runtime ne décode pas correctement les caractères UTF-8 en dehors de la plage ASCII et les résultats des tests ne seront pas exacts.
Ouvrez le panneau Tests unitaires sur le côté droit de l’écran. Sélectionnez Afficher les>tests dans le menu.
Cliquez sur l’icône Ancrer pour garder le panneau ouvert.
Cliquez sur le bouton Tout exécuter.
Tous les tests sont concluants.
Gérer les échecs de test
Si vous effectuez un développement piloté par les tests (TDD), vous écrivez d’abord des tests et ils échouent la première fois que vous les exécutez. Ensuite, vous ajoutez du code à l’application, et le test réussit alors. Pour ce tutoriel, vous avez créé le test après avoir écrit le code de l’application qu’il valide, de sorte que vous n’avez pas vu le test échouer. Pour vérifier qu’un test échoue lorsque vous vous attendez à ce qu’il échoue, ajoutez une valeur non valide à l’entrée de test.
Modifiez le tableau
words
dans la méthodeTestDoesNotStartWithUpper
en y incluant la chaîne « Erreur ». Vous n’avez pas besoin d’enregistrer le fichier, car Visual Studio enregistre automatiquement les fichiers ouverts quand une solution est générée pour exécuter des tests.string[] words = { "alphabet", "Error", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство", "1234", ".", ";", " " };
Réexécutez les tests.
Cette fois, la fenêtre Explorateur de tests indique que deux tests ont réussi et qu’un test a échoué.
Effectuez un Ctrl + clic sur le test ayant échoué,
TestDoesNotStartWithUpper
, puis sélectionnez le panneau Afficher les résultats dans le menu contextuel.Le panneau Résultats affiche le message généré par l’assertion : « Échec de Assert.IsFalse ». « Erreur » : false ; réel : True » était attendu ». En raison de l’échec, aucune chaîne du tableau après « Erreur » n’a été testée.
Supprimez la chaîne « Erreur » que vous avez ajoutée à l’étape 1. Réexécutez le test et les tests réussissent.
Tester la version Release de la bibliothèque
Maintenant que les tests ont tous réussi lors de l’exécution de la build Debug de la bibliothèque, exécutez les tests une fois supplémentaire sur la build Release de la bibliothèque. Un certain nombre de facteurs, notamment les optimisations du compilateur, peuvent parfois produire un comportement différent entre les versions Debug et Release.
Pour tester la version Release :
Dans la barre d’outils de Visual Studio, modifiez la configuration de build de Debug à Release.
Dans le panneau Solutions, effectuez un Ctrl + clic sur le projet StringLibrary et sélectionnez Générer dans le menu contextuel pour recompiler la bibliothèque.
Réexécutez les tests unitaires.
Les tests réussissent.
Déboguer les tests
Si vous utilisez Visual Studio pour Mac comme IDE, vous pouvez utiliser le même processus que celui présenté dans le Tutoriel : Déboguer une application console .NET à l’aide de Visual Studio pour Mac pour déboguer du code à l’aide de votre projet de test unitaire. Au lieu de démarrer le projet d’application ShowCase, effectuez un Ctrl + clic sur le projet StringLibraryTests, puis sélectionnez Démarrer le débogage du projet dans le menu contextuel.
Visual Studio démarre le projet de test avec le débogueur attaché. L’exécution s’arrête à tout point d’arrêt que vous avez ajouté au projet de test ou au code de bibliothèque sous-jacent.
Ressources supplémentaires
Étapes suivantes
Dans ce tutoriel, vous avez effectué le test unitaire d’une bibliothèque de classes. Vous pouvez rendre la bibliothèque accessible à d’autres utilisateurs en la publiant sur NuGet en tant que package. Pour en savoir plus, suivez un tutoriel NuGet :
Si vous publiez une bibliothèque en tant que package NuGet, d’autres utilisateurs peuvent l’installer et l’utiliser. Pour en savoir plus, suivez un tutoriel NuGet :
Une bibliothèque ne doit pas nécessairement être distribuée en tant que package. Elle peut être proposée avec une application console qui l’utilise. Pour savoir comment publier une application console, consultez le tutoriel précédent de cette série :
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour