Antes de mais nada, vamos citar alguns conceitos importantes de BDD.

Estórias e Cenários

BDD é baseado em estórias e cenários, e para criarmos ambos, vamos seguir alguns padrões pré-definidos por autores de BDD. Uma vez que BDD é focado em comportamento e sequência, as estórias e cenários devem ter um formato rígido para que as ferramentas consigam entendê-los e interpretá-los.

As estórias, possuem o seguinte formato:

As I [X]
I want [Y]
so that [Z]

E os cenários possuem o seguinte formato:

Given some initial context (the givens),
When an event occurs,
then ensure some outcomes.

Ou seja, isso quer dizer que devemos pensar em nossos requisitos de maneira que possam ser escritos baseados nessa convenção.

O JBehave é originalmente escrito para entender estórias em inglês, entretanto como BDD é focado em pessoas (stakeholders) e na descrição de situações reais, faz muito mais sentido semanticamente que as estórias e cenários sejam escritos em português e para resolver isso, usei uma contribuição do Emerson Macedo para que os cenários possam ser escritos e entendidos em português pelo JBehave.

Começando com o JBehave

O primeiro passo para utilização do JBehave, é fazer download do JAR do projeto e incluí-lo no classpath do seu projeto.

O próximo passo é escrever a estória juntamente com o cenário e para tal resolvi criar um exemplo simples para que o entendimento do conceito possa ser casado através do código a ser desenvolvido.

O exemplo escolhido é baseado no requisito: Compra de produtos em promoção com aviso por email. E é isso que nosso cenário BDD deve descrever.

Por questão de organização, resolvi quebrar a estória em 3 cenários diferentes, onde a primeira parte representa a verificação de produtos em promoção, a segunda representa a compra desses produtos e o terceiro é a finalização da compra e o envio de email. Então, a estória e os cenários ficaram assim:

Compra de produtos em promoção com aviso por email
 
Narrativa:
Como um usuário
Eu quero comprar produtos em promoção
E então receber um email de confirmação
 
Cenário: Verificar produtos em promoção
Dado Que uma loja possui 10 produtos
E Que 5 estão em promoção
Quando Eu verifico quais estão em promoção
Então Preencho minha sacola apenas com produtos em promoção
 
Cenário: Comprar produtos em promoção
Dado Que minha sacola de compras está preenchida com 5 produtos em promoção
Quando Eu verifico o somatório de produtos
Então Devo ter somente um total de 500 reais em produtos
 
Cenário: Enviar email
Dado Que minha sacola está preenchida de produtos
Quando Enviar um email de confirmação
Então Devo receber o status do envio "true"

A primeira linha do arquivo texto representa o título da nossa estória, o requisito de fato. A narrativa é um resumo do que essa estória deve cumprir e a seguir vem os três cenários, que no caso são as três etapas da estória.

É importante notar, que as palavras chaves em inglês (Given, When, Then, And) foram substituídas por palavras em português (Dado, Quando, Então, E).

Esse arquivo texto deve ser salvo com a extensão *.cenario e o seu nome está diretamente ligado a classe que irei criar no passo a seguir, que no caso é a classe que representa a estória e a associação com os cenários.

Criando a classe que irá comportar os cenários

Nesse passo irei criar a classe que irá apontar os cenários que compõe a estória e essa classe deve extender a classe Scenario do JBehave. Dessa forma, a classe ficaria assim:

PrecoPromocaoTeste.java

package scenario1;
 
import scenario1.steps.CompraSteps;
import scenario1.steps.EmailSteps;
import scenario1.steps.PromocaoSteps;
import scenario1.util.PtBRScenario;
 
public class PrecoPromocaoTeste extends PtBRScenario {
	public PrecoPromocaoTeste() {
           addSteps(new PromocaoSteps());
           addSteps(new CompraSteps());
           addSteps(new EmailSteps());
	}
}

No exemplo acima, estou extendo a classe PtBRScenario só para que a estória e o cenário sejam escritos em português, mas essa classa herda a classe Scenario como descrito anteriormente.

No construtor da classe, inclui os passos que a estória deve seguir para ser satisfeita e como quebrei a estória em três pedaços, precisei incluir três passos sequenciados.

Criando os passos da estória

Como a estória foi quebrada em três partes, se faz por necessário a criação de 3 classes que irão representar os passos da estória e todas essas classes devem herdar a classe Steps do JBehave.

Pela ordem definida na nossa classe de cenário, vamos aos passos:

PromocaoSteps.java

package scenario1.steps;
 
import java.util.List;
 
import junit.framework.Assert;
 
import org.jbehave.scenario.annotations.Given;
import org.jbehave.scenario.annotations.Then;
import org.jbehave.scenario.annotations.When;
 
import scenario1.entity.Loja;
import scenario1.entity.Produto;
import scenario1.util.PtBRSteps;
import scenario1.vo.Sacola;
 
