Использование стабов для изоляции частей приложения друг от друга для модульного тестирования

Типы заглушек — это важная технология, предоставляемая платформой Microsoft Fakes, которая позволяет легко изолировать тестируемый компонент от других компонентов, на которые он полагается. Заглушка выступает в качестве небольшого фрагмента кода, заменяющего другой компонент во время тестирования. Ключевым преимуществом использования заглушек является возможность получать стабильные результаты, что облегчает написание тестов. Даже если другие компоненты еще не полностью функциональны, вы по-прежнему можете выполнять тесты с помощью заглушек.

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

Например, рассмотрим схему, которая иллюстрирует задействованные компоненты:

Схема классов Real и Stub в StockAnalyzer.

На этой схеме тестируемый компонент, StockAnalyzerкак правило, зависит от другого компонента RealStockFeed. Однако RealStockFeed создает проблему для тестирования, так как оно возвращает разные результаты при каждом вызове методов. Эта изменчивость затрудняет обеспечение согласованного и надежного StockAnalyzerтестирования.

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

Ниже приведен пример использования внедрения зависимостей в коде:

public int GetContosoPrice(IStockFeed feed) => feed.GetSharePrice("COOO");

Ограничения заглушки

Ознакомьтесь со следующими ограничениями для заглушек.

Создание заглушки: пошаговое руководство

Давайте начнем это упражнение с мотивирующим примером: одним из них, показанным на предыдущей схеме.

Создание библиотеки классов

Выполните следующие действия, чтобы создать библиотеку классов.

  1. Откройте Visual Studio и создайте проект библиотеки классов .

    Снимок экрана: проект библиотеки классов в Visual Studio.

  2. Настройте атрибуты проекта:

    • Установите имя проекта на StockAnalysis.
    • Задайте для имени решения значение StubsTutorial.
    • Установите целевую платформу проекта на .NET 8.0 или более позднюю версию.

  3. Удалите файл по умолчанию Class1.cs.

  4. Добавьте новый файл с именем IStockFeed.cs и скопируйте его в следующее определение интерфейса:

    // IStockFeed.cs
public interface IStockFeed
{
    int GetSharePrice(string company);
}

  5. Добавьте еще один новый файл с именем StockAnalyzer.cs и скопируйте его в следующее определение класса:

    // StockAnalyzer.cs
public class StockAnalyzer
{
    private IStockFeed stockFeed;
    public StockAnalyzer(IStockFeed feed)
    {
        stockFeed = feed;
    }
    public int GetContosoPrice()
    {
        return stockFeed.GetSharePrice("COOO");
    }
}

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

Создайте тестовый проект для упражнения.

  1. Щелкните правой кнопкой мыши решение и добавьте новый проект с именем MSTest Test Project.

  2. Задайте для имени проекта значение TestProject.

  3. Задайте целевую платформу проекта для .NET 8.0 или более поздней версии.

    Снимок экрана: тестовый проект в Visual Studio.

Добавить сборку Fakes

Добавьте сборку Fakes для проекта.

  1. Добавьте ссылку проекта на StockAnalyzer.

    Снимок экрана: команда

  2. Добавьте сборку Fakes.

    1. В обозревателе решений найдите ссылку на сборку:

      • Для старого проекта .NET Framework (не в стиле SDK) раскройте узел Ссылки в проекте модульного тестирования.

      • Для проекта в стиле SDK, предназначенного для .NET Framework, .NET Core или .NET 5.0 и более поздних версий, раскройте узел зависимостей, чтобы найти сборку, которую вы хотите замокировать в разделе сборки, проекты или пакеты.

      • Если вы работаете в Visual Basic, выберите "Показать все файлы " на панели инструментов обозревателя решений , чтобы просмотреть узел "Ссылки ".

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

    3. В контекстном меню выберите "Добавить фиктивную сборку".

      Снимок экрана: команда Add Fakes Assembly.

Создание модульного теста

Теперь создайте модульный тест.

  1. Измените файл по умолчанию UnitTest1.cs , чтобы добавить следующее Test Method определение.

    [TestClass]
class UnitTest1
{
    [TestMethod]
    public void TestContosoPrice()
    {
        // Arrange:
        int priceToReturn = 345;
        string companyCodeUsed = "";
        var componentUnderTest = new StockAnalyzer(new StockAnalysis.Fakes.StubIStockFeed()
        {
            GetSharePriceString = (company) =>
            {
                // Store the parameter value:
                companyCodeUsed = company;
                // Return the value prescribed by this test:
                return priceToReturn;
            }
        });

        // Act:
        int actualResult = componentUnderTest.GetContosoPrice();

        // Assert:
        // Verify the correct result in the usual way:
        Assert.AreEqual(priceToReturn, actualResult);

        // Verify that the component made the correct call:
        Assert.AreEqual("COOO", companyCodeUsed);
    }
}

    Особый элемент магии — это класс StubIStockFeed. Для каждого интерфейса в указанной сборке механизм Microsoft Fakes создает класс заглушки. Имя класса заглушки является производным от имени интерфейса с "Fakes.Stub" в качестве префикса, а имена типов параметров добавляются в конце.

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

    Снимок экрана: обозреватель решений, показывающий все файлы.

  2. Откройте обозреватель тестов и запустите тест.

    Снимок экрана: обозреватель тестов.

