Спокойствие BDD с Spring и JBehave

1. Вступление

Ранее у нас былоintroduced the Serenity BDD framework.

В этой статье мы расскажем, как интегрировать Serenity BDD со Spring.

2. Maven Dependency

Чтобы включить Serenity в нашем проекте Spring, нам нужно добавитьserenity-core иserenity-spring кpom.xml:


    net.serenity-bdd
    serenity-core
    1.4.0
    test


    net.serenity-bdd
    serenity-spring
    1.4.0
    test

Нам также необходимо настроитьserenity-maven-plugin, что важно для создания отчетов о тестировании Serenity:


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

3. Весенняя интеграция

Тест интеграции Spring должен быть@RunWithSpringJUnit4ClassRunner. Но мы не можем использовать средство запуска тестов напрямую с Serenity, так как тесты Serenity должны запускатьсяSerenityRunner.

Для тестов с Serenity мы можем использоватьSpringIntegrationMethodRule иSpringIntegrationClassRule для включения инъекции.

Мы будем основывать наш тест на простом сценарии: при добавлении числа при добавлении другого числа возвращается сумма.

**3.1. SpringIntegrationMethodRuleс**

SpringIntegrationMethodRule - этоMethodRule, применяемый к методам испытаний. Контекст Spring будет построен до@Before и после@BeforeClass.

Предположим, у нас есть свойство для внедрения в наши bean-компоненты:

Теперь давайте добавимSpringIntegrationMethodRule, чтобы включить внедрение значений в нашем тесте:

@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();
    }
}

Он также поддерживает аннотации на уровне методаspring test. Если какой-то тестовый метод загрязняет тестовый контекст, мы можем отметить на нем@DirtiesContext:

@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();
    }

}

В приведенном выше примере, когда мы вызываемadderServiceSteps.whenAccumulate(), поле базового числа@Service, введенного вadderServiceSteps, будет изменено:

@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);
    }

}

В частности, мы присваиваем сумму базовому номеру:

@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;
    }
}

В первом тесте_0_givenNumber_whenAddAndAccumulate_thenSummedUp базовое число изменяется, делая контекст грязным. Когда мы пытаемся добавить еще одно число, мы не получаем ожидаемую сумму.

Обратите внимание, что даже если мы пометили первый тест с помощью@DirtiesContext, второй тест все равно будет затронут: после добавления сумма все еще неверна. Why?

Теперь при обработке уровня метода@DirtiesContext интеграция Serenity Spring перестраивает только тестовый контекст для текущего тестового экземпляра. Базовый контекст зависимости в@Steps не будет перестроен.

Чтобы обойти эту проблему, мы можем внедрить@Service в наш текущий тестовый экземпляр и сделать сервис явной зависимостью от@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;
    }

    // ...
}

Или мы можем поместить этап инициализации условия в раздел@Before, чтобы избежать грязного контекста. Но такого рода решение может быть недоступно в некоторых сложных ситуациях.

@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с**

Чтобы включить аннотации на уровне класса, мы должны использоватьSpringIntegrationClassRule. Скажем, у нас есть следующие тестовые классы; каждый загрязняет контекст:

@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();
    }
}

В этом примере все неявные инъекции будут перестроены для уровня класса@DirtiesContext.

**3.3. SpringIntegrationSerenityRunnerс**

Существует удобный классSpringIntegrationSerenityRunner, который автоматически добавляет оба вышеуказанных правила интеграции. Мы можем запустить тесты выше с этим бегуном, чтобы избежать указания метода или правил теста класса в нашем тесте:

@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. Интеграция SpringMVC

В случаях, когда нам нужно только протестировать компоненты SpringMVC с помощью Serenity, мы можем просто использоватьRestAssuredMockMvc вrest-assured вместо интеграцииserenity-spring.

4.1. Maven Dependency

Нам нужно добавить зависимостьrest-assured spring-mock-mvc кpom.xml:


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

**4.2. RestAssuredMockMvc в действии**

Давайте теперь протестируем следующий контроллер:

@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;
    }
}

Мы можем воспользоваться утилитами для имитации MVCRestAssuredMockMvc следующим образом:

@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();
    }
}

Тогда остальная часть ничем не отличается от того, как мы используемrest-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 и Spring

Поддержка интеграции Spring в Serenity без проблем работает сJBehave. Давайте напишем наш тестовый сценарий в виде истории 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

Мы можем реализовать логику в@Service и раскрыть действия через API:

@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);
    }
}

Теперь мы можем построить тест Serenity-JBehave с помощьюRestAssuredMockMvc следующим образом:

@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();
    }
}

Мы можем пометитьSerenityStory только@ContextConfiguration, тогда внедрение Spring будет включено автоматически. Это работает точно так же, как@ContextConfiguration на@Steps.

6. Резюме

В этой статье мы рассказали о том, как интегрировать Serenity BDD со Spring. Интеграция не совсем идеальна, но она определенно приближается.

Как всегда, полную реализацию можно найти наthe GitHub project.

TOC

Спокойствие BDD с Spring и JBehave