Test d'intégration au printemps

1. Vue d'ensemble

Les tests d'intégration jouent un rôle important dans le cycle de développement d'applications en vérifiant le comportement de bout en bout d'un système.

Dans cet article, nous verrons comment nous pouvons tirer parti du framework de test Spring MVC afin d'écrire et d'exécuter des tests d'intégration qui testent les contrôleurs sans démarrer explicitement un conteneur Servlet.

2. Préparation

Les dépendances Maven suivantes sont nécessaires pour exécuter les tests d'intégration comme décrit dans cet article. Avant tout, les dernières dépendances de test JUnit et Spring:

 junit junit 4.12 test   org.springframework spring-test 4.3.2.RELEASE test  

Pour une affirmation efficace des résultats, nous allons également utiliser Hamcrest et le chemin JSON:

 org.hamcrest hamcrest-library 1.3 test   com.jayway.jsonpath json-path 2.2.0 test 

3. Configuration du test Spring MVC

Voyons maintenant comment configurer et exécuter les tests activés par Spring.

3.1. Activer le printemps dans les tests

Tout d'abord, tout test activé par Spring sera exécuté avec l'aide de @RunWith (SpringJUnit4ClassRunner.class) ; le coureur est essentiellement le point d'entrée pour commencer à utiliser le framework Spring Test.

Nous avons également besoin des annotations @ContextConfiguration pour charger la configuration de contexte et amorcer le contexte que le test utilisera .

Regardons:

@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(classes = { ApplicationConfig.class }) @WebAppConfiguration public class GreetControllerIntegrationTest { .... }

Remarquez comment, dans @ContextConfiguration, nous avons fourni la classe de configuration ApplicationConfig.class qui charge la configuration dont nous avons besoin pour ce test particulier.

Nous avons utilisé une classe de configuration Java ici pour spécifier la configuration du contexte; de même, nous pouvons utiliser la configuration basée sur XML:

@ContextConfiguration(locations={""})

Enfin - le test est également annoté avec @ WebAppConfiguration - qui chargera le contexte de l'application Web.

Par défaut, il recherche l'application Web racine au chemin par défaut src / main / webapp ; l'emplacement peut être remplacé en transmettant l' attribut value comme suit:

@WebAppConfiguration(value = "")

3.2. L' objet WebApplicationContext

WebApplicationContext ( wac ) fournit une configuration d'application Web. Il charge tous les beans et contrôleurs d'application dans le contexte.

Nous allons maintenant pouvoir câbler le contexte de l'application Web directement dans le test:

@Autowired private WebApplicationContext wac;

3.3. Mocking Web Context Beans

MockMvc prend en charge les tests Spring MVC. Il encapsule tous les beans d'application Web et les rend disponibles pour les tests.

Voyons comment l'utiliser:

private MockMvc mockMvc; @Before public void setup() throws Exception { this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build(); }

Nous devons initialiser l' objet mockMvc dans la méthode annotée @Before , afin que nous n'ayons pas besoin de l'initialiser à l'intérieur de chaque test.

3.4. Vérifier la configuration du test

Pour notre tutoriel ici, vérifions en fait que nous chargeons correctement l' objet WebApplicationContext ( wac ). Nous vérifierons également que le bon servletContext est attaché:

@Test public void givenWac_whenServletContext_thenItProvidesGreetController() { ServletContext servletContext = wac.getServletContext(); Assert.assertNotNull(servletContext); Assert.assertTrue(servletContext instanceof MockServletContext); Assert.assertNotNull(wac.getBean("greetController")); }

Notez que nous vérifions également qu'un bean GreetController.java existe dans le contexte Web - ce qui garantit que les beans spring sont chargés correctement.

À ce stade, la configuration du test d'intégration est terminée. Voyons comment nous pouvons tester les méthodes de ressources à l'aide de l' objet MockMvc .

4. Rédaction de tests d'intégration

Dans cette section, nous allons passer en revue les opérations de base disponibles via le framework de test.

