phpunit legacy adapter

อะแดปเตอร์เวอร์ชันดั้งเดิมของ PHPUnit

เมื่อคุณอยู่ที่นี่ คุณอาจทราบดีว่า PHPUnit 8+ ต้องใช้วิธีเทมเพลตทั่วไป เช่น setUp() หรือ tearDown() เพื่อให้มีการประกาศประเภทการส่งคืน void ซึ่งวิธีการดังกล่าวจะทำลายสิ่งใดก็ตามที่ต่ำกว่า PHP 7.1 โดยธรรมชาติ

แม้ว่าจะไม่ใช่เรื่องใหญ่ที่จะต้องอัปเดตโค้ดของคุณโดยอัตโนมัติเพื่อใช้การประกาศประเภทการส่งคืนเหล่านี้ด้วยความช่วยเหลือจาก PHP-CS-Fixer หรือ Rector แต่ก็อาจกลายเป็นปัญหาได้หากด้วยเหตุผลใดก็ตามที่โชคร้าย (แต่หวังว่าจะได้กำไร) คุณต้องแน่ใจว่าโค้ดของคุณทำงานภายใต้ PHP 7.0 หรือ PHP 5.6 ในขณะที่ต้องการใช้โลกที่ดีที่สุดก็สามารถให้ PHPUnit เวอร์ชันล่าสุดที่น้อยลงได้

ในกรณีนี้ คุณจะมีปัญหาสองประการ หนึ่ง PHPUnit เวอร์ชันใหม่กว่าไม่มีการยืนยันแบบเก่า แต่คุณสามารถหาวิธีแก้ไขได้ และอีกเวอร์ชันหนึ่งตามที่กล่าวไว้ PHPUnit เวอร์ชันใหม่กว่าจำเป็นต้องมีการประกาศประเภทการส่งคืน void สำหรับวิธีเทมเพลตที่สะดวก จากนั้นคุณติดอยู่เนื่องจากการเขียนใหม่ การทดสอบการทำงานโดยไม่ใช้วิธีเทมเพลตเหล่านี้ถือเป็นปัญหาใหญ่และอาจเป็นไปไม่ได้ด้วยซ้ำ แล้วห้องสมุดเล็กๆ แห่งนี้ก็มาช่วยคุณ!

 composer require --dev sanmai/phpunit-legacy-adapter:"^6.4 || ^8.2.1"

วิธีใช้

ขั้นแรก อัปเดตการทดสอบของคุณเพื่อขยายจาก LegacyPHPUnitTestCase แทน PHPUnitFrameworkTestCase :

 - class MyTest extends PHPUnitFrameworkTestCase
+ class MyTest extends LegacyPHPUnitTestCase

จากนั้นที่คุณต้องใช้ setUp(): void template method ให้ใช้ doSetUp() method โดยละเว้นประเภทการส่งคืนใด ๆ ทั้งหมดในวิธีที่เข้ากันได้แบบย้อนหลังโดยสมบูรณ์

 - protected function setUp(): void
+ protected function doSetUp()

มีการแทนที่ที่คล้ายกันสำหรับวิธีเทมเพลตอื่นๆ ส่วนใหญ่:

 - public static function setUpBeforeClass(): void
+ public static function doSetUpBeforeClass() 

 - public static function tearDownAfterClass(): void
+ public static function doTearDownAfterClass() 

 - protected function setUp(): void
+ protected function doSetUp() 

 - protected function tearDown(): void
+ protected function doTearDown() 

 - protected function assertPreConditions(): void
+ protected function doAssertPreConditions() 

 - protected function assertPostConditions(): void
+ protected function doAssertPostConditions()

อ้างอิง

วิธี	การทดแทน
setUpBeforeClass(): void	doSetUpBeforeClass()
tearDownAfterClass(): void	doTearDownAfterClass()
setUp(): void	doSetUp()
tearDown(): void	doTearDown()
assertPreConditions(): void	doAssertPreConditions()
assertPostConditions(): void	doAssertPostConditions()

รุ่นที่รองรับ

• สาขาเวอร์ชัน 6.x รองรับ PHPUnit 4, PHPUnit 5 และ PHPUnit 6
  • ได้รับการทดสอบว่าทำงานภายใต้ PHP 5.3 - PHP 7.4
  • 
• สาขาเวอร์ชัน 8.x รองรับ PHPUnit 7, PHPUnit 8 และ PHPUnit 9
  • ได้รับการทดสอบว่าทำงานภายใต้ PHP 7.1 - PHP 8.1
  • 

เวอร์ชันต่อๆ ไปก็คงจะมีรูปแบบเดียวกัน

สิ่งที่ห้องสมุดแห่งนี้ไม่ได้ทำ

แม้ว่าห้องสมุดนี้จะแก้ปัญหาส่วนที่น่ารำคาญที่สุด แต่ก็มีส่วนอื่น ๆ ที่ห้องสมุดไม่ได้รับการออกแบบให้ครอบคลุม ตัวอย่างเช่น:

• PHPUnit บางเวอร์ชันอนุญาตให้ assertContains สามารถใช้กับสตริงได้ ในขณะที่เวอร์ชันอื่นๆ ไม่อนุญาต
• ในบางเวอร์ชันจะมีวิธีหนึ่งเรียกว่า expectExceptionMessageRegExp ในขณะที่วิธีอื่นๆเรียกว่า expectExceptionMessageMatches
• และต่อๆไป

มีโพลีฟิลสำหรับวิธีที่เปลี่ยนแปลงเหล่านี้ (ดูด้านล่าง) แต่ไม่ควรเป็นเรื่องใหญ่ที่จะเขียนโพลีฟิลเฉพาะกิจสำหรับวิธีที่คุณต้องการเท่านั้น เช่น:

    public function __call ( $ method , $ args )
    {
        if ( $ method === ' assertStringContainsString ' ) {
            $ this -> assertContains (... $ args );
        }
        
        if ( $ method === ' assertIsBool ' ) {
            $ this -> assertTrue ( is_bool ( $ args [ 0 ]));
        }
        
        if ( $ method === ' expectExceptionMessageRegExp ' ) {
            $ this -> expectExceptionMessageMatches (... $ args );
        }
        
        throw new  InvalidArgumentException ();
    }

หากมีโพลีฟิลหลายเวอร์ชันแบบโมดูลาร์ (ไม่ใช่) หลายเวอร์ชันสำหรับสิ่งเหล่านี้ และวิธีการอื่น:

• หนึ่งในสิ่งที่ใช้มากที่สุดคืออันที่มาพร้อมกับ PHPUnit Bridge ของ Symfony คุณสามารถตรวจสอบแหล่งที่มาได้ที่นี่ โปรดทราบว่ามันไม่รองรับการสืบทอด (คุณจะต้องนำเข้าลักษณะไปยังทุกคลาส)
• มี yoast/phpunit-polyfills
• มี phpunitgoodpractices/polyfill