Guia de extensões Spock

Sometimes we need to ignore some feature methods or spec classes. Assim, podemos precisar mesclar nossas alterações o mais rápido possível, mas a integração contínua ainda falha. Podemos ignorar algumas especificações e ainda assim fazer uma fusão bem-sucedida.

Podemos usar@Ignore em um nível de método para pular um único método de especificação:

Spock won’t execute this test method. E a maioria dos IDEs marcará o teste comoskipped.

Além disso, podemos usar@Ignore on o nível da classe:

Podemos simplesmenteprovide a reason why nosso conjunto de testes ou método for ignorado:

Da mesma forma, podemos ignorar todas as especificações, exceto uma, que podemos marcar com uma anotação@IgnoreRest:

Às vezes, gostaríamos de ignorar condicionalmente um ou dois testes. Nesse caso,we can use @IgnoreIf, which accepts a predicate como argumento:

O Spock fornece o conjunto de propriedades e classes auxiliares, para facilitar a leitura e gravação de nossos predicados:

Podemos reescrever o exemplo anterior usandoos property. Na verdade, é a classespock.util.environment.OperatingSystem com alguns métodos úteis, como por exemploisWindows():

Observe queSpock usesSystem.getProperty(…) oltura. O objetivo principal é fornecer uma interface clara, em vez de definir regras e condições complicadas.

Além disso, como nos exemplos anteriores, podemos aplicar a anotação@IgnoreIf no nível da classe.

Às vezes, é mais fácil inverter nossa lógica de predicado de@IgnoreIf. Nesse caso, podemos usar@Requires:

Portanto, enquanto o@Requires makes this test run only if the OS is Windows, o@IgnoreIf, ustentando o mesmo predicado, faz com que o teste seja executado apenas se o sistema operacional fornot Windows.

In general,it’s much better to say under which condition the test will execute, rather than when it gets ignored.

EmTDD, we escreva os testes primeiro. Então, precisamos escrever um código para fazer esses testes passarem. Em alguns casos, precisaremos confirmar nossos testes antes que o recurso seja implementado.

Este é um bom caso de uso para@PendingFeature:

Há uma diferença principal entre@Ignore e@PendingFeature. Em@PedingFeature, os stests são executados, mas todas as falhas são ignoradas.

Se um teste marcado com@PendingFeature for enviado sem erro, ele será relatado como uma falha, para lembrar sobre a remoção da anotação.

Dessa forma, podemos inicialmente ignorar falhas de recursos não implementados, mas, no futuro, essas especificações farão parte dos testes normais, em vez de serem ignoradas para sempre.

Podemos executar os métodos de uma especificação em uma determinada ordem com a anotação@Stepwise:

In general, tests should be deterministic. Um não deve depender do outro. É por isso que devemos evitar o uso de@Stepwise annotation.

Mas se for necessário, precisamos estar cientes de que@Stepwise doesn’t override the behavior of @Ignore, @IgnoreRest, or@IgnoreIf. Devemos ter cuidado ao combinar essas anotações com@Stepwise.

Podemos limitar o tempo de execução de um único método de especificação e falhar antes:

Observe que esse é o tempo limite para uma única iteração, sem contar o tempo gasto nos métodos de fixação.

Por padrão, ospock.lang.Timeout usa os segundos como unidade de tempo base. Mas,we can specify other time units:

@Timeout no nível da classe tem o mesmo efeito que aplicá-lo a cada método de recurso separadamente:

Usar@Timeout em um único método de especificação sempre substitui o nível de classe.

Às vezes, podemos ter alguns testes de integração não determinísticos. Eles podem falhar em algumas execuções por motivos como processamento assíncrono ou dependendo da resposta de outros clientesHTTP. Além disso, o servidor remoto com compilação e IC falhará e nos forçará a executar os testes e compilar novamente.

Para evitar essa situação,we can use @Retry annotation on a method or class level, to repeat failed tests:

Por padrão, ele tentará novamente três vezes.

É muito útil determinar as condições sob as quais devemos repetir nosso teste. Podemos especificar a lista de exceções:

Ou quando houver uma mensagem de exceção específica:

Muito útil é uma nova tentativa com um atraso:

