Начало работы с C# и MSTest

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

В этой статье описывается тестирование проекта .NET Core. Если вы тестируете проект ASP.NET Core, см. тесты интеграции в ASP.NET Core.

Предпосылки

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

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

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

Сделайте PrimeService текущим каталогом и запустите dotnet new classlib для создания исходного проекта.

Измените каталог обратно в каталог unit-testing-using-mstest. Запустите dotnet sln add, чтобы добавить проект библиотеки классов в решение:

dotnet sln add PrimeService/PrimeService.csproj

Переименуйте Class1.cs в каталоге PrimeService в PrimeService.cs. Замените код в файле следующим кодом, чтобы создать неудачную реализацию класса PrimeService:

using System;

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

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

Создайте каталог PrimeService.Tests. В следующей схеме показана структура каталога:

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

Сделайте каталог PrimeService.Tests текущим каталогом и создайте новый проект с помощью dotnet new mstest. Команда dotnet new создает тестовый проект, использующий MSTest в качестве тестовой библиотеки. Шаблон настраивает тестовый запуск в файле PrimeServiceTests.csproj:

<ItemGroup>
  <PackageReference Include="MSTest" Version="4.1.0" />
</ItemGroup>

Note

Показанные версии пакетов приведены в качестве примеров. Версии, созданные с помощью dotnet new mstest, зависят от вашего пакета SDK .NET. Шаблоны и скачанные примеры могут не использовать последние версии пакетов NuGet.

Чтобы проверить наличие обновлений после создания и запуска тестов, запустите dotnet package list --outdated из каталога тестового проекта. Используйте dotnet package add <PACKAGE_NAME> для обновления ссылки на пакет до последней совместимой стабильной версии. Просмотрите заметки о выпуске на предмет изменений, нарушающих совместимость, перед обновлением и снова запустите dotnet test после этого.

Если вы используете пакет SDK .NET 9 или более ранних версий, используйте dotnet list package --outdated и dotnet add package <PACKAGE_NAME> вместо этого.

Тестовый проект требует создания и запуска модульных тестов других пакетов. dotnet new на предыдущем шаге добавил необходимые пакеты и средства MSTest для создания отчетов о покрытии кода.

Добавьте библиотеку классов PrimeService в качестве другой зависимости в проект. Используйте команду dotnet reference add:

dotnet reference add ../PrimeService/PrimeService.csproj

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

В следующей схеме показан окончательный макет решения:

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

Перейдите в каталог unit-testing-using-mstest и запустите dotnet sln add:

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

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

Напишите тест, который не проходит, сделайте его проходящим, затем повторите этот процесс. Удалите UnitTest1.cs из каталога PrimeService.Tests и создайте файл C# с именем PrimeService_IsPrimeShould.cs со следующим содержимым:

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Prime.Services;

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

        public PrimeService_IsPrimeShould()
        {
            _primeService = new PrimeService();
        }

        [TestMethod]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            bool result = _primeService.IsPrime(1);

            Assert.IsFalse(result, "1 shouldn't be prime");
        }
    }
}

Атрибут TestClass обозначает класс, содержащий модульные тесты. Атрибут TestMethod указывает, что метод является методом теста.

MSTest создает новый экземпляр тестового класса для каждого теста, поэтому конструктор создает отдельный PrimeService экземпляр для каждого теста. Конструктор содержит только настройку, необходимую каждому тесту в этом классе. Если тесты нуждаются в другой настройке, создайте объекты в методах тестирования или вызовите вспомогательные методы из этих методов. Инструкции см. в разделе "Использование вспомогательных методов вместо установки и разборки".

Сохраните этот файл и выполните dotnet test, чтобы создать тесты и библиотеку классов, а затем запустить тесты. Средство выполнения тестов MSTest содержит точку входа программы, чтобы запустить ваши тесты. dotnet test запускает тест-раннер, используя созданный вами проект модульного теста.

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

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

В директории unit-testing-using-mstest запустите dotnet test еще раз. Команда dotnet test запускает сборку для проекта PrimeService, а затем для проекта PrimeService.Tests. После создания обоих проектов он запускает этот единичный тест. Это пройдет.

Добавление дополнительных функций

