Léo Hackin 0.2c » simpletest

Mock Objects no SimpleTest

Léo Hackin — Fri, 04 Dec 2009 15:51:34 +0000

Olá pessoal,

Continuando nossa sequência de artigos sobre o SimpleTest, já aprendemos como fazer testes unitários e agrupa-los para facilitar a execução em lote: agora vamos falar um pouco sobre mock objects.

Até agora, nossos testes unitários se resumiram a testar métodos e funcionalidades que envolviam apenas uma classe como nossa calculadora: tínhamos um método chamado “somar” que fazia parte da própria classe e recebia como parametro de entrada apenas dois inteiros.

A idéia do teste unitário (ou de unidade), como o próprio nome diz, é isolar e testar apenas aquele ponto e funcionalidade do software: então é imprescindível que possamos isolar da melhor maneira apenas a classe/métodos que desejamos testar para que, caso apresente falha, possamos identificar exatamente onde a falha ocorreu.

Mas e quando nossa classe depende de outra(s) classe(s) para fazer um método funcionar ?

Conceituando o problema

Então, vamos imaginar a seguinte situação: estamos desenvolvendo um software de e-commerce e em dado momento precisamos validar se um usuário existe em nosso banco de dados. Apesar das possibilidades abrangentes de um sistema de validação/autenticação, vamos nos preocupar com o básico e implementá-lo de uma forma simples como abaixo:

As classes usadas no validador

Vamos criar uma classe chamada Validator, que receberá o login do usuário, verificará no banco de dados se ele existe ou não e validará seu acesso. Para tanto, nossa classe de validação terá um método chamado validate, que receberá um parâmetro string representando o nome do usuário a ser validado.

Para conectar-se ao banco de dados, nossa classe receberá em sua criação um objeto referente à classe Conexao, que disponibilizará um método chamado query, que consulta o banco e retorna uma array de resultados.

classe validator.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

class Validator {

var $conexao;

function __construct($conexao) {

$this->conexao = $conexao;

}

public function validate($nome) {
// aqui vai a lógica para verificar se o usuário existe ou não e que vamos testar
}

}

classe conexao.php

1
2
3
4
5
6
7
8
9
10
11

class Conexao {

function __construct($config) {
// configura o acesso ao banco de dados
}

function query($query) {
// retorna um array com os resultados da consulta
}

}

Para que tudo fique mais claro, podemos dar uma olhada em como ficaria nosso código final da aplicação:

1
2
3
4
5
6
7
8
9
10

$config = new Config();
$conexao = new $Conexao($config);
$validator = new Validator($conexao);

$usuario = 'Léo';
if ($validator($usuario)) {
// redireciona para a página restrita
} else {
// retorna uma alerta falando que o usuário não existe
}

Como aprendemos em nosso primeiro artigo sobre TDD, primeiro fazemos os testes e depois fazemos nossa aplicação passar nos neles, implementando a lógica de negócio válida. Nosso objetivo nesse momento é testar o método validate: fazendo um pouco de nossa flexão mental chegamos a dois comportamentos válidos para o método:

Se o usuário existir, ele retornará true;
Se o usuário não existir, ele retornará false;

O problema

Então, pensamos “Bacana! Então vou fazer um caso de teste chamado ValidatorTestCase e um teste chamado testValidarSeUsuarioExistir que irá validar se um usuário foi validado se ele existir!“.

Partimos para o código então:

1
2
3
4
5
6
7
8
9
10
11
12

class ValidatorTestCase extends UnitTestCase {

function testValidarSeUsuarioExistir() {

$config = new Config();
$conexao = new Conexao($config);
$validator = new Validator($conexao);
$this->assertEqual($validator->validate('Léo'), true);

}

}

Tudo ok ? NADA OK! O código acima pode funcionar mas temos alguns problemas:

