Como expor os cenários automatizados escritos em Guerkin para usuários fora do time de Dev

PROBLEMAS : Após a escrita de histórias com seus respectivos cenários, faz-se necessário a exposição desses artefatos em um repositório para qualquer membro que não esteja dentro do time de desenvolvimento acessa-la de forma que todos possam ler as especificações e ver o resultado do testes realizados de forma simples e direta. Como agregar valor para o usuário final sendo que o mesmo não consegue acessar de forma transparente essa documentação viva?

PROPOSTA: Em alguns casos não conseguimos justificar a utilização de ferramentas de terceiros com custo atrelado (Speclog, Relish ou SpecFlow+ LivingDoc). A ferramenta que encontrei que ajuda a resolver esse tipo de problema é o Pickles, ele utiliza suas especificações escritas em Gherkin e as transforma em uma documentação com saídas em vários formatos (.Html .Excel., Word. etc…), mantendo também as mesmas atualizadas, conforme alterações efetuadas nos arquivos .feature das especificações escritas.

PASSO A PASSO: No exemplo que irei demonstrar, estou utilizando o Specflow para a escrita dos cenários. Irei realizar a geração da documentação através do MSBuild realizado pelo Visual Studio.

• Ferramentas necessárias: No exemplo a ser feito iremos efetuar o download através do NuGet da versão para MSBuild do Pickles.

Após efetuar o download, acesse seu arquivo .csproj e note a linha de Import, note o caminho do arquivo target importado que iremos editar.

Iremos navegar na estrutura de pasta conforme imagem abaixo descrita no Import e abrir o aquivo Piclkes.MSBuild.targets

Iremos alterar as seguintes linhas:

• Na primeira linha iremos alterar o valor da chave Condition para True
• Na segunda linha iremos alterar o valor da chave Pickles_FeatureDirectory de Feature para o diretório raiz dos arquivos .feature dos nossos cenários escritos, no meu caso eles se estão no diretório Testes.
•  Todas os outro parâmetros iremos deixar como padrão já tokenizadas

Após a alteração o arquivo ficará assim:

Após todas as condições de parâmetros serem configuradas, vamos compilar nosso projeto e ver na pasta de saída o arquivo .feature em .html.

Por padrão a geração do documento será feita em html e podemos localiza-lo no diretório do projeto conforme imagem abaixo

Ao acessar veremos algo parecido com a imagem abaixo:

Conclusão: O Pickles é um framework que pode ajudar na exposição de histórias de usuário assim como resultados de testes efetuados nesses cenários para pessoas que não estão diretamente ligados ao time de desenvolvimento do produto. A proposta dele é gerar artefatos que possam ser disponibilizados para todos que não possuem acesso a estrutura do projeto versionado. Existem ferramentas que propõem o mesmo, porém possuem custo atrelado, diferente do Pickles que é um projeto OpenSource em constante implementação.

No próximo artigo vou exemplificar a utilização do Pickles com script em PowerShell que pode facilitar a execução em sua Pipeline de Continuous Integration.

Até o próximo artigo!

Artigo original no meu blog