Serenity BDD com Spring e JBehave

1. Introdução

Anteriormente, temosintroduced the Serenity BDD framework.

Neste artigo, apresentaremos como integrar o Serenity BDD ao Spring.

2. Dependência do Maven

Para ativar o Serenity em nosso projeto Spring, precisamos adicionarserenity-coreeserenity-spring aopom.xml:


    net.serenity-bdd
    serenity-core
    1.4.0
    test


    net.serenity-bdd
    serenity-spring
    1.4.0
    test

Também precisamos configurar oserenity-maven-plugin, que é importante para gerar relatórios de teste de serenidade:


    net.serenity-bdd.maven.plugins
    serenity-maven-plugin
    1.4.0
    
        
            serenity-reports
            post-integration-test
            
                aggregate

3. Integração Spring

O teste de integração de primavera precisa@RunWithSpringJUnit4ClassRunner. Mas não podemos usar o executor de teste diretamente com o Serenity, pois os testes de serenidade precisam ser executados porSerenityRunner.

Para testes com serenidade, podemos usarSpringIntegrationMethodRuleeSpringIntegrationClassRule para habilitar a injeção.

Vamos basear nosso teste em um cenário simples: dado um número, ao adicionar outro número, então retorna a soma.

3.1. SpringIntegrationMethodRule

SpringIntegrationMethodRule é umMethodRule aplicado aos métodos de teste. O contexto Spring será construído antes de@Beforee depois de@BeforeClass.

Suponha que tenhamos uma propriedade para injetar em nossos beans:

Agora vamos adicionarSpringIntegrationMethodRule para habilitar a injeção de valor em nosso teste:

@RunWith(SerenityRunner.class)
@ContextConfiguration(locations = "classpath:adder-beans.xml")
public class AdderMethodRuleIntegrationTest {

    @Rule
    public SpringIntegrationMethodRule springMethodIntegration
      = new SpringIntegrationMethodRule();

    @Steps
    private AdderSteps adderSteps;

    @Value("#{props['adder']}")
    private int adder;

    @Test
    public void givenNumber_whenAdd_thenSummedUp() {
        adderSteps.givenNumber();
        adderSteps.whenAdd(adder);
        adderSteps.thenSummedUp();
    }
}

Ele também suporta anotações de nível de método despring test. Se algum método de teste suja o contexto de teste, podemos marcar@DirtiesContext nele:

@RunWith(SerenityRunner.class)
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
@ContextConfiguration(classes = AdderService.class)
public class AdderMethodDirtiesContextIntegrationTest {

    @Steps private AdderServiceSteps adderServiceSteps;

    @Rule public SpringIntegrationMethodRule springIntegration = new SpringIntegrationMethodRule();

    @DirtiesContext
    @Test
    public void _0_givenNumber_whenAddAndAccumulate_thenSummedUp() {
        adderServiceSteps.givenBaseAndAdder(randomInt(), randomInt());
        adderServiceSteps.whenAccumulate();
        adderServiceSteps.summedUp();

        adderServiceSteps.whenAdd();
        adderServiceSteps.sumWrong();
    }

    @Test
    public void _1_givenNumber_whenAdd_thenSumWrong() {
        adderServiceSteps.whenAdd();
        adderServiceSteps.sumWrong();
    }

}

No exemplo acima, quando invocamosadderServiceSteps.whenAccumulate(), o campo do número base de@Service injetado emadderServiceSteps será alterado:

@ContextConfiguration(classes = AdderService.class)
public class AdderServiceSteps {

    @Autowired
    private AdderService adderService;

    private int givenNumber;
    private int base;
    private int sum;

    public void givenBaseAndAdder(int base, int adder) {
        this.base = base;
        adderService.baseNum(base);
        this.givenNumber = adder;
    }

    public void whenAdd() {
        sum = adderService.add(givenNumber);
    }

    public void summedUp() {
        assertEquals(base + givenNumber, sum);
    }

    public void sumWrong() {
        assertNotEquals(base + givenNumber, sum);
    }

    public void whenAccumulate() {
        sum = adderService.accumulate(givenNumber);
    }

}

Especificamente, atribuímos a soma ao número base:

@Service
public class AdderService {

    private int num;

    public void baseNum(int base) {
        this.num = base;
    }

    public int currentBase() {
        return num;
    }

    public int add(int adder) {
        return this.num + adder;
    }

    public int accumulate(int adder) {
        return this.num += adder;
    }
}