Como garantir que nosso banco de dados vai estar disponível na hora do teste ?
Como vamos saber se existe o usuário que queremos testar está no banco, para testarmos se a validação realmente vai passar no teste e se comportar como queremos ?
E se ocorrer um erro de conexão ao banco no meio do teste ?
E se a conexão banco for demorada e nosso caso de teste ter 50 testes acessando o banco? oO
Como saber se as configurações estão exatas para a conexão no banco? Aliás, eu nem sei nada sobre config até agora!
E principalmente: e se ocorrer um problema na pesquisa da query que não tenha nada haver exatamente com nosso validador, já que nosso objetivo é testar unicamente se “ao receber um usuário, verificar se ele existe no banco e validar em caso afirmativo”.

Haja coisa né ?

Mock Objects (nosso boneco de testes)

Pensando nesse problema, foram criados os Mock objects. Um mock object (vou usar o termo em inglês pois a esmagadora maioria das referências TDD estão assim) nada mais é que um objeto que simula e imita o comportamento de um objeto real.

Imagine os bonecos de teste de batidas de carro: os engenheiros os constroem com peso, altura, juntas e vários aspectos que imitam o corpo de um ser humano para poderem fazer seus testes. Eles colocam esses bonecos nas mais variadas situações e posições possíveis para testarem a segurança de um carro entre outras coisas, sem precisar matar ninguém para isso.

No nosso caso, nossos mock objects são representações de classes reais onde podemos simular e forçar qualquer comportamento que desejamos para testarmos certas situações que talvez não seriam possíveis de serem alcançadas “explicitamente” sem gambiarra-las ou mesmo que sejam de dificil configuração.

Em resumo, usamos um mock quando nossa classe real (colado do wikipedia – thank’s god):

gera resultados não deterministicos (e.g. a hora ou temperatura atual);
tem estados que são difíceis de criar ou reproduzir (e.g. erro de comunicação da rede);
é lento (e.g. um banco de dados completo que precisa ser inicializado antes do teste);
ainda não existe ou pode ter comportamento alterado;
teriam que adicionar informações e métodos exclusivamente para os testes (e não para sua função real).

Analisando nosso problema anterior, podemos constatar que nossa classe Conexao é forte candidata à ser “mockeada”: assim nos livramos de todos aqueles problemas de conexão, de existência de registros e tudo mais que não tem nada haver com nosso teste unitário em si, que diz respeito pura e diretamente à nossa classe Validator.

Ou seja, ao invés de usar a classe Conexao real, vamos usar uma “imitação” dela, muito mais simples e fácil de manipular para chegarmos de forma mais simples ao nosso resultado esperado no teste unitário. Vamos utilizar esse mock pois não faz sentido testar a conexão nem nenhum método dessa classe e sim utilizar o comportamento referente ao código que vamos utilizar no nosso teste.

Codando!

Como vimos, nossa classe Conexao não tem nada implementado ainda. Mas isso não nos interessa pois vamos fazer um mock da classe, para podermos simular o que precisamos: o retorno dos resultados que desejamos para testar o método validate do Validator.

Para criar um mock de nossa classe, simplesmente fazemos o include dessa classe em nosso teste e “geramos” esse mock com o método generate da classe Mock (que é importada automaticamente no nosso include do autorun.php do Simpletest).

1
2
3
4
5

require_once('simpletest/autorun.php');
require_once('conexao.php');
require_once('validator.php');

Mock::generate('Conexao');

Com isso, vamos gerar um clone mockeado da classe Conexao para podermos usa-la em nossos testes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Fácil né ?

Mocks como atores

Agora que sabemos como criar um mock, vamos aprender a “imitar” o que a classe original faz afim de “simular” os resultados que queremos ter para fazer nossos testes passarem.

Os Mocks podem se comportar de duas maneiras:

como Atores (Actors), onde o Mock é usado para simular o retorno de propriedades e métodos (e o que vamos usar aqui).
como Críticos (Critics), onde o Mock é usado para guardar e verificar as interações entre os objetos num teste.

