Back-End

17 jul, 2009

Iniciando com o SimpleTest

Publicidade

Salve, people! Vamos iniciar hoje uma pequena jornada a terras
que possivelmente muita gente só viu/leu em sites especializados e
muito pouco comentadas em PHP: a terra do desenvolvimento orientado a
testes, ou TDD.

Se você não sabe ou nem faz idéia do que é TDD, dê uma procurada no Google pois existem dezenas de sites muito bacanas destilando idéias e tudo mais sobre isso.

Em poucas palavras, TDD
(Test Driven Development) é um técnica de desenvolvimento de software
que nos diz que devemos escrever os testes antes de escrever o código
da aplicação propriamente dito.

Inicialmente isso parece
meio louco: afinal, você sempre testa DEPOIS de escrever seus programas
ou durante, enquanto debuga tudo, correto? Mas, com o passar do tempo,
a verdadeira natureza e vantagem do TDD, quando aplicada corretamente,
se faz presente.

Você se torna capaz de antecipar a detecção e
correção de várias falhas, reduzindo dramaticamente o tempo gasto com
correções em cima de implementações muito complexas já praticamente no
final do seu cronograma.

Hoje em dia, existem várias frameworks
que auxiliam nessa tarefa de escrever testes. O foco aqui é algo que
poucos sites (principalmente em português) abordam de forma prática que
é o uso da SimpleTest, uma framework para testes unitários que vem ganhando o espaço antes ocupado pelo PHPUnit.

No
decorrer dos próximos artigos sobre o SimpleTest, você poderá adquirir um
pouco de conhecimento que poderá ser útil em seus futuros projetos.
Então, vamos simbora.

Instalando o SimpleTest

A instalação do SimpleTest em si é muito fácil.

  1. Baixe a versão mais atual do SimpleTest no site http://www.simpletest.org (a versão que usaremos nessa sequência de tutoriais é a 1.0.1). A framework é composta por uma pasta simples;
  2. Descompacte
    o arquivo dentro de sua aplicação. Para fins de organização, vamos
    criar uma pasta “tests” na raíz de nossa aplicação e descompactar o
    zip/tar do SimpleTest lá: ao descompactar você verá uma pasta chamada simpletest sendo criada.

Em tese, nossa aplicação pode ter qualquer estrutura de diretórios. O
SimpleTest funciona tanto com functions como com classes. Vamos abordar
o uso de classes, dado que o TDD é amplamente usado em sua maioria em
soluções OO (Orientadas a Objeto) e acho que já passou da hora de a
comunidade PHP pensar OO.

Partindo desse pressuposto, vamos criar a pasta “classes” na raíz de nossa aplicação: lá iremos botar todas as nossas classes que serão usadas nos testes.

Teremos, então, uma estrutura de arquivos como abaixo:

A pasta app_tdd é a pasta onde está nossa aplicação: uma pasta criada dentro do meu htdocs (raiz do Apache).

Se o seu servidor web estiver instalado com configurações-padrão, provavelmente você poderá acessar usando: http://localhost/app_tdd

Nosso problema: uma calculadora

Com o SimpleTest “instalado” em nossa aplicação e nossa estrutura de
diretórios resolvida, vamos escrever nosso primeiro caso de teste.

O cenário de nossa aplicação é uma calculadora: nossa calculadora conseguirá efetuar apenas a operação de soma.

Com uma análise rápida do problema, já nos vem à cabeça que:

  • Uma classe chamada “Calculadora” com um método chamado “soma”;
  • Nosso método soma recebendo dois números
  • Nosso método retornando o valor da soma entre os dois números

Nossa abordagem não TDD seria: vamos fazer a classe,
implementar o método e depois testá-lo em uma página teste. Correto?
Num primeiro momento isso seria ótimo: afinal, o código e complexidade
das classes inicialmente são lindos.

Mas imagine agora sua aplicação crescendo e crescendo:
classes estendendo e usando outras classes. Você estende a Calculadora,
outra classe utiliza o método soma e você vai testando apenas “o que
vem depois”.

Num dado momento, você tem um resultado incorreto de soma:
uma entrada incorreta de parâmetros, um deles ser uma letra e não um
número, termos uma passagem de um objeto ao invés de um número
propriamente dito De quem é a culpa? Da classe
nova, que esqueceu de filtrar a entrada de parâmetros? Do designer,
que esqueceu de limitar a entrada dos valores no form para apenas
números? Do outro programador, que foi descuidado e não validou se os
dados passados eram realmente números antes de chamar a soma?

Enfim, temos N cenários onde a detecção do erro pode ser muito custosa,
seja pelo método para encontrá-lo (que varia do debug minucioso ao
“achismo”) e/ou pelo custo em termos de tempo para consertá-lo. Tudo
isso pode gerar um custo/prejuízo que seria reduzido com a
implementação do pensando TDD.

Pensando primeiro em testes