Nous montrerons comment envoyer des requêtes avec des variables de chemin et des paramètres. En outre, nous allons suivre avec les quelques exemples qui montrent comment affirmer que le nom de vue correct est résolu ou que le corps de la réponse est comme prévu.

Les extraits de code suivants utilisent des importations statiques à partir des classes M ockMvcRequestBuilders ou MockMvcResultMatchers .

4.1. Vérifier le nom de la vue

Appelons le point de terminaison / homePage à partir de notre test comme :

//localhost:8080/spring-mvc-test/

ou

//localhost:8080/spring-mvc-test/homePage

Extrait de code:

@Test public void givenHomePageURI_whenMockMVC_thenReturnsIndexJSPViewName() { this.mockMvc.perform(get("/homePage")).andDo(print()) .andExpect(view().name("index")); }

Décomposons cela:

  • perform() method will call a get request method which returns the ResultActions. Using this result we can have assertion expectations on response like content, HTTP status, header, etc
  • andDo(print()) will print the request and response. This is helpful to get a detailed view in case of error
  • andExpect()will expect the provided argument. In our case we are expecting “index” to be returned via MockMvcResultMatchers.view()

4.2. Verify Response Body

We will invoke /greet endpoint from our test as:

//localhost:8080/spring-mvc-test/greet

Expected Output:

{ "id": 1, "message": "Hello World!!!" }

Code Snippet:

@Test public void givenGreetURI_whenMockMVC_thenVerifyResponse() { MvcResult mvcResult = this.mockMvc.perform(get("/greet")) .andDo(print()).andExpect(status().isOk()) .andExpect(jsonPath("$.message").value("Hello World!!!")) .andReturn(); Assert.assertEquals("application/json;charset=UTF-8", mvcResult.getResponse().getContentType()); }

Let's see exactly what's going on:

  • andExpect(MockMvcResultMatchers.status().isOk())will verify that response HTTP status is Ok i.e. 200. This ensures that the request was successfully executed
  • andExpect(MockMvcResultMatchers.jsonPath(“$.message”).value(“Hello World!!!”)) will verify that response content matches with the argument “Hello World!!!“. Here we used jsonPath which extracts response content and provide the requested value
  • andReturn()will return the MvcResult object which is used when we have to verify something which is not achievable by the library. You can see we have added assertEquals to match the content type of response that is extracted from the MvcResult object

4.3. Send GET Request With Path Variable

We will invoke /greetWithPathVariable/{name} endpoint from our test as:

//localhost:8080/spring-mvc-test/greetWithPathVariable/John

Expected Output:

{ "id": 1, "message": "Hello World John!!!" }

Code Snippet:

@Test public void givenGreetURIWithPathVariable_whenMockMVC_thenResponseOK() { this.mockMvc .perform(get("/greetWithPathVariable/{name}", "John")) .andDo(print()).andExpect(status().isOk()) .andExpect(content().contentType("application/json;charset=UTF-8")) .andExpect(jsonPath("$.message").value("Hello World John!!!")); }

MockMvcRequestBuilders.get(“/greetWithPathVariable/{name}”, “John”) will send request as “/greetWithPathVariable/John“.

This becomes easier with respect to readability and knowing what are the parameters which are dynamically set in the URL. Note that we can pass as many path parameters as needed.

4.4. Send GET Request With Query Parameters

We'll invoke /greetWithQueryVariable?name={name} endpoint from our test as:

//localhost:8080/spring-mvc-test /greetWithQueryVariable?name=John%20Doe

Expected Output:

{ "id": 1, "message": "Hello World John Doe!!!" }

Code Snippet:

@Test public void givenGreetURIWithQueryParameter_whenMockMVC_thenResponseOK() { this.mockMvc.perform(get("/greetWithQueryVariable") .param("name", "John Doe")).andDo(print()).andExpect(status().isOk()) .andExpect(content().contentType("application/json;charset=UTF-8")) .andExpect(jsonPath("$.message").value("Hello World John Doe!!!")); }

