phpunit legacy adapter

PHPUnit-Adapter für ältere Versionen

Da Sie hier sind, wissen Sie wahrscheinlich genau, dass PHPUnit 8+ gängige Template-Methoden wie setUp() oder tearDown() erfordert, um eine void Rückgabetypdeklaration zu haben, wobei diese Methoden natürlich alles unter PHP 7.1 kaputt machen.

Obwohl es keine große Sache ist, Ihren Code mit Hilfe von Programmen wie PHP-CS-Fixer oder Rector automatisch so zu aktualisieren, dass er diese Rückgabetypdeklaration verwendet, könnte es aus irgendwelchen unglücklichen (aber hoffentlich lukrativen) Gründen zu einem Problem werden , müssen Sie sicherstellen, dass Ihr Code unter PHP 7.0 oder PHP 5.6 funktioniert, und gleichzeitig das Beste nutzen, was Ihnen die neueren Versionen von PHPUnit bieten können.

In diesem Fall treten zwei Probleme auf. Eine, neuere Versionen von PHPUnit haben keine alten Assertions, aber Sie können einen Weg finden, dies zu umgehen, und eine andere, wie bereits erwähnt, neuere Versionen von PHPUnit erfordern void Rückgabetypdeklarationen für die praktischen Vorlagenmethoden, und dann stecken Sie wegen des Umschreibens fest Das Funktionieren von Tests ohne diese Vorlagenmethoden ist sehr mühsam und möglicherweise sogar unmöglich. Und dann kommt diese kleine Bibliothek, um Ihren Tag zu retten!

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

Wie zu verwenden

Aktualisieren Sie zunächst Ihre Tests so, dass sie von LegacyPHPUnitTestCase anstelle von PHPUnitFrameworkTestCase erweitert werden:

 - class MyTest extends PHPUnitFrameworkTestCase
+ class MyTest extends LegacyPHPUnitTestCase

Wo Sie dann die Methode setUp(): void template verwenden mussten, verwenden Sie die Methode doSetUp() und lassen alle Rückgabetypen vollständig abwärtskompatibel weg.

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

Für die meisten anderen Vorlagenmethoden gibt es ähnliche Ersetzungen:

 - 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()

Referenz

Verfahren	Ersatz
setUpBeforeClass(): void	doSetUpBeforeClass()
tearDownAfterClass(): void	doTearDownAfterClass()
setUp(): void	doSetUp()
tearDown(): void	doTearDown()
assertPreConditions(): void	doAssertPreConditions()
assertPostConditions(): void	doAssertPostConditions()

Unterstützte Versionen

• Der Versionszweig 6.x unterstützt PHPUnit 4, PHPUnit 5 und PHPUnit 6.
  • Es wurde getestet, dass es unter PHP 5.3 bis PHP 7.4 funktioniert.
  • 
• Der 8.x-Versionszweig unterstützt PHPUnit 7, PHPUnit 8 und PHPUnit 9.
  • Es wurde getestet, dass es unter PHP 7.1 bis PHP 8.1 funktioniert.
  • 

Zukünftige Versionen werden wahrscheinlich demselben Muster folgen.

Was diese Bibliothek nicht kann

Obwohl diese Bibliothek den lästigsten Teil des Problems löst, gibt es andere Teile, für deren Abdeckung die Bibliothek nicht konzipiert wurde. Zum Beispiel:

• Einige Versionen von PHPUnit erlauben die Verwendung von assertContains mit Zeichenfolgen, andere nicht.
• In einigen Versionen heißt eine Methode expectExceptionMessageRegExp , während in anderen dieselbe Methode expectExceptionMessageMatches heißt.
• Und so weiter und so weiter.

Es gibt Polyfills für diese geänderten Methoden (siehe unten), aber es sollte keine große Sache sein, ein Ad-hoc-Polyfill nur für die Methoden zu schreiben, die Sie benötigen. Z.B:

    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 ();
    }

Wenn es für diese und andere Methoden mehrere modulare (und nicht) Multiversions-Polyfills gibt:

• Eines der am häufigsten verwendeten ist eines, das mit der PHPUnit Bridge von Symfony geliefert wird. Sie können die Quelle hier überprüfen. Beachten Sie, dass die Vererbung nicht unterstützt wird (Sie müssen das Merkmal in jede Klasse importieren).
• Es gibt yoast/phpunit-polyfills .
• Es gibt phpunitgoodpractices/polyfill .