Quando trabalhamos com o Mock apenas como Ator, apenas simulando o retorno de propriedades e métodos, ele é considerado um “server stub”, que nada mais é que um objeto que simula um comportamento. Existe uma grande discussão existe em torno disso, mas por enquanto vamos deixar pra lá pois vamos falar sobre os Mocks como uma ferramenta para testes baseados em interação no próximo post e isso vai ficar mais claro.

Se analisarmos a classe Conexao novamente, vamos chegar à conclusão que o método que vai ser utilizado em nosso teste será apenas o query: vamos fazer uma consulta à base dados buscando todos os usuários cujo nome seja igual ao parametro que enviarmos ao método validate.

Nosso mock da Conexao ainda não sabe fazer nada, mas podemos instrui-lo a retornar o que a quisermos. Por exemplo, em nosso teste chamado testValidarSeUsuarioExistir vamos ter que dizer ao mock para retornar sempre um resultado que satisfaça nosso teste. Ou seja, como no exemplo da implementação, se eu envio “Léo” ele tem que me devolver um resultado onde “Léo” esteja presente, pois queremos testar o comportamento do validate e não o retorno de valor da conexão.

Então, vamos fazer nosso mock devolver sempre um resultado onde exista o usuário “Léo” no resultado.

Como vimos, nosso método query retorna uma array com os resultados da consulta. Vamos então instruir o mock a retornar sempre um array quando o método query for chamado. Quando o objeto é mockeado, ele ganha vários métodos, entre eles o setReturnValue: esse método diz ao mock “retorne sempre X resultado quando tal método for chamado”.

1 2	$conexao = new MockConexao(); $conexao->setReturnValue('query',array('1','Léo'));

Pronto! Agora podemos testar nosso validate:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

O que aconteceu em nosso teste:

Criamos um mock do nossa classe Conexao
Instanciamos esse mock em nosso teste
Instruimos ao mock para que ele devolvesse sempre um array com o usuário Léo quando o método query fosse chamado
Instanciamos nosso validator, passando como parâmetro nossa conexao mockeada
fizemos o teste para verificar se a validação deu certo

Fui roda-lo e ….

Opsss! Falhou!

Temos nosso resultado esperado, afinal não implementamos ainda nosso método validate. Então, vamos resolver isso:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

class Validator {

var $conexao;

function __construct($conexao) {
$this->conexao = $conexao;
}

public function validate($nome) {
$resultados = $this->conexao->query("select id, nome from users where nome = '{$nome}'");
if (array_search($nome,$resultados)) {
return true;
}
return false;
}

}

Implementamos uma lógica onde fazemos uma pesquisa ao banco pedindo para selecionar o id e o nome da tabela users onde o nome seja igual ao parâmetro enviado. A mágica acontece finalmente: nossa ” falsa conexao” foi instruída a retornar sempre um array com uma posição apenas, onde o resultado sempre é Léo.

Agora quando rodamos o teste:

Teste do validator agora com a implementação

Bingo! Nosso teste passou!

Para comprovarmos que o funcionamento do validate está correto, vamos complementar nosso caso de teste adicionando um teste pra verificar se informarmos um usuário que não existe, ele retornar false.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

require_once('simpletest/autorun.php');
require_once('conexao.php');
require_once('validator.php');

Mock::generate('Conexao');

class ValidatorTestCase extends UnitTestCase {

function testValidarSeUsuarioExistir() {

$conexao = new MockConexao();
$conexao->setReturnValue('query',array('1','Léo'));

$validator = new Validator($conexao);
$this->assertEqual($validator->validate('Léo'), true);

}

function testNaoValidarSeUsuarioNaoExistir() {

$conexao = new MockConexao();
$conexao->setReturnValue('query',array('1','Léo'));

$validator = new Validator($conexao);
$this->assertEqual($validator->validate('Jeveaux'), false);

}

}

Vamos testar denovo e …

Fazendo dois testes