No primeiro teste_0_givenNumber_whenAddAndAccumulate_thenSummedUp, o número base é alterado, tornando o contexto sujo. Quando tentamos adicionar outro número, não obtemos a soma esperada.

Observe que mesmo se marcarmos o primeiro teste com@DirtiesContext, o segundo teste ainda é afetado: após a adição, a soma ainda está errada. Why?

Agora, enquanto processa o nível de método@DirtiesContext, a integração do Serenity Spring apenas reconstrói o contexto de teste para a instância de teste atual. O contexto de dependência subjacente em@Steps não será reconstruído.

Para contornar esse problema, podemos injetar@Service em nossa instância de teste atual e tornar o serviço uma dependência explícita de@Steps:

@RunWith(SerenityRunner.class)
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
@ContextConfiguration(classes = AdderService.class)
public class AdderMethodDirtiesContextDependencyWorkaroundIntegrationTest {

    private AdderConstructorDependencySteps adderSteps;

    @Autowired private AdderService adderService;

    @Before
    public void init() {
        adderSteps = new AdderConstructorDependencySteps(adderService);
    }

    //...
}

public class AdderConstructorDependencySteps {

    private AdderService adderService;

    public AdderConstructorDependencySteps(AdderService adderService) {
        this.adderService = adderService;
    }

    // ...
}

Ou podemos colocar a etapa de inicialização da condição na seção@Before para evitar contexto sujo. Mas esse tipo de solução pode não estar disponível em algumas situações complexas.

@RunWith(SerenityRunner.class)
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
@ContextConfiguration(classes = AdderService.class)
public class AdderMethodDirtiesContextInitWorkaroundIntegrationTest {

    @Steps private AdderServiceSteps adderServiceSteps;

    @Before
    public void init() {
        adderServiceSteps.givenBaseAndAdder(randomInt(), randomInt());
    }

    //...
}

3.2. SpringIntegrationClassRule

Para habilitar anotações em nível de classe, devemos usarSpringIntegrationClassRule. Digamos que temos as seguintes classes de teste; cada um suja o contexto:

@RunWith(SerenityRunner.class)
@ContextConfiguration(classes = AdderService.class)
public static abstract class Base {

    @Steps AdderServiceSteps adderServiceSteps;

    @ClassRule public static SpringIntegrationClassRule springIntegrationClassRule = new SpringIntegrationClassRule();

    void whenAccumulate_thenSummedUp() {
        adderServiceSteps.whenAccumulate();
        adderServiceSteps.summedUp();
    }

    void whenAdd_thenSumWrong() {
        adderServiceSteps.whenAdd();
        adderServiceSteps.sumWrong();
    }

    void whenAdd_thenSummedUp() {
        adderServiceSteps.whenAdd();
        adderServiceSteps.summedUp();
    }
}

@DirtiesContext(classMode = AFTER_CLASS)
public static class DirtiesContextIntegrationTest extends Base {

    @Test
    public void givenNumber_whenAdd_thenSumWrong() {
        super.whenAdd_thenSummedUp();
        adderServiceSteps.givenBaseAndAdder(randomInt(), randomInt());
        super.whenAccumulate_thenSummedUp();
        super.whenAdd_thenSumWrong();
    }
}

@DirtiesContext(classMode = AFTER_CLASS)
public static class AnotherDirtiesContextIntegrationTest extends Base {

    @Test
    public void givenNumber_whenAdd_thenSumWrong() {
        super.whenAdd_thenSummedUp();
        adderServiceSteps.givenBaseAndAdder(randomInt(), randomInt());
        super.whenAccumulate_thenSummedUp();
        super.whenAdd_thenSumWrong();
    }
}

Neste exemplo, todas as injeções implícitas serão reconstruídas para o nível de classe@DirtiesContext.

3.3. SpringIntegrationSerenityRunner

Existe uma classe convenienteSpringIntegrationSerenityRunner que adiciona automaticamente as duas regras de integração acima. Podemos executar os testes acima com esse corredor para evitar a especificação do método ou das regras de teste de classe em nosso teste:

@RunWith(SpringIntegrationSerenityRunner.class)
@ContextConfiguration(locations = "classpath:adder-beans.xml")
public class AdderSpringSerenityRunnerIntegrationTest {

    @Steps private AdderSteps adderSteps;

    @Value("#{props['adder']}") private int adder;

    @Test
    public void givenNumber_whenAdd_thenSummedUp() {
        adderSteps.givenNumber();
        adderSteps.whenAdd(adder);
        adderSteps.thenSummedUp();
    }
}

