Eenheid testen C# met NUnit en .NET Core

Artikel
04/05/2024

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

.NET 8.0 of nieuwere versies.
Een teksteditor of code-editor naar keuze.

Het bronproject maken

Open een shellvenster. Maak een map met de naam unit-testing-using-nunit om de oplossing te bewaren. Voer in deze nieuwe map de volgende opdracht uit om een nieuw oplossingsbestand voor de klassebibliotheek en het testproject te maken:

dotnet new sln

Maak vervolgens een PrimeService-map . In het volgende overzicht ziet u de map- en bestandsstructuur tot nu toe:

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

Maak PrimeService de huidige map en voer de volgende opdracht uit om het bronproject te maken:

dotnet new classlib

Wijzig de naam van Class1.cs in PrimeService.cs. U maakt een mislukte implementatie van de PrimeService klasse:

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-nunit . Voer de volgende opdracht uit om het klassebibliotheekproject toe te voegen aan de oplossing:

dotnet sln add PrimeService/PrimeService.csproj

Het testproject maken

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

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

Maak de map PrimeService.Tests de huidige map en maak een nieuw project met behulp van de volgende opdracht:

dotnet new nunit

Met de nieuwe dotnet-opdracht maakt u een testproject dat NUnit als testbibliotheek gebruikt. De gegenereerde sjabloon configureert de testrunner in het bestand PrimeService.Tests.csproj :

<ItemGroup>
  <PackageReference Include="nunit" Version="4.2.2" />
  <PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
  <PackageReference Include="NUnit.Analyzers" Version="4.3.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
</ItemGroup>

Notitie

Vóór .NET 9 kan de gegenereerde code verwijzen naar oudere versies van het NUnit-testframework. U kunt dotnet CLI gebruiken om de pakketten bij te werken. U kunt ook het bestand PrimeService.Tests.csproj openen en de inhoud van de pakketverwijzingen itemgroep vervangen door de bovenstaande code.

Voor het testproject zijn andere pakketten vereist om eenheidstests te maken en uit te voeren. De dotnet new opdracht in de vorige stap heeft de Microsoft Test SDK, het NUnit-testframework en de NUnit-testadapter toegevoegd. Voeg nu 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-nunit
    unit-testing-using-nunit.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests
        Test Source Files
        PrimeService.Tests.csproj

Voer de volgende opdracht uit in de map unit-testing-using-nunit :

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

De eerste test maken

U schrijft één mislukte test, voert deze door en herhaalt het proces. Wijzig in de map PrimeService.Tests de naam van het bestand UnitTest1.cs in PrimeService_IsPrimeShould.cs en vervang de volledige inhoud door de volgende code:

using NUnit.Framework;
using Prime.Services;

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

        [SetUp]
        public void SetUp()
        {
            _primeService = new PrimeService();
        }

        [Test]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            var result = _primeService.IsPrime(1);

            Assert.That(result, Is.False, "1 should not be prime");
        }
    }
}

Het [TestFixture] kenmerk geeft een klasse aan die eenheidstests bevat. Het [Test] kenmerk geeft aan dat een methode een testmethode is.

Sla dit bestand op en voer de dotnet test opdracht uit om de tests en de klassebibliotheek te bouwen en de tests uit te voeren. De NUnit-testloper bevat het ingangspunt van het programma 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 de test wordt doorgegeven door de eenvoudigste code in de PrimeService klasse te schrijven 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-nunit. Met de dotnet test opdracht wordt een build voor het PrimeService project uitgevoerd en vervolgens voor het PrimeService.Tests project. Nadat u beide projecten hebt gebouwd, 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 [Test] kenmerk, maar dat wordt snel vervelend. Er zijn andere NUnit-kenmerken waarmee u een suite met vergelijkbare tests kunt schrijven. Een [TestCase] kenmerk wordt gebruikt om een reeks tests te maken die dezelfde code uitvoeren, maar verschillende invoerargumenten hebben. U kunt het [TestCase] kenmerk gebruiken om waarden voor deze invoer op te geven.

In plaats van nieuwe tests te maken, past u dit kenmerk toe om één gegevensgestuurde test te maken. De gegevensgestuurde test is een methode waarmee verschillende waarden worden getest die kleiner zijn dan twee, wat het laagste priemnummer is:

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

    Assert.That(result, Is.False, $"{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 Main methode in het bestand PrimeService.cs :

if (candidate < 2)

Blijf herhalen door meer tests, theorieën en 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 ook gestructureerd, zodat het toevoegen van nieuwe pakketten en tests deel uitmaakt van de standaardwerkstroom. U hebt zich het grootste deel van uw tijd en moeite geconcentreerd op het oplossen van de doelstellingen van de toepassing.

Share via