Mantemos o nosso mock retornando apenas “Léo” nos resultados, mas dessa vez passamos o nome “Jeveaux” para procurar e como esperado, ele retornou false, dado que o usuário “Jeveaux” não existe. Show!

Ufa! Vamos resumir o testamento

O aprendizado de mock objects é um pouco abstrato inicialmente mas com alguma prática se revela uma técnica perfeita e viável para fazemos nossos testes unitários funcionarem de forma correta e independente. A utilização do Mock Object apenas como ator (ou server stub como você lerá muito por ai) é apenas uma parte do poder real de um mock.

Dentro de nosso entendimento, podemos resumir que um mock object é uma imitação de nosso objeto real que podemos manipular de forma fácil e simples para que ele faça exatamente o que quisermos, facilitando assim a implementação de nossos testes unitários e isolando nossas classes.

Algumas leituras legais melhorar o entendimento dos Mock Objects:

Outra referência bem bacana é o blog do Jeveaux, meu revisor TDD oficial e grande conhecer de causa.

No próximo post vamos ver como trabalhar com nosso Mock Object em sua forma mais plena e com um exemplo um pouco mais complexo para partir também para o modo Critic.

Simbora.

Agrupando casos de teste no SimpleTest

Léo Hackin — Mon, 27 Jul 2009 02:33:13 +0000

Aloha,

Primeiramente, obrigado ao pessoal pelas belas palavras de incentivo e tudo mais: é esse tipo de coisa que nos empolga pra continuar trabalhando e estudando duro.

Em nosso post de iniciação no SimpleTest, criamos um caso de teste completo de uma calculadora. Relembrando nossa telinha bonita do caso de teste…

Agora vejamos … e se por exemplo, tivéssemos não apenas uma calculadora em nossa aplicação, mas também uma agenda de compromissos, uma agenda de contatos, um wiki, um mural de recados e … enfim, se nossa aplicação fosse composta por N classes como faríamos para rodar os casos de teste unitários de TODAS AS CLASSES ?

Na TDD, como vimos antes, escrevemos todos os testes antes de começarmos a implementar nossa aplicação em si: quando pensamos “rodar os testes” isso se aplica à todas as classes e funcionalidades que possam gerar erros em nossa aplicação.

Ai você: “Rapaz, vou ter que acessar teste por teste como fiz com a calculadora? Mamãe, eu tenho 253 casos de uso!!!!”

Imagina só se você executar, URL por URL ou comando por comando, 253 casos de uso. =/

Pensando nisso, a SimpleTest disponibiliza um recurso de agrupamento de casos de teste chamado de Test Suite. Esse recurso permite agrupar vários casos de testes numa só classe, facilitando e permitindo a execução desses testes com uma só chamada.

Seria como um script de checagem, onde cada item seria um caso de teste:

Checagem do carro

Checar Óleo
Checar Rodas
Checar Água Carburador
Checar itens de segurança

A test suite funciona exatamente assim, executando cada caso de teste na ordem que você desejar: o “check list” roda e no final você tem todos as falhas que ocorreram, separadas por caso de test e método.

Codando!

Bom, vamos supor que vamos ter uma aplicação composta por 5 classes: ClasseA, ClasseB, ClasseC, ClasseD e ClasseE. Cada uma delas tem suas próprias implementações e vamos ter que fazer casos de testes que testem elas individualmente.

Para ilustrar o funcionamento, vamos escrever um método para todas as classes chamado Dizer: esse método deverá receber a uma string e retornar “Estou dizendo ” concatenado com o que você passou como parâmetro. Exemplificando

1	$obj->Dizer('Muito Bacana'); // Estou Dizendo Muito Bacana

Vamos botar esse método em todas as classes apenas para simularmos as passagens e não passagens de teste delas. hehhehe

Bom, partindo do pressuposto que você esteja com o SimpleTest instalado e com nossa estrutura de arquivos do artigo de iniciação à ele, vamos escrever o caso de teste da ClasseA que será salvo dentro da nossa pasta tests e terá o nome de classe_a_test.php.

