Туториал по JUnit 5 - Аннотация @BeforeAll

Аннотация JUnit 5 помечает @BeforeAll метод, являющийся методом жизненного цикла JUnit 5 теста. @BeforeAll - это замена аннотации @BeforeClass в JUnit 4.

Это продолжение туториала по JUnit 5. Введение опубликовано здесь.

1. Аннотация @BeforeAll

Аннотация @BoforeAll используются для указания о том, что аннотированный метод должен быть выполнен перед всеми @Test, @RepeatedTest, @ParameterizedTest и @TestFactory методами в текущем классе.

По умолчанию тестовые методы будут выполняться в том же потоке, что и аннотированный @BeforeAll метод.

• Аннотированный @BeforeAll метод ДОЛЖЕН быть статическим методом в тестовом классе.

@BeforeAll
public static void init(){
    System.out.println("BeforeAll init() method called");
}

• Или мы можем применить эту аннотацию к default методам интерфейса, если тестовый интерфейс или тестовый класс аннотированы с помощью @TestInstance(Lifecycle.PER_CLASS).

@TestInstance(Lifecycle.PER_CLASS)
interface TestLifecycleLogger {

    @BeforeAll
    default void beforeAllTests() {
        //
    }
}

Если этого не сделать, JUnit выдаст ошибку времени выполнения типа JUnitException.

org.junit.platform.commons.JUnitException: 
@BeforeAll method 'public void com.howtodoinjava.junit5.examples. 
JUnit5AnnotationsExample.init()' must be static.
at org.junit.jupiter.engine.descriptor. 
LifecycleMethodUtils.assertStatic(LifecycleMethodUtils.java:66)

@BeforeAll в родительском и дочернем классах

@BeforeAll методы наследуются от родительских классов (или интерфейсов), если они не скрыты или не переопределены. 

Кроме того, @BeforeAll методы из родительских классов (или интерфейсов) будут выполняться перед @BeforeAll методами в дочерних классах.

2. Пример аннотации @BeforeAll

Рассмотрим пример. Мы написали тест для класса Calculator и его метода add().

Выполним тест 5 раз с помощью аннотации @RepeatedTest. Аннотация @Repeated вызовет запуск теста add пять раз. Но аннотированный @BeforeAll метод нужно вызывать только один раз.

package com.howtodoinjava.junit5.examples;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
import org.junit.jupiter.api.RepetitionInfo;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;

public class BeforeAllTest {

    @DisplayName("Add operation test")
    @RepeatedTest(5)
    void addNumber(TestInfo testInfo, RepetitionInfo repetitionInfo) {
        System.out.println("Running test -> " + repetitionInfo.getCurrentRepetition());
        Assertions.assertEquals(2, Calculator.add(1, 1), "1 + 1 should equal 2");
    }

    @BeforeAll
    public static void init(){
        System.out.println("Before All init() method called");
    }
}

Это класс калькулятора:

package com.howtodoinjava.junit5.examples;

public class Calculator
{
    public static int add(int a, int b) {
        return a + b;
    }
}

Теперь выполните тест, и вы увидите на консоли вывод:

Before All init() method called

Running test -> 1
Running test -> 2
Running test -> 3
Running test -> 4
Running test -> 5

Понятно, что аннотированный @BeforeAll метод init() вызывается только один раз.

Хорошего изучения!!!

Скачать исходный код