Testowanie jednostkowe bibliotek platformy .NET Core w języku Visual Basic przy użyciu testów dotnet i NUnit

  • Artykuł

Ten samouczek przeprowadzi Cię przez interaktywne środowisko tworzenia przykładowego rozwiązania krok po kroku, aby poznać pojęcia dotyczące testowania jednostkowego. Jeśli wolisz wykonać czynności opisane w samouczku przy użyciu wstępnie utworzonego rozwiązania, przed rozpoczęciem wyświetl lub pobierz przykładowy kod . Aby uzyskać instrukcje dotyczące pobierania, zobacz Przykłady i samouczki.

Ten artykuł dotyczy testowania projektu platformy .NET Core. Jeśli testujesz projekt ASP.NET Core, zobacz Testy integracji w programie ASP.NET Core.

Wymagania wstępne

Tworzenie projektu źródłowego

Otwórz okno powłoki. Utwórz katalog o nazwie unit-testing-vb-nunit do przechowywania rozwiązania. W tym nowym katalogu uruchom następujące polecenie, aby utworzyć nowy plik rozwiązania dla biblioteki klas i projektu testowego:

dotnet new sln

Następnie utwórz katalog PrimeService . Na poniższym konspekcie przedstawiono strukturę plików do tej pory:

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

Utwórz bieżący katalog PrimeService i uruchom następujące polecenie, aby utworzyć projekt źródłowy:

dotnet new classlib -lang VB

Zmień nazwę Class1.VB na PrimeService.VB. Tworzenie implementacji klasy kończy PrimeService się niepowodzeniem:

Namespace Prime.Services
    Public Class PrimeService
        Public Function IsPrime(candidate As Integer) As Boolean
            Throw New NotImplementedException("Please create a test first.")
        End Function
    End Class
End Namespace

Zmień katalog z powrotem na katalog unit-testing-vb-using-mstest . Uruchom następujące polecenie, aby dodać projekt biblioteki klas do rozwiązania:

dotnet sln add .\PrimeService\PrimeService.vbproj

Tworzenie projektu testowego

Następnie utwórz katalog PrimeService.Tests . W poniższym konspekcie przedstawiono strukturę katalogów:

/unit-testing-vb-nunit
    unit-testing-vb-nunit.sln
    /PrimeService
        Source Files
        PrimeService.vbproj
    /PrimeService.Tests

Utwórz katalog PrimeService.Tests jako bieżący katalog i utwórz nowy projekt przy użyciu następującego polecenia:

dotnet new nunit -lang VB

Polecenie dotnet new tworzy projekt testowy, który używa narzędzia NUnit jako biblioteki testowej. Wygenerowany szablon konfiguruje moduł uruchamiający testy w pliku PrimeServiceTests.vbproj :

<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" />
</ItemGroup>

Uwaga

Przed platformą .NET 9 wygenerowany kod może odwoływać się do starszych wersji platformy testowej NUnit. Do zaktualizowania pakietów można użyć interfejsu wiersza polecenia dotnet. Alternatywnie otwórz plik PrimeService.Tests.vbproj i zastąp zawartość grupy elementów odwołania do pakietu kodem powyżej.

Projekt testowy wymaga innych pakietów do tworzenia i uruchamiania testów jednostkowych. dotnet new w poprzednim kroku dodano element NUnit i kartę testową NUnit. Teraz dodaj bibliotekę PrimeService klas jako inną zależność do projektu. dotnet add reference Użyj polecenia :

dotnet add reference ../PrimeService/PrimeService.vbproj

Cały plik można zobaczyć w repozytorium przykładów w witrynie GitHub.

Masz następujący końcowy układ rozwiązania:

/unit-testing-vb-nunit
    unit-testing-vb-nunit.sln
    /PrimeService
        Source Files
        PrimeService.vbproj
    /PrimeService.Tests
        Test Source Files
        PrimeService.Tests.vbproj

Wykonaj następujące polecenie w katalogu unit-testing-vb-nunit :

dotnet sln add .\PrimeService.Tests\PrimeService.Tests.vbproj

Tworzenie pierwszego testu

Napisz jeden test zakończony niepowodzeniem, wykonaj go pomyślnie, a następnie powtórz ten proces. W katalogu PrimeService.Tests zmień nazwę pliku UnitTest1.vb na PrimeService_IsPrimeShould.VB i zastąp całą jego zawartość następującym kodem:

Imports NUnit.Framework

