Eenheid testen C# met MSTest en .NET

In deze zelfstudie wordt u stapsgewijs begeleid bij het bouwen van een voorbeeldoplossing voor het leren van concepten voor het testen van eenheden. Als u liever de zelfstudie volgt met behulp van een vooraf gebouwde oplossing, bekijkt of downloadt u de voorbeeldcode voordat u begint. Zie Voorbeelden en zelfstudies voor downloadinstructies.

Dit artikel gaat over het testen van een .NET Core-project. Als u een ASP.NET Core-project test, raadpleegt u Integratietests in ASP.NET Core.

Vereisten

Het bronproject maken

Open een shellvenster. Maak een map met de naam unit-testing-using-mstest om de oplossing te bewaren. Voer in deze nieuwe map uit dotnet new sln om een nieuw oplossingsbestand te maken voor de klassebibliotheek en het testproject. Maak een PrimeService-map . In het volgende overzicht ziet u de map- en bestandsstructuur tot nu toe:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService

Maak PrimeService de huidige map en voer deze uit dotnet new classlib om het bronproject te maken. Wijzig de naam van Class1.cs in PrimeService.cs. Vervang de code in het bestand door de volgende code om een mislukte implementatie van de PrimeService klasse te maken:

using System;

namespace Prime.Services
{
    public class PrimeService
    {
        public bool IsPrime(int candidate)
        {
            throw new NotImplementedException("Please create a test first.");
        }
    }
}

Wijzig de map weer in de map unit-testing-using-mstest . Voer dotnet sln add uit om het klassebibliotheekproject toe te voegen aan de oplossing:

dotnet sln add PrimeService/PrimeService.csproj

Het testproject maken

Maak de map PrimeService.Tests . In het volgende overzicht ziet u de mapstructuur:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests

Maak de map PrimeService.Tests de huidige map en maak een nieuw project met behulp van dotnet new mstest. Met de nieuwe dotnet-opdracht maakt u een testproject dat MSTest als testbibliotheek gebruikt. De sjabloon configureert de testrunner in het bestand PrimeServiceTests.csproj :

<ItemGroup>
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
  <PackageReference Include="MSTest.TestAdapter" Version="2.1.1" />
  <PackageReference Include="MSTest.TestFramework" Version="2.1.1" />
  <PackageReference Include="coverlet.collector" Version="1.3.0" />
</ItemGroup>

Voor het testproject zijn andere pakketten vereist om eenheidstests te maken en uit te voeren. dotnet new in de vorige stap hebt u de MSTest SDK, het MSTest-testframework, de MSTest runner en coverlet toegevoegd voor het rapporteren van codedekking.

Voeg de PrimeService klassebibliotheek toe als een andere afhankelijkheid aan het project. Gebruik de dotnet add reference opdracht:

dotnet add reference ../PrimeService/PrimeService.csproj

U kunt het hele bestand zien in de opslagplaats met voorbeelden op GitHub.

In het volgende overzicht ziet u de uiteindelijke indeling van de oplossing:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests
        Test Source Files
        PrimeServiceTests.csproj

Ga naar de map unit-testing-using-mstest en voer het volgende uit dotnet sln add:

dotnet sln add ./PrimeService.Tests/PrimeService.Tests.csproj

De eerste test maken

Schrijf een mislukte test, breng deze door en herhaal het proces. Verwijder UnitTest1.cs uit de map PrimeService.Tests en maak een nieuw C#-bestand met de naam PrimeService_IsPrimeShould.cs met de volgende inhoud:

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Prime.Services;

namespace Prime.UnitTests.Services
{
    [TestClass]
    public class PrimeService_IsPrimeShould
    {
        private readonly PrimeService _primeService;

        public PrimeService_IsPrimeShould()
        {
            _primeService = new PrimeService();
        }

        [TestMethod]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            bool result = _primeService.IsPrime(1);

            Assert.IsFalse(result, "1 should not be prime");
        }
    }
}

Het kenmerk TestClass geeft een klasse aan die eenheidstests bevat. Het kenmerk TestMethod geeft aan dat een methode een testmethode is.

Sla dit bestand op en voer deze uit dotnet test om de tests en de klassebibliotheek te bouwen en voer vervolgens de tests uit. De MSTest-testrunner bevat het programmainvoerpunt om uw tests uit te voeren. dotnet test start de testrunner met behulp van het eenheidstestproject dat u hebt gemaakt.

Uw test mislukt. U hebt de implementatie nog niet gemaakt. Zorg ervoor dat deze test wordt doorgegeven door de eenvoudigste code te schrijven in de PrimeService klasse die werkt:

public bool IsPrime(int candidate)
{
    if (candidate == 1)
    {
        return false;
    }
    throw new NotImplementedException("Please create a test first.");
}

Voer dotnet test opnieuw uit in de map unit-testing-using-mstest. Met de dotnet test opdracht wordt een build voor het PrimeService project uitgevoerd en vervolgens voor het PrimeService.Tests project. Na het bouwen van beide projecten wordt deze enkele test uitgevoerd. Het gaat voorbij.

Meer functies toevoegen

Nu u één testpas hebt gemaakt, is het tijd om meer te schrijven. Er zijn enkele andere eenvoudige gevallen voor priemgetallen: 0, -1. U kunt nieuwe tests toevoegen met het kenmerk TestMethod, maar dat wordt snel vervelend. Er zijn andere MSTest-kenmerken waarmee u een suite met vergelijkbare tests kunt schrijven. Een testmethode kan dezelfde code uitvoeren, maar verschillende invoerargumenten hebben. U kunt het kenmerk DataRow gebruiken om waarden voor deze invoer op te geven.

In plaats van nieuwe tests te maken, past u deze twee kenmerken toe om één gegevensgestuurde test te maken. De gegevensgestuurde test is een methode waarmee verschillende waarden worden getest die kleiner zijn dan twee, het laagste priemnummer. Voeg een nieuwe testmethode toe in PrimeService_IsPrimeShould.cs:

[TestMethod]
[DataRow(-1)]
[DataRow(0)]
[DataRow(1)]
public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
{
    var result = _primeService.IsPrime(value);

    Assert.IsFalse(result, $"{value} should not be prime");
}

Uitvoeren dotnet testen twee van deze tests mislukken. Als u alle tests wilt laten slagen, wijzigt u de if component aan het begin van de IsPrime methode in het bestand PrimeService.cs :

if (candidate < 2)

Blijf herhalen door meer tests, meer theorieën en meer code toe te voegen in de hoofdbibliotheek. U hebt de voltooide versie van de tests en de volledige implementatie van de bibliotheek.

U hebt een kleine bibliotheek en een set eenheidstests voor die bibliotheek gemaakt. U hebt de oplossing gestructureerd zodat het toevoegen van nieuwe pakketten en tests deel uitmaakt van de normale werkstroom. U hebt zich het grootste deel van uw tijd en moeite geconcentreerd op het oplossen van de doelstellingen van de toepassing.

Zie ook