param(“name”, “John Doe”) will append the query parameter in the GET request. It is similar to “ /greetWithQueryVariable?name=John%20Doe“.

The query parameter can also be implemented using the URI template style:

this.mockMvc.perform( get("/greetWithQueryVariable?name={name}", "John Doe"));

4.5. Send POST Request

We will invoke /greetWithPost endpoint from our test as:

//localhost:8080/spring-mvc-test/greetWithPost

Expected Output:

{ "id": 1, "message": "Hello World!!!" }

Code Snippet:

@Test public void givenGreetURIWithPost_whenMockMVC_thenVerifyResponse() { this.mockMvc.perform(post("/greetWithPost")).andDo(print()) .andExpect(status().isOk()).andExpect(content() .contentType("application/json;charset=UTF-8")) .andExpect(jsonPath("$.message").value("Hello World!!!")); }

MockMvcRequestBuilders.post(“/greetWithPost”) will send the post request. Path variables and Query Parameters can be set in a similar way we looked earlier, whereas Form Data can be set via param() method only similar to Query Parameter as:

//localhost:8080/spring-mvc-test/greetWithPostAndFormData

Form Data:

id=1;name=John%20Doe

Expected Output:

{ "id": 1, "message": "Hello World John Doe!!!" }

Code Snippet:

@Test public void givenGreetURIWithPostAndFormData_whenMockMVC_thenResponseOK() { this.mockMvc.perform(post("/greetWithPostAndFormData").param("id", "1") .param("name", "John Doe")).andDo(print()).andExpect(status().isOk()) .andExpect(content().contentType("application/json;charset=UTF-8")) .andExpect(jsonPath("$.message").value("Hello World John Doe!!!")) .andExpect(jsonPath("$.id").value(1)); }

In the above code snippet, we've added two parameters id as “1” and name as “John Doe”.

5. MockMvc Limitations

MockMvc provides an elegant and easy to use API to call web endpoints and inspect and assert their response at the same time. Despite all its benefits, it has a few limitations.

First of all, it does use a subclass of the DispatcherServlet to handle test requests. To be more specific, the TestDispatcherServlet is responsible for calling controllers and performing all of the familiar Spring magic.

The MockMvc class wraps this TestDispatcherServlet internally. So, every time we send a request using the perform() method, MockMvc will use the underlying TestDispatcherServlet directly. Therefore, there are no real network connections made, and consequently, we won't test the whole network stack while using MockMvc.

Also,because Spring prepares a fake web application context to mock the HTTP requests and responses, it may not support all features of a full-blown Spring application.

For example, this mock setup does not support HTTP redirections. This may not seem that significant at first. However, Spring Boot handles some errors by redirecting the current request to the /error endpoint. So if we're using the MockMvc, we may not be able to test some API failures.

As an alternative to MockMvc, we can set up a more real application contextand then use RestTemplate or even Rest Assured to test our application.

For instance, this is easy using Spring Boot:

@RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = RANDOM_PORT) public class GreetControllerRealIntegrationTest { @LocalServerPort private int port; @Before public void setUp() { RestAssured.port = port; } @Test public void givenGreetURI_whenSendingReq_thenVerifyResponse() { given().get("/greet") .then() .statusCode(200); } }

This way, every test will make a real HTTP request to the application that listens on a random TCP port.

6. Conclusion

In this tutorial, we implemented a few simple Spring enabled integration tests.

We also looked at the WebApplicationContext and MockMVC object creation which played an important role in calling the endpoints of the application.

Looking further we covered how we can send GET and POST requests with variations of parameter passing and how to verify the HTTP response status, header, and content.

As a closing remark, we did also evaluate some limitations of the MockMvc. Knowing those limitations can guide us to make an informed decision about how we're going to implement our tests.

Enfin, l'implémentation de tous ces exemples et extraits de code est disponible dans GitHub .