4. Integração SpringMVC

Nos casos em que precisamos apenas testar componentes SpringMVC com o Serenity, podemos simplesmente usarRestAssuredMockMvc emrest-assured em vez da integraçãoserenity-spring.

4.1. Dependência do Maven

Precisamos adicionar a dependênciarest-assured spring-mock-mvc aopom.xml:


    io.rest-assured
    spring-mock-mvc
    3.0.3
    test

**4.2. RestAssuredMockMvc em ação**

Vamos agora testar o seguinte controlador:

@RequestMapping(value = "/adder", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@RestController
public class PlainAdderController {

    private final int currentNumber = RandomUtils.nextInt();

    @GetMapping("/current")
    public int currentNum() {
        return currentNumber;
    }

    @PostMapping
    public int add(@RequestParam int num) {
        return currentNumber + num;
    }
}

Podemos tirar proveito dos utilitários de simulação MVC deRestAssuredMockMvc como este:

@RunWith(SerenityRunner.class)
public class AdderMockMvcIntegrationTest {

    @Before
    public void init() {
        RestAssuredMockMvc.standaloneSetup(new PlainAdderController());
    }

    @Steps AdderRestSteps steps;

    @Test
    public void givenNumber_whenAdd_thenSummedUp() throws Exception {
        steps.givenCurrentNumber();
        steps.whenAddNumber(randomInt());
        steps.thenSummedUp();
    }
}

Então, a parte restante não é diferente de como usamosrest-assured:

public class AdderRestSteps {

    private MockMvcResponse mockMvcResponse;
    private int currentNum;

    @Step("get the current number")
    public void givenCurrentNumber() throws UnsupportedEncodingException {
        currentNum = Integer.valueOf(given()
          .when()
          .get("/adder/current")
          .mvcResult()
          .getResponse()
          .getContentAsString());
    }

    @Step("adding {0}")
    public void whenAddNumber(int num) {
        mockMvcResponse = given()
          .queryParam("num", num)
          .when()
          .post("/adder");
        currentNum += num;
    }

    @Step("got the sum")
    public void thenSummedUp() {
        mockMvcResponse
          .then()
          .statusCode(200)
          .body(equalTo(currentNum + ""));
    }
}

5. Serenity, JBehave e Spring

O suporte de integração do Serenity Spring funciona perfeitamente comJBehave. Vamos escrever nosso cenário de teste como uma história JBehave:

Scenario: A user can submit a number to adder and get the sum
Given a number
When I submit another number 5 to adder
Then I get a sum of the numbers

Podemos implementar a lógica em a@Servicee expor as ações por meio de APIs:

@RequestMapping(value = "/adder", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@RestController
public class AdderController {

    private AdderService adderService;

    public AdderController(AdderService adderService) {
        this.adderService = adderService;
    }

    @GetMapping("/current")
    public int currentNum() {
        return adderService.currentBase();
    }

    @PostMapping
    public int add(@RequestParam int num) {
        return adderService.add(num);
    }
}

Agora podemos construir o teste Serenity-JBehave com a ajuda deRestAssuredMockMvc da seguinte maneira:

@ContextConfiguration(classes = {
  AdderController.class, AdderService.class })
public class AdderIntegrationTest extends SerenityStory {

    @Autowired private AdderService adderService;

    @BeforeStory
    public void init() {
        RestAssuredMockMvc.standaloneSetup(new AdderController(adderService));
    }
}

public class AdderStory {

    @Steps AdderRestSteps restSteps;

    @Given("a number")
    public void givenANumber() throws Exception{
        restSteps.givenCurrentNumber();
    }

    @When("I submit another number $num to adder")
    public void whenISubmitToAdderWithNumber(int num){
        restSteps.whenAddNumber(num);
    }

    @Then("I get a sum of the numbers")
    public void thenIGetTheSum(){
        restSteps.thenSummedUp();
    }
}

Podemos apenas marcarSerenityStory com@ContextConfiguration, então a injeção Spring é habilitada automaticamente. Isso funciona da mesma forma que@ContextConfiguration em@Steps.

6. Sumário

Neste artigo, abordamos como integrar o Serenity BDD ao Spring. A integração não é totalmente perfeita, mas definitivamente está chegando lá.

Como sempre, a implementação completa pode ser encontrada emthe GitHub project.

TOC

Serenity BDD com Spring e JBehave