Теперь, когда вы сделали один тестовый проход, пришло время написать больше. Существует несколько других простых случаев для простых чисел: 0, -1. Вы можете добавить новые тесты с помощью атрибута TestMethod, но это быстро становится утомительно. Существуют другие атрибуты MSTest, позволяющие создавать набор аналогичных тестов. Метод теста может выполнять один и тот же код, но иметь разные входные аргументы. Атрибут dataRow можно использовать для указания значений для этих входных данных.

Вместо создания новых тестов примените эти два атрибута для создания одного управляемого данными теста. Тест на основе данных — это метод, который проверяет несколько значений менее двух значений, что является самым низким простым числом. Добавьте новый метод теста в PrimeService_IsPrimeShould.cs:

[TestMethod]
[DataRow(-1)]
[DataRow(0)]
[DataRow(1)]
public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
{
    bool result = _primeService.IsPrime(value);

    Assert.IsFalse(result, $"{value} should not be prime");
}

Запустите dotnet test, и два из этих тестов завершаются с ошибкой. Чтобы выполнить все тесты, измените предложение if в начале метода IsPrime в файле PrimeService.cs:

if (candidate < 2)

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

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

Запуск тестов в Azure Pipelines

Чтобы выполнять тесты автоматически при отправке изменений, добавьте конфигурацию Azure Pipelines в репозиторий, содержащий готовое решение. Вам нужен проект Azure DevOps и доступ к агенту, размещенному Microsoft-hosted. Предварительные требования см. в разделе Создание первого конвейера.

  1. В корне репозитория создайте azure-pipelines.yml файл со следующим содержимым. В примере предполагается, что каталоги PrimeService и PrimeService.Tests находятся в корневом каталоге репозитория, а оба проекта предназначены для .NET 10.

    trigger:
    - main
    
    pool:
      vmImage: ubuntu-latest
    
    steps:
    - task: UseDotNet@2
      displayName: Install .NET SDK
      inputs:
        packageType: sdk
        version: 10.0.x
    
    - task: DotNetCoreCLI@2
      displayName: Run MSTest tests
      inputs:
        command: test
        projects: PrimeService.Tests/PrimeService.Tests.csproj
        arguments: --configuration Release
        publishTestResults: true
    
  2. Настройте конфигурацию под ваш репозиторий:

    • Если ветвь имеет другое имя, замените main в trigger именем этой ветви.
    • Если решение находится в подкаталоге, обновите projects до пути тестового проекта относительно корневого каталога репозитория.
    • Если проекты нацелены на другую версию .NET, измените version в задаче UseDotNet@2 соответственно. Например, используйте 8.0.x для проектов, ориентированных на net8.0. Если репозиторий содержит файл global.json, убедитесь, что установленный пакет SDK соответствует требованиям к версии.
  3. Зафиксируйте и отправьте решение и файл azure-pipelines.yml в свой Git-репозиторий.

  4. В проекте Azure DevOps выберите Конвейеры>Новый конвейер или Создать конвейер, если это первый конвейер. Выберите поставщика репозитория и репозиторий.

  5. На странице "Настройка конвейера" выберите существующий Azure Pipelines YAML-файл, выберите ветвь и /azure-pipelines.yml, а затем выберите Продолжить. Просмотрите конфигурацию и выберите Выполнить.

UseDotNet@2 задача устанавливает пакет SDK .NET. ЗадачаDotNetCoreCLI@2 запускает dotnet test, который восстанавливает зависимости, собирает тестовый проект и связанную с ним библиотеку и выполняет тесты в конфигурации Release.

При этом publishTestResults: trueзадача создает файл результатов TRX и публикует результаты, даже если тест завершается сбоем. После выполнения конвейера откройте вкладку Тесты конвейера, чтобы просмотреть успешные и неуспешные тесты. Неудачный тест также приводит к сбою задачи тестирования и конвейера.

Note

В этом примере используется конфигурация VSTest по умолчанию из dotnet new mstest с использованием пакета SDK .NET 10. Если включить Microsoft.Testing.Platform (MTP), см. статью Выполнение тестов MTP в непрерывной интеграции для требуемой конфигурации runner.

См. также