PHP TDD: Desenvolvimento Guiado a Testes

Voc� j� se perguntou o porqu� de testar um software. Se n�o testarmos, o software funciona? Por que testar? Dentre algumas metodologias �geis, o TDD tem conseguido espaço em projetos, principalmente os de grande porte, visando trazer qualidade ao software.

Mas, por que TDD? O TDD � mais do que testar c�digo: � uma mudança cultural que prop�e uma nova cultura no padr�o de desenvolvimento de software. Entenda alguns pontos fortes da metodologia:

Software escal�vel e flex�vel;
Prevenç�o de erros desde o in�cio;
Qualidade agregada ao produto final;
Confiança do c�digo;
Facilita a documentaç�o.

Mas se testar � importante, por que nem sempre testamos? Porque testar tem um custo. Muitas vezes achamos que o esforço de contratar um profissional com conhecimentos em testes de software � um custo desnecess�rio. Por outro lado, o custo de contrataç�o de um novo profissional no orçamento de uma empresa geralmente � menor do que o custo de reparar poss�veis bugs causados por falhas de software. Quando testamos, descobrimos erros precocemente. Essa � uma das vantagens de usar uma metodologia de testes.

Vamos analisar melhor uma aplicaç�o muito comum. Suponhamos um software para uma instituiç�o de ensino, e que dentro do nosso projeto de software existe uma classe aluno.php que serve como base para criaç�o de nossos alunos. A Listagem 1 mostra o modelo da nossa classe de maneira resumida.


    <?php
    class Aluno {
      private $nome;
      private $turma;
      private $idade;
      private $notaGeral;
      private $matricula;
    
      //Construtor da classe
      public function __construct($nome, $turma, $idade, $matricula) {
        $this->nome = $nome;
        $this->turma = $turma;
        $this->idade = $idade;
        $this->matricula = $matricula;
      }
    
      public function atribuirNota($n1,$n2,$n3) {
        $notas = array();
        array_push($notas, $n1,$n2,$n3);
        $this->notaGeral = array_sum($notas);
      }
    
      public function getTurma() {
        return $this->turma;
      }
    
      public function getNotaGeral() {
        return $this->notaGeral;
      }
    
      public function getMatricula() {
        return $this->matricula;
      }
    }
      ?>

Listagem 1. Classe Aluno

Quando nos referimos a testes em um projeto Orientado a objetos, a funç�o do teste de unidade � testar uma pequena parte do projeto, ou seja, a menor unidade que pode ser testada � a classe. Ent�o dever� existir um teste de unidade para cada classe existente.

Para nosso arquivo aluno.php vamos criar um arquivo de teste com a classe AlunoTest. A base da nossa classe teste ficaria conforme a Listagem 2.


      <?php
      require_once '../../../src/Application/Exemplo/aluno.php';
      class AlunoTest extends Aluno{
          public function testarNumeroMatricula() { }
          public function testarTurma() { }
          public function testarNota() { }
      }
      ?>

Listagem 2. Classe de teste AlunoTest

Cada m�todo que necessita ser implementado � respons�vel por testar uma funç�o da classe Aluno em aluno.php. O trabalho � exaustivo, pois primeiro ter�amos que instanciar objetos da classe Aluno em nossa classe filha Alunotest, e s� assim, testar as possibilidades de implementaç�o, testando poss�veis dados corretos e dados que causariam falha ao c�digo.

O PHPUnit poupa bastante trabalho quando se trata de testes, devido � uma grande quantidade de m�todos j� implementados que podem ser usados, poupando boa parte da implementaç�o.

Vejamos como pode ser feita a aplicaç�o do TDD em um projeto de PHP. Cada funcionalidade � iniciada com a criaç�o de um teste, ou seja, em um projeto TDD devemos criar a classe de teste antes da pr�pria classe que ser� testada.

Foi mostrado no c�digo anterior como podemos criar e definir uma classe de teste funcional, respons�vel por uma pequena parte do c�digo. Voc� pode pensar que � f�cil e r�pido. Pode at� ser feito de forma r�pida em um pequeno projeto, com poucas classes implementadas. Mas imagine um grande projeto com centenas ou at� milhares de classes. � invi�vel criar testes manualmente. � importante que estes sejam automatizados, pois a automaç�o dos processos do TDD gera c�digos de testes de maior qualidade e menor probabilidade de erros.

Os processos de teste automatizados s�o semelhantes aos manuais. Precisamos ter uma situaç�o para execut�-los e recebermos uma validaç�o.

Ambiente > Execuç�o > Validaç�o

J� que falamos de automaç�o, vamos ent�o repensar nossa maneira de testar nossas classes, especificamente usando a linguagem PHP.

