在测试 class 之外使用 Spring Boot/JUnit 5 连接到测试生命周期事件

Question

JUnit 5 具有 @BeforeEach、@BeforeAll、@AfterAll、@AfterEach 注释等功能，允许您在测试生命周期事件期间执行代码，例如清除将在测试之间共享的状态。

我想要一种针对某些测试配置自动执行此操作的方法，而不必记住在每个测试中放置这些生命周期挂钩。

例如：

如果我有一个 Spring 加载一些存根数据源的测试配置：

interface DataProvider {
    String getData(String id);
}

还有一个 class 取决于此：

@Component
class ClassThatDependsOnDataProvider {
    private final DataProvider dataProvider;

    @Autowired
    ClassThatDependsOnDataProvider(DataProvider dataProvider) {
        this.dataProvider = dataProvider;
    }

    public String process(String id) {
        String data = dataProvider.get(id);
        return some_processing_of(data);
    }
}

通常这可能会影响后端，但对于我的测试，我会将其替换为内存中的解决方案：

@TestComponent
class InMemoryDataProvider implements DataProvider {
    private Map<String, String> data = new HashMap<>();

    public void setData(String id, String data) {
        data.put(id, data);
    }

    public String getData(String id) {
        return data.get(id);
    }

    public void clear() {
        data.clear();
    }
}

在我的测试中，我可能想用它来存根我后端的数据，比如：

@SpringBootTest
@Import({InMemoryDataProvider.class})
class ClassThatDependsOnDataProviderTests {
    @Autowired InMemoryDataProvider dataProvider;

    @Autowired ClassThatDependsOnDataProvider classThatDependsOnDataProvider;

    @Test
    public void should_correctly_process_data() {
        // given i have an id with a value
        dataProvider.setData("stub_id", "stub_value");

        // when i process my id
        var result = classThatDependsOnDataProvider.process("stub_id");

        // then i receive expected result
        assertThat(result).isWhatIExpect();
    }

    // more @Tests

    // DON'T WANT TO HAVE TO DO THIS IN EACH TEST CLASS
    @AfterEach
    public void tearDown() {
        dataProvider.clear();
    }
}

我希望能够删除此处用 @AfterEach 注释的 tearDown() 方法，并将该行为移至测试 component/test 伪造或配置 class 这样，有了一组这样的提供程序，就可以很容易地维护一组测试，这些测试将用假版本替换它们，而无需为每个测试手动管理它们的生命周期。

是否有某种 Spring 功能、生命周期事件或 JUnit 5 功能允许这样做？

请原谅这个简单的例子，对于这么简单的测试来说显然是矫枉过正，但它只是一个讨论的参考。假设 @MockBean 或使用模拟库不是一个选项。

Answer 1

您可以使用 JUnit5 扩展：https://junit.org/junit5/docs/current/user-guide/#extensions。

例如，您的扩展程序如下所示：

public class InMemoryDataProviderExtension implements AfterEachCallback {

    /**
     * {@inheritDoc}
     */
    @Override
    public void afterEach(final ExtensionContext context) throws Exception {
        final ApplicationContext applicationContext = SpringExtension.getApplicationContext(context);

        final InMemoryDataProvider inMemoryDataProvider = applicationContext.getBean(InMemoryDataProvider.class);
        inMemoryDataProvider.clear();

    }
}

注意：

SpringExtension.getApplicationContext(context); 获取 spring 应用程序上下文，因此您可以检索上下文中定义的 beans
该扩展实现了 AfterEachCallback 接口，但对于其他扩展点（即 BeforeEachCallback、BeforeAllCallback 等）存在其他接口

为了在您的测试中激活扩展：

@SpringBootTest
@ExtendWith(InMemoryDataProviderExtension.class)
public class ClassThatDependsOnDataProviderTests { ... }

在测试 class 之外使用 Spring Boot/JUnit 5 连接到测试生命周期事件

Hooking into test lifecycle events with Spring Boot/JUnit 5 outside of test class

junit

spring

spring-boot

junit5