使用模拟服务/组件进行Spring Boot集成测试

时间:2017-03-07 06:42:59

标签: spring-boot junit4 spring-test

情况和问题:在Spring Boot中,如何将一个或多个模拟类/ bean注入应用程序以进行集成测试? StackOverflow上有一些答案,但它们专注于Spring Boot 1.4之前的情况,或者只是不适合我。

背景是,在下面的代码中,Settings的实现依赖于第三方服务器和其他外部系统。 Settings的功能已经在单元测试中进行了测试,因此对于完整的集成测试,我想模拟对这些服务器或系统的依赖性,只提供虚拟值。

MockBean将忽略所有现有的bean定义并提供虚拟对象,但此对象不会在注入此类的其他类中提供方法行为。在测试之前使用@Before方式设置行为不会影响注入的对象,也不会在AuthenticationService等其他应用程序服务中注入。

我的问题:如何将我的bean注入应用程序上下文? 我的测试:

package ch.swaechter.testapp;

import ch.swaechter.testapp.utils.settings.Settings;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import org.springframework.test.context.junit4.SpringRunner;

@TestConfiguration
@RunWith(SpringRunner.class)
@SpringBootTest(classes = {MyApplication.class})
public class MyApplicationTests {

    @MockBean
    private Settings settings;

    @Before
    public void before() {
        Mockito.when(settings.getApplicationSecret()).thenReturn("Application Secret");
    }

    @Test
    public void contextLoads() {
        String applicationsecret = settings.getApplicationSecret();
        System.out.println("Application secret: " + applicationsecret);
    }
}

并且下面应该使用模拟类的服务,但是没有收到这个模拟的类:

package ch.swaechter.testapp;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class AuthenticationServiceImpl implements AuthenticationService {

    private final Settings settings;

    @Autowired
    public AuthenticationServiceImpl(Settings settings) {
        this.settings = settings;
    }

    @Override
    public boolean loginUser(String token) {
        // Use the application secret to check the token signature
        // But here settings.getApplicationSecret() will return null (Instead of Application Secret as specified in the mock)!
        return false;
    }
}

3 个答案:

答案 0 :(得分:10)

在指定其模拟行为之前,您似乎正在使用“设置”对象。 你必须运行

Mockito.when(settings.getApplicationSecret()).thenReturn("Application Secret");

在配置设置期间。为了防止您可以创建特殊配置类以进行测试。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {MyApplication.class, MyApplicationTest.TestConfig.class})
public class MyApplicationTest {

    private static final String SECRET = "Application Secret";

    @TestConfiguration
    public static class TestConfig {
        @Bean
        @Primary
        public Settings settingsBean(){
            Settings settings = Mockito.mock(Settings.class);
            Mockito.when(settings.getApplicationSecret()).thenReturn(SECRET);
            Mockito.doReturn(SECRET).when(settings).getApplicationSecret();
            return settings;
        }

    }

.....

}  

另外,我建议您使用下一个表示法进行模拟:

Mockito.doReturn(SECRET).when(settings).getApplicationSecret();

它不会运行 settings :: getApplicationSecret

答案 1 :(得分:1)

当您使用@MockBean注释一个字段时,spring将创建一个带注释类的模拟,并使用它来自动装配应用程序上下文的所有bean。

您必须使用

自行创建模拟
 Settings settings = Mockito.mock(Settings.class);

这将创建第二个模拟,导致描述的问题。

解决方案:

@MockBean
private Settings settings;

@Before
public void before() {
Mockito.when(settings.getApplicationSecret()).thenReturn("Application Secret");
}

@Test
public void contextLoads() {
    String applicationsecret = settings.getApplicationSecret();
    System.out.println("Application secret: " + applicationsecret);
}

答案 2 :(得分:-1)

您可以在测试中使用构造函数注入:

@Test
public void consumeService() {
    AuthenticationService authenticationService = new AuthenticationServiceImpl(settings);

    Boolean logedIn authenticationService.loginUser("token");

}

这将确保使用模拟的实例。