Test di integrazione in primavera

1. Panoramica

Il test di integrazione svolge un ruolo importante nel ciclo di sviluppo dell'applicazione verificando il comportamento end-to-end di un sistema.

In questo articolo, vedremo come possiamo sfruttare il framework di test Spring MVC per scrivere ed eseguire test di integrazione che testano i controller senza avviare esplicitamente un contenitore Servlet.

2. Preparazione

Le seguenti dipendenze Maven sono necessarie per eseguire i test di integrazione come descritto in questo articolo. Prima di tutto le ultime dipendenze di JUnit e Spring test:

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

Per un'efficace affermazione dei risultati, utilizzeremo anche Hamcrest e il percorso JSON:

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

3. Configurazione di prova Spring MVC

Presentiamo ora come configurare ed eseguire i test abilitati per la primavera.

3.1. Abilita la primavera nei test

Innanzitutto, qualsiasi test abilitato per Spring verrà eseguito con l'aiuto di @RunWith (SpringJUnit4ClassRunner.class) ; il runner è essenzialmente il punto di ingresso per iniziare a utilizzare il framework Spring Test.

Abbiamo anche bisogno delle annotazioni @ContextConfiguration per caricare la configurazione del contesto e avviare il contesto che verrà utilizzato dal test .

Diamo un'occhiata:

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

Si noti come, in @ContextConfiguration, abbiamo fornito la classe di configurazione ApplicationConfig.class che carica la configurazione necessaria per questo particolare test.

Abbiamo utilizzato una classe di configurazione Java qui per specificare la configurazione del contesto; allo stesso modo, possiamo usare la configurazione basata su XML:

@ContextConfiguration(locations={""})

Infine - il test è anche annotato con @ WebAppConfiguration - che caricherà il contesto dell'applicazione web.

Per impostazione predefinita, cerca l'applicazione Web root nel percorso predefinito src / main / webapp ; la posizione può essere sovrascritta passando l' attributo value come:

@WebAppConfiguration(value = "")

3.2. Il WebApplicationContext Object

WebApplicationContext ( wac ) fornisce una configurazione dell'applicazione Web. Carica tutti i bean e i controller dell'applicazione nel contesto.

Ora saremo in grado di collegare il contesto dell'applicazione Web direttamente al test:

@Autowired private WebApplicationContext wac;

3.3. Fagioli di contesto web beffardi

MockMvc fornisce supporto per i test Spring MVC. Incapsula tutti i bean dell'applicazione Web e li rende disponibili per il test.

Vediamo come usarlo:

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

Dobbiamo inizializzare l' oggetto mockMvc nel metodo annotato @Before , in modo da non doverlo inizializzare all'interno di ogni test.

3.4. Verifica configurazione di prova

Per il nostro tutorial qui, verifichiamo effettivamente di caricare correttamente l' oggetto WebApplicationContext ( wac ). Verificheremo anche che venga allegato il servletContext corretto :

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

Si noti che stiamo anche verificando che nel contesto web sia presente un bean GreetController.java , il che garantisce che i bean spring siano caricati correttamente.

A questo punto, l'impostazione del test di integrazione è terminata. Vediamo come possiamo testare i metodi delle risorse utilizzando l' oggetto MockMvc .

4. Scrittura di test di integrazione

In questa sezione, esamineremo le operazioni di base disponibili tramite il framework di test.

Mostreremo come inviare richieste con variabili e parametri di percorso. Inoltre, seguiremo con i pochi esempi che mostrano come affermare che il nome della vista corretto è stato risolto o che il corpo della risposta è come previsto.

I seguenti frammenti utilizzano importazioni statiche dalle classi M ockMvcRequestBuilders o MockMvcResultMatchers .

4.1. Verifica il nome della vista

Invochiamo l' / Home endpoint dal nostro test come :

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

o

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

Snippet di codice:

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

Analizziamolo:

  • 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.

Infine, l'implementazione di tutti questi esempi e frammenti di codice è disponibile in GitHub .