PHPUnit: Realizando Testes Unit�rios em PHP

Guia do artigo:

O que � o PHPUnit?
Por que teste unit�rio � importante?
Introduç�o
Vis�o Geral
Instalaç�o
Configuraç�o
Escrevendo testes
Como executar um teste?
Na Pr�tica
Ambiente
Dubl�s de Teste
Assertions
Principais m�todos da classe TestCase
Aprenda PHP

O que � o PHPUnit?

O PHPUnit � um framework para realizaç�o de testes unit�rios em PHP com base na arquitetura xUnit.

Teste unit�rio � uma metodologia de testes automatizados que leva em consideraç�o a menor unidade do software, ou seja, ao inv�s de testar dentro do c�digo fonte e executar o c�digo manualmente para imprimir o resultado na tela, o programador cria um projeto de teste, que executa cada trecho do c�digo de forma autom�tica e exibe o resultado de todos os testes.

Por que teste unit�rio � importante?

Todo mundo testa, a diferença est� na qualidade dos testes que s�o feitos. Muitos programadores, principalmente iniciantes, possuem o h�bito de realizar seus testes junto do c�digo fonte da aplicaç�o seja fazendo breakpoints, imprimindo dados na tela ou simplesmente verificando a execuç�o da aplicaç�o. Essas formas de testar possuem uma s�rie de problemas: n�o possuem uma boa cobertura do c�digo sendo testado, pois os testes s�o perdidos conforme o c�digo � posto em produç�o e s�o inseguros de uma forma geral conforme o software escala para um projeto de porte maior.

O Teste Unit�rio � a primeira abordagem em mat�ria de confecç�o de testes mais robustos e confi�veis, a t�cnica consiste em testar as menores unidades poss�veis de c�digo da aplicaç�o em cen�rios isoladamente em um projeto separado da aplicaç�o principal, o que permite a manutenç�o e a escalabilidade dos testes em conjunto com a aplicaç�o.

Introduç�o

O PHPUnit � um framework para realizaç�o de testes unit�rios em PHP baseada na arquitetura xUnit. � a forma mais difundida para realizar a pr�tica de testes unit�rios pela comunidade PHP.

Ap�s ler essa documentaç�o confira tamb�m a documentaç�o de PHPUnit, que cobre t�picos mais avançados sobre esse Framework.

Vis�o Geral

O PHPUnit foi criado por Sebastian Bergmann com o intuito de trazer ao PHP todos os recursos que j� haviam no framework de teste unit�rio JUnit da linguagem Java, com os diferenciais para se adequar as peculiaridades da linguagem PHP. O PHPUnit est� dispon�vel para aplicaç�es com o PHP a partir da vers�o 5.5.

Por exemplo, quando precisamos testar se um m�todo de consulta est� buscando o registro certo, o mais comum � por o resultado dentro de um var_dump para imprimir o resultado na tela para ver se o valor � o esperado.

$clienteDao = new ClienteDAO();
    $cliente = $clienteDao->findById(10);
    var_dump($cliente->nome);
    //O valor impresso na tela deve ser "Edson Arantes do Nascimento"

Em um projeto maior esse tipo de teste tende a se tornar invi�vel e inseguro a medida que a complexidade do m�dulo e da unidade aumentam, � natural sentir falta de uma metodologia de testes, que permita medir a cobertura de teste do c�digo, tornando f�cil criar os cen�rios nos quais as falhas ser�o percebidas. Os testes unit�rios suprem essas e outras car�ncias do processo de teste de c�digo.

public function testFindById()
    {
        $clienteDao = new ClienteDAO();
        $cliente = $clienteDao->findById(10);
        $this->assertEquals("Edson Arantes do Nascimento", $cliente->nome)
    }

O PHPUnit � instalado como uma depend�ncia ao projeto e se adequa perfeitamente com a estrutura do mesmo. Possui uma Interface de Linha de Comando pr�pria com opç�es de customizaç�o para a forma de executar os testes.

Instalaç�o

O PHPUnit pode ser instalado pelo Composer, um gerenciador de depend�ncias do PHP que permite a declaraç�o das bibliotecas das quais o seu projeto depende e as instala de forma automatizada.

Para isso execute o seguinte comando no diret�rio raiz do seu projeto:

composer require --dev phpunit/phpunit

Nota: Caso esteja utilizando algum framework verifique se ele j� possui o PHPUnit instalado como ferramenta de teste padr�o, como � o caso do Laravel.

Configuraç�o

Para utilizar o PHPUnit dentro do seu projeto � preciso criar na raiz do mesmo um arquivo chamado phpunit.xml e uma pasta chamada tests. A estrutura do projeto deve se parecer com ilustrado na Figura 1:

Figura 1. Estrutura do projeto

No arquivo phpunit.xml adicione as seguintes configuraç�es:

<?xml version="1.0" encoding="UTF-8"?>
    
     <phpunit bootstrap="vendor/autoload.php"
            colors="true"
            verbose="true"
            stopOnFailure="false">
        <testsuites>
            <testsuite name="Primeiro exemplo">
                <directory>tests</directory>
            </testsuite> 
        </testsuites>
    </phpunit>

Vejamos passo a passo uma explicaç�o sobre esse c�digo.

Linha 3: instru�mos o PHPUnit onde encontrar e carregar as suas classes a partir de um autoload e atrav�s do atributo bootstrap.

phpunit bootstrap="vendor/autoload.php"
Linha 4: instru�mos o PHPUnit para que o terminal exiba cores referentes ao sucesso ou fracasso do teste, algo que s� pode ser percebido em um terminal com suporte a cores.

colors="true"
Linha 5: instru�mos o PHPUnit que desejamos visualizar mais informaç�es referentes aos testes executados.

