GwtCachingFilterTest.java example

Explorer
ovirt-engine-master
package org.ovirt.engine.ui.frontend.server.gwt;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.io.IOException;
import java.util.Calendar;
import java.util.Locale;
import java.util.TimeZone;

import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

@RunWith(MockitoJUnitRunner.class)
public class GwtCachingFilterTest {
    private static final String GMT = "GMT"; //$NON-NLS-1$

    @Mock
    private HttpServletRequest mockRequest;

    @Mock
    private HttpServletResponse mockResponse;

    @Mock
    private FilterChain mockChain;

    @Mock
    private FilterConfig mockConfig;

    @Captor
    private ArgumentCaptor<HttpServletResponse> responseCaptor;

    private GwtCachingFilter testFilter;

    @Before
    public void setUp() throws Exception {
        testFilter = new GwtCachingFilter();
        when(mockConfig.getInitParameter(GwtCachingFilter.CACHE_INIT_PARAM)).thenReturn(".*\\.cache\\..*"); //$NON-NLS-1$
        when(mockConfig.getInitParameter(GwtCachingFilter.NO_CACHE_INIT_PARAM)).thenReturn(".*\\.nocache\\..*"); //$NON-NLS-1$
        when(mockConfig.getInitParameter(GwtCachingFilter.NO_STORE_INIT_PARAM)).thenReturn(".*RPCService.*"); //$NON-NLS-1$
        testFilter.init(mockConfig);
    }

    @Test
    public void testDoFilter_NoMatch() throws IOException, ServletException {
        when(mockRequest.getRequestURI()).thenReturn(""); //$NON-NLS-1$
        testFilter.doFilter(mockRequest, mockResponse, mockChain);
        verify(mockChain).doFilter(mockRequest, mockResponse);
        verify(mockResponse, never()).setHeader(eq(GwtCachingFilter.EXPIRES_HEADER), anyString());
        verify(mockResponse, never()).setHeader(eq(GwtCachingFilter.CACHE_CONTROL_HEADER), anyString());
        verify(mockResponse, never()).setHeader(eq(GwtCachingFilter.PRAGMA_HEADER), anyString());
        verify(mockChain).doFilter(eq(mockRequest), responseCaptor.capture());
        assertFalse(responseCaptor.getValue() instanceof HttpServletResponseWrapper);
    }

    @Test
    public void testDoFilter_CacheMatch() throws IOException, ServletException {
        when(mockRequest.getRequestURI()).thenReturn("something.cache.js"); //$NON-NLS-1$
        testFilter.doFilter(mockRequest, mockResponse, mockChain);
        verify(mockResponse).setHeader(eq(GwtCachingFilter.EXPIRES_HEADER), anyString());
        verify(mockResponse).setHeader(eq(GwtCachingFilter.CACHE_CONTROL_HEADER), eq(GwtCachingFilter.CACHE_YEAR));
        verify(mockResponse).setHeader(eq(GwtCachingFilter.PRAGMA_HEADER), eq(GwtCachingFilter.EMPTY_STRING));
        verify(mockChain).doFilter(eq(mockRequest), responseCaptor.capture());
        assertTrue(responseCaptor.getValue() instanceof HttpServletResponseWrapper);
        HttpServletResponse responseWrapper = responseCaptor.getValue();
        responseWrapper.setHeader(GwtCachingFilter.ETAG_HEADER, "test"); //$NON-NLS-1$
        responseWrapper.setHeader(GwtCachingFilter.LAST_MODIFIED_HEADER, "test"); //$NON-NLS-1$
        verify(mockResponse).setHeader(eq(GwtCachingFilter.ETAG_HEADER), anyString());
        verify(mockResponse).setHeader(eq(GwtCachingFilter.LAST_MODIFIED_HEADER), anyString());
    }

    @Test
    public void testDoFilter_NoCacheMatch() throws IOException, ServletException {
        when(mockRequest.getRequestURI()).thenReturn("something.nocache.js"); //$NON-NLS-1$
        testFilter.doFilter(mockRequest, mockResponse, mockChain);
        verify(mockResponse).setHeader(eq(GwtCachingFilter.EXPIRES_HEADER), anyString());
        verify(mockResponse).setHeader(eq(GwtCachingFilter.CACHE_CONTROL_HEADER), eq(GwtCachingFilter.NO_CACHE));
        verify(mockResponse).setHeader(eq(GwtCachingFilter.PRAGMA_HEADER), eq(GwtCachingFilter.NO_CACHE));
        verify(mockChain).doFilter(eq(mockRequest), responseCaptor.capture());
        assertTrue(responseCaptor.getValue() instanceof HttpServletResponseWrapper);
        HttpServletResponse responseWrapper = responseCaptor.getValue();
        responseWrapper.setHeader(GwtCachingFilter.ETAG_HEADER, "test"); //$NON-NLS-1$
        responseWrapper.setHeader(GwtCachingFilter.LAST_MODIFIED_HEADER, "test"); //$NON-NLS-1$
        verify(mockResponse).setHeader(eq(GwtCachingFilter.ETAG_HEADER), anyString());
        verify(mockResponse).setHeader(eq(GwtCachingFilter.LAST_MODIFIED_HEADER), anyString());
    }