1
2
3
4
5
6
7
8
9
10
11

require_once('simpletest/autorun.php');
require_once('../classes/classe_a.php');code>

class TestOfClasseA extends UnitTestCase {

function testDizer() {
$classea = new ClasseA();
$this->assertIdentical($classea->dizer('Muito Bacana'), 'Estou dizendo Muito Bacana');
}

}

Relembrando um pouco:

Fazemos o include do arquito autorun.php para automatizar nossos testes;
Fazemos o include da classe que vai ser testada
Implementamos a classe de teste iniciando por “Test” afim de que a SimpleTest execute-a automaticamente;
Criamos o método testDizer para testar o método dizer da nossa ClasseA;
Fazemos um assertIdentical que executará nosso método dizer passando “Muito Bacana” e esperará como resultado algo IDENTICO à “Estou dizendo Muito Bacana”;

Beleza, agora vamos rodar nosso teste …

Como era esperado (espero) nosso teste deu pau porque não escrevemos nossa ClasseA ainda em arquivo algum. Então, vamos escrevê-la e salva-la dentro da pasta classes com o nome de classe_a.php:

1
2
3
4
5

class ClasseA {
function dizer($frase) {
return 'Estou dizendo ' . $frase;
}
}

Agora, vamos rodar novamente nosso teste:

Massa demais! Fizemos novamente um caso de teste. Até ai nenhuma novidade.

Agora o exercício braçal: crie os casos de teste para a ClasseB. ClasseC, ClasseD e ClasseE lembrando que:

Classes da aplicação devem ser salvas dentro da pasta classes
Classes dos casos de teste dentro da pasta tests

Após a criação delas, faça os testes (jura?) e veja se está tudo ok.

Criando nossa suite de testes

Agora que executamos todos os testes de forma separada, vamos junta-los em nossa suite para faze-los todos de uma vez só.

Vamos criar nossa suite de testes no arquivo all_tests.php e salva-lo na pasta tests junto com todos os nosses casos de uso.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

require_once('simpletest/autorun.php');
require_once('classe_a_test.php');
require_once('classe_b_test.php');
require_once('classe_c_test.php');
require_once('classe_d_test.php');
require_once('classe_e_test.php');

class AllTests extends TestSuite {
function AllTests() {
$this->TestSuite('All tests');
$this->addTestCase(new TestOfClasseA());
$this->addTestCase(new TestOfClasseB());
$this->addTestCase(new TestOfClasseC());
$this->addTestCase(new TestOfClasseD());
$this->addTestCase(new TestOfClasseE());
}
}

Explicando nosso script:

fazemos o include de simpletest/autorun.php para fazer rodar nossos testes
fazemos os includes de todas os casos de testes que usaremos na suite
criamos uma classe AllTests que extende TestSuite, que por sua vez é a classe que será responsável pelo agrupamento e execução de todos os testes
criamos um método AllTests que fará a execução dos casos de teste
Nomeamos a suite de testes com o nome All tests com o método $this->TestSuite;
Adicionamos então todos os nossos casos de teste com o método $this->addTestCase, instanciando o objeto de cada classe de teste

Agora, basta rodar:

Pronto! Nossa suite agrupou nossos testes (que eram cinco ao todo, cada um com um método de teste) e executou todos de uma vez. A lógica da suíte é você inserir os testes conforme seu contexto e sua necessidade de agrupamento de testes. Para incluir, basta repetir o procedimento já feito no arquivo da suíte:

faça o require_once do arquivo php do caso de teste
inclua o caso de teste com $this->addTestCase

E se algum teste falha-se ? Vamos fazer o teste da ClasseB falhar. Para isso altere a classe B para para retornar algo que não seja “Estou dizendo ” mas sim “Eu vou dizer “: com isso, nosso teste vai falhar. Após alterar a classeB, rode a suite de testes novamente:

