generated from hmcts/spring-boot-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* interceptor for incorrect Accept header value * unit test * update instanceOf + remove explicit cast
- Loading branch information
Showing
5 changed files
with
167 additions
and
0 deletions.
There are no files selected for viewing
12 changes: 12 additions & 0 deletions
12
src/main/java/uk/gov/hmcts/opal/annotation/CheckAcceptHeader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
package uk.gov.hmcts.opal.annotation; | ||
|
||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
@Target(ElementType.METHOD) | ||
@Retention(RetentionPolicy.RUNTIME) | ||
public @interface CheckAcceptHeader { | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package uk.gov.hmcts.opal.config; | ||
|
||
import org.springframework.context.annotation.Configuration; | ||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry; | ||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; | ||
import uk.gov.hmcts.opal.interceptor.AcceptHeaderInterceptor; | ||
|
||
@Configuration | ||
public class WebConfig implements WebMvcConfigurer { | ||
|
||
@Override | ||
public void addInterceptors(InterceptorRegistry registry) { | ||
registry.addInterceptor(new AcceptHeaderInterceptor()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
src/main/java/uk/gov/hmcts/opal/interceptor/AcceptHeaderInterceptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
package uk.gov.hmcts.opal.interceptor; | ||
|
||
import jakarta.servlet.http.HttpServletRequest; | ||
import jakarta.servlet.http.HttpServletResponse; | ||
import org.springframework.web.servlet.HandlerInterceptor; | ||
import org.springframework.web.method.HandlerMethod; | ||
import uk.gov.hmcts.opal.annotation.CheckAcceptHeader; | ||
|
||
public class AcceptHeaderInterceptor implements HandlerInterceptor { | ||
|
||
@Override | ||
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) | ||
throws Exception { | ||
if (handler instanceof HandlerMethod handlerMethod | ||
&& handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)) { | ||
String acceptHeader = request.getHeader("Accept"); | ||
if (!isAcceptableMediaType(acceptHeader)) { | ||
response.setStatus(HttpServletResponse.SC_NOT_ACCEPTABLE); | ||
response.getWriter().write("{\"error\":\"Not Acceptable\",\"message\"" | ||
+ ":\"The requested media type is not supported\"}"); | ||
return false; | ||
} | ||
} | ||
return true; | ||
} | ||
|
||
private boolean isAcceptableMediaType(String acceptHeader) { | ||
return acceptHeader != null && (acceptHeader.contains("application/json") || acceptHeader.contains("*/*")); | ||
} | ||
} |
108 changes: 108 additions & 0 deletions
108
src/test/java/uk/gov/hmcts/opal/interceptor/AcceptHeaderInterceptorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
package uk.gov.hmcts.opal.interceptor; | ||
|
||
import jakarta.servlet.http.HttpServletRequest; | ||
import jakarta.servlet.http.HttpServletResponse; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.ExtendWith; | ||
import org.mockito.Mock; | ||
import org.mockito.junit.jupiter.MockitoExtension; | ||
import org.springframework.web.method.HandlerMethod; | ||
import uk.gov.hmcts.opal.annotation.CheckAcceptHeader; | ||
|
||
import java.io.PrintWriter; | ||
import java.io.StringWriter; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertFalse; | ||
import static org.junit.jupiter.api.Assertions.assertTrue; | ||
import static org.mockito.Mockito.verify; | ||
import static org.mockito.Mockito.verifyNoInteractions; | ||
import static org.mockito.Mockito.when; | ||
|
||
@ExtendWith(MockitoExtension.class) | ||
class AcceptHeaderInterceptorTest { | ||
|
||
private AcceptHeaderInterceptor interceptor; | ||
|
||
@Mock | ||
private HttpServletRequest request; | ||
|
||
@Mock | ||
private HttpServletResponse response; | ||
|
||
@Mock | ||
private HandlerMethod handlerMethod; | ||
|
||
@BeforeEach | ||
void setUp() { | ||
interceptor = new AcceptHeaderInterceptor(); | ||
} | ||
|
||
@Test | ||
void preHandle_WithCheckAcceptHeaderAnnotationAndValidJsonAcceptHeader_ShouldReturnTrue() throws Exception { | ||
when(handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)).thenReturn(true); | ||
when(request.getHeader("Accept")).thenReturn("application/json"); | ||
|
||
boolean result = interceptor.preHandle(request, response, handlerMethod); | ||
|
||
assertTrue(result); | ||
verifyNoInteractions(response); | ||
} | ||
|
||
@Test | ||
void preHandle_WithCheckAcceptHeaderAnnotationAndValidWildcardAcceptHeader_ShouldReturnTrue() throws Exception { | ||
when(handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)).thenReturn(true); | ||
when(request.getHeader("Accept")).thenReturn("*/*"); | ||
|
||
boolean result = interceptor.preHandle(request, response, handlerMethod); | ||
|
||
assertTrue(result); | ||
verifyNoInteractions(response); | ||
} | ||
|
||
@Test | ||
void preHandle_WithCheckAcceptHeaderAnnotationAndInvalidAcceptHeader_ShouldReturnFalse() throws Exception { | ||
when(handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)).thenReturn(true); | ||
when(request.getHeader("Accept")).thenReturn("application/xml"); | ||
|
||
StringWriter stringWriter = new StringWriter(); | ||
PrintWriter writer = new PrintWriter(stringWriter); | ||
when(response.getWriter()).thenReturn(writer); | ||
|
||
boolean result = interceptor.preHandle(request, response, handlerMethod); | ||
|
||
assertFalse(result); | ||
verify(response).setStatus(HttpServletResponse.SC_NOT_ACCEPTABLE); | ||
writer.flush(); | ||
assertTrue(stringWriter.toString().contains("\"error\":\"Not Acceptable\"")); | ||
assertTrue(stringWriter.toString().contains("\"message\":\"The requested media type is not supported\"")); | ||
} | ||
|
||
@Test | ||
void preHandle_WithCheckAcceptHeaderAnnotationAndNullAcceptHeader_ShouldReturnFalse() throws Exception { | ||
when(handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)).thenReturn(true); | ||
when(request.getHeader("Accept")).thenReturn(null); | ||
|
||
StringWriter stringWriter = new StringWriter(); | ||
PrintWriter writer = new PrintWriter(stringWriter); | ||
when(response.getWriter()).thenReturn(writer); | ||
|
||
boolean result = interceptor.preHandle(request, response, handlerMethod); | ||
|
||
assertFalse(result); | ||
verify(response).setStatus(HttpServletResponse.SC_NOT_ACCEPTABLE); | ||
writer.flush(); | ||
assertTrue(stringWriter.toString().contains("\"error\":\"Not Acceptable\"")); | ||
assertTrue(stringWriter.toString().contains("\"message\":\"The requested media type is not supported\"")); | ||
} | ||
|
||
@Test | ||
void preHandle_WithoutCheckAcceptHeaderAnnotation_ShouldReturnTrue() throws Exception { | ||
when(handlerMethod.hasMethodAnnotation(CheckAcceptHeader.class)).thenReturn(false); | ||
|
||
boolean result = interceptor.preHandle(request, response, handlerMethod); | ||
|
||
assertTrue(result); | ||
verifyNoInteractions(response); | ||
} | ||
} |