E, finalmente, como quase sempre, podemos especificar uma nova tentativa no nível da classe:

Podemos manipular variáveis ​​de ambiente com@RestoreSystemProperties.

Essa anotação, quando aplicada, salva o estado atual das variáveis ​​e as restaura posteriormente. Também inclui métodossetup oucleanup:

Observe quewe shouldn’t run the tests concurrently when we’re manipulating the system properties. Nossos testes podem ser não determinísticos.

Podemos adicionar um título de teste amigável usando a anotação@Title:

Da mesma forma, podemos adicionar uma descrição da especificação com a anotação@Narrative e com uma stringGroovy Sde várias linhas:

Para vincular uma ou mais referências externas, podemos usar a anotação @See:

Para passar mais de um link, podemos usar o operando Groovy[] para criar uma lista:

Podemos denotar que um método de recurso se refere a um problema ou vários problemas:

E, finalmente, podemos indicar qual classe é a classe em teste com@Subject:

No momento, é apenas para fins informativos.

Usando um arquivo de configuração, podemos filtrar (ou não) os rastreamentos de pilha:

O valor padrão étrue.

Para ver como funciona e praticar, vamos criar um teste simples que lança umRuntimeException:

QuandofilterStackTrace  é definido como falso, veremos na saída:

Definindo essa propriedade paratrue,, obteremos:

Embora tenha em mente, às vezes é útil ver o rastreamento de pilha completo.

Às vezes,we might need to filter stack traces conditionally. Por exemplo, precisaremos ver rastreamentos de pilha completos em uma ferramenta de integração contínua, mas isso não é necessário em nossa máquina local.

Podemos adicionar uma condição simples, baseada, por exemplo, nas variáveis ​​de ambiente:

O arquivo de configuração do Spock é um arquivo Groovy, portanto, pode conter trechos de código Groovy.

Anteriormente, falamos sobre a anotação@Issue. Também podemos configurar isso usando o arquivo de configuraçãoby defining a common URL part with issueUrlPrefix. 

A outra propriedade éissueNamePrefix. Então, todo valor de@Issue é precedido pela propriedadeissueNamePrefix.

Precisamos adicionar essas duas propriedades emthe report:

The other very helpful tool is optimizeRunOrder. Spock pode se lembrar de quais especificações falharam e com que frequência e quanto tempo é necessário para executar um método de recurso.

Com base nesse conhecimento,Spock executará primeiro os recursos que falharam na última execução. Em primeiro lugar, ele executará as especificações que falharam mais sucessivamente. Além disso, as especificações mais rápidas serão executadas primeiro.

Este comportamento pode ser habilitado no arquivo de configuração . Para habilitar o otimizador, usamosoptimizeRunOrder property:

Por padrão, o otimizador para ordem de execução está desabilitado.

Spock pode excluir ou incluir determinadas especificações. We can lean on classes, super-classes, interfaces or annotations, which are applied on specification classes. A biblioteca pode ser capaz de excluir ou incluir recursos únicos, com base na anotação em um nível de recurso.

Podemos simplesmente excluir um conjunto de testes da classeTimeoutTest usando a propriedadeexclude:

TimeoutTest and all its subclasses will be excluded. SeTimeoutTest fosse uma anotação aplicada em uma classe de especificação, então esta especificação seria excluída.

Podemos especificar anotações e classes base separadamente:

O exemplo acimawill exclude test classes or methods with the @Issue annotation as well as TimeoutTest or any of its subclasses.

Para incluir qualquer especificação, simplesmente usamosinclude property. Podemos definir as regras deinclude da mesma forma queexclude.

Based on the test results and previously known annotations, we can generate a report with Spock. Além disso, este relatório conterá coisas como valores@Title, @See, @Issue, and @Narrative.

Podemos ativar a geração de um relatório no arquivo de configuração. Por padrão, ele não gerará o relatório.

Tudo o que precisamos fazer é passar valores para algumas propriedades:

As propriedades acima são:

Quando definimosenabled paratrue,, então é obrigatório definirlogFileDirelogFileName properties. OlogFileSuffix é opcional.

Também podemos definir todos eles nas propriedades do sistema:enabled,spock.logFileDir,spock.logFileNameespock.logFileSuffix.