inject mocks

Inject-Mocks

Автоматическое внедрение макетов в испытуемых с помощью аннотаций #InjectMocks и #Mock для ускорения модульного тестирования с помощью PHPUnit.

Краткое содержание

• Язык / Идиома
• Установка
• Требования
• Функции
• Использование

Язык / Идиома

Лея — это португальская версия.

Установка

Для установки в среду разработки:

composer require --dev silasyudi/inject-mocks

Требования

• PHP 8.3+
• Композитор 2

Функции

Используя аннотации #InjectMocks и #Mock в тестовых классах, вы можете автоматически внедрять макеты в объекты тестирования.

В типичном сценарии мы бы сделали это так:

Пример без #InjectMocks/#Mock:

 class SomeTest extends  PHPUnit  Framework TestCase
{
    public void testSomething() 
    {
        $ someDependency = $ this -> createMock (Dependency::class);    
        $ anotherDependency = $ this -> createMock (AnotherDependency::class);
        . . .
        $ subject = new Service ( $ someDependency , $ anotherDependency , ...);
        . . .    
    }
    
    ...

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

С помощью аннотаций #InjectMocks/#Mock мы абстрагируем эти изменения объекта тестирования. Пример:

Пример с #InjectMocks/#Mock:

 use SilasYudi  InjectMocks  InjectMocks ;
use SilasYudi  InjectMocks  Mock ;
use SilasYudi  InjectMocks  MockInjector ;

class SomeTest extends  PHPUnit  Framework TestCase
{
    #[Mock]
    private Dependency $ someDependency ;
    #[Mock]
    private AnotherDependency $ anotherDependency ;
    
    . . .
    
    # [InjectMocks]
    
    public function setUp() : void 
    {
        MockInjector:: inject ( $ this );
    }
    
    public void testSomething ()
    {
        // $this->subject e as dependências já estão instanciadas.
    }
    
    ...

Использование

Как и в примере из предыдущего раздела, атрибут #InjectMocks необходимо поместить в свойство субъекта тестирования, которое вы хотите протестировать, а атрибут #Mock должен быть помещен в свойства, соответствующие зависимостям, которые вы хотите имитировать или вводить.

После этого запустите службу инжектора с предложением MockInjector::inject($this) . Это выполнение может быть объявлено в каждом тесте или в setUp .

После выполнения инжектора service , помеченная #InjectMocks, станет реальным экземпляром, доступным в области тестового класса, а каждая зависимость, помеченная #Mock, будет экземпляром MockObject, внедренным в объект тестирования через конструктор, и будет также быть доступным в рамках тестового класса.

Подробности

1. Область действия атрибутов

• И #InjectMocks, и #Mock ДОЛЖНЫ быть помещены поверх свойства TYPED в классе TestCase;
• Свойства, получающие атрибуты #InjectMocks и #Mock, ДОЛЖНЫ быть объектами;
• Вы ДОЛЖНЫ использовать только один атрибут #InjectMocks для каждого TestCase. При использовании более одной библиотеки в одной области эта библиотека будет использовать только первую и игнорировать остальные;
• Вы ДОЛЖНЫ использовать атрибут #Mock для каждой зависимости объекта тестирования, которую вы хотите имитировать;
• Использование атрибутов для нетипизированных свойств или примитивных типов приведет к исключению MockInjectException .
• При использовании #Mock для более чем одного объекта одного и того же типа в одном тестовом классе эта библиотека будет сопоставлять каждый из них через имена свойств, которые ДОЛЖНЫ быть идентичны классу объекта тестирования.

2. Поведение

#InjectMocks и #Mock работают независимо и по отдельности или вместе. Подробности о каждом:

2.1. #InjectMocks

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

• mock созданный на основе атрибута #[Mock], если он существует;
• Значение default , если это необязательный параметр;
• null если он введен как null ;
• Создаст mock если он не является примитивным типом. В этом случае этот mock не будет внедрен в область действия TestCase;
• Наконец, если предыдущие параметры не удовлетворены, будет выдано исключение MockInjectException .

Наблюдение: вы можете использовать атрибут #Mock для всех, некоторых или ни одной из зависимостей испытуемого.

2.2. #Насмехаться

Создаст mock , внедренный в область действия TestCase, без использования конструктора. Это поведение создания идентично TestCase::createMock() .