Como exemplo, ser� utilizado o framework de testes PHPUnit. E para instal�-lo vamos precisar de alguns requisitos (saiba que existe mais de uma maneira de instalaç�o, mas no nosso projeto instalaremos atrav�s do Composer. Mais detalhes poder�o ser conferidos na documentaç�o oficial do PHPUnit (seç�o Links)):

Composer (Gerenciamento de depend�ncias);
PHP (Instalar a �ltima vers�o do PHP � altamente recomend�vel);
Suporte a extens�es .json, que normalmente est�o habilitadas por padr�o;

Como exemplo, a IDE usada ser� a Sublime Text 3.

Instalando o PHPUnit

Existe mais de uma forma de instalar o PHPUnit. No site oficial tem informaç�es de como instalar usando o Composer ou atrav�s do download do arquivo PHAR (PHP Archive).

Faremos a instalaç�o atrav�s do Composer, que � o gerenciador de depend�ncias do PHP. Antes de instalar o PHPUnit, a primeira tarefa que deve ser feita � criar um diret�rio no qual vamos trabalhar. Dentro deste diret�rio dever� conter o arquivo "composer.json", onde dever�o estar declaradas as bibliotecas utilizadas pelo PHPUnit. O arquivo funcionar� basicamente como auxiliar e gerenciar� todas as depend�ncias do projeto. Tudo que estiver no reposit�rio do Composer ser� gerenciado conforme as especificaç�es do arquivo.

Dentro deste arquivo, obrigatoriamente, dever� conter o conte�do de acordo com a Listagem 3.


      {
        "require-dev" : {
        "phpunit/phpunit" : "*"
        }
      }

Listagem 3. Arquivo composer.json

Veja que estamos importando o PHPUnit na sua vers�o mais atual. Caso queira utilizar alguma vers�o espec�fica, basta acrescentar o n�mero da vers�o antes de "*", dentro das aspas.

Assim a declaraç�o das depend�ncias que ser�o usadas no projeto est� pronta.

O pr�ximo passo � instalar o Composer no diret�rio do projeto. Para isso, utilizando a linha de comando, navegue at� o diret�rio onde se encontra o arquivo composer.json e utilize o comando a seguir:


    Composer install

Veja na Figura 1 o processo de instalaç�o.

Figura 1. Instalaç�o do composer via Prompt de comando

Voc� perceber� que o Composer iniciar� a instalaç�o, inclusive do PHPUnit, conforme mostra a Figura 2.

Figura 2. Instalaç�o do PHPUnit com composer

Perceba que foi feito o download do framework conforme a especificaç�o do arquivo composer.json.

Ap�s o t�rmino da instalaç�o ser�o criadas algumas pastas no nosso diret�rio. A estrutura de pastas de instalaç�o ficar� conforme a Figura 3.

Figura 3. Diret�rio de instalaç�o do composer

Na pasta vendor � onde est�o as bibliotecas de terceiros (incluindo o PHPUnit) que poder�o ser usadas no projeto. Al�m disso, na pasta raiz aparecer� um arquivo, o composer.lock, que armazena as vers�es exatas das bibliotecas assim como quaisquer alteraç�es feitas.

Conhecendo o PHPUnit

Ap�s a instalaç�o, vamos testar se tudo est� conforme o esperado. Na linha de comando digite phpunit. Se a instalaç�o foi bem-sucedida, o resultado ser� uma esp�cie de helper com comandos v�lidos de acordo com a Figura 4.

Figura 4. Helper PHPUnit

Todos esses comandos ser�o v�lidos no nosso console sempre que utilizarmos o phpunit.

Al�m dos testes convencionais, � poss�vel testar interaç�es com bancos de dados. Para isso existe o DbUnit, que pode ser instalado via composer adicionando no arquivo composer.json a depend�ncia:


    "phpunit/dbunit": ">=1.2"

Asserç�es no PHPUnit3

Asserç�es s�o funç�es do PHPUnit j� implementadas que servem para validaç�es. Elas asseguram que uma sa�da ter� o valor esperado. Existem asserç�es para testar tipos primitivos ou at� mesmo objetos e comunicaç�es com bancos de dados.

Normalmente o m�todo de asserç�o usado com bastante frequ�ncia � o assertEquals().

Iniciando com PHPUnit

Com o PHPUnit instalado crie os subdiret�rios do projeto de modo que sejam iguais. Isso � importante para facilitar e separar a responsabilidade de cada diret�rio.

A Figura 5 mostra como exemplo uma estrutura de diret�rios, diferenciando a pasta de c�digo de produç�o e de testes, onde na pasta src temos nosso c�digo em produç�o, e na pasta teste temos nossos arquivos de testes unit�rios.

Figura 5. Exemplo de diret�rio