    @Test
    public void testDoFilter_NoStoreMatch() throws IOException, ServletException {
        when(mockRequest.getRequestURI()).thenReturn("RPCService"); //$NON-NLS-1$
        testFilter.doFilter(mockRequest, mockResponse, mockChain);
        verify(mockResponse).setHeader(eq(GwtCachingFilter.EXPIRES_HEADER), anyString());
        verify(mockResponse).setHeader(eq(GwtCachingFilter.CACHE_CONTROL_HEADER), eq(GwtCachingFilter.NO_STORE));
        verify(mockResponse).setHeader(eq(GwtCachingFilter.PRAGMA_HEADER), eq(GwtCachingFilter.NO_CACHE));
        verify(mockChain).doFilter(eq(mockRequest), responseCaptor.capture());
        assertTrue(responseCaptor.getValue() instanceof HttpServletResponseWrapper);
        HttpServletResponse responseWrapper = responseCaptor.getValue();
        responseWrapper.setHeader(GwtCachingFilter.ETAG_HEADER, "test"); //$NON-NLS-1$
        responseWrapper.setHeader(GwtCachingFilter.LAST_MODIFIED_HEADER, "test"); //$NON-NLS-1$
        verify(mockResponse, never()).setHeader(eq(GwtCachingFilter.ETAG_HEADER), anyString());
        verify(mockResponse, never()).setHeader(eq(GwtCachingFilter.LAST_MODIFIED_HEADER), anyString());

    }

    @Test
    public void testCacheFilterPatternMatches_PositiveMatch() {
        when(mockRequest.getRequestURI()).thenReturn("something.cache.js"); //$NON-NLS-1$
        assertTrue(testFilter.cacheFilterPatternMatches(mockRequest));
    }

    @Test
    public void testCacheFilterPatternMatches_NegativeMatch() {
        when(mockRequest.getRequestURI()).thenReturn("something.nocache.js"); //$NON-NLS-1$
        assertFalse(testFilter.cacheFilterPatternMatches(mockRequest));
    }

    @Test
    public void testNoCacheFilterPatternMatches_PositiveMatch() {
        when(mockRequest.getRequestURI()).thenReturn("something.nocache.js"); //$NON-NLS-1$
        assertTrue(testFilter.noCacheFilterPatternMatches(mockRequest));
    }

    @Test
    public void testNoCacheFilterPatternMatches_NegativeMatch() {
        when(mockRequest.getRequestURI()).thenReturn("something.cache.js"); //$NON-NLS-1$
        assertFalse(testFilter.noCacheFilterPatternMatches(mockRequest));
    }

    @Test
    public void testNoStoreFilterPatternMatches_PositiveMatch() {
        when(mockRequest.getRequestURI()).thenReturn("RPCService"); //$NON-NLS-1$
        assertTrue(testFilter.noStoreFilterPatternMatches(mockRequest));
    }

    @Test
    public void testNoStoreFilterPatternMatches_NegativeMatch() {
        when(mockRequest.getRequestURI()).thenReturn("OtherService"); //$NON-NLS-1$
        assertFalse(testFilter.noStoreFilterPatternMatches(mockRequest));
    }

    @Test
    public void testGetNowPlusYearHttpDate() {
        Calendar calendar = spy(Calendar.getInstance(TimeZone.getTimeZone(GMT), Locale.US));
        calendar.clear();
        calendar.set(2000, 0, 1, 15, 0);
        String result = testFilter.getNowPlusYearHttpDate(calendar);
        assertNotNull(result);
        //We know this should be 01 Jan 2001 15:00:00 as the code generates
        //dates in GMT
        assertTrue(result.contains("01 Jan 2001 15:00:00")); //$NON-NLS-1$
        verify(calendar).add(Calendar.YEAR, 1);
    }

    @Test
    public void testGetYesterdayHttpDate() {
        Calendar calendar = spy(Calendar.getInstance(TimeZone.getTimeZone(GMT), Locale.US));
        calendar.clear();
        calendar.set(2000, 0, 5, 15, 0);
        String result = testFilter.getYesterdayHttpDate(calendar);
        assertNotNull(result);
        //We know this should be 04 Jan 2001 15:00:00 as the code generates
        //dates in GMT
        assertTrue(result.contains("04 Jan 2000 15:00:00")); //$NON-NLS-1$
        verify(calendar).add(Calendar.DAY_OF_MONTH, -1);
    }

}