001/* 002 * Copyright 2002-2017 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.test.web.servlet.setup; 018 019import javax.servlet.http.HttpSession; 020 021import org.springframework.lang.Nullable; 022import org.springframework.test.web.servlet.request.RequestPostProcessor; 023import org.springframework.web.context.WebApplicationContext; 024 025/** 026 * {@link MockMvcConfigurer} that stores and re-uses the HTTP session across 027 * multiple requests performed through the same {@code MockMvc} instance. 028 * 029 * <p>Example use: 030 * <pre class="code"> 031 * import static org.springframework.test.web.servlet.setup.SharedHttpSessionConfigurer.sharedHttpSession; 032 * 033 * // ... 034 * 035 * MockMvc mockMvc = MockMvcBuilders.standaloneSetup(new TestController()) 036 * .apply(sharedHttpSession()) 037 * .build(); 038 * 039 * // Use mockMvc to perform requests ... 040 * </pre> 041 * 042 * @author Rossen Stoyanchev 043 * @since 5.0 044 */ 045public class SharedHttpSessionConfigurer implements MockMvcConfigurer { 046 047 @Nullable 048 private HttpSession session; 049 050 051 @Override 052 public void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder) { 053 builder.alwaysDo(result -> this.session = result.getRequest().getSession(false)); 054 } 055 056 @Override 057 public RequestPostProcessor beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, 058 WebApplicationContext context) { 059 060 return request -> { 061 if (this.session != null) { 062 request.setSession(this.session); 063 } 064 return request; 065 }; 066 } 067 068 public static SharedHttpSessionConfigurer sharedHttpSession() { 069 return new SharedHttpSessionConfigurer(); 070 } 071 072}