Namespace PrimeService.Tests
    <TestFixture>
    Public Class PrimeService_IsPrimeShould
        Private _primeService As Prime.Services.PrimeService = New Prime.Services.PrimeService()

        <Test>
        Sub IsPrime_InputIs1_ReturnFalse()
            Dim result As Boolean = _primeService.IsPrime(1)

            Assert.That(result, [Is].False, $"1 should not be prime")
        End Sub

    End Class
End Namespace

Atrybut <TestFixture> wskazuje klasę zawierającą testy. Atrybut <Test> określa metodę uruchamianą przez moduł uruchamiający testy. W pliku unit-testing-vb-nunit wykonaj polecenie dotnet test , aby skompilować testy i bibliotekę klas, a następnie uruchomić testy. Moduł uruchamiający testy NUnit zawiera punkt wejścia programu do uruchamiania testów. dotnet test uruchamia moduł uruchamiający testy przy użyciu utworzonego projektu testów jednostkowych.

Test kończy się niepowodzeniem. Implementacja nie została jeszcze utworzona. Wykonaj ten test, pisząc najprostszy kod w PrimeService klasie, która działa:

Public Function IsPrime(candidate As Integer) As Boolean
    If candidate = 1 Then
        Return False
    End If
    Throw New NotImplementedException("Please create a test first.")
End Function

W katalogu unit-testing-vb-nunit ponownie uruchom polecenie dotnet test . Polecenie dotnet test uruchamia kompilację dla PrimeService projektu, a następnie dla PrimeService.Tests projektu. Po utworzeniu obu projektów zostanie uruchomiony ten pojedynczy test. Przechodzi.

Dodawanie większej liczby funkcji

Teraz, gdy wykonano jeden test, nadszedł czas, aby napisać więcej. Istnieje kilka innych prostych przypadków dla liczb pierwszych: 0, -1. Można dodać te przypadki jako nowe testy z atrybutem <Test> , ale to szybko staje się żmudne. Istnieją inne atrybuty xUnit, które umożliwiają pisanie zestawu podobnych testów. Atrybut <TestCase> reprezentuje zestaw testów, które wykonują ten sam kod, ale mają różne argumenty wejściowe. Możesz użyć atrybutu <TestCase> , aby określić wartości dla tych danych wejściowych.

Zamiast tworzyć nowe testy, zastosuj te dwa atrybuty, aby utworzyć serię testów, które testuje kilka wartości mniejszych niż dwa, co jest najmniejszą liczbą pierwszą:

<TestFixture>
Public Class PrimeService_IsPrimeShould
    Private _primeService As Prime.Services.PrimeService = New Prime.Services.PrimeService()

    <TestCase(-1)>
    <TestCase(0)>
    <TestCase(1)>
    Sub IsPrime_ValuesLessThan2_ReturnFalse(value As Integer)
        Dim result As Boolean = _primeService.IsPrime(value)

        Assert.That(result, [Is].False, $"{value} should not be prime")
    End Sub

    <TestCase(2)>
    <TestCase(3)>
    <TestCase(5)>
    <TestCase(7)>
    Public Sub IsPrime_PrimesLessThan10_ReturnTrue(value As Integer)
        Dim result As Boolean = _primeService.IsPrime(value)

        Assert.That(result, [Is].True, $"{value} should be prime")
    End Sub

    <TestCase(4)>
    <TestCase(6)>
    <TestCase(8)>
    <TestCase(9)>
    Public Sub IsPrime_NonPrimesLessThan10_ReturnFalse(value As Integer)
        Dim result As Boolean = _primeService.IsPrime(value)

        Assert.That(result, [Is].False, $"{value} should not be prime")
    End Sub
End Class

Uruchom polecenie dotnet test, a dwa z tych testów kończą się niepowodzeniem. Aby wszystkie testy przeszły pomyślnie, zmień klauzulę if na początku Main metody w pliku PrimeServices.cs :

if candidate < 2

Kontynuuj iterowanie, dodając więcej testów, więcej teorii i więcej kodu w bibliotece głównej. Masz ukończoną wersję testów i kompletną implementację biblioteki.

Utworzono małą bibliotekę i zestaw testów jednostkowych dla tej biblioteki. Rozwiązanie zostało ustrukturyzowane tak, aby dodawanie nowych pakietów i testów było częścią normalnego przepływu pracy. Większość czasu i nakładu pracy na rozwiązywaniu celów aplikacji koncentrujesz się przez większość czasu i wysiłku.