public class PromocaoSteps extends PtBRSteps {	
	Loja loja 		= new Loja();
	Sacola sacola 	= new Sacola();
	List<Produto> listaProdutoPromocao;
	int quantidadeProdutoPromocao;
 
	@Given("Que uma loja possui $quant produtos")
	public void populaLoja(Integer quantidade) {
		loja.inicializaProdutos(quantidade);
	}	
 
	@Given("Que $quant estão em promoção")
	public void informaProdutosPromocao(Integer quantidade) {
		loja.colocaProdutosPromocao(quantidade);
		quantidadeProdutoPromocao = quantidade;
	}	
 
	@When("Eu verifico quais estão em promoção")
	public void verificaProdutosPromocao() {		
		listaProdutoPromocao = loja.retornaProdutosPromocao();
	}
 
	@Then("Preencho minha sacola apenas com produtos em promoção")
	public void populaSacola() {
		sacola.populaSacola(listaProdutoPromocao);
 
		Assert.assertEquals(listaProdutoPromocao.size(), quantidadeProdutoPromocao);
	}
}

CompraSteps.java

package scenario1.steps;
 
import java.util.ArrayList;
import java.util.List;
 
import junit.framework.Assert;
 
import org.jbehave.scenario.annotations.Given;
import org.jbehave.scenario.annotations.Then;
import org.jbehave.scenario.annotations.When;
 
import scenario1.entity.Produto;
import scenario1.util.PtBRSteps;
import scenario1.vo.Sacola;
 
public class CompraSteps extends PtBRSteps {
	Sacola sacola 				= new Sacola();
	double somatorioProdutos 	= 0d;
 
	@Given("Que minha sacola de compras está preenchida com $quant produtos em promoção")
	public void verificaSacola(Integer quantidade) {
		List<Produto> listaProduto = new ArrayList<Produto>();
 
		for (int i=1; i<=quantidade; i++) {
			Produto produto 	= new Produto();
			produto.preco 		= Math.round(Math.random()*100);
			produto.emPromocao 	= true;
 
			listaProduto.add(produto);
		}
 
		sacola.populaSacola(listaProduto);
	}
 
	@When("Eu verifico o somatório de produtos")
	public void verificaTotalProdutosSacola() {
		for ( Produto produto : sacola.retornaProdutos() ) {
			somatorioProdutos = produto.preco + somatorioProdutos;
		}
	}
 
	@Then("Devo ter somente um total de R$ $total reais em produtos")
	public void validaSacola(double totalProduto) {		
		if ( somatorioProdutos > totalProduto )
			Assert.fail("Total de produtos é acima de R$ 500");
	}
}

EmailSteps.java

package scenario1.steps;
 
import static org.jbehave.Ensure.ensureThat;
 
import org.jbehave.scenario.annotations.Given;
import org.jbehave.scenario.annotations.Then;
import org.jbehave.scenario.annotations.When;
 
import scenario1.util.PtBRSteps;
import scenario1.vo.Sacola;
 
import com.guilhermechapiewski.fluentmail.email.EmailMessage;
import com.guilhermechapiewski.fluentmail.transport.EmailTransportConfiguration;
 
public class EmailSteps extends PtBRSteps {
	Sacola sacola 		= new Sacola();
	Boolean statusEnvio = false;
 
	@Given("Que minha sacola está preenchida de produtos")
	public void verificaSacola() {
		System.out.println("Lista cheia..");
	}
 
	@When("Enviar um email de confirmação")
	public void enviaEmail() {
		EmailTransportConfiguration.configure("localhost", false, false, "", "");
 
		new EmailMessage()
	    	.from("eusou@marcuscavalcanti.net")
	    	.to("eusou@marcuscavalcanti.net")
	    	.withSubject("Testando BDD")
	    	.withBody("Testando terceiro cenário e o final da estória.")
	    	.send();
 
		statusEnvio = true;
	}
 
	@Then("Devo receber o status do envio \"$retorno\"")
	public void recebeStatusEnvio(String retorno) {	
		ensureThat(statusEnvio.toString().equals(retorno));
	}
}

Nos exemplos acima, que representam os passos de um cenário, é importante notar que os métodos seguem a ordem definida no arquivo texto, assim como todos são anotados com as palavras chaves correspondentes, no caso Given, When, And, Then. As anotações recebem como parâmetro as frases descritas no arquivo texto, excluindo apenas as palavras chaves no começo da frase, que estão devidamente representadas pelas anotações.

Os parâmetros são identificados com o formato $variavel, e uma vez que usamos esses parâmetros, devemos também colocá-los na assinatura dos métodos. Esses parâmetros são automaticamente capturados pelo JBehave através do uso de expressões regulares.

Executando o exemplo

Para executar o exemplo deve-se executar a classe que extende a classe Scenario do JBehave, nesse caso seria a classe PrecoPromocaoTeste.java, e para acompanhar os resultados, eu utilizo a integração do Eclipse com o JUnit, através de uma view própria da IDE.