Mentalize: “Quais as situações que podem quebrar meu método soma? Se acontecer, como devo tratar esse erro?”

Com base nesse pensamento, podemos deduzir:

  • Para somar, nossa calculadora terá que receber sempre dois números;
  • A soma sempre ocorre entre dois números, nunca entre letras, objetos ou qualquer coisa que não seja exatamente um número;
  • Se algo der erro, devo retornar falso;

Interessante! Não implementamos nenhuma linha de nossa solução e já sabemos:

  • Que vamos precisar de uma classe (Calculadora) com um método de soma;
  • Sabemos que o método deverá receber dois parâmetros que deverão ser sempre números;
  • Que se for passada qualquer coisa que não sejam dois números, eu devo retornar falso;

Bom, então vamos implementar a classe? Não, pequeno gafanhoto: vamos implementar primeiro os testes,
porque é com base neles que vamos ter certeza de que nossa classe se
comportará exatamente como pensamos que ela deve se comportar sob os
mais diversos cenários.

Escrevendo nosso primeiro teste

Implementar um teste com SimpleTest é, como o nome já diz, “simples”.

Vamos criar todos os nossos testes dentro da pasta tests.
Para cada classe que tivermos que testar, vamos criar um caso de teste
(unit test case) que será representado em um arquivo php.

Então, nosso primeiro caso de teste será o calculadora_test.php. O nome do arquivo não tem um padrão de nomenclatura, mas por convenção usa-se sempre nomedaclasse_test.php.

calculadora.php -> calculadora_test.php

A estrutura inicial do nosso arquivo calculadora_test.php será a seguinte:


PHP | copy code | ?

require_once('simpletest/autorun.php');

require_once('../classes/calculadora.php');

class TestOfCalculadora extends UnitTestCase {

// os testes vão aqui ;)

}

Pronto! Nosso caso de teste da classe Calculadora está feito. Para testá-lo, vamos apontar o browser para http://localhost/app_tdd/tests/calculadora_test.php. O resultado será:


PHP | copy code | ?

Warning: require_once(../classes/calculadora.php) [function.require-once]: failed to open stream: No such file or directory in /Applications/MAMP/htdocs/app_tdd/tests/calculadora_test.php on line 4

Fatal error: require_once() [function.require]: Failed opening required '../classes/calculadora.php' (include_path='.:/Applications/MAMP/bin/php5/lib/php:/Users/leohackin/PEAR') in /Applications/MAMP/htdocs/app_tdd/tests/calculadora_test.php on line 4

Ops! Não criamos nossa classe ainda, por isso
obtemos esse erro. Quando disse que escrevemos testes antes de
implementar nossa lógica, estava falando sério. =)

Vamos criar nossa classe Calculadora então.

PHP | 		 copy code |	?	 

class Calculadora {

function soma($a,$b) {

}

}

Legal, agora vamos acessar nosso caso de teste de novo.

Uhu! Funfou!!!

Analisando o código:

  • fazemos o include de dois arquivos:
    • o arquivo autorun.php é o arquivo que faz a “mágica”
      acontecer: é ele quem roda os testes e exibe os resultados, portanto
      deverá sempre estar no seu caso de teste;
    • o outro arquivo é a classe que desejamos usar no teste, no caso calculadora.php
  • Criamos uma classe chamada TestOfCalculadora extendendo UnitTestCase, que será a classe que o SimpleTest usará para fazer o teste. É obrigatório que a classe inicie com o nome “test” para que o SimpleTest execute automaticamente a mesma como um caso de teste. Existe uma forma de fazê-lo sem iniciar o nome com “test”, mas isso não vem ao caso agora.

Maneiro, né? Mas como puderam notar, nosso caso de teste não testa nada ainda. Hahahaha

Vamos adicionar agora um teste:
o teste vai verificar se a soma está realmente “somando” dois números.
Para isso, devemos adicionar um método à nossa classe de testes. Vamos
chamar esse teste de “testSomaDoisNumerosInteiros“, onde vamos passar dois números inteiros esperando que a soma deles esteja correta.

Usar
nomes grandes assim no nome do método são uma boa prática, já que
deixam os testes mais legíveis na hora de rodar o caso de teste.

PHP | 		 copy code |	?	 

require_once('simpletest/autorun.php');

require_once('../classes/calculadora.php');

class TestOfCalculadora extends UnitTestCase {

function testSomaDoisNumerosInteiros() {

$calculadora = new Calculadora();

$this->assertEqual($calculadora->soma(1,1), 2);
}

}

Como visto, temos nosso método testSomaDoisNumerosInteiros que instancia nossa classe Calculadora e depois executa um método chamado assertEqual. Esse método é o responsável por testar nossa soma. Ele significa:

Verifique se a chamada $calculadora->soma(1,1) retornará um resultado igual à 2

Se
a chamada retornar qualquer coisa diferente de dois, nosso teste irá
falhar, identificando que algo de podre está acontecendo em nosso
método soma.

