WebAsyncManagerIntegrationFilterTests.java

/*
 * Copyright 2002-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.security.web.context.request.async;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.when;

import java.util.concurrent.Callable;
import java.util.concurrent.ThreadFactory;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.springframework.core.task.SimpleAsyncTaskExecutor;
import org.springframework.mock.web.MockFilterChain;
import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.context.request.async.AsyncWebRequest;
import org.springframework.web.context.request.async.CallableProcessingInterceptorAdapter;
import org.springframework.web.context.request.async.WebAsyncManager;
import org.springframework.web.context.request.async.WebAsyncUtils;

/**
 *
 * @author Rob Winch
 *
 */
@RunWith(MockitoJUnitRunner.class)
public class WebAsyncManagerIntegrationFilterTests {
	@Mock
	private SecurityContext securityContext;
	@Mock
	private HttpServletRequest request;
	@Mock
	private HttpServletResponse response;
	@Mock
	private AsyncWebRequest asyncWebRequest;
	private WebAsyncManager asyncManager;
	private JoinableThreadFactory threadFactory;

	private MockFilterChain filterChain;

	private WebAsyncManagerIntegrationFilter filter;

	@Before
	public void setUp() {
		when(asyncWebRequest.getNativeRequest(HttpServletRequest.class)).thenReturn(
				request);
		when(request.getRequestURI()).thenReturn("/");
		filterChain = new MockFilterChain();

		threadFactory = new JoinableThreadFactory();
		SimpleAsyncTaskExecutor executor = new SimpleAsyncTaskExecutor();
		executor.setThreadFactory(threadFactory);

		asyncManager = WebAsyncUtils.getAsyncManager(request);
		asyncManager.setAsyncWebRequest(asyncWebRequest);
		asyncManager.setTaskExecutor(executor);
		when(request.getAttribute(WebAsyncUtils.WEB_ASYNC_MANAGER_ATTRIBUTE)).thenReturn(
				asyncManager);

		filter = new WebAsyncManagerIntegrationFilter();
	}

	@After
	public void clearSecurityContext() {
		SecurityContextHolder.clearContext();
	}

	@Test
	public void doFilterInternalRegistersSecurityContextCallableProcessor()
			throws Exception {
		SecurityContextHolder.setContext(securityContext);
		asyncManager
				.registerCallableInterceptors(new CallableProcessingInterceptorAdapter() {
					@Override
					public <T> void postProcess(NativeWebRequest request,
							Callable<T> task, Object concurrentResult) throws Exception {
						assertThat(SecurityContextHolder.getContext()).isNotSameAs(
								securityContext);
					}
				});
		filter.doFilterInternal(request, response, filterChain);

		VerifyingCallable verifyingCallable = new VerifyingCallable();
		asyncManager.startCallableProcessing(verifyingCallable);
		threadFactory.join();
		assertThat(asyncManager.getConcurrentResult()).isSameAs(securityContext);
	}

	@Test
	public void doFilterInternalRegistersSecurityContextCallableProcessorContextUpdated()
			throws Exception {
		SecurityContextHolder.setContext(SecurityContextHolder.createEmptyContext());
		asyncManager
				.registerCallableInterceptors(new CallableProcessingInterceptorAdapter() {
					@Override
					public <T> void postProcess(NativeWebRequest request,
							Callable<T> task, Object concurrentResult) throws Exception {
						assertThat(SecurityContextHolder.getContext()).isNotSameAs(
								securityContext);
					}
				});
		filter.doFilterInternal(request, response, filterChain);
		SecurityContextHolder.setContext(securityContext);

		VerifyingCallable verifyingCallable = new VerifyingCallable();
		asyncManager.startCallableProcessing(verifyingCallable);
		threadFactory.join();
		assertThat(asyncManager.getConcurrentResult()).isSameAs(securityContext);
	}

	private static final class JoinableThreadFactory implements ThreadFactory {
		private Thread t;

		public Thread newThread(Runnable r) {
			t = new Thread(r);
			return t;
		}

		public void join() throws InterruptedException {
			t.join();
		}
	}

	private class VerifyingCallable implements Callable<SecurityContext> {

		public SecurityContext call() throws Exception {
			return SecurityContextHolder.getContext();
		}

	}
}