Как написать модульный тест

Тестируемый код

Для написания юнит-теста мне понадобится пример, и я придумал следующий сценарий:

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

Код, который мы хотим протестировать, выглядит примерно так (читай: точно):

public class BugTracker
{
    private readonly IBugRepository _repository;
    private readonly IEmailClient _emailClient;




    public BugTracker(IBugRepository repository, IEmailClient emailClient)
    {
        _repository = repository;
        _emailClient = emailClient;
    }




    public Bug CreatNewBug(string title, Severity severity)
    {
        if (string.IsNullOrEmpty(title))
        {
            throw new ApplicationException("Title cannot be empty");
        }




        var newBug = new Bug
             {
                 Title = title,
                 Severity = severity
             };




        SaveBugToDb(newBug);




        // Here be code        




        return newBug;
    }

И так как мы заядлые практики TDD (Test Driven Design), мы начнем с написания теста в первую очередь.

Решите, что вы тестируете

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

Я обнаружил, что называние метода тестирования таким образом, что заставляет меня (и моих коллег-разработчиков) думать о том, что они собираются делать:

[TestFixture]
public class BugTrackerTests
{
    [Test]
    public void CreatNewBug_CreateBugHasHighestSeverity_SendEmailToProjectManager()
    {
        
    }
}

Я не придумал это соглашение об именах, но считаю его очень полезным. Название делится на три части:

1. Метод, который я тестирую — не описание, а сценарий, только название метода
2. Сценарий, который я тестирую
3. Что я ожидаю, что произойдет

Дополнительным преимуществом является то, что, когда этот тест не пройден — все, что мне нужно, это прочитать название теста, чтобы узнать, что пошло не так, — возьмите этот F5!

Существуют и другие похожие схемы именования — выберите одну и будьте настойчивы в этом.

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

Напишите тестируемый метод

Я начинаю с нуля и строю свой тест изнутри.

Сначала я создаю класс, который я тестирую, а затем я запускаю метод, который я тестирую.

[Test]
public void CreatNewBug_CreateBugHasHighestSeverity_SendEmailToProjectManager()
{
    var cut = new BugTracker();




    cut.CreatNewBug("my title", Severity.OhMyGod);
}

К сожалению, это даже не компилируется. Проблема в том, что мне нужно «накормить»
класс BugTracker двумя зависимостями типа
IBugRepository и
IEmailClient — так что давайте добавим их в качестве основы Isolation (в данном случае FakeItEasy):

[Test]
public void CreatNewBug_CreateBugHasHighestSeverity_SendEmailToProjectManager()
{
    var fakeBugRepository = A.Fake<IBugRepository>();
    var fakeEmailClient = A.Fake<IEmailClient>();




    var cut = new BugTracker(fakeBugRepository, fakeEmailClient);




    cut.CreatNewBug("my title", Severity.OhMyGod);
}

И теперь мы можем написать фактическое утверждение.

Напишите утверждение

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

[Test]
public void CreatNewBug_CreateBugHasHighestSeverity_SendEmailToProjectManager()
{
    var fakeBugRepository = A.Fake<IBugRepository>();
    var fakeEmailClient = A.Fake<IEmailClient>();




    var cut = new BugTracker(fakeBugRepository, fakeEmailClient);




    cut.CreatNewBug("my title", Severity.OhMyGod);




    A.CallTo(() => fakeEmailClient.Send("manager@project.com", "Don't Panic!")).MustHaveHappened();
}

Запустить тест

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

Тест не удался, но по неправильной причине:
кажется, у меня есть код внутри метода «SaveBugToDb», который выдает исключение:

private void SaveBugToDb(Bug newBug)
{
    if (!_repository.Connected)
    {
        throw new ApplicationException("Cannot access bug repository");
    }




    _repository.Save(newBug);
}

[Test]
public void CreatNewBug_CreateBugHasHighestSeverity_SendEmailToProjectManager()
{
    var fakeBugRepository = A.Fake<IBugRepository>();
    A.CallTo(() => fakeBugRepository.Connected).Returns(true);




    var fakeEmailClient = A.Fake<IEmailClient>();




    var cut = new BugTracker(fakeBugRepository, fakeEmailClient);




    cut.CreatNewBug("my title", Severity.OhMyGod);




    A.CallTo(() => fakeEmailClient.Send("manager@project.com", "Don't Panic!")).MustHaveHappened();
}

public Bug CreatNewBug(string title, Severity severity)
{
    if (string.IsNullOrEmpty(title))
    {
        throw new ApplicationException("Title cannot be empty");
    }




    var newBug = new Bug
         {
             Title = title,
             Severity = severity
         };




    SaveBugToDb(newBug);




    if (severity == Severity.OhMyGod)
    {
        _emailClient.Send("manager@project.com", "Don't Panic!");
    }




    return newBug;
}