4 – Coleta de logs – Parte I

Na aula passada conseguimos o básico de um teste funcional automatizado com uso do Selenium e Cucumber. No entanto, ainda há o que melhorar, e novas peças a serem adicionadas nesse “LEGO” da automação. Aliás, essa é uma boa analogia quando trabalhamos com Selenium: nós podemos montar os testes utilizando os componentes (peças) que desejamos. Por exemplo, até o momento juntamos as “peças” Eclipse, Selenium, Cucumber, Maven, ChromeDriver, e agora o ExtentReports.

Vamos iniciar a aula de hoje ajustando um pequeno detalhe em nossa classe feature:

Vamos ajustar a descrição do campo “Feature” acima para a descrição mostrada abaixo:

Muito mais claro agora: nossa feature vai cuidar do cadastro de clientes.

Vamos à parte do ExtentReports. Para isso, acesse o endereço http://extentreports.com/

Clique sobre o botão “Community Edition”, pois vamos utilizar a versão gratuita.

Ao clicar, teremos as informações necessárias para utilizar o Maven (sim, mais uma “peça LEGO” que será adicionada através do Maven):

<!– pom.xml –>
<dependency>
<groupId>com.aventstack</groupId>
<artifactId>extentreports</artifactId>
<version>3.0.3</version>
</dependency>

Com essas informações, vamos abrir o pom.xml do nosso projeto no Eclipse, acessar a aba “Dependencies” e então clicar em “Add…”

Na janela que abrir, inserimos as informações conforme ilustrado abaixo:

Após clicar em OK, a dependência será adicionada:

Após salvar o projeto no Eclipse, é hora de utilizarmos essa biblioteca de reports. Ao contrário do TestComplete, onde já vem tudo configurado (só arrastar e usar), aqui é preciso ter um pouco de “paciência”.

Na classe “TestRule.java”, crie uma variável estática privada chamada “private static ExtentHtmlReporter htmlReporter; ”. Após criá-la, é preciso realizar o import correto. A imagem abaixo ilustra a criação da variável bem como a realização do import que deve ser feito:

Em seguida, crie uma nova variável privada estática: “private static ExtentReports extentReport;”. A imagem abaixo ilustra tanto a variável quanto o import a ser utilizado:

Finalmente, adicionamos uma terceira variável privada estática: “private static ExtentTest feature; ”. A criação da variável bem como o import é mostrado abaixo:

Mas, o que são essas três variáveis? Abaixo uma breve explicação de cada tipo de variável:

• ExtentHtmlReporter: indica o TIPO de report que iremos gerar ao final do teste. Nesse caso, iremos criar um report do tipo html;
• ExtentReports: é como se fosse o “gerenciador” dos reports gerados;
• ExtentTest: é o teste propriamente dito. É nele que estarão os logs do cenário executado, informações, prints, etc…

Prosseguindo com o uso do extentReports, vamos modificar um pouco o método “beforeCenario” da classe “TestRule.java”, conforme ilustrado abaixo:

O código destacado acima ilustra o que deve ser adicionado dentro do método “beforeCenario”.

Abaixo uma descrição do esse código faz:

Linha 27: inicializa a variável “extentReport”;

Linha 28: inicializa a variável “htmlReport” e diz ONDE SERÁ CRIADO O HTML (“src/test/resources/htmlReporter.html”). Nesse caso, será criado em um diretório dentro do projeto.

Linha 29: adiciona o “htmlReporter” ao “extentReport” (lembre-se que o “extentReport” é como um gerenciador encarregado de organizar os reports).

Linha 26: o if é para verificar se o extentReport já não foi inicializado previamente. Lembre-se que o método “beforeCenario” é sempre chamado antes do início de um novo cenário. Se o extentReport for inicializado todas as vezes que iniciar um cenário, a informação guardada por ele do cenário executado anteriormente será perdida. Então basta ele ser inicializado uma vez somente (no caso, na execução do primeiro cenário somente).

Linha 32: inicia um novo teste, recebendo como parâmetro o id do cenário que está sendo executado.

Agora, preste atenção no construtor do método “beforeCenario”. Foi adicionado a ele um parâmetro do tipo “Scenario”. É a partir dele que iremos pegar o id do cenário que está sendo executado. Abaixo é mostrado o import a ser realizado para utilizá-lo:

Esses eram os ajustes a serem feitos no método “beforeCenario” para utilização da biblioteca “ExtentReports”.

Finalizado os ajustes no método “beforeCenario”, é hora de criar o método “afterCenario”: esse método é chamado ao final de cada teste executado. A necessidade dele é simples: ao final do cenário precisamos chamar o método “extentReport.flush()”, que é o responsável por gravar as informações coletadas do cenário no report html. Sem ele nenhuma informação do teste seria gravada no report. Abaixo tem-se o método (sem os imports realizados):

Vamos analisar o código e o método:

Linha 47: o método comentado anteriormente, que realiza a gravação das informações coletadas no report;

Linha 46: Um exemplo de log a ser coletado. Para isso basta chamar o método “extentTest.log” passando dois parâmetros: o primeiro indica o tipo de log que será coletado (PASS, ERROR, FAIL, INFO, …, semelhante ao TestComplete). O segundo parâmetro é um texto que irá aparecer no log. Nesse exemplo, estamos dizendo que o cenário foi executado com sucesso.

Abaixo as imagens mostrando os imports a serem realizados:

Após os imports realizados:

Agora é hora de executar o teste automatizado:

Abaixo o resultado da execução:

E quanto ao report gerado? Ele é mostrado abaixo:

Esse foi o report gerado. Obviamente ele está bem simples pois só tem uma entrada de log: o log que diz que o cenário foi executado com sucesso.

E quanto aos prints? Precisamos de prints, precisamos de evidências. Na próxima aula!!!

EXERCÍCIO: o objeto desse exercício é fixar o conhecimento aprendido na aula relacionado à biblioteca ExtentReports. Para isso:

1. Releia com atenção a aula de hoje;
2. Acesse a página http://extentreports.com/ conforme mostrado na aula para obter o xml da versão Community mais atual do ExtentReports necessário para utilização do Maven;
3. Com as informações obtidas desse xml, abra o pom.xml do nosso projeto no Eclipse e adicione essas informações para que o projeto possa utilizar o ExtentReports conforme visto na aula;
4. Na classe “TestRule.java”, crie as variáveis estáticas privadas “htmlReporter”, “extentReport” e “extentTest” conforme apresentado na aula, não esquecendo de realizar os imports devidos;
5. Atualize o método “beforeCenario” da classe “TestRule.java” conforme demonstrado na aula para fazer uso do ExtentReport;
6. Na classe “TestRule.java” crie o método “afterCenario” conforme visto na aula, não esquecendo de realizar os imports necessários;
7. Revise seu projeto e execute o teste. Após executá-lo com sucesso, analise o report html gerado: abra-o, observe-o, conheça-o!;