Como pode ser visto, nossa suite de testes dá o erro exetamente onde ele aconteceu: no nosso caso, a suite de testes que chamamos de All tests reportou o erro do caso de teste TestOfClasseB no método testDizer. Maneirasso não ?

Nossa suite mostra todas as falhas por caso de teste. Simples e rápido.

E vamos às considerações

A forma que fizemos a construção da nossa suite de testes está diferente da forma em que o próprio site da SimpleTest (http://www.simpletest.org/en/start-testing.html) mostra em sua página inicial no Quick Start dele, que está diferente do link que deveria ser a mesma explicação mais detalhada, mas não é. Se olharmos o script de test suite do quick start teremos, aplicando ao nosso exemplo, teríamos:

1
2
3
4
5
6
7
8
9

require_once('simpletest/autorun.php');

class AllTests extends TestSuite {
function AllTests() {
$this->TestSuite('All tests');
$this->addFile('classe_a_test.php');
//... outros casos de teste ...
}
}

Concerteza é um jeito mais prático: ao invés de fazer-mos os includes dos casos de testes e fazermos os instanciamentos dos mesmos no addTestCase, requerendo mais programação, simplesmente podemos incluir o teste com um addFile. E isso realmente funciona. Mas infelizmente não sem algumas adaptações no código.

Se quiser re-escrever sua suite de testes nesse formato, se atente ao fato que o SimpleTest aparentemente trabalha com a suite de testes acessando os caminhos absolutos dos arquivos e se perde quando referenciamos nossos arquivos, mesmo que eles estejam na mesma pasta tests. Para contornar isso, coloque a inclusão do arquivo de classe no caso de testes e a referência ao arquivo do caso de teste na suite com seus caminhos absolutos. Vamos isso na classeA por exemplo:

Na classe_a_test.php teríamos:

1	require_once($_SERVER['DOCUMENT_ROOT'] . '/app_tdd/classes/classe_a.php');

E na nossa suite all_tests.php seria re-escrita como:

1
2
3
4
5
6
7
8

require_once('simpletest/autorun.php');

class AllTests extends TestSuite {
function AllTests() {
$this->TestSuite('All tests');
$this->addFile($_SERVER['DOCUMENT_ROOT'] . '/app_tdd/tests/classe_a_test.php');
}
}

Espero que tenham gostado e no próximo post falaremos um pouco sobre MockObjetcs.

Até lá.

Iniciando com o SimpleTest

Léo Hackin — Thu, 02 Jul 2009 20:11:24 +0000

Salve people,

Vamos iniciar hoje uma pequena jornada à 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 procura 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 posts 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.

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;
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 da 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 (raíz 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 testa-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 extendendo e usando outras classes. Você extende 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 parametros ? 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 encontra-lo (que varia do debug minucioso ao “achismo”) e/ou pelo custo em termos de tempo para concerta-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 passado 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 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:

1
2
3
4
5
6

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 testa-lo, vamos apontar o browser para http://localhost/app_tdd/tests/calculadora_test.php. O resultado será:

1
2
3

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.

1
2
3
4

class Calculadora {
function soma($a,$b) {
}
}

Legal, agora vamos acessar nosso caso de teste denovo.

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 faze-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. Hahahah

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.

1
2
3
4
5
6
7
8
9
10
11

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, indentificando 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:

1
2
3
4
5

class Calculadora {
function soma($a,$b) {
return $a + $b;
}
}

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

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: haviamos combinado que nessa situação, devolveriamos falso para o resultado, correto ? Então, vamos escrever o teste: vamos chama-lo de “testSomaNaoNumeros“:

1
2
3
4

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. Ai 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 dados 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 funcionamnento 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:

1
2
3
4
5
6
7
8
9

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 ai vai.

Finalizando

Você pode estar se perguntando: “Uai, mas podemos ter muito mais ocasiões que podem quebrar a soma! Podemos também extender 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 re-escrever 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 possívelmente só apareceriam no final do projeto gerando assim muito re-trabalho;

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

Espero que tenham gostado do post.

Simbora!