Spring Test 404 Redirecting - spring-boot

Question

I have an application that redirects all invalid paths to the swagger page like this:
#Configuration
public class MyProjectContext implements WebMvcConfigurer {
#Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController(Endpoints.NOT_FOUND)
.setViewName("redirect:" + Endpoints.SWAGGER);
}
#Bean
public WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> containerCustomizer() {
return container -> {
container.addErrorPages(
new ErrorPage(HttpStatus.NOT_FOUND, Endpoints.NOT_FOUND)
);
};
}
}
Now I would like to test that. For that, I have written a test like this:
#AutoConfigureTestEntityManager
#SpringBootTest
#ContextConfiguration(classes = { MyProjectContext.class })
#AutoConfigureMockMvc
class MyProjectErrorControllerTest {
#Autowired
private MockMvc mockMvc;
#Test
void errorEnpointShouldRedirectToSwaggerPage() throws Exception {
mockMvc.perform(get("/dfhdfth"))
.andExpect(redirectedUrl(Endpoints.SWAGGER));
}
}
However, that test currently fails for the following reason:
java.lang.AssertionError: Redirected URL expected:</swagger-ui/index.html> but was:<null>
Also, here's the console output of the Request and Response:
MockHttpServletRequest:
HTTP Method = GET
Request URI = /dfhdfth
Parameters = {}
Headers = []
Body = null
Session Attrs = {}
Handler:
Type = org.springframework.web.servlet.resource.ResourceHttpRequestHandler
Async:
Async started = false
Async result = null
Resolved Exception:
Type = null
ModelAndView:
View name = null
View = null
Model = null
FlashMap:
Attributes = null
MockHttpServletResponse:
Status = 404
Error message = null
Headers = [Vary:"Origin", "Access-Control-Request-Method", "Access-Control-Request-Headers"]
Content type = null
Body =
Forwarded URL = null
Redirected URL = null
Cookies = []
I could imagine this is because of my use of MockMvc here. Is that the case? And if so, how do I write this "properly"?

Answer 1

Okay, I now managed to get it to work as follows:
First, I added the webflux dependency to my build.gradle as follows:
testImplementation 'org.springframework.boot:spring-boot-starter-webflux'
Then, I wrote the tests using the WebTestClient like this:
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.http.HttpStatus;
import org.springframework.test.web.reactive.server.WebTestClient;
#SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
#AutoConfigureWebTestClient
class ErrorControllerTest {
#Autowired
private WebTestClient webTestClient;
#Test
void errorEnpointShouldRedirect() throws Exception {
webTestClient.get()
.uri("/garxms")
.exchange()
.expectStatus()
.isEqualTo(HttpStatus.FOUND);
}
#Test
void errorEnpointShouldRedirectToSwaggerPage() throws Exception {
webTestClient.get()
.uri("/garxms")
.exchange()
.expectHeader()
.valueMatches("Location", ".*" + Endpoints.SWAGGER);
}
}
Works like a charm.