Test RESTful Services avec RestTemplate

Il y a de bonnes chapitre à ce sujet dans la documentation, je vous suggère de le lire, pour comprendre pleinement ce que vous pouvez faire.

J'aime utiliser @IntegrationTest avec une configuration personnalisée depuis que démarre l'ensemble du serveur et permet de tester le système complet. Si vous souhaitez remplacer certaines parties du système avec des objets fantaisie que vous pouvez faire que par l'exclusion de certaines configurations ou les haricots et les remplacer par votre propre.

Voici un petit exemple. J'ai laissé de côté l' MessageService interface parce que c'est évident à partir de IndexController ce qu'il fait, et c'est par défaut de mise en œuvre - DefaultMessageService - parce qu'il n'est pas pertinent.

Ce qu'il fait est qu'il tourne l'ensemble de l'application, moins le DefaultMessageService mais avec son propre MessageService à la place. Il utilise ensuite RestTemplate de problème réel les requêtes HTTP de l'application en cours d'exécution dans le cas du test.

Les classes d'Application:

IntegrationTestDemo.java:

@SpringBootApplication
public class IntegrationTestDemo {

    public static void main(String[] args) {
        SpringApplication.run(IntegrationTestDemo.class, args);
    }

}

IndexController.java:

@RestController
public class IndexController {

    @Autowired
    MessageService messageService;

    @RequestMapping("/")
    String getMessage() {
        return messageService.getMessage();
    }
}

Classes de Test:

IntegrationTestDemoTest.java:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfig.class)
@WebIntegrationTest //This will start the server on a random port
public class IntegrationTestDemoTest {

    //This will hold the port number the server was started on
    @Value("${local.server.port}")
    int port;

    final RestTemplate template = new RestTemplate();

    @Test
    public void testGetMessage() {
        String message = template.getForObject("http://localhost:" + port + "/", String.class);

        Assert.assertEquals("This is a test message", message);
    }
}

TestConfig.java:

@SpringBootApplication
@ComponentScan(
    excludeFilters = {
        //Exclude the default message service
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = DefaultMessageService.class),
        //Exclude the default boot application or it's
        //@ComponentScan will pull in the default message service
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = IntegrationTestDemo.class)
    }
)
public class TestConfig {

    @Bean
    //Define our own test message service
    MessageService mockMessageService() {
        return new MessageService() {
            @Override
            public String getMessage() {
                return "This is a test message";
            }
        };
    }
}

Puisque vous êtes à l'aide de Spring MVC pour le RESTE, je vous conseille d'utiliser les installations d'essais fournis par l'instanciation de MockMVC() - activation de tests, tels que:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {
 ... //any required Spring config
)
@WebAppConfiguration
public class RestControllerTest {

    @Autowired
    private WebApplicationContext context;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
    }


    @Test
    public void getUserList() throws Exception {
        mockMvc.perform(get("/user"))
            .andExpect(status().isOk())
            .andExpect(content().contentType("application/json;charset=UTF-8")) 
            .andExpect(content().encoding("UTF-8"))
            .andExpect(jsonPath("$", hasSize(8)))
            .andExpect(jsonPath("$[0].id").exists())
            .andExpect(jsonPath("$[0].alias").exists())
            .andExpect(jsonPath("$[0].name").exists())
        );
    }
}

Ce test permettra de tester une interface REST sans déployer. Plus précisément, si exactement 8 utilisateurs sont retournés et le premier a le champs 'id', 'alias' et 'nom'.

La jsonPath affirmations besoin de deux dépendances:

'com.jayway.jsonpath:json-path:0.8.1'
'com.jayway.jsonpath:json-path-assert:0.8.1'

Et probablement aussi:

'org.springframework:spring-test:4.1.7.RELEASE'