inject mocks

ฉีด-Mocks

การแทรกการเยาะเย้ยลงในวิชาทดสอบโดยอัตโนมัติผ่านคำอธิบายประกอบ #InjectMocks และ #Mock เพื่อเร่งการทดสอบหน่วยด้วย PHPUnit

สรุป

• ภาษา / สำนวน
• การติดตั้ง
• ความต้องการ
• คุณสมบัติ
• การใช้งาน

ภาษา / สำนวน

Leia a versão em português aqui.

การติดตั้ง

หากต้องการติดตั้งในสภาพแวดล้อมการพัฒนา:

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 บนคุณสมบัติที่สอดคล้องกับการขึ้นต่อกันที่คุณต้องการจำลองหรือ ฉีด.

หลังจากนั้น ให้รัน injector service ด้วยประโยค 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. #ฉีดม็อคส์

มันจะสร้างอินสแตนซ์จริงผ่านตัวสร้าง และหากมีพารามิเตอร์ในตัวสร้าง ค่าต่อไปนี้จะถูกใช้ในแต่ละพารามิเตอร์ ตามลำดับนี้:

• mock ที่สร้างขึ้นจากแอตทริบิวต์ #[Mock] หากมีอยู่
• ค่า default หากเป็นพารามิเตอร์ทางเลือก
• null หากพิมพ์เป็น null ;
• จะสร้าง mock หากไม่ใช่ประเภทดั้งเดิม ในกรณีนี้ mock นี้จะไม่ถูกฉีดเข้าไปในขอบเขต TestCase
• สุดท้ายนี้ หากตัวเลือกก่อนหน้านี้ไม่พอใจ ก็จะเกิดข้อยกเว้น MockInjectException

Obs.: คุณสามารถใช้แอตทริบิวต์ #Mock กับการอ้างอิงของหัวข้อทดสอบทั้งหมด บางส่วนหรือไม่มีเลยก็ได้

2.2. #ม็อค

จะสร้าง mock ที่ฉีดเข้าไปในขอบเขต TestCase โดยไม่ต้องใช้ตัวสร้าง ลักษณะการสร้างนี้เหมือนกับ TestCase::createMock()