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

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

Создайте решение

В этом разделе описано, как создать решение, которое содержит проект исходного кода и тестовый проект. Полное решение имеет следующую структуру каталогов:

/unit-testing-using-dotnet-test
    unit-testing-using-dotnet-test.sln
    /PrimeService
        PrimeService.vb
        PrimeService.vbproj
    /PrimeService.Tests
        PrimeService_IsPrimeShould.vb
        PrimeServiceTests.vbproj

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

• Откройте окно оболочки.

• Выполните следующую команду:

  dotnet new sln -o unit-testing-using-dotnet-test
  

  Команда dotnet new sln создает новое решение в каталоге unit-testing-using-dotnet-test.

• Теперь перейдите в папку unit-testing-using-dotnet-test.

• Выполните следующую команду:

  dotnet new classlib -o PrimeService --lang VB
  

  Команда dotnet new classlib создает новый проект библиотеки классов в папке PrimeService. Новая библиотека классов будет содержать код для тестирования.

• Переименуйте Class1.vb в PrimeService.vb.

• Замените код файла PrimeService.vb кодом, приведенным ниже.

  Imports System
  
  Namespace Prime.Services
      Public Class PrimeService
          Public Function IsPrime(candidate As Integer) As Boolean
              Throw New NotImplementedException("Not implemented.")
          End Function
      End Class
  End Namespace
  

• Предыдущий код:

  • Создает исключение NotImplementedException с сообщением о том, что код не реализован.
  • Мы обновим его позже.

• Выполните приведенную ниже команду в каталоге unit-testing-using-dotnet-test, чтобы добавить в решение проект библиотеки классов.

  dotnet sln add ./PrimeService/PrimeService.vbproj
  

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

  dotnet new xunit -o PrimeService.Tests
  

• Предыдущая команда:

  • Создает проект PrimeService.Tests в каталоге PrimeService.Tests. В тестовом проекте используется библиотека тестов xUnit.
  • Настраивает средство выполнения теста, добавив следующие <PackageReference />элементы в файл проекта:
    • Microsoft.NET.Test.Sdk
    • xunit
    • xunit.runner.visualstudio

• Добавьте тестовый проект в файл решения, выполнив следующую команду:

  dotnet sln add ./PrimeService.Tests/PrimeService.Tests.vbproj
  

• Добавьте в проект PrimeService.Tests библиотеку классов PrimeService в качестве зависимости:

  dotnet add ./PrimeService.Tests/PrimeService.Tests.vbproj reference ./PrimeService/PrimeService.vbproj  
  

Команды для создания решения

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

Следующие команды создают тестовое решение на компьютере Windows. В macOS и UNIX измените в команде ren версию ОС на значение ren, чтобы переименовать файл:

dotnet new sln -o unit-testing-using-dotnet-test
cd unit-testing-using-dotnet-test
dotnet new classlib -o PrimeService
ren .\PrimeService\Class1.vb PrimeService.vb
dotnet sln add ./PrimeService/PrimeService.vbproj
dotnet new xunit -o PrimeService.Tests
dotnet add ./PrimeService.Tests/PrimeService.Tests.vbproj reference ./PrimeService/PrimeService.vbproj
dotnet sln add ./PrimeService.Tests/PrimeService.Tests.vbproj

Выполните инструкции по замене кода в файле PrimeService.vb, из предыдущего раздела.

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

Разработка на основе тестирования (TDD) обычно подразумевает написание теста до реализации целевого кода. В этом руководстве используется подход TDD. Метод IsPrime является вызываемым, но он пока не реализован. Тестовый вызов IsPrime завершается ошибкой. При использовании TDD мы создаем тест, который ожидаемо завершается ошибкой. Затем мы обновляем целевой код, чтобы пройти только созданный тест. Этот подход повторяется циклически: сначала вы создаете тест, который не выполняется, а затем обновляете целевой код, чтобы выполнить тест.

Обновите проект PrimeService.Tests.

• Удалите PrimeService.Tests/UnitTest1.vb.
• Создайте файл PrimeService.Tests/PrimeService_IsPrimeShould.vb.
• Замените код файла PrimeService_IsPrimeShould.vb кодом, приведенным ниже.

Imports Xunit

Namespace PrimeService.Tests
    Public Class PrimeService_IsPrimeShould
        Private ReadOnly _primeService As Prime.Services.PrimeService

        Public Sub New()
            _primeService = New Prime.Services.PrimeService()
        End Sub


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

            Assert.False(result, "1 should not be prime")
        End Sub

    End Class
End Namespace

Атрибут [Fact] объявляет метод теста, который выполняется средством выполнения тестов. В папке PrimeService.Tests выполните dotnet test. Команда dotnet test компилирует оба проекта и выполняет тесты. Средство запуска тестов xUnit содержит точку входа в программу для выполнения тестов. dotnet test запускает средство выполнения тестов, используя проект модульного тестирования.

Тест возвращает ошибку, так как мы еще не реализовали IsPrime. Согласно концепции TDD, нужно создавать только такой код, который позволит пройти этот тест. Обновите IsPrime, включив в него следующий код.

Public Function IsPrime(candidate As Integer) As Boolean
    If candidate = 1 Then
        Return False
    End If
    Throw New NotImplementedException("Not implemented.")
End Function

Запустите dotnet test. Тест будет пройден.

Добавьте дополнительные тесты.

Добавьте проверку простых чисел для 0 и -1. Можно скопировать предыдущий тест и изменить в нем код, чтобы использовать 0 и -1:

Dim result As Boolean = _primeService.IsPrime(1)

Assert.False(result, "1 should not be prime")

Копирование кода теста, в котором изменяется только один параметр, приводит к дублированию кода и раздуванию теста. Следующие атрибуты xUnit позволяют создавать набор сходных тестов.

• [Theory] представляет набор тестов, которые выполняют один и тот же код, но имеют разные входные аргументы.
• Атрибут [InlineData] задает значения для этих входных данных.

Чтобы не создавать новые тесты, примените указанные выше атрибуты xUnit для создания единой теории. Замените код

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

    Assert.False(result, "1 should not be prime")
End Sub

указанным ниже кодом:

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

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

В приведенном выше коде [Theory] и [InlineData] позволяют тестировать несколько значений, не превышающих 2. Число 2 является наименьшим простым числом.

Выполните команду dotnet test, и два теста завершатся ошибкой. Поместите следующие код в метод IsPrime, чтобы успешно пройти все тесты:

Public Function IsPrime(candidate As Integer) As Boolean
    If candidate < 2 Then
        Return False
    End If
    Throw New NotImplementedException("Not fully implemented.")
End Function

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

Составленный нами метод IsPrime не является эффективным алгоритмом для тестирования простых чисел.

Дополнительные ресурсы

• Официальный сайт xUnit.net
• Тестирование логики контроллера в ASP.NET Core
• dotnet add reference