Unittests für C# mit NUnit und .NET Core

  • Artikel

Dieses Tutorial führt Sie interaktiv Schritt für Schritt durch das Erstellen einer Beispielprojektmappe, um die Konzepte von Komponententests zu erlernen. Wenn Sie dem Tutorial lieber mit einer vorgefertigten Projektmappe folgen, zeigen Sie den Beispielcode an, oder laden Sie ihn herunter, bevor Sie beginnen. Anweisungen zum Herunterladen finden Sie unter Beispiele und Lernprogramme.

Dieser Artikel befasst sich mit dem Testen eines .NET Core-Projekts. Wenn Sie ein ASP.NET Core-Projekt testen, finden Sie weitere Informationen unter Integrationstests in ASP.NET Core.

Voraussetzungen

  • .NET 8.0 oder spätere Versionen.
  • Ein Text-Editor oder Code-Editor Ihrer Wahl.

Erstellen des Quellprojekts

Öffnen eines Shell-Fensters. Erstellen Sie ein Verzeichnis namens unit-testing-using-nunit, um die Projektmappe zu speichern. Führen Sie in diesem neuen Verzeichnis den folgenden Befehl aus, um eine neue Projektmappendatei für die Klassenbibliothek und das Testprojekt zu erstellen:

dotnet new sln

Erstellen Sie als Nächstes ein PrimeService-Verzeichnis. Die folgende Gliederung zeigt die bisherige Verzeichnis- und Dateistruktur:

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

Machen Sie PrimeService zum aktuellen Verzeichnis, und führen Sie den folgenden Befehl aus, um das Quellprojekt zu erstellen:

dotnet new classlib

Benennen Sie Class1.cs in PrimeService.cs um. Erstellen Sie eine fehlerhafte Implementierung der PrimeService-Klasse:

using System;

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

Ändern Sie das Verzeichnis wieder in das Verzeichnis unit-testing-using-nunit. Führen Sie den folgenden Befehl aus, um das Klassenbibliotheksprojekt zur Projektmappe hinzuzufügen:

dotnet sln add PrimeService/PrimeService.csproj

Erstellen des Testprojekts

Erstellen Sie als Nächstes das Verzeichnis PrimeService.Tests. Die folgende Gliederung zeigt die Verzeichnisstruktur:

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

Machen Sie das Verzeichnis PrimeService.Tests zum aktuellen Verzeichnis, und erstellen Sie mit dem folgenden Befehl ein neues Projekt:

dotnet new nunit

Mit dem Befehl dotnet new wird ein Testprojekt erstellt, in dem NUnit als Testbibliothek verwendet wird. Die generierte Vorlage konfiguriert das Testprogramm in der Datei PrimeServiceTests.csproj:

<ItemGroup>
  <PackageReference Include="nunit" Version="4.1.0" />
  <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
  <PackageReference Include="NUnit.Analyzers" Version="4.1.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
</ItemGroup>

Hinweis

Vor .NET 9 verweist der generierte Code möglicherweise auf ältere Versionen des NUnit-Testframeworks. Sie können die dotnet-CLI zum Aktualisieren der Pakete verwenden. Öffnen Sie alternativ die Datei PrimeService.Tests.csproj, und ersetzen Sie den Inhalt der Elementgruppe mit Paketverweisen durch den obigen Code.

Für das Testprojekt sind weitere Pakete zum Erstellen und Ausführen von Unittests erforderlich. Der Befehl dotnet new im vorherigen Schritt fügte das Microsoft-Test-SDK, das NUnit-Testframework und den NUnit-Testadapter hinzu. Fügen Sie jetzt die PrimeService-Klassenbibliothek als weitere Abhängigkeit zum Projekt hinzu. Verwenden Sie den Befehl dotnet add reference:

dotnet add reference ../PrimeService/PrimeService.csproj

Die ganze Datei finden Sie im Beispielerepository auf GitHub.

Die folgende Gliederung zeigt das endgültige Projektmappenlayout:

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

Führen Sie im Verzeichnis unit-testing-using-nunit den folgenden Befehl aus:

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

Erstellen des ersten Tests

Sie schreiben einen fehlerhaften Test, lassen ihn als bestanden gelten und wiederholen dann den Prozess. Benennen Sie im Verzeichnis PrimeService.Tests die Datei UnitTest1.cs in PrimeService_IsPrimeShould.cs um, und ersetzen Sie die zugehörigen Inhalte durch Inhalte mit dem folgenden 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");
        }
    }
}

Das [TestFixture]-Attribut gibt eine Klasse an, die Unittests enthält. Das [Test]-Attribut gibt an, dass es sich bei einer Methode um eine Testmethode handelt.

Speichern Sie diese Datei, und führen Sie den dotnet test-Befehl aus, um die Tests und die Klassenbibliothek zu erstellen und die Tests auszuführen. Der NUnit Test Runner enthält den Programmeinstiegspunkt zum Ausführen Ihrer Tests. dotnet test startet Test Runner mithilfe des von Ihnen erstellten Komponententestprojekts.

Ihr Test schlägt fehl. Sie haben die Implementierung noch nicht erstellt. Damit dieser Test erfolgreich verläuft, schreiben Sie einen ganz einfachen, funktionierenden Code in die PrimeService-Klasse:

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

Führen Sie im Verzeichnis unit-testing-using-nunit erneut dotnet test aus. Der dotnet test-Befehl führt einen Build für das PrimeService-Projekt und anschließend für das PrimeService.Tests-Projekt aus. Nachdem Sie beide Projekte erstellt haben, wird dieser einzelne Test ausgeführt. Er ist erfolgreich.

Hinzufügen weiterer Features

Nachdem Sie dafür gesorgt haben, dass ein Test erfolgreich verläuft, schreiben Sie weiter. Es gibt einige weitere einfache Fälle für Primzahlen: 0, -1. Sie könnten diese neuen Tests mit dem Attribut [Test] hinzufügen, aber das wird schnell recht mühsam. Es gibt andere NUnit-Attribute, mit deren Hilfe Sie eine Reihe ähnlicher Tests schreiben können. Ein [TestCase]-Attribut wird verwendet, um eine Reihe von Tests zu erstellen, die zwar denselben Code ausführen, jedoch unterschiedliche Eingabeargumente verwenden. Sie können das Attribut [TestCase] verwenden, um Werte für diese Eingaben anzugeben.

Statt neue Tests zu erstellen, wenden Sie dieses Attribut zum Erstellen eines einzelnen datengesteuerten Tests an. Bei dem datengesteuerten Test handelt es sich um eine Methode, die mehrere Werte unter zwei als niedrigste Primzahl testet:

[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");
}

Führen Sie dotnet test aus und zwei dieser Tests schlagen fehl. Damit alle Tests erfolgreich sind, müssen Sie in der Datei PrimeService.cs am Anfang der Methode Main die if-Klausel ändern:

if (candidate < 2)

Wiederholen Sie den Vorgang, indem Sie weitere Tests, Theorien und Code in der Hauptbibliothek hinzufügen. Sie verfügen über die endgültige Version der Tests und die vollständige Implementierung der Bibliothek.

Sie haben eine kleine Bibliothek und eine Reihe von Unittests für diese Bibliothek erstellt. Sie haben die Projektmappe auch so strukturiert, dass das Hinzufügen neuer Pakete und Tests Teil des Standardworkflows ist. Sie haben den Großteil Ihrer Zeit und Ihres Aufwands mit der Erreichung der Anwendungsziele verbracht.