verbose="true"
Linha 6: instru�mos o PHPUnit a n�o interromper os testes na primeira falha.

stopOnFailure="false">
Linha 7 at� 11: Aqui configuramos as su�tes de teste, as quais damos um nome com o atributo name do elemento testsuite. � aqui tamb�m que indicamos qual ser� a pasta que conter� as classes de teste, usando para isso o elemento directory.

<testsuites> <testsuite name="Primeiro exemplo"> <directory>tests</directory> </testsuite> </testsuites>

Escrevendo testes

Para escrever testes em PHPUnit basta criar uma classe que herde de PHPUnit\Framework\TestCase. Chamamos essa classe de classe de teste.

Vis�o geral

O PHPUnit localiza os m�todos de teste pelo prefixo test em seu nome ou pela anotaç�o @test no docblock do m�todo. Por exemplo, considere que queremos testar isoladamente o seguinte m�todo freteGratis da classe Compra:

<?php
        namespace App;
        
        class Compra
        {
            public function freteGratis($valor)
            {
                return $valor >= 150;
            }
        }

Criamos ent�o a classe CompraTest dentro da pasta tests, como o m�todo testFreteGratis, de acordo com o c�digo abaixo.

<?php
        namespace Tests;
        
        use PHPUnit\Framework\TestCase;
        use App\Compra;
        
        class CompraTest extends TestCase
        {
            public function testFreteGratis()
            {
                $compra = new Compra();
                $this->assertTrue($compra->freteGratis(150));
            }
        }

Linha 7: a classe de teste, por convenç�o, tem o mesmo nome da classe a ser testada, com exceç�o da palavra �ltima palavra, Test. O PHPUnit segue essa convenç�o para identificar as classes de teste.

class CompraTest extends TestCase
Linha 12: essa express�o � referente � execuç�o do teste em si. Nesse caso o m�todo freteGratis do objeto $compra � executado e � esperado que o seu resultado seja equivalente a True. Sendo assim, o teste ter� sucesso, caso contr�rio ele ter� falhado.

$this->assertTrue($compra->freteGratis(150));

Como executar um teste?

Para executar todos os testes criados basta rodar o seguinte comando no terminal dentro da raiz do projeto:

.\vendor\bin\phpunit

Para rodar um arquivo de testes espec�fico, execute o seguinte comando:

.\vendor\bin\phpunit [NomeDaClasse]

Na Pr�tica

Em certas situaç�es � necess�rio saber se uma unidade ir� gerar uma Exception. Para esse tipo de situaç�o, o PHPUnit possui um m�todo espec�fico chamado expectedException($tipo) que determina se o c�digo sendo testado deve disparar uma exceç�o e qual tipo de exceç�o deve ser disparada. O m�todo expectedException() deve ser declarado antes do teste executar a unidade.

Exemplo 1:

Ainda usando a classe CompraTest criamos um m�todo que testar� freteGratis sem passar nenhum par�metro. Dessa forma, esperamos que seja gerado um erro de contagem de argumentos e que a exceç�o ArgumentCountError seja disparada. Caso a exceç�o n�o seja disparada na unidade, o teste resultar� em uma falha.

public function testFreteGratisExcecao()
        {
            $compra = new Compra();
            $this->expectException(\ArgumentCountError::class);
            $compra->freteGratis();
        }

Exemplo 2:

Em outras situaç�es o teste � feito sobre uma unidade cujo valor de retorno costuma variar e � preciso certificar que esse retorno simplesmente n�o est� vazio.

No caso de testar um Objeto de Acesso a Dados, precisamos assegurar que o seu m�todo de consultar cliente est� tendo um retorno adequado e n�o est� retornando null.

