phpunit legacy adapter

Adaptador de versões legadas do PHPUnit

Como você está aqui, você provavelmente está ciente de que o PHPUnit 8+ requer métodos de modelo comuns como setUp() ou tearDown() para ter uma declaração de tipo de retorno void , cujos métodos quebram naturalmente qualquer coisa abaixo do PHP 7.1.

Embora não seja grande coisa atualizar automaticamente seu código para usar essas declarações de tipo de retorno com a ajuda de PHP-CS-Fixer ou Rector, isso pode se tornar um problema se, por qualquer motivo infeliz (mas, esperançosamente, lucrativo) , você deve garantir que seu código esteja funcionando no PHP 7.0 ou PHP 5.6, ao mesmo tempo em que deseja usar o melhor que o mundo pode oferecer nas versões mais ou menos recentes do PHPUnit.

Neste caso, você terá dois problemas. Uma, as versões mais recentes do PHPUnit não possuem asserções antigas, mas você pode encontrar uma maneira de contornar isso, e outra, como mencionado, as versões mais recentes do PHPUnit exigem declarações de tipo de retorno void para os métodos de modelo convenientes, e então você fica preso porque reescrever testes funcionarem sem esses métodos de modelo é uma grande dor e pode até ser impossível. E então esta pequena biblioteca chega para salvar o seu dia!

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

Como usar

Primeiro, atualize seus testes para estender de LegacyPHPUnitTestCase em vez de PHPUnitFrameworkTestCase :

 - class MyTest extends PHPUnitFrameworkTestCase
+ class MyTest extends LegacyPHPUnitTestCase

Então, onde você teve que usar o método setUp(): void template, use o método doSetUp() , omitindo todos os tipos de retorno de uma forma totalmente compatível com versões anteriores.

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

Existem substituições semelhantes para a maioria dos outros métodos de modelo:

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

Referência

Método	Substituição
setUpBeforeClass(): void	doSetUpBeforeClass()
tearDownAfterClass(): void	doTearDownAfterClass()
setUp(): void	doSetUp()
tearDown(): void	doTearDown()
assertPreConditions(): void	doAssertPreConditions()
assertPostConditions(): void	doAssertPostConditions()

Versões suportadas

• A ramificação da versão 6.x suporta PHPUnit 4, PHPUnit 5 e PHPUnit 6.
  • Foi testado para funcionar em PHP 5.3 - PHP 7.4.
  • 
• A ramificação da versão 8.x suporta PHPUnit 7, PHPUnit 8 e PHPUnit 9.
  • Foi testado para funcionar em PHP 7.1 - PHP 8.1.
  • 

Versões futuras provavelmente seguirão o mesmo padrão.

O que esta biblioteca não faz

Embora esta biblioteca resolva a parte mais irritante do problema, há outras partes que a biblioteca não foi projetada para cobrir. Por exemplo:

• Algumas versões do PHPUnit permitem que assertContains seja usado com strings, enquanto outras não.
• Em algumas versões, um método é chamado expectExceptionMessageRegExp , enquanto em outras o mesmo método é chamado expectExceptionMessageMatches .
• E assim por diante.

Existem polyfills para esses métodos alterados (veja abaixo), mas não deve ser um grande problema escrever um polyfill ad hoc apenas para os métodos que você precisa. Por exemplo:

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

Se houver vários polyfills multiversão modulares (e não) para estes e outros métodos:

• Um dos mais utilizados é aquele que vem com o PHPUnit Bridge do Symfony. Você pode verificar a fonte aqui. Observe que ele não suporta herança (você terá que importar a característica para todas as classes).
• Existe yoast/phpunit-polyfills .
• Há phpunitgoodpractices/polyfill .