Se rodarmos esse script teremos enfim:

Tivemos uma falha. Traduzindo a mensagem de forma prática:

O
seu teste testSomeDoisNumerosInteiros, do caso de teste
TestOfCalculadora, falhou porque NULL (que foi retornado pela chamada
ao nosso método soma) não é igual a 2 (que seria nossa resposta
esperada).

A resposta para isso é que ainda nem
implementamos nosso método soma. Mas vejamos que nesse ponto já sabemos
exatamente como deve ser comportar nosso método para o funcionamento
com dois números.

Vamos implementar nossa classe então:


PHP | copy code | ?
1
class Calculadora {

function soma($a,$b) {

return $a + $b;
}
}

Com nosso método agora implementado, vamos executar nosso caso de teste de novo.

Agora, sim! Temos um caso de teste funcional que testa uma classe implementada. Parabéns por chegar até aqui.

Nesse ponto, já temos conhecimento suficiente para escrever vários casos de teste para nossas classes. Um caso de teste pode conter vários testes diferentes: cada teste é feito através de um método da classe do caso de teste.

Revisando
aquelas possibilidades de cenário que poderiam “quebrar” nossa
calculadora, já testamos se a soma está correta. Agora, podemos testar
as possibilidades que podem gerar um erro na calculadora.

Uma
delas é se passarmos letras no lugar de números: havíamos combinado que,
nessa situação, devolveríamos falso para o resultado, correto? Então,
vamos escrever o teste: vamos chamá-lo de “testSomaNaoNumeros“:


PHP | copy code | ?

function testSomaNaoNumeros() {

$calculadora = new Calculadora();

$this->assertEqual($calculadora->soma(1,'A'), false);
}

Adicionamos essa função à nossa classe. Rodamos nosso teste novamente e …

Previsivelmente, temos um erro pois nosso método soma ainda não verifica se os parâmetros recebidos são números válidos. Aí você irá pensar:

Mas eu vou escrevendo os testes e vou implementando toda a minha lógica de negócio ao mesmo tempo?

A TDD tem uma característica bacana, que anda de mãos dadas ao refactoring:
a TDD nos diz que devemos SIM escrever os testes primeiro e fazer as
classes “passarem no teste” usando o mínimo de código possível: se a
lógica for complexa, retorne uma resposta “hardcode” para “enganar” o
teste e depois faça o refactory do código.

O refactory deve ser
feito apenas depois de todos os testes serem feitos, pois nesse ponto
você terá certeza de como o funcionamento de sua classe atenderá a
todos as respostas que são requisitadas nos testes como “corretos”.

Pensando nisso, vamos fazer nosso método soma “passar” no teste:


PHP | copy code | ?

class Calculadora {

function soma($a,$b) {

if (is_int($a) && is_int($b)){

return $a + $b;

} else {

return false;

}

}

}

Agora, vamos rodar nosso teste.

Blz!
Nosso teste passou, mas testamos apenas se os valores são inteiros e se
forem, efetuamos a soma. Se não forem, a gente retorna false, como
nosso teste pediu. Podemos depois refatorar isso: verificar se o valor
é uma string com um número dentro e por aí vai.

Finalizando

Você pode estar se perguntando: “Uai,
mas podemos ter muito mais ocasiões que podem quebrar a soma! Podemos
também estender algumas funcionalidades e exibir mensagens de erro”.

Tivemos
uma amostra do que é o SimpleTest em seu cenário mais simples: apesar
do tamanho do post, o conceito e a aplicação são bem simples como
puderam ver.

Além do assetEqual, a SimpleTest tem um set de ações enorme de validações, além de recursos mais avançados, como suites, mocks e web tests que veremos em breve.

Crie
outras classes, pense nos testes, escreva seus casos de teste e vá
executando: com a prática isso vai ficar tão automático que o ganho com
a diminuição dos testes e bugs no final da aplicação vão ser notórios.

Testes nos tornam programadores melhores. Pense nisso.

Algumas coisas para se pensar quando começar a abordar isso:

  • Não precisamos escrever TODOS os testes: é completamente
    normal se esquecermos algo ou houver alguma necessidade de mudança de
    negócio do cliente que nos fará escrever novos testes ou reescrever os
    existentes. Tenha em mente que o TDD é para ajudar e não para ser mais
    uma fase carrancuda e intransponível no desenvolvimento;
  • A
    análise para chegar aos casos de teste faz bem ao início do projeto:
    com essa abordagem, você pode fazer perguntas ao cliente (e ele a você)
    sobre algumas coisas que possivelmente só apareceriam no final do
    projeto gerando assim muito retrabalho;

Bom, por enquanto é isso, pessoal. No próximo artigo falaremos um pouco
sobre agrupamentos de teste e partir para um exemplo mais complexo.

Espero que tenham gostado!

Simbora!