Заглушки для различных типов элементов типа

Существуют заглушки для различных типов элементов типа.

Методы

В приведенном примере методы можно подменять путем присоединения делегата к экземпляру заглушечного класса. Имя типа заглушки является производным от имен метода и параметров. Например, рассмотрим следующий IStockFeed интерфейс и его метод GetSharePrice:

// IStockFeed.cs
interface IStockFeed
{
    int GetSharePrice(string company);
}

Прикрепляем заглушку к GetSharePrice путём использования GetSharePriceString:

// unit test code
var componentUnderTest = new StockAnalyzer(new StockAnalysis.Fakes.StubIStockFeed()
        {
            GetSharePriceString = (company) =>
            {
                // Store the parameter value:
                companyCodeUsed = company;
                // Return the value prescribed by this test:
                return priceToReturn;
            }
        });

Если вы не предоставляете заглушку для метода, Fakes создает функцию, которая возвращает default value тип возвращаемого значения. Для чисел значение по умолчанию равно 0. По умолчанию для типов классов: null язык C# или Nothing язык Visual Basic.

Свойства

Методы получения свойств и методы задания предоставляются в виде отдельных делегатов и могут быть помечены по отдельности. Например, рассмотрим Value свойство IStockFeedWithProperty:

interface IStockFeedWithProperty
{
    int Value { get; set; }
}

Чтобы заглушить геттер и сеттер Value и создать автоматическое свойство, можно использовать следующий код:

// unit test code
int i = 5;
var stub = new StubIStockFeedWithProperty();
stub.ValueGet = () => i;
stub.ValueSet = (value) => i = value;

Если вы не предоставляете методы заглушки для метода задания или получения свойства, Fakes создает заглушку, которая сохраняет значения, что делает свойство заглушки поведением простой переменной.

Events

События предоставляются как поля делегатов, что позволяет любому заглушенному событию быть вызванным через простое обращение к соответствующему полю. Рассмотрим следующий интерфейс для создания заглушки:

interface IStockFeedWithEvents
{
    event EventHandler Changed;
}

Чтобы инициировать событие Changed, вызовите поддерживающий делегат:

// unit test code
var withEvents = new StubIStockFeedWithEvents();
// raising Changed
withEvents.ChangedEvent(withEvents, EventArgs.Empty);

Универсальные методы

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

interface IGenericMethod
{
    T GetValue<T>();
}

Вы можете заглушить инициализацию GetValue<int> следующим образом:

[TestMethod]
public void TestGetValue()
{
    var stub = new StubIGenericMethod();
    stub.GetValueOf1<int>(() => 5);

    IGenericMethod target = stub;
    Assert.AreEqual(5, target.GetValue<int>());
}

Если код вызывает GetValue<T> с любой другой реализацией, заглушка выполняет своё поведение.

Заглушки виртуальных классов

В предыдущих примерах заглушки были сгенерированы из интерфейсов. Однако вы также можете создавать заглушки из класса с виртуальными или абстрактными элементами. Рассмотрим пример.

// Base class in application under test
public abstract class MyClass
{
    public abstract void DoAbstract(string x);
    public virtual int DoVirtual(int n)
    {
        return n + 42;
    }

    public int DoConcrete()
    {
        return 1;
    }
}

В заглушке, созданной из этого класса, вы можете задать методы делегата для DoAbstract() и DoVirtual(), но не для DoConcrete().

// unit test
var stub = new Fakes.MyClass();
stub.DoAbstractString = (x) => { Assert.IsTrue(x>0); };
stub.DoVirtualInt32 = (n) => 10 ;

Если вы не предоставляете делегат для виртуального метода, Fakes может предоставить поведение по умолчанию или вызвать метод в базовом классе. Чтобы вызвать базовый метод, задайте CallBase свойство:

// unit test code
var stub = new Fakes.MyClass();
stub.CallBase = false;
// No delegate set - default delegate:
Assert.AreEqual(0, stub.DoVirtual(1));

stub.CallBase = true;
// No delegate set - calls the base:
Assert.AreEqual(43,stub.DoVirtual(1));

Изменение поведения заглушек по умолчанию

Каждый тип заглушки, созданный, содержит экземпляр интерфейса IStubBehavior через свойство IStub.InstanceBehavior. Это поведение вызывается всякий раз, когда клиент вызывает члена без присоединенного пользовательского делегата. Если поведение не задано, он использует экземпляр, возвращаемый свойством StubsBehaviors.Current . По умолчанию это свойство возвращает поведение, вызывающее NotImplementedException исключение.

В любой момент можно изменить поведение, установив свойство InstanceBehavior для любого экземпляра заглушки. Например, следующий фрагмент кода изменяет поведение так, чтобы заглушка либо ничего не делает, либо возвращает значение по умолчанию возвращаемого типа default(T):

// unit test code
var stub = new StockAnalysis.Fakes.StubIStockFeed();
// return default(T) or do nothing
stub.InstanceBehavior = StubsBehaviors.DefaultValue;

Поведение также можно изменить глобально для всех объектов заглушки, в которых поведение не задано свойством StubsBehaviors.Current :

// Change default behavior for all stub instances where the behavior has not been set.
StubBehaviors.Current = BehavedBehaviors.DefaultValue;

Связанный контент

  • Last updated on