CheCacheDisablingFilterTest.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.filter;

import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.testng.MockitoTestNGListener;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
import org.testng.annotations.Test;

import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;

import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyLong;
import static org.mockito.Matchers.anyString;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
 * @author Max Shaposhnik (mshaposhnik@codenvy.com)
 */
@Listeners(value = {MockitoTestNGListener.class})
public class CheCacheDisablingFilterTest {

    @Mock
    private FilterChain chain;

    @Mock
    private HttpServletRequest request;

    @Mock
    private HttpServletResponse response;

    @InjectMocks
    private CheCacheDisablingFilter filter;

    @BeforeMethod
    public void init() throws Exception {
        filter.init(new MockFilterConfig());
    }


    @Test(dataProvider = "nonCachedPathProvider")
    public void shouldSetDisablingCacheHeaders(String uri) throws Exception {
        when(request.getRequestURI()).thenReturn(uri);

        //when
        filter.doFilter(request, response, chain);

        verify(response).setDateHeader(eq("Date"), anyLong());
        verify(response).setDateHeader(eq("Expires"), anyLong());
        verify(response).setHeader(eq("Cache-control"), eq("no-cache, no-store, must-revalidate"));
        verify(chain).doFilter(any(ServletRequest.class), any(ServletResponse.class));
    }

    @Test(dataProvider = "cachedPathProvider")
    public void shouldBypassDisablingCacheHeaders(String uri) throws Exception {
        when(request.getRequestURI()).thenReturn(uri);

        //when
        filter.doFilter(request, response, chain);

        verify(response, never()).setHeader(eq("Cache-control"), anyString());
        verify(chain).doFilter(any(ServletRequest.class), any(ServletResponse.class));
    }


    @DataProvider(name = "nonCachedPathProvider")
    public Object[][] nonCachedPathProvider() {
        return new Object[][]{{"/_app/browserNotSupported.js"},
                              {"/_app/_app.nocache.js"},
                              {"/other/_app/something.js"},
                              {"/other/something.nocache.js"}
        };
    }

    @DataProvider(name = "cachedPathProvider")
    public Object[][] cachedPathProvider() {
        return new Object[][]{{"/other/.something.js"},
                              {"/app/something.js"},
                              {"/something/something"}
        };
    }

    private class MockFilterConfig implements FilterConfig {
        private final Map<String, String> filterParams = new HashMap<>();

        MockFilterConfig() {
            this.filterParams.put("pattern1", "^.*\\.nocache\\..*$");
            this.filterParams.put("pattern2", "^.*/_app/.*$");
        }

        @Override
        public String getFilterName() {
            return this.getClass().getName();
        }

        @Override
        public ServletContext getServletContext() {
            throw new UnsupportedOperationException("The method does not supported in " + this.getClass());
        }

        @Override
        public String getInitParameter(String key) {
            return this.filterParams.get(key);
        }

        @Override
        public Enumeration<String> getInitParameterNames() {
               return Collections.enumeration(filterParams.keySet());
        }
    }
}