Agora, para iniciarmos o trabalho com o PHPUnit � interessante trabalharmos com autoloader, al�m de ser um padr�o do Framework Interop Group (FIG).

Ent�o adicionaremos algumas linhas no arquivo composer.json, que ficar� com a seguinte estrutura de acordo com a Figura 6.

Figura 6. Arquivo composer.json

Agora vamos praticar os nossos testes e o ciclo do TDD.

O seu funcionamento � dividido em tr�s estados: Red, Green, refactor, como de acordo com a Figura 7.

Figura 7. Ciclo do TDD

Primeiro escreva um teste que falhe. Depois escreva um que funcione da maneira mais simples e, por fim, refatore o c�digo. Geralmente esse ciclo � feito uma vez para cada teste unit�rio.

Vamos ao nosso exemplo aluno.php, mas desta vez, vamos testar nossa classe usando o PHPUnit. A nossa classe de teste foi modelada conforme a Listagem 4.


      require_once '../../../src/Application/Exemplo/aluno.php';
      class AlunoTest extends Aluno{
          public function testarNumeroMatricula() { }
          public function testarTurma() { }
          public function testarNota() { }
      }
      ?>

Listagem 4. Classe alunotest a ser modificada

Essa classe merece ser reescrita de acordo com o uso do PHPUnit. Vamos reescrev�-la conforme a Listagem 5.


    
      <?php
       
      use PHPUnit_Framework_TestCase as PHPUnit;
       
      require_once '../../../src/Application/Exemplo/aluno.php';
       
      class AlunoTest extends PHPUnit{
                      
          //Funç�o de teste de tipo - Compara tipo da vari�vel Matricula
          public function testType() {
              $aluno = new Aluno("Jose", "B", 12, 001);
              $this->assertInternalType('int', $aluno->getMatricula());
          }
    
          //Funç�o de teste de n�mero de matricula - Verifica numero de alunos cadastrados
          public function testNumeroMatricula() {
              $aluno = new Aluno("Jose", "B", 12, 001);
              $this->assertEquals(001, $aluno->getMatricula());
          }
          //Funç�o de teste que verifica turma do aluno
          public function testTurma() {
              $aluno = new Aluno("Maria", "C", 10, 002);
              $this->assertEquals("C", $aluno->getTurma());
          }
    
          //Funç�o que compara nota do aluno atual com nota esperada
          public function testNota() {
              $aluno = new Aluno("Joao", "C", 10, 002);
              $aluno->atribuirNota(10,7,9);
              $this->assertEquals(25, $aluno->getNotaGeral());
          }
      }
      ?>

Listagem 5. Classe alunoTest remodelada

Perceba no c�digo apresentado que foram usadas algumas convenç�es do framework. O nome da classe est� como AlunoTest, que � uma convenç�o do PHPUnit, onde uma classe de teste, para ser reconhecida como classe uma, deve possuir o sufixo "Test". Al�m disso, est� herdando da classe PHPUnit_Framework_TestCase. Isso � necess�rio para que se possa trabalhar com os m�todos j� implementados pelo framework. No caso dos m�todos, deve ser usada a palavra "test" como prefixo, ou seja, antes do nome do m�todo.

Perceba tamb�m que na maioria dos nossos m�todos foi utilizado a funç�o assertEquals(), com dois par�metros:


    assertEquals(x,y);

Onde x � o resultado esperado para a funç�o e y � o resultado corrente.

Visualizando resultados

Como a instalaç�o foi feita via composer, vamos executar os testes atrav�s do prompt de comando.

No diret�rio do arquivo alunoTest.php, vamos executar o seguinte comando:


    Phpunit �debug alunoTest.php

Isso far� com que o teste seja executado. Veja a execuç�o na Figura 8.

Figura 8. Execuç�o dos testes atrav�s da linha de comando

Veja que logo ap�s phpunit existe o comando debug, que habilita o modo debug para detalhamento das aç�es que est�o sendo tomadas.

Veja tamb�m que o teste apresentou uma falha no m�todo testNota.

A explicaç�o da falha foi: Failled asserting that 26 matches expected 25.

