How do I unit test a Servlet Filter with jUnit? ServletRequest, ServletResponse, FilterChain

huangapple
go评论126阅读模式
英文:

How do I unit test a Servlet Filter with jUnit? ServletRequest, ServletResponse, FilterChain

问题

  1. @SlingFilter(order = -700, scope = SlingFilterScope.REQUEST)
  2. public class LoggingFilter implements Filter {
  4.     private final Logger logger = LoggerFactory.getLogger(getClass());
  6.     @Override
  7.     public void doFilter(final ServletRequest request, final ServletResponse response,
  8.             final FilterChain filterChain) throws IOException, ServletException {
  10.         final SlingHttpServletRequest slingRequest = (SlingHttpServletRequest) request;
  11.         logger.debug("request for {}, with selector {}", slingRequest
  12.                 .getRequestPathInfo().getResourcePath(), slingRequest
  13.                 .getRequestPathInfo().getSelectorString());
  15.         filterChain.doFilter(request, response);
  16.     }
  18.     @Override
  19.     public void init(FilterConfig filterConfig) {}
  21.     @Override
  22.     public void destroy() {}
  24. }
英文:

How to properly cover Filter with JUnit?

  1. @SlingFilter(order = -700, scope = SlingFilterScope.REQUEST)
  2. public class LoggingFilter implements Filter {
  4.     private final Logger logger = LoggerFactory.getLogger(getClass());
  6.     @Override
  7.     public void doFilter(final ServletRequest request, final ServletResponse response,
  8.             final FilterChain filterChain) throws IOException, ServletException {
  10.         final SlingHttpServletRequest slingRequest = (SlingHttpServletRequest) request;
  11.         logger.debug("request for {}, with selector {}", slingRequest
  12.                 .getRequestPathInfo().getResourcePath(), slingRequest
  13.                 .getRequestPathInfo().getSelectorString());
  15.         filterChain.doFilter(request, response);
  16.     }
  18.     @Override
  19.     public void init(FilterConfig filterConfig) {}
  21.     @Override
  22.     public void destroy() {}
  24. }

答案1

得分: 4

  1. @ExtendWith(MockitoExtension.class)
  2. public class LoggingFilterTest {
  4.     @InjectMocks
  5.     private LoggingFilter loggingFilter;
  7.     @Mock
  8.     private ServletRequest request;
  10.     @Mock
  11.     private ServletResponse response;
  13.     @Mock
  14.     private FilterChain filterChain;
  16.     @Mock
  17.     private RequestPathInfo requestPathInfo;
  19.     @Test
  20.     public void testDoFilter() throws IOException, ServletException {
  22.         Mockito.when(request.getResourcePath()).thenReturn(requestPathInfo);
  23.         Mockito.when(requestPathInfo.getResourcePath()).thenReturn("/testPath", "selectorString");
  24.         Mockito.doNothing().when(filterChain).doFilter(Mockito.eq(request), Mockito.eq(response));
  26.         loggingFilter.doFilter(request, response, filterChain);
  28.         Mockito.verify(filterChain, times(1)).doFilter(Mockito.eq(request), Mockito.eq(response));
  29.     }
  30. }

If you are using junit4, then change @ExtendWith(MockitoExtension.class) to @RunWith(MockitoJUnitRunner.class).

  2. <details>
  3. <summary>英文:</summary>
  5. You can use below code for your testing with `Junit-5`

@ExtendWith(MockitoExtension.class)
public class LoggingFilterTest{

