Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

"sharedHttpSession" shortcut for MockMvc builders

Browse Source 
Issue: SPR-13820
This commit is contained in:
Rossen Stoyanchev
2017-01-25 12:32:07 -05:00
parent 1d35c7c55a
commit f5d2b88e3f
4 changed files with 227 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
spring-test/src/main/java/org/springframework/test/web/servlet/setup/ConfigurableMockMvcBuilder.java
View File

@@ -122,6 +122,13 @@ public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder
/**
* Add a {@code MockMvcConfigurer} that automates MockMvc setup and
* configures it for some specific purpose (e.g. security).
*
* <p>There is a built-in {@link SharedHttpSessionConfigurer} that can be
* used to re-use the HTTP session across requests. 3rd party frameworks
* like Spring Security also use this mechanism to provide configuration
* shortcuts.
*
* @see SharedHttpSessionConfigurer
*/
<T extends B> T apply(MockMvcConfigurer configurer);

69
spring-test/src/main/java/org/springframework/test/web/servlet/setup/SharedHttpSessionConfigurer.java Normal file
View File

@@ -0,0 +1,69 @@
/*
* Copyright 2002-2017 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.test.web.servlet.setup;
import javax.servlet.http.HttpSession;
import org.springframework.test.web.servlet.request.RequestPostProcessor;
import org.springframework.web.context.WebApplicationContext;
/**
* {@link MockMvcConfigurer} that stores and re-uses the HTTP session across
* multiple requests performed through the same {@code MockMvc} instance.
*
* <p>Example use:
* <pre class="code">
* import static org.springframework.test.web.servlet.setup.SharedHttpSessionConfigurer.sharedHttpSession;
*
* // ...
*
* MockMvc mockMvc = MockMvcBuilders.standaloneSetup(new TestController())
* .apply(sharedHttpSession())
* .build();
*
* // Use mockMvc to perform requests ...
* </pre>
*
* @author Rossen Stoyanchev
* @since 5.0
*/
public class SharedHttpSessionConfigurer implements MockMvcConfigurer {
private HttpSession session;
@Override
public void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder) {
builder.alwaysDo(result -> this.session = result.getRequest().getSession(false));
}
@Override
public RequestPostProcessor beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
WebApplicationContext context) {
return request -> {
if (this.session != null) {
request.setSession(this.session);
}
return request;
};
}
public static SharedHttpSessionConfigurer sharedHttpSession() {
return new SharedHttpSessionConfigurer();
}
}

108
spring-test/src/test/java/org/springframework/test/web/servlet/setup/SharedHttpSessionTests.java Normal file
View File

@@ -0,0 +1,108 @@
/*
* Copyright 2002-2017 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.test.web.servlet.setup;
import javax.servlet.http.HttpSession;
import org.junit.Test;
import org.springframework.stereotype.Controller;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.web.bind.annotation.GetMapping;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.setup.SharedHttpSessionConfigurer.sharedHttpSession;
/**
* Tests for {@link SharedHttpSessionConfigurer}.
* @author Rossen Stoyanchev
*/
public class SharedHttpSessionTests {
@Test
public void httpSession() throws Exception {
MockMvc mockMvc = MockMvcBuilders.standaloneSetup(new TestController())
.apply(sharedHttpSession())
.build();
String url = "/session";
MvcResult result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
HttpSession session = result.getRequest().getSession(false);
assertNotNull(session);
assertEquals(1, session.getAttribute("counter"));
result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
session = result.getRequest().getSession(false);
assertNotNull(session);
assertEquals(2, session.getAttribute("counter"));
result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
session = result.getRequest().getSession(false);
assertNotNull(session);
assertEquals(3, session.getAttribute("counter"));
}
@Test
public void noHttpSession() throws Exception {
MockMvc mockMvc = MockMvcBuilders.standaloneSetup(new TestController())
.apply(sharedHttpSession())
.build();
String url = "/no-session";
MvcResult result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
HttpSession session = result.getRequest().getSession(false);
assertNull(session);
result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
session = result.getRequest().getSession(false);
assertNull(session);
url = "/session";
result = mockMvc.perform(get(url)).andExpect(status().isOk()).andReturn();
session = result.getRequest().getSession(false);
assertNotNull(session);
assertEquals(1, session.getAttribute("counter"));
}
@Controller
private static class TestController {
@GetMapping("/session")
public String handle(HttpSession session) {
Integer counter = (Integer) session.getAttribute("counter");
session.setAttribute("counter", (counter != null ? counter + 1 : 1));
return "view";
}
@GetMapping("/no-session")
public String handle() {
return "view";
}
}
}