Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Propagate TestSecurityContextHolder to SecurityContextHolder
Create SecurityMockMvcResultHandlers to define security related MockMvc ResultHandlers Create a method to allow copying the SecurityContext from the TestSecurityContextHolder to SecurityContextHolder Closes gh-9565
- Loading branch information
1 parent
017c218
commit ab098f1
Showing
4 changed files
with
230 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
...org/springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlers.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* Copyright 2002-2021 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 | ||
* | ||
* https://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.test.web.servlet.response; | ||
|
||
import org.springframework.security.core.context.SecurityContext; | ||
import org.springframework.security.core.context.SecurityContextHolder; | ||
import org.springframework.security.test.context.TestSecurityContextHolder; | ||
import org.springframework.test.web.servlet.MockMvc; | ||
import org.springframework.test.web.servlet.MvcResult; | ||
import org.springframework.test.web.servlet.ResultHandler; | ||
|
||
/** | ||
* Security related {@link MockMvc} {@link ResultHandler}s | ||
* | ||
* @author Marcus da Coregio | ||
* @since 5.6 | ||
*/ | ||
public final class SecurityMockMvcResultHandlers { | ||
|
||
private SecurityMockMvcResultHandlers() { | ||
} | ||
|
||
/** | ||
* Exports the {@link SecurityContext} from {@link TestSecurityContextHolder} to | ||
* {@link SecurityContextHolder} | ||
*/ | ||
public static ResultHandler exportTestSecurityContext() { | ||
return new ExportTestSecurityContextHandler(); | ||
} | ||
|
||
/** | ||
* A {@link ResultHandler} that copies the {@link SecurityContext} from | ||
* {@link TestSecurityContextHolder} to {@link SecurityContextHolder} | ||
* | ||
* @author Marcus da Coregio | ||
* @since 5.6 | ||
*/ | ||
private static class ExportTestSecurityContextHandler implements ResultHandler { | ||
|
||
@Override | ||
public void handle(MvcResult result) { | ||
SecurityContextHolder.setContext(TestSecurityContextHolder.getContext()); | ||
} | ||
|
||
} | ||
|
||
} |
106 changes: 106 additions & 0 deletions
106
...springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlersTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
/* | ||
* Copyright 2002-2021 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 | ||
* | ||
* https://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.test.web.servlet.response; | ||
|
||
import org.junit.jupiter.api.AfterEach; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.ExtendWith; | ||
|
||
import org.springframework.beans.factory.annotation.Autowired; | ||
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; | ||
import org.springframework.security.core.Authentication; | ||
import org.springframework.security.core.context.SecurityContextHolder; | ||
import org.springframework.security.test.context.support.WithMockUser; | ||
import org.springframework.test.context.ContextConfiguration; | ||
import org.springframework.test.context.junit.jupiter.SpringExtension; | ||
import org.springframework.test.context.web.WebAppConfiguration; | ||
import org.springframework.test.web.servlet.MockMvc; | ||
import org.springframework.test.web.servlet.setup.MockMvcBuilders; | ||
import org.springframework.web.bind.annotation.RequestMapping; | ||
import org.springframework.web.bind.annotation.RestController; | ||
import org.springframework.web.context.WebApplicationContext; | ||
import org.springframework.web.servlet.config.annotation.EnableWebMvc; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.springframework.security.test.web.servlet.response.SecurityMockMvcResultHandlers.exportTestSecurityContext; | ||
import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity; | ||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; | ||
|
||
@ExtendWith(SpringExtension.class) | ||
@ContextConfiguration(classes = SecurityMockMvcResultHandlersTest.Config.class) | ||
@WebAppConfiguration | ||
public class SecurityMockMvcResultHandlersTest { | ||
|
||
@Autowired | ||
private WebApplicationContext context; | ||
|
||
private MockMvc mockMvc; | ||
|
||
@BeforeEach | ||
public void setup() { | ||
// @formatter:off | ||
this.mockMvc = MockMvcBuilders | ||
.webAppContextSetup(this.context) | ||
.apply(springSecurity()) | ||
.build(); | ||
// @formatter:on | ||
} | ||
|
||
@AfterEach | ||
public void tearDown() { | ||
SecurityContextHolder.clearContext(); | ||
} | ||
|
||
@Test | ||
@WithMockUser | ||
public void withTestSecurityContextCopiedToSecurityContextHolder() throws Exception { | ||
this.mockMvc.perform(get("/")).andDo(exportTestSecurityContext()); | ||
|
||
Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); | ||
|
||
assertThat(authentication.getName()).isEqualTo("user"); | ||
assertThat(authentication.getAuthorities()).hasSize(1).first().hasToString("ROLE_USER"); | ||
} | ||
|
||
@Test | ||
@WithMockUser | ||
public void withTestSecurityContextNotCopiedToSecurityContextHolder() throws Exception { | ||
this.mockMvc.perform(get("/")); | ||
|
||
Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); | ||
|
||
assertThat(authentication).isNull(); | ||
} | ||
|
||
@EnableWebSecurity | ||
@EnableWebMvc | ||
static class Config { | ||
|
||
@RestController | ||
static class Controller { | ||
|
||
@RequestMapping("/") | ||
String ok() { | ||
return "ok"; | ||
} | ||
|
||
} | ||
|
||
} | ||
|
||
} |