No exemplo, usei ainda algumas classes auxiliares criadas especificamente para o exemplo, mas que não irei mostrar aqui os seus códigos para não tornar o tópico extenso demais. De qualquer forma, ao final desse tópico botarei um link para download do projeto no Eclipse que contém todos os códigos.

Observações finais

Um dos problemas que eu notei no JBehave é em relação a parametrização de alguns valores no arquivo texto para o código Java, em alguns casos isso pode se tornar um trabalho sacal e pouco produtivo, mas acredito que com a evolução do framework esse problema será resolvido.

Algumas pessoas utilizam alternativas variadas para resolver esse problema, como por exemplo criar o valor dos parâmetros diretamente como atributos nas classes que representam os passos. Eu particularmente não gosto dessa abordagem, pois acredito que isso faz com que os arquivos que descrevem os cenários percam seu valor e esses arquivos são essencial para utilização e sentido do BDD.

No exemplo citado, usei ainda algumas bibliotecas como FluentMailApi, Mail e Activation da JavaMail e Hamcrest. Essas bibliotecas servem basicamente para o envio de email e uso mais aperfeiçoado de expressões regulares por parte do JBehave.

Para finalizar, é importante citar que as classes do meu negócio (Sacola, Usuario, Loja, etc) foram construídas baseadas no meu requesito, no meu cenário, que foi a primeira etapa a ser elaborada na construção do exemplo.

Download

Para download do projeto completo no Eclipse, basta clicar aqui.

BDD ajuda você, BDD ajuda seu cliente

Um ponto que pude observar, é que usando BDD a possibilidade de um cliente participar de um projeto é imensa, mesmo que você não use alguma metodologia ágil (falarei sobre isso a seguir). E por que ele pode participar? É simples, pois é ele quem pode escrever os testes. Se ainda assim não for o seu cliente o responsável por escrever os testes, será ele quem irá validá-los, ou seja, você pode escrever os testes e pedir para que ele aprove ou não. Isso é muito importante, pois nesse caso os testes em BDD seriam o contrato entre você o seu cliente, entre o que você está entregando e o que ele está esperando.

BDD favorece o sucesso do uso de metodologias ágeis

Sem dúvida nenhuma um dos pontos fortes do uso de BDD é que suas características se encaixam muito bem em equipes que fazem o uso de metodologia ágil. E são vários pontos que favorecem.

Uma delas é a já citada participação do cliente, pois um dos requisitos para o sucesso do uso de metodologias ágeis é a participação e contribuição efetiva do cliente e no caso do uso de BDD ele pode participar diretamente, uma vez que é ele quem é o responsável (PO) por criar as estórias (ítens do backlog) e criar os testes de aceitação para as mesmas, onde tudo isso é usado no BDD.

Os artefatos que constituem BDD são muito, mais muito semelhantes aos artefatos presentes em ágil.

Em BDD se usa estórias e testes de aceitação, além de BDD favorecer a construção de aplicativos de forma evolutiva (sprints) e tudo isso casa perfeitamente com os requisitos das metodologias ágeis.

Favorece a escrita de testes antes da implementação

Uma boa prática na criação de testes, independente se você usa BDD ou TDD, é que os testes sejam criados antes de tudo. Ok, eu concordo, mas devo dizer que com TDD isso não é muito nítido, pois na maioria dos casos, principalmente no começo, as pessoas tendem a implementar os códigos e depois escreverem os testes para validá-los. Já com BDD, a primeira coisa que você precisa ter em mãos antes de implementar os testes são as estórias e os cenários, não tem como fugir disso, o que torna muito mais nítido que em primeiro lugar vem os testes e depois as implementações.

Torna mais nítido o que sua aplicação deve fazer

Com BDD é muito mais fácil isolar as funcionalidade da sua aplicação, já que o que é testado é exatamente isso, dessa forma fica fácil identificar os componentes que envolvem determinada funcionalidade, torna mais nítido qual é o papel daquela funcionalidade, além do que consegue dar um sentido melhor para a sua aplicação de maneira geral.

Com BDD, você consegue ainda uma visão de workflow da sua aplicação, ou seja, uma visão macro, o que favorece dar manutenção a mesma. Percebo também, que BDD favorece um bom design de código, evitando assim problemas de desenvolvimento como códigos com alto-acoplamento.

Torna os testes mais humanos

A essência do BDD são os cenários e não parte isoladas da aplicação e essa maneira de lidar com testes favorece o entendimento por parte de nós, humanos.

Testes de interface com o Selenium, tornam-se mais compreensíveis num contexto que envolva BDD, como em um teste de login, por exemplo.

Conclusão

Na minha opinião, está mais do que clara a vantagem no uso de BDD, entretanto ele não substitui o uso de TDD, pois a abordagem de ambas são diferentes e complementares.

No próximo tópico, irei mostrar um cenário de testes com o framework JBehave, um framework BDD para Java.

Mais sobre o assunto

The truth about DDD

The difference between TDD and BDD