Модульное тестирование библиотек .NET Core в Visual Basic с использованием dotnet test и NUnit

Статья
03/27/2024

Этот учебник описывает пошаговую процедуру по созданию примера решения для изучения концепций модульного тестирования. Если при изучении учебника вы предпочитаете использовать готовое решение, просмотрите или скачайте пример кода перед началом работы. Инструкции по загрузке см. в разделе Просмотр и скачивание примеров.

Эта статья посвящена тестированию проекта .NET Core. Если вы тестируете проект ASP.NET Core, ознакомьтесь с тестами интеграции в ASP.NET Core.

Необходимые компоненты

Пакет SDK для .NET 8 или более поздние версии.
Текстовый редактор или редактор кода по вашему выбору.

Создание исходного проекта

Откройте окно оболочки. Создайте каталог с именем unit-testing-vb-nunit для хранения решения. В этом каталоге выполните следующую команду, чтобы создать файл решения для библиотеки классов и тестового проекта:

dotnet new sln

Затем создайте каталог PrimeService. Ниже приведена актуальная структура файлов:

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

Перейдите в каталог PrimeService и выполните следующую команду, чтобы создать исходный проект:

dotnet new classlib -lang VB

Переименуйте Class1.VB в PrimeService.VB. Создайте сбойную реализацию класса PrimeService:

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

Вернитесь в каталог unit-testing-vb-using-mstest. Чтобы добавить проект библиотеки классов в решение, выполните следующую команду:

dotnet sln add .\PrimeService\PrimeService.vbproj

Создание тестового проекта

Затем создайте каталог PrimeService.Tests. Ниже представлена структура каталогов:

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

Перейдите в каталог PrimeService.Tests и создайте проект, выполнив следующую команду:

dotnet new nunit -lang VB

Команда dotnet new создает тестовый проект, который использует NUnit в качестве библиотеки тестов. Созданный шаблон позволяет настроить средство выполнения тестов в файле 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>

Примечание.

До .NET 9 созданный код может ссылаться на старые версии платформы тестирования NUnit. Вы можете использовать dotnet CLI для обновления пакетов. Кроме того, откройте файл PrimeService.Tests.vbproj и замените содержимое группы элементов ссылки на пакет приведенным выше кодом.

Тестовый проект требует других пакетов для создания и выполнения модульных тестов. Команда dotnet new на предыдущем шаге добавляет NUnit и адаптер тестирования NUnit. Теперь добавьте в проект библиотеку классов PrimeService в качестве еще одной зависимости. Используйте команду dotnet add reference:

dotnet add reference ../PrimeService/PrimeService.vbproj

Все содержимое файла можно просмотреть в репозитории образцов на сайте GitHub.

Ниже показан окончательный макет решения:

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

Выполните следующую команду в каталоге unit-testing-vb-nunit:

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

Создание первого теста

Напишите один тест сбоя теста, запустите его, а затем повторите этот процесс. В каталоге PrimeService.Tests переименуйте файл UnitTest1.vb в PrimeService_IsPrimeShould.VB и замените его содержимое следующим кодом:

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

Атрибут <TestFixture> указывает класс, который содержит тесты. Атрибут <Test> обозначает метод, который выполняется с помощью средства выполнения тестов. Из каталога unit-testing-vb-nunit выполните команду dotnet test для создания тестов и библиотеки классов, а затем выполните тесты. Средство запуска тестов NUnit содержит точку входа в программу для выполнения тестов. dotnet test запускает средство выполнения тестов с помощью проекта модульного теста, который вы создали.

Тест не будет пройден. Вы еще не создали реализацию. Чтобы тест был пройден, напишите простейший код в классе PrimeService, который работает:

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

Выполните команду dotnet test еще раз в каталоге unit-testing-vb-nunit. Команда dotnet test запускает сборку для проекта PrimeService и затем для проекта PrimeService.Tests. После сборки обоих проектов она запускает этот отдельный тест. Он выполняется.

Добавление дополнительных возможностей

Теперь, когда тест проходит успешно, пора создать дополнительные тесты. Есть еще ряд элементарных случаев с простыми числами: 0, -1. Можно добавить их в качестве тестов с помощью атрибута <Test>, но это скоро станет утомительным. Есть другие атрибуты xUnit, которые позволяют создавать наборы похожих тестов. Атрибут <TestCase> представляет набор тестов, которые выполняют один и тот же код, но имеют разные входные аргументы. С помощью атрибута <TestCase> можно указать значения для этих входных аргументов.

Вместо создания тестов примените эти два атрибута, чтобы создать последовательность тестов, которая проверяет несколько значений меньше 2, то есть наименьшего простого числа.

<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

Выполните команду dotnet test, и два из этих тестов завершаются ошибкой. Для успешного выполнения всех тестов нужно изменить предложение if в начале метода Main в файле PrimeServices.cs:

if candidate < 2

Продолжайте итерации, добавляя тесты, алгоритмы и код в главной библиотеке. В результате вы получите готовую версию тестов и полную реализацию библиотеки.

Вы создали небольшую библиотеку и набор модульных тестов для нее. Вы структурировали решение, чтобы сделать добавление новых пакетов и тестов частью обычного рабочего процесса и получить возможность сосредоточиться на задачах приложения.