Vamos verificar esta parte do c�digo na Listagem 6.


      public function testNota() {
        $aluno = new Aluno("Joao", "C", 10, 002);
        $aluno->atribuirNota(10,7,9);
        $this->assertEquals(25, $aluno->getNotaGeral());

Listagem 6. Funç�o testNota

A funç�o assertEquals compara dois resultados, neste caso estamos passando como par�metro o n�mero 25 como esperado para a operaç�o, quando na verdade a soma das notas passadas na chamada do m�todo vai gerar o resultado 26 (10+7+9 = 26).

Veja na Listagem 7 a correç�o da funç�o e vamos ver os resultados na Figura 9.


      public function testNota() {
        $aluno = new Aluno("Joao", "C", 10, 002);
        $aluno->atribuirNota(10,7,9);
        $this->assertEquals(26, $aluno->getNotaGeral());

Listagem 7. Funç�o testNota corrigida

Figura 9. Verificaç�o de resultados do PHPUnit

Note que ap�s a verificaç�o de cada m�todo dentro da classe de teste, o PHPUnit retornou a mensagem OK (4 tests, 4 assertions). Isso significa que todos os testes passaram sem erros ou falhas.

Al�m disso, o PHPUnit nos retornou o tempo de execuç�o e a mem�ria alocada.

Manipulando dados no prompt de comando

Existem alguns comandos que podem ser usados no console no momento de gerar o output com PHPUnit que podem ser �teis no entendimento dos dados gerados.

Vejamos alguns deles:


    Phpunit testdox arquivoTest.php

O c�digo imprime na tela um checkbox com os m�todos implementados na classe de teste. Os testes que passaram recebem um "x" e os que falharam apresentam um campo em branco, como mostra a Figura 10.

Figura 10. Testdox


    Phpunit �tap arquivoTest.php

O comando --tap imprime os m�todos e os relacionam com sua classe de forma numerada, como na Figura 11.

Figura 11. Comando �tap do PHPUnit

Outro comando que tamb�m ajuda a visualizar a informaç�o � o seguinte:


    Phpunit �colors

Este �ltimo apenas imprime a informaç�o com cores: cor vermelha para testes que falharam e cor verde para os bem-sucedidos.

Executando uma su�te de testes

Al�m de executar testes um a um na linha de comando, o PHPUnit possui uma funcionalidade chamada de testsuite, que � usada para executarmos v�rios deles ao mesmo tempo.

O testsuite pode ser executado de duas maneiras:

Essa � a forma mais simples: pela linha de comando � preciso apontar o executor de testes para o diret�rio que cont�m os arquivos a serem testados, como mostra o exemplo a seguir:

Phpunit --bootstrap vendor/autoload.php tests

O comando --bootstrap est� apontando o executor do PHPUnit para o diret�rio tests, que cont�m todos os arquivos de teste, assim todos os arquivos ser�o testados em lote.
A outra forma � atrav�s de um arquivo XML, como mostra o exemplo da Listagem 8.
<?xml version="1.0" encoding="UTF-8" ?> <phpunit> <testsuites> <testsuite name="Exemplo de su�te de testes"> <directory> ./tests/</directory> </testsuite> </testsuites> </phpunit>
Listagem 8. Testsuites com XML

O arquivo XML passa como par�metro o diret�rio dentro das tags . Isso significa que todos os arquivos que estiverem dentro deste diret�rio ser�o testados.Para executarmos o arquivo XML no terminal, basta digitarmos o seguinte comando:

Phpunit �configuration diretorio/arquivo.xml

Caso queira executar arquivos espec�ficos dentro da testsuite, basta incluir no arquivo xml a tag , passando como par�metro o diret�rio completo do arquivo, acompanhado de sua extens�o .php, como mostra a Listagem 9.

<?xml version="1.0" encoding="UTF-8" ?> <phpunit> <testsuites> <testsuite name="Exemplo de su�te de testes"> <file> ./tests/Application/Exemplo/alunoTest.php</file> </testsuite> </testsuites> </phpunit>
Listagem 9. Testsuites com arquivos espec�ficos

Perceba que as tags foram retiradas. Em contrapartida, foram adicionadas as tags.

Pulando arquivos da su�te de testes

Se por algum motivo quisermos que determinado arquivo dentro de nosso diret�rio n�o seja testado, basta usarmos a tag , passando o diret�rio completo do arquivo .php, como mostra o exemplo da Listagem 10.


      <?xml version="1.0" encoding="UTF-8" ?>
        <phpunit>
      <testsuites>
          <testsuite name="Exemplo de su�te de testes">
            <directory> ./tests/ </directory>
            <exlude> ./tests/Application/Exemplo/alunoDAOTest.php</exclude>
          </testsuite>
      </testsuites>
    </phpunit>

Listagem 10. Pulando arquivos

Com isso, o arquivo passado entre as tags ser� mantido no diret�rio, mas n�o ser� inclu�do nos testes.

O objetivo deste artigo n�o foi ensinar PHP, mas apenas dar uma breve introduç�o ao TDD e ao PHPUnit, que hoje � o framework mais popular para testes em PHP.

A metodologia baseada em testes muda a maneira de como desenvolvemos software. Apesar de uma mudança cultural nos processos do desenvolvimento padr�o, testar o c�digo torna o software mais confi�vel, flex�vel, escal�vel e garante a conformidade com os requisitos.

Links:

Documentaç�o PHPUnit