public function testFindClientById()
        {
            $clientDao = new ClientDAO();
            $this->expectNotNull($clientDao->findClientByID(552);
        }

Exemplo 3:

Outra situaç�o interessante � quando precisamos testar se uma dada string est� de acordo com um padr�o determinado por uma express�o regular(RegExp).

Testando se um m�todo da classe de validaç�o est� retornando o CNPJ no formato adequado(xx.xxx.xxx/xxxx-xx) ap�s receber os n�meros adequados.

public function testFormataCNPJ()
        {
            $validador = new Validador();
            $this->assertRegExp(
                "\d.?\d.?\d/?\d-?\d",
                $validador->formataCNPJ(00000000000000)
            );
        }

Ambiente

Em muitas situaç�es � necess�rio reutilizar inst�ncias em mais de um teste dentro de uma classe de teste. O ambiente de testes consiste dos objetos que ser�o utilizados em todos os testes da classe de testes.

Vis�o geral

O PHPUnit possui ferramentas para a montagem e desmontagem de ambientes de teste. setUp � o m�todo da superclasse TestCase que � executado antes de cada teste na mesma classe, ideal para instanciar objetos, abrir conex�es, entre outros usos. tearDown � o m�todo da superclasse TestCase que � executado ap�s cada teste na mesma classe, ideal para fechar conex�es ao banco de dados, arquivos, entre outros.

Na pr�tica

Exemplo 1

Embora seja um recurso �til, devemos evitar utilizar setUp e tearDown quando forem desnecess�rias, uma vez que podem tornar a leitura do c�digo mais dif�cil, visto que para acompanhar o que eles fazem o programador dever� dividir a sua atenç�o entre alguns m�todos. Abaixo vemos um caso no qual utilizar essas m�todos � algo dispens�vel e indevido.

<?php
    
    namespace Test;
    
    use App\Models\Funcionario;
    use App\Helpers\Connection;
    use PHPUnit\Framework\TestCase;
    
    class FuncionarioTest extends TestCase
    {
      protected $funcionario;
      protected $conexao;
    
      public function setUp()
      {
        $this->funcionario = new Funcionario(3000, "Jos�", 1, 171.9);
        $this->conexao = new Connection('localhost', 'root', 'dfre43e$$');
      }
    
      public function tearDown()
      {
        $this->conexao->close();
      }
    }

Uma outra abordagem a esse problema, em que temos um objeto que precisa ser constru�do antes e destru�do ap�s cada teste, � a construç�o de m�todos de f�brica que forneçam esses objetos.

<?php
    
    namespace Test;
    
    use App\Models\Funcionario;
    use App\Helpers\Connection;
    use PHPUnit\Framework\TestCase;
    
    class FuncionarioTest extends TestCase
    {
      protected $funcionario;
      protected $conexao;
    
      public function testGravacaoDeUmFuncionario()
      {
        $this->conexao = getConexao();
        $this->funcionario = new Funcionario(3000, "Jos�", 1, 171.9);
        ...
      }
    
      public function getConexao()
      {
        return new Connection('localhost', 'root', 'dfre43e$$');
      }
    }

Exemplo 2

Em geral, setUp e tearDown n�o s�o utilizados, exceto em alguns poucos casos. Um deles � quando precisamos reiniciar objetos est�ticos ou singletons, anulando quaisquer dados retidos por eles. Considere que tenhamos uma classe de log dispon�vel dessa forma, que � obtida a partir de uma f�brica e que ao realizar suas aç�es mant�m em mem�ria dados como o nome do arquivo utilizado, um buffer do seu conte�do, entre outras coisas.

Sabendo que grandes aplicaç�es costumam executar seus testes de forma aut�noma, em um processo que pode durar horas at� que todo o sistema esteja coberto por eles. Nesse contexto, � importante que cada teste na pilha possa ser executado sem nenhuma conex�o com o anterior como uma garantia de que a falha em um determinado teste n�o comprometer� a confiabilidade dos seguintes. De outra forma, pode ser necess�rio rastrear a origem problemas como testes que falham dependendo da ordem em que s�o executados, o que pode facilmente consumir algumas horas do programador.

Sendo assim, podemos utilizar o m�todo tearDown para recuperar o estado original desse objeto de log, antes do pr�ximo teste ser executado.

<?php
    namespace Tests;
    
    use PHPUnit\Framework\TestCase;
    use App\Services\Analizador;
    
    class AnalizadorTest extends TestCase 
    {    
        public function testNomeArquivoLogValidoLetrasMaiusculas()
        {
            $this->logger = LoggerFabrica.getLogger();
            ...
            $result = analizador.nomeLogValido("log_salvo.log");
            $this->assertTrue($resultado);
        }
    
        public function tearDown()
        {
            $this->logger = null;
        }
    }

Dessa forma, se algum teste posterior a esse utilizar a mesma classe de log, os dados armazenados durante a execuç�o deste teste n�o colocar�o em d�vida o seu resultado.

Dubl�s de Teste

Um dubl� � um objeto falso, ou mock, constru�do a partir de uma classe. Geralmente criamos esse objeto para utiliz�-lo em lugar de uma depend�ncia do cen�rio a ser testado. Assim, tornamos o c�digo de teste isento a erros indiretamente relacionados ao objetivo principal em um determinado contexto de teste.

Vis�o geral

Considerando que desejamos validar um modelo a ser persistido, podemos usar um dubl� para substituir a classe de persist�ncia, que nesse caso � necess�ria para a completude da aç�o, mas ainda assim indiretamente importante. Dessa forma, podemos nos concentrar na validaç�o e isentar o c�digo de teste de erros de conex�o, entre outros.

Um dubl� n�o se comporta como o objeto real, apenas fornece a mesma interface. Ele � criado utilizando-se a classe que desejamos simular a partir dos m�todos createMock($classe) e getMockBuilder($classe).

Os m�todos para criaç�o de dubl�s possuem a seguinte estrutura:

// Retorna um dubl� de teste da classe ou interface especificada.
        createMock($tipo)
        
        // Retorna um dubl� customiz�vel que precisa ser configurado manualmente.
        getMockBuilder($tipo)

Na pr�tica

Exemplo 1

Usamos o m�todo createMock($tipo) para retornar um dubl� com configuraç�es pr�-definidas. Ele ignora os m�todos __construct() e __clone() da classe que simula. Por padr�o os m�todos desse mock n�o fazem nada. Lembre-se que um dubl� � um objeto falso, criado a partir de uma classe, mas n�o � uma inst�ncia dessa classe. Quando precisamos que um m�todo de um mock gerado desse jeito retorne algo devemos explicitamente declarar isso usando os m�todos method(�metodo�) e willReturn(�retorno�).

Como exemplo, considere que queremos testar o seguinte m�todo, que recebe um valor e calcula a sua convers�o de uma outra moeda:

public function pagamentoMoedaExtrangeira($tipoMoeda, $valor, Currency $currency)
        {
            if($tipoMoeda === Currency::COTACAO_DOLAR) {
                $valor *= $currency->getCotacaoDolar();
            }elseif ($tipoMoeda === Currency::COTACAO_LIBRA) {
                $valor *= $currency->getCotacaoLibra();
            }elseif ($tipoMoeda === Currency::COTACAO_EURO) {
                $valor *= $currency->getCotacaoEuro();
            }else {
                throw new \Exception("moeda n�o registrada");
                $valor = 0;
            }
            return $valor;
        }

Para um primeiro teste vamos criar um mock da classe Currency e definir que seu m�todo getCotacaoDolar vai ter um retorno igual a 3,00. Com isso desejamos simular uma chamada a uma API que forneça o valor do dolar do dia.

public function testPagamentoDolar()
        {
            $fakeCurrency = $this->createMock(\App\Helpers\Currency::class);
        
            $valorDolarDia = 3;
        
            $fakeCurrency->method('getCotacaoDolar')
                         ->willReturn($valorDolarDia);
        
            $this->assertEquals(6000, $this->pagamentoMoedaExtrangeira(Currency::COTACAO_DOLAR, 2000, $fakeCurrency));
        }

Linha 3: cria um mock da classe Currency. Esse mock n�o � uma inst�ncia da classe Currency, mas o objeto que depende da classe Currency enxergar� o mock como se ele fosse a classe Currency.

$fakeCurrency = $this->createMock(\App\Helpers\Currency::class);
Linhas 5 e 6: determinamos que o m�todo getDolar retornar� o valor 3, independentemente do valor passado para ele como par�metro.

$fakeCurrency->method('getCotacaoDolar') ->willReturn($valorDolarDia);
Linha 7: executamos o teste utilizando o mock.

$this->assertEquals(6000, $this->pagamentoMoedaExtrangeira(Currency::COTACAO_DOLAR, 2000, $fakeCurrency));

Exemplo 2

Usamos o m�todo getMockBuilder($tipo) para retornar um dubl� cujas configuraç�es precisam ser declaradas manualmente. O mock � respons�vel por testar como o c�digo sob teste se comporta com ele, incluindo chamadas de m�todos com passagem de par�metros, entre outros. O mock precisa ser configurado inteiramente de forma manual.

O exemplo abaixo ilustra um teste para o m�todo editFuncionario. Esse m�todo recebe como par�metro um objeto do tipo Funcionario com os dados que devem ser salvos no reposit�rio.

<?php 
        namespace App\Services;
        
        use App\Repositories\FuncionarioRepository;
        use App\Models\Funcionario;
        
        class FuncionarioService
        {   
            protected $repository;
        
            public function __construct(FuncionarioRepository $repository)
            {
                $this->repository = $repository;
            }
        
            public function atualizaFuncionario(Funcionario $funcionario)
            {
                try {
                    $this->repository->save($funcionario);
                } catch(Exception $e) {
                    throw new FalhaDeGravacaoException('Funcionario nao foi gravado');
                }
            }
        }

Para que atualizaFuncionario seja testado � preciso criar um mock de FuncionarioRepository, definir a entrada e sa�da do m�todo save e passar o mock no construtor de FuncionarioService, que � o objeto cujo m�todo ser� testado.

Observe abaixo que criamos o mock da classe FuncionarioRepository, desabilitamos o __construct() e o __clone() e definimos o m�todo que ter� algum retorno em setMethods. Note que o m�todo � informado dentro de um vetor mesmo sendo apenas um.

public function testEditFuncionario()
        {
            $repository = $this->getMockBuilder(FuncionarioRepository::class)
                ->disableOriginalConstructor()
                ->disableOriginalClone()
                ->setMethods(['save'])
                ->getMock();
        
            $repository->expects($this->once())
                ->method('save')
                ->with($this->equalTo(new Funcionario(3000, "Jos�", 1, 171.9)))
                ->willReturn(true);
        
            $funcionarioService = new FuncionarioService($repository);
            $novoFuncionario = new Funcionario(3000, "Jos�", 1, 171.9);
        
            $this->expectException(\FalhaDeGravacaoException::class);
        
            $funcionarioService->atualizaFuncionario($novoFuncionario);
        }

Linha 6: informamos que o mock ter� o m�todo save.

->setMethods(['save'])
Linha 9 at� 12: configuramos o mock de forma que se o m�todo save n�o for chamado exatamente uma vez o teste falhar�.

$repository->expects($this->once()) ->method('save') ->with($this->equalTo(new Funcionario(3000, "Jos�", 1, 171.9))) ->willReturn(true);

Em seguida configuramos em expect que o m�todo ser� executado uma vez, em method informamos de qual se trata, em with definimos o par�metro que ele pode receber e que retornar� true em willReturn.

Ap�s a configuraç�o do mock definimos os objetos reais que ser�o usados em nosso teste e, por fim, testamos de fato o m�todo.

Assertions

S�o os m�todos que fazem o teste propriamente dito, s�o os que executam a unidade e certificam que o resultado gerado no teste � o esperado com sucesso ou falham.

Vis�o geral

Os m�todos da classe TestCase que começam com o prefixo assert, s�o parte importante dos casos de teste e avaliam se certas condiç�es, decisivas para determinar o sucesso ou falha do teste, geram um resultado esperado.

...
class FuncionarioTest extends TestCase
{
    ...
    public function testSalarioLiquido()
    {
        $funcionario = new Funcionario(2500) 
        $this->assertEquals(2026.43, $funcionario->getSalarioLiquido(), "sal�rio real difere do esperado");
    {
    ...
}

Principais m�todos da classe TestCase

assertArrayHasKey()
assertClassHasAttribute()
assertArraySubset()
assertClassHasStaticAttribute()
assertContains()
assertContainsOnly()
assertContainsOnlyInstancesOf()
assertCount()
assertDirectoryExists()
assertDirectoryIsReadable()
assertDirectoryIsWritable()
assertEmpty()
TassertEqualXMLStructureext()
assertEquals()
assertFalse()
assertFileEquals()
assertFileExists()
assertFileIsReadable()
assertFileIsWritable()
assertGreaterThan()
assertGreaterThanOrEqual()
assertInfinite()
assertInstanceOf()
assertInternalType()
assertIsReadable()
assertIsWritable()
assertJsonFileEqualsJsonFile()
assertJsonFileEqualsJsonFile()
assertJsonStringEqualsJsonFile()
assertJsonStringEqualsJsonString()
assertLessThan()
assertLessThanOrEqual()
assertNan()
assertNull()
assertObjectHasAttribute()
assertRegExp()
assertStringMatchesFormat()
assertStringMatchesFormatFile()
assertSame()
assertStringEndsWith()
assertStringEqualsFile()
assertStringStartsWith()
assertThat()
assertTrue()
assertXmlFileEqualsXmlFile()
assertXmlStringEqualsXmlFile()
assertXmlStringEqualsXmlString()

assertArrayHasKey()

Exibe uma mensagem definida em $mensagem se o $vetor n�o cont�m a $chave.

assertArrayHasKey(mixed $chave, array $vetor[, string $mensagem = ''])

assertArrayNotHasKey() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertClassHasAttribute()

Exibe uma mensagem definida em $mensagem se $nomeClasse::nomeAtributo n�o existir.

assertClassHasAttribute(string $nomeAtributo, string $nomeClasse[, string $mensagem = ''])

assertClassNotHasAttribute() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertArraySubset()

Exibe uma mensagem definida em $mensagem se $vetor n�o cont�m o $subconjunto.

assertArraySubset(array $subconjunto, array $vetor[, bool $strict = '', string $mensagem = ''])

$strict � uma flag usada para comparar a identidade de objetos dentro dos arrays.

assertClassHasStaticAttribute()

Exibe uma mensagem definida em $mensagem se o $nomeClasse::nomeAtributo n�o existir.

assertClassHasStaticAttribute(string $nomeAtributo, string $nomeClasse[, string $mensagem = ''])

assertClassNotHasStaticAttribute() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertContains()

Exibe uma mensagem definida em $mensagem se o $needle n�o � um elemento de $haystack.

assertContains(mixed $needle, Iterator|array $haystack[, string $mensagem = ''])

assertNotContains() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeContains() e assertAttributeNotContains() s�o inv�lucros convenientes que usam um atributo public, protected, ou private de uma classe ou objeto como a haystack.

assertContains(string $needle, string $haystack[, string $mensagem = '', boolean $ignorarMaiuscula = FALSE])

Exibe uma mensagem definida em $mensagem se $needle n�o � uma substring de $haystack.

Se $ignorarMaiuscula � true, o teste ser� case insensitive.

assertContainsOnly()

Exibe uma mensagem definida em $mensagem se $haystack n�o cont�m somente vari�veis do tipo $tipo.

assertContainsOnly(string $tipo, Iterator|array $haystack[, boolean $isNativeType = null, string $mensagem = ''])

$isNativeType � uma flag usada para indicar se $tipo � um tipo nativo do PHP ou n�o.

assertNotContainsOnly() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeContainsOnly() e assertAttributeNotContainsOnly() s�o inv�lucros convenientes que usam um atributo public, protected, ou private de uma classe ou objeto como a haystack.

assertContainsOnlyInstancesOf()

Exibe uma mensagem definida em $mensagem se $haystack n�o cont�m somente inst�ncias da classe $nomeClasse.

assertContainsOnlyInstancesOf(string $nomeClasse, Traversable|array $haystack[, string $mensagem = ''])

assertCount()

Exibe uma mensagem definida em $mensagem se o n�mero de elementos no $haystack n�o for $contagemEsperada.

assertCount($contagemEsperada, $haystack[, string $mensagem = ''])

assertNotCount() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertDirectoryExists()

Exibe uma mensagem definida em $mensagem se o diret�rio especificado por $diretorio n�o existir.

assertDirectoryExists(string $diretorio[, string $mensagem = ''])

assertDirectoryNotExists() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertDirectoryIsReadable()

Exibe uma mensagem definida em $mensagem se o diret�rio especificado por $diretorio n�o � um diret�rio ou n�o � leg�vel.

assertDirectoryIsReadable(string $diretorio[, string $mensagem = ''])

assertDirectoryNotIsReadable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertDirectoryIsWritable()

Exibe uma mensagem definida em $mensagem se o diret�rio especificado por $diretorio n�o � um diret�rio ou n�o � grav�vel.

assertDirectoryIsWritable(string $diretorio[, string $mensagem = ''])

assertDirectoryNotIsWritable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertEmpty()

Exibe uma mensagem definida em $mensagem se $factual n�o est� vazio.

assertEmpty(mixed $factual[, string $mensagem = ''])

assertNotEmpty() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeEmpty() e assertAttributeNotEmpty() s�o inv�lucros convenientes que podem ser aplicados para um atributo public, protected, ou private de uma classe ou objeto.

assertEqualXMLStructure()

Exibe uma mensagem definida em $mensagem se a estrutura XML do DOMElement no $elementoFactualn�o � igual a estrutura XML do DOMElement no $elementoEsperado.

assertEqualXMLStructure(DOMElement $elementoEsperado, DOMElement $elementoFactual[, 
                         boolean $checkAttributes = false, string $mensagem = ''])

assertEquals()

Exibe uma mensagem definida em $mensagem se as vari�veis $esperado e $factual n�o s�o iguais.

assertEquals(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertNotEquals() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeEquals() e assertAttributeNotEquals() s�o inv�lucros convenientes que usam um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

Comparaç�es mais especializadas s�o usadas para tipos de argumentos espec�ficos para $expectede $factual, veja abaixo.

assertEquals(float $esperado, float $factual[, string $mensagem = '', float $delta = 0])

Exibe uma mensagem definida em $mensagem se os dois floats $esperado e $factual n�o est�o dentro do $delta um do outro.

assertEquals(DOMDocument $esperado, DOMDocument $factual[, string $mensagem = ''])

Exibe uma mensagem definida em $mensagem se a forma canonical n�o-comentada dos documentos XML representada pelos objetos DOMDocument $esperado e $factual n�o s�o iguais.

assertEquals(object $esperado, object $factual[, string $mensagem = ''])

Exibe uma mensagem definida em $mensagem se os objetos $esperado e $factual n�o tem valores de atributos iguais.

assertEquals(array $esperado, array $factual[, string $mensagem = ''])

Exibe uma mensagem definida em $mensagem se os arrays $esperado e $factual n�o s�o iguais.

assertFalse()

Exibe uma mensagem definida em $mensagem se a $condicao � true.

assertFalse(bool $condicao[, string $mensagem = ''])

assertNotFalse() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertFileEquals()

Exibe uma mensagem definida em $mensagem se o arquivo especificado pelo $esperado n�o tem o mesmo conte�do que o arquivo especificado pelo $actual.

assertFileEquals(string $esperado, string $factual[, string $mensagem = ''])

assertFileNotEquals() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertFileExists()

Exibe uma mensagem definida em $mensagem se o arquivo especificado pelo $nomeArquivo n�o existir.

assertFileExists(string $nomeArquivo[, string $mensagem = ''])

assertFileNotExists() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertFileIsReadable()

Exibe uma mensagem definida em $mensagem se o arquivo especificado por $nomeArquivo n�o � um arquivo ou n�o � leg�vel.

assertFileIsReadable(string $nomeArquivo[, string $mensagem = ''])

assertFileNotIsReadable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertFileIsWritable()

Exibe uma mensagem definida em $mensagem se o arquivo especificado por $nomeArquivo n�o � um arquivo ou n�o � grav�vel.

assertFileIsWritable(string $nomeArquivo[, string $mensagem = ''])

assertFileNotIsWritable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertGreaterThan()

Exibe uma mensagem definida em $mensagem se o valor de $factual n�o � maior que o valor de $esperado.

assertGreaterThan(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertAttributeGreaterThan() � um inv�lucro conveniente que usa um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

assertGreaterThanOrEqual()

Exibe uma mensagem definida em $mensagem se o valor de $factual n�o � maior ou igual ao valor de $esperado.

assertGreaterThanOrEqual(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertAttributeGreaterThanOrEqual() � um inv�lucro conveniente que usa um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

assertInfinite()

Exibe uma mensagem definida em $mensagem se $variavel n�o � INF.

assertInfinite(mixed $variavel[, string $mensagem = ''])

assertFinite() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertInstanceOf()

Exibe uma mensagem definida em $mensagem se $factual n�o � uma inst�ncia de $esperado.

assertInstanceOf($esperado, $factual[, $mensagem = ''])

assertNotInstanceOf() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeInstanceOf() e assertAttributeNotInstanceOf() s�o inv�lucros convenientes que podem ser aplicados a um atributo public, protected, ou private de uma classe ou objeto.

assertInternalType()

Exibe uma mensagem definida em $mensagem se $factual n�o � do tipo $esperado.

assertInternalType($esperado, $factual[, $mensagem = ''])

assertNotInternalType() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeInternalType() e assertAttributeNotInternalType() s�o inv�lucros convenientes que podem aplicados a um atributo public, protected, ou private de uma classe ou objeto.

assertIsReadable()

Exibe uma mensagem definida em $mensagem se o arquivo ou diret�rio especificado por $nomeArquivo n�o � leg�vel.

assertIsReadable(string $nomeArquivo[, string $mensagem = ''])

assertNotIsReadable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertIsWritable()

Reporta um erro especificado pela $mensagem se o arquivo ou diret�rio especificado por $nomeArquivo n�o � grav�vel.

assertIsWritable(string $nomeArquivo[, string $mensagem = ''])

assertNotIsWritable() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertJsonFileEqualsJsonFile()

Exibe uma mensagem definida em $mensagem se o valor de $arquivoFactual n�o combina com o valor de $arquivoEsperado.

assertJsonFileEqualsJsonFile(mixed $arquivoEsperado, mixed $arquivoFactual[, string $mensagem = ''])

assertJsonStringEqualsJsonFile()

Exibe uma mensagem definida em $mensagem se o valor de $jsonFactual n�o combina com o valor de $arquivoEsperado.

assertJsonStringEqualsJsonFile(mixed $arquivoEsperado, mixed $jsonFactual[, string $mensagem = ''])

assertJsonStringEqualsJsonString()

Exibe uma mensagem definida em $mensagem se o valor de $jsonFactual n�o combina com o valor de $expectedJson.

assertJsonStringEqualsJsonString(mixed $expectedJson, mixed $jsonFactual[, string $mensagem = ''])

assertLessThan()

Exibe uma mensagem definida em $mensagem se o valor de $factual n�o � menor que o valor de $esperado.

assertLessThan(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertAttributeLessThan() � um inv�lucro conveniente que usa um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

assertLessThanOrEqual()

Exibe uma mensagem definida em $mensagem se o valor de $factual n�o � menor ou igual ao valor de $esperado.

assertLessThanOrEqual(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertAttributeLessThanOrEqual() � um inv�lucro conveniente que usa um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

assertNan()

Exibe uma mensagem definida em $mensagem se $variavel n�o � NAN.

assertNan(mixed $variavel[, string $mensagem = ''])

assertNull()

Exibe uma mensagem definida em $mensagem se o $variavel n�o � null.

assertNull(mixed $variavel[, string $mensagem = ''])

assertNotNull() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertObjectHasAttribute()

Exibe uma mensagem definida em $mensagem se $object->attributeName n�o existir.

assertObjectHasAttribute(string $nomeAtributo, object $object[, string $mensagem = ''])

assertObjectNotHasAttribute()

corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertRegExp()

Exibe uma mensagem definida em $mensagem se $string n�o combina com a express�o regular $padrao.

assertRegExp(string $padrao, string $string[, string $mensagem = ''])

assertNotRegExp()

corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertStringMatchesFormat()

Exibe uma mensagem definida em $mensagem se a $string n�o combina com a string $formato.

assertStringMatchesFormat(string $formato, string $string[, string $mensagem = ''])

assertStringNotMatchesFormat() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

A string de formato pode conter os seguintes substitutos (placeholders):

%e: Representa um separador de diret�rio, por exemplo / no Linux.
%s: Um ou mais de qualquer coisa (caractere ou espaço em branco) exceto o caractere de fim de linha.
%S: Zero ou mais de qualquer coisa (caractere ou espaço em branco) exceto o caractere de fim de linha.
%a: Um ou mais de qualquer coisa (caractere ou espaço em branco) incluindo o caractere de fim de linha.
%A: Zero ou mais de qualquer coisa (caractere ou espaço em branco) incluindo o caractere de fim de linha.
%w: Zero ou mais caracteres de espaços em branco.
%i: Um valor inteiro assinado, por exemplo +3142, -3142.
%d: Um valor inteiro n�o-assinado, por exemplo 123456.
%x: Um ou mais caracteres hexadecimais. Isto �, caracteres na classe 0-9, a-f, A-F.
%f: Um n�mero de ponto flutuante, por exemplo: 3.142, -3.142, 3.142E-10, 3.142e+10.
%c: Um �nico caractere de qualquer ordem.

assertStringMatchesFormatFile()

Exibe uma mensagem definida em $mensagem se a $string n�o combina com o conte�do do $formatoArquivo.

assertStringMatchesFormatFile(string $formatoArquivo, string $string[, string $mensagem = ''])

assertStringNotMatchesFormatFile() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertSame()

Exibe uma mensagem definida em $mensagem se as vari�veis $esperado e $factual n�o tem o mesmo tipo e valor.

assertSame(mixed $esperado, mixed $factual[, string $mensagem = ''])

assertNotSame() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertAttributeSame() e assertAttributeNotSame() s�o inv�lucros convenientes que usam um atributo public, protected, ou private de uma classe ou objeto como o valor atual.

assertSame(object $esperado, object $factual[, string $mensagem = ''])

Exibe uma mensagem definida em $mensagem se as vari�veis $esperado e $factual n�o referenciam o mesmo objeto.

assertStringEndsWith()

Exibe uma mensagem definida em $mensagem se a $string n�o termina com $sufixo.

assertStringEndsWith(string $sufixo, string $string[, string $mensagem = ''])

assertStringEndsNotWith() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertStringEqualsFile()

Exibe uma mensagem definida em $mensagem se o arquivo especificado por $arquivoEsperado n�o tem $stringFactual como seu conte�do.

assertStringEqualsFile(string $arquivoEsperado, string $stringFactual[, string $mensagem = ''])

assertStringNotEqualsFile() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertStringStartsWith()

Exibe uma mensagem definida em $mensagem se a $string n�o inicia com $prefixo.

assertStringStartsWith(string $prefixo, string $string[, string $mensagem = ''])

assertStringStartsNotWith() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertThat().

assertThat(mixed $valor, PHPUnit_Framework_Constraint $restricao[, $mensagem = ''])

Permite a criaç�o de asserç�es mais complexas formuladas com o uso das classes PHPUnit_Framework_Constraint.

Exibe uma mensagem definida em $mensagem se o $valor n�o combina com a $restricao.

Restriç�o	Significado
PHPUnit_Framework_Constraint_Attribute attribute(PHPUnit_Framework_Constraint $restricao, $nomeAtributo)	Aplica outra restriç�o a um atributo de uma classe ou objeto.
PHPUnit_Framework_Constraint_IsAnything anything()	Aceita qualquer valor de entrada.
PHPUnit_Framework_Constraint_ArrayHasKey arrayHasKey(mixed $chave)	Assegura que o array foi avaliado a ter uma dada chave.
PHPUnit_Framework_Constraint_TraversableContains contains(mixed $valor)	Assegura que o array ou objeto que implementa a interface Iterator foi avaliado para conter um dado valor.
PHPUnit_Framework_Constraint_TraversableContainsOnly containsOnly(string $tipo)	Assegura que o array ou objeto que implementa a interface Iterator foi avaliado para conter somente valores de um dado tipo.
PHPUnit_Framework_Constraint_TraversableContainsOnly containsOnlyInstancesOf(string $nomeClasse)	Assegura que o array ou objeto que implementa a interface Iterator foi avaliado para conter somente inst�ncias de um dado nome de classe.
PHPUnit_Framework_Constraint_IsEqual equalTo($valor, $delta = 0, $maxDepth = 10)	Verifica se um valor � igual a outro.
PHPUnit_Framework_Constraint_Attribute attributeEqualTo($nomeAtributo, $valor, $delta = 0, $maxDepth = 10)	Verifica se um valor � igual a um atributo de uma classe ou objeto.
PHPUnit_Framework_Constraint_DirectoryExists directoryExists()	Verifica se o diret�rio que foi avaliado existe.
PHPUnit_Framework_Constraint_FileExists fileExists()	Verifica se o arquivo(nome) que foi avaliado existe.
PHPUnit_Framework_Constraint_IsReadable isReadable()	Verifica se o arquivo(nome) que foi avaliado � leg�vel.
PHPUnit_Framework_Constraint_IsWritable isWritable()	Verifica se o arquivo(nome) que foi avaliado � grav�vel.
PHPUnit_Framework_Constraint_GreaterThan greaterThan(mixed $valor)	Assegura que o valor que foi avaliado � maior que um dado valor.
PHPUnit_Framework_Constraint_Or greaterThanOrEqual(mixed $valor)	Assegura que o valor que foi avaliado � maior ou igual a um dado valor.
PHPUnit_Framework_Constraint_ClassHasAttribute classHasAttribute(string $nomeAtributo)	Assegura que a classe que foi avaliada tem um dado atributo.
PHPUnit_Framework_Constraint_ClassHasStaticAttribute classHasStaticAttribute(string $nomeAtributo)	Assegura que a classe que foi avaliada tem um dado atributo est�tico.
PHPUnit_Framework_Constraint_ObjectHasAttribute hasAttribute(string $nomeAtributo)	Assegura que o objeto que foi avaliado tem um dado atributo.
PHPUnit_Framework_Constraint_IsIdentical identicalTo(mixed $valor)	Assegura que um valor � id�ntico a outro.
PHPUnit_Framework_Constraint_IsFalse isFalse()	Assegura que o valor que foi avaliado � false.
PHPUnit_Framework_Constraint_IsInstanceOf isInstanceOf(string $nomeClasse)	Assegura que o objeto que foi avaliado � uma inst�ncia de uma dada classe.
PHPUnit_Framework_Constraint_IsNull isNull()	Assegura que o valor que foi avaliado � null.
PHPUnit_Framework_Constraint_IsTrue isTrue()	Assegura que o valor que foi avaliado � true.
PHPUnit_Framework_Constraint_IsType isType(string $tipo)	Assegura que o valor que foi avaliado � de um tipo especificado.
PHPUnit_Framework_Constraint_LessThan lessThan(mixed $valor)	Assegura que o valor que foi avaliado � menor que um dado valor.
PHPUnit_Framework_Constraint_Or lessThanOrEqual(mixed $valor)	Assegura que o valor que foi avaliado � menor ou igual a um dado valor.
logicalAnd()	L�gico AND.
logicalNot(PHPUnit_Framework_Constraint $restricao)	L�gico NOT.
logicalOr()	L�gico OR.
logicalXor()	L�gico XOR.
PHPUnit_Framework_Constraint_PCREMatch matchesRegularExpression(string $padrao)	Assegura que a string que foi avaliada combina com uma express�o regular.
PHPUnit_Framework_Constraint_StringContains stringContains(string $string, bool $case)	Assegura que a string que foi avaliada cont�m uma dada string.
PHPUnit_Framework_Constraint_StringEndsWith stringEndsWith(string $sufixo)	Assegura que a string que foi avaliada termina com um dado sufixo.
PHPUnit_Framework_Constraint_StringStartsWith stringStartsWith(string $prefixo)	Assegura que a string que foi avaliada começa com um dado prefixo.

assertTrue()

Exibe uma mensagem definida em $mensagem se a $condicao � false.

assertTrue(bool $condicao[, string $mensagem = ''])

assertNotTrue() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertXmlFileEqualsXmlFile()

Exibe uma mensagem definida em $mensagem se o documento XML em $arquivoFactual n�o � igual ao documento XML em $arquivoEsperado.

assertXmlFileEqualsXmlFile(string $arquivoEsperado, string $arquivoFactual[, string $mensagem = ''])

assertXmlFileNotEqualsXmlFile() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertXmlStringEqualsXmlFile()

Exibe uma mensagem definida em $mensagem se o documento XML em $xmlFactual n�o � igual ao documento XML em $arquivoEsperado.

assertXmlStringEqualsXmlFile(string $arquivoEsperado, string $xmlFactual[, string $mensagem = ''])

assertXmlStringNotEqualsXmlFile() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

assertXmlStringEqualsXmlString()

Exibe uma mensagem definida em $mensagem se o documento XML em $xmlFactual n�o � igual ao documento XML em $xmlEsperado.

assertXmlStringEqualsXmlString(string $xmlEsperado, string $xmlFactual[, string $mensagem = ''])

assertXmlStringNotEqualsXmlString() corresponde ao m�todo assert inverso, recebe os mesmos par�metros.

Confira tamb�m

Aprenda PHP

Guia

Introduç�o ao PHP

Curso

Cursos de PHP

Cursos

Teste unit�rio com PHPUnit

O PHPUnit é um framework para realização de testes unitários em PHP com base na arquitetura xUnit.

Guia do artigo:

O que � o PHPUnit?

Por que teste unit�rio � importante?

Introduç�o

Vis�o Geral

Instalaç�o

Configuraç�o

Escrevendo testes

Vis�o geral

Como executar um teste?

Na Pr�tica

Exemplo 1:

Exemplo 2:

Exemplo 3:

Ambiente

Vis�o geral

Na pr�tica

Exemplo 1

Exemplo 2

Dubl�s de Teste

Vis�o geral

Na pr�tica

Exemplo 1

Exemplo 2

Assertions

Vis�o geral

Principais m�todos da classe TestCase

assertArrayHasKey()

assertClassHasAttribute()

assertArraySubset()

assertClassHasStaticAttribute()

assertContains()

assertContainsOnly()

assertContainsOnlyInstancesOf()

assertCount()

assertDirectoryExists()

assertDirectoryIsReadable()

assertDirectoryIsWritable()

assertEmpty()

assertEqualXMLStructure()

assertEquals()

assertFalse()

assertFileEquals()

assertFileExists()

assertFileIsReadable()

assertFileIsWritable()

assertGreaterThan()

assertGreaterThanOrEqual()

assertInfinite()

assertInstanceOf()

assertInternalType()

assertIsReadable()

assertIsWritable()

assertJsonFileEqualsJsonFile()

assertJsonStringEqualsJsonFile()

assertJsonStringEqualsJsonString()

assertLessThan()

assertLessThanOrEqual()

assertNan()

assertNull()

assertObjectHasAttribute()

assertRegExp()

assertStringMatchesFormat()

assertStringMatchesFormatFile()

assertSame()

assertStringEndsWith()

assertStringEqualsFile()

assertStringStartsWith()

assertThat().

assertTrue()

assertXmlFileEqualsXmlFile()

assertXmlStringEqualsXmlFile()

assertXmlStringEqualsXmlString()

Confira tamb�m

Aprenda PHP

Introduç�o ao PHP

Cursos de PHP

Artigos relacionados