inject mocks

注入模擬

透過 #InjectMocks 和 #Mock 註解自動將模擬注入測試對象，以加快 PHPUnit 的單元測試。

概括

• 語言/慣用語
• 安裝
• 要求
• 特徵
• 用法

語言/慣用語

萊婭 (Leia) 與葡萄牙語版本相同。

安裝

在開發環境中安裝：

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中聲明此執行。

執行注入器後，用#InjectMocks註解的service將是測試類別範圍內可用的真實實例，而用#Mock註解的每個依賴項將是MockObject的實例，透過建構子注入到測試主體中，並將也可以在測試類別的範圍內使用。

細節

1. 屬性範圍

• #InjectMocks 和 #Mock 都必須放置在 TestCase 類別中的 TYPED 屬性上；
• 接收 #InjectMocks 和 #Mock 屬性的屬性必須是物件；
• 每個測試用例只能使用一個 #InjectMocks 屬性。當在同一範圍內使用多個時，該庫將僅使用第一個，而忽略其他；
• 您必須為要模擬的每個測試主題依賴項使用 #Mock 屬性；
• 在無類型屬性或基元類型上使用屬性將導致MockInjectException異常。
• 當在同一測試類別中的多個相同類型的對像上使用 #Mock 時，該庫將透過屬性名稱來匹配每個對象，該屬性名稱必須與測試主題類別相同。

2. 行為

#InjectMocks 和 #Mock 獨立工作或一起工作。每一項的詳細資料：

2.1. #InjectMocks

它將透過建構函式建立一個真實的實例，如果建構函式中有參數，則每個參數將按以下順序使用下列值：

• 從 #[Mock] 屬性建立的mock （如果存在）；
• 如果是可選參數， default值；
• 若輸入為null則為null ；
• 如果它不是原始類型，將建立一個mock 。在這種情況下，這個mock不會被注入到TestCase作用域中；
• 最後，如果前面的選項不滿足，就會拋出MockInjectException例外。

觀察：您可以對所有、部分測試物件的依賴項使用 #Mock 屬性，或不使用 #Mock 屬性。

2.2. ＃嘲笑

將會建立一個注入 TestCase 範圍的mock ，而不使用建構子。此創建行為與TestCase::createMock()相同。