  1. @InjectMocks
  2. private LoggingFilter loggingFilter;
  4. @Mock
  5. private ServletRequest request
  7. @Mock
  8. private ServletResponse response
  10. @Mock
  11. private FilterChain filterChain
  13. @Mock
  14. private RequestPathInfo requestPathInfo;
  16. @Test
  17. public void testDoFilter() throws IOException, ServletException{
  19. 	Mockito.when(request.getResourcePath()).thenReturn(requestPathInfo);
  20. 	Mockito.when(requestPathInfo.getResourcePath()).thenReturn(&quot;/testPath&quot;, &quot;selectorString&quot;);
  21. 	Mockito.doNothing().when(filterChain).doFilter(Mockito.eq(request),	Mockito.eq(response));
  22. 	
  23. 	loggingFilter.doFilter(request, response, filterChain);
  24. 	
  25. 	Mockito.verify(filterChain, times(1)).doFilter(Mockito.eq(request),	Mockito.eq(response));
  26. }

}

  2. If you are using `junit4` then change `@ExtendWith(MockitoExtension.class)` to `@RunWith(MockitoJUnitRunner.class)`
  4. </details>
  8. # 答案2
  9. **得分**: 3
  11. 调用 doFilter，将模拟的 ServletRequest、ServletResponse 和 FilterChain 作为其参数传递。
  13. ```java
  14. @Test
  15. public void testDoFilter() {
  16.     LoggingFilter filterUnderTest = new LoggingFilter();    
  17.     MockFilterChain mockChain = new MockFilterChain();
  18.     MockServletRequest req = new MockServletRequest("/test.jsp");
  19.     MockServletResponse rsp = new MockServletResponse();
  21.     filterUnderTest.doFilter(req, rsp, mockChain);
  23.     assertEquals("/test.jsp", rsp.getLastRedirect());
  24. }

在实际应用中，您会希望将设置移到 @Before setUp() 方法中，并编写更多的 @Test 方法来覆盖每个可能的执行路径。

您可能会使用模拟框架，比如 JMock 或 Mockito 来创建模拟，而不是我在这里使用的假设的 MockModeService 等。这是单元测试的方法，而不是集成测试。您只测试正在测试的单元（以及测试代码）。

英文:

Invoke doFilter passing the mock ServletRequest, ServletResponse and FilterChain as its parameters.

  1. @Test
  2. public void testDoFilter() {
  3.     LoggingFilter filterUnderTest = new LoggingFilter();    
  4.     MockFilterChain mockChain = new MockFilterChain();
  5.     MockServletRequest req = new MockServletRequest(&quot;/test.jsp&quot;);
  6.     MockServletResponse rsp = new MockServletResponse();
  8.     filterUnderTest.doFilter(req, rsp, mockChain);
  10.     assertEquals(&quot;/test.jsp&quot;,rsp.getLastRedirect());
  11. }

In practice, you'll want to move the setup into an @Before setUp() method, and write more @Test methods to cover every possible execution path.

And you'd probably use a mocking framework like JMock or Mockito to create mocks, rather than the hypothetical MockModeService etc. I've used here.

This is a unit testing approach, as opposed to an integration test. You are only exercising the unit under test (and the test code).

答案3

得分: 1

如果您在JUnit 5中使用AEM Mocks，代码可能如下所示：

  1. @ExtendWith(AemContextExtension.class)
  2. class SimpleFilterTest {
  4.     private static final AemContext context = new AemContext(ResourceResolverType.RESOURCERESOLVER_MOCK);
  6.     private static final String RESOURCE_PATH = "/content/test";
  7.     private static final String SELECTOR_STRING = "selectors";
  9.     private static SimpleFilter simpleFilter;
  10.     private static FilterChain filterChain;
  12.     @BeforeAll
  13.     static void setup() {
  14.         simpleFilter = context.registerService(SimpleFilter.class, new SimpleFilter());
  15.         filterChain = context.registerService(FilterChain.class, new MockFilterChain());
  16.     }
  18.     @Test
  19.     @DisplayName("GIVEN the request, WHEN is executed, THEN request should be filtered and contain corresponding header")
  20.     void testDoFilter() throws ServletException, IOException {
  21.         context.requestPathInfo().setResourcePath(RESOURCE_PATH);
  22.         context.requestPathInfo().setSelectorString(SELECTOR_STRING);
  24.         simpleFilter.doFilter(context.request(), context.response(), filterChain);
  26.         assertEquals("true", context.response().getHeader("filtered"));
  27.     }
  29. }

Mock

  1. public class MockFilterChain implements FilterChain {
  3.     @Override
  4.     public void doFilter(final ServletRequest request, final ServletResponse response) throws IOException, ServletException {
  5.         // do nothing
  6.     }
  8. }

一些简单的过滤器

  1. @Component(service = Filter.class)
  2. @SlingServletFilter(scope = SlingServletFilterScope.REQUEST)
  3. @ServiceRanking(-700)
  4. public class SimpleFilter implements Filter {
  6.     @Override
  7.     public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain filterChain) throws IOException, ServletException {
  8.         final SlingHttpServletRequest slingRequest = (SlingHttpServletRequest) request;
  9.         log.debug("request for {}, with selector {}", slingRequest.getRequestPathInfo().getResourcePath(),
  10.           slingRequest.getRequestPathInfo().getSelectorString());
  12.         final SlingHttpServletResponse slingResponse = (SlingHttpServletResponse) response;
  13.         slingResponse.setHeader("filtered", "true");
  14.         filterChain.doFilter(request, response);
  15.     }
  17.     @Override
  18.     public void init(FilterConfig filterConfig) {
  19.     }
  21.     @Override
  22.     public void destroy() {
  23.     }
  25. }
英文:

If you use AEM Mocks with Junit5, then it could look something like this.

  1. @ExtendWith(AemContextExtension.class)
  2. class SimpleFilterTest {
  4.     private static final AemContext context =  new AemContext(ResourceResolverType.RESOURCERESOLVER_MOCK);
  6.     private static final String RESOURCE_PATH = &quot;/content/test&quot;;
  7.     private static final String SELECTOR_STRING = &quot;selectors&quot;;
  9.     private static SimpleFilter simpleFilter;
  10.     private static FilterChain filterChain;
  12.     @BeforeAll
  13.     static void setup() {
  14.         simpleFilter = context.registerService(SimpleFilter.class, new SimpleFilter());
  15.         filterChain = context.registerService(FilterChain.class, new MockFilterChain());
  16.     }
  18.     @Test
  19.     @DisplayName(&quot;GIVEN the request, WHEN is executed, THEN request should be filtered and contain corresponding header&quot;)
  20.     void testDoFilter() throws ServletException, IOException {
  21.         context.requestPathInfo().setResourcePath(RESOURCE_PATH);
  22.         context.requestPathInfo().setSelectorString(SELECTOR_STRING);
  24.         simpleFilter.doFilter(context.request(), context.response(), filterChain);
  26.         assertEquals(&quot;true&quot;, context.response().getHeader(&quot;filtered&quot;));
  27.     }
  29. }

Mock

  1. public class MockFilterChain implements FilterChain {
  3.     @Override
  4.     public void doFilter(final ServletRequest request, final ServletResponse response) throws IOException, ServletException {
  5.         // do nothing
  6.     }
  8. }

Some simple filter

  1. @Component(service = Filter.class)
  2. @SlingServletFilter(scope = SlingServletFilterScope.REQUEST)
  3. @ServiceRanking(-700)
  4. public class SimpleFilter implements Filter {
  6.     @Override
  7.     public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain filterChain) throws IOException, ServletException {
  8.         final SlingHttpServletRequest slingRequest = (SlingHttpServletRequest) request;
  9.         log.debug(&quot;request for {}, with selector {}&quot;, slingRequest.getRequestPathInfo().getResourcePath(),
  10.           slingRequest.getRequestPathInfo().getSelectorString());
  12.         final SlingHttpServletResponse slingResponse = (SlingHttpServletResponse) response;
  13.         slingResponse.setHeader(&quot;filtered&quot;, &quot;true&quot;);
  14.         filterChain.doFilter(request, response);
  15.     }
  17.     @Override
  18.     public void init(FilterConfig filterConfig) {
  19.     }
  21.     @Override
  22.     public void destroy() {
  23.     }
  25. }

huangapple
  • 本文由 发表于 2020年9月2日 21:07:49
  • 转载请务必保留本文链接：https://go.coder-hub.com/63706202.html
  • aem
  • java
  • junit
  • junit4
  • mocking
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定