我使用的是Spring Boot 1.4.2,我是Spring Boot的新手。我有一个身份验证过滤器,用于在用户登录时设置当前用户信息。在给控制器的一条建议中,我打电话获取当前用户ID,如下所示:
public static String getCurrentUserToken(){
return ((AuthenticatedUser) SecurityContextHolder.getContext().getAuthentication().getPrincipal()).getUserId();
}
这是我的自定义AuthenticatedUser:
public class AuthenticatedUser implements Serializable {
private final String userName;
private final String userId;
private final String sessionId;
public AuthenticatedUser(String userName, String userId, String sessionId) {
super();
this.userName = userName;
this.userId = userId;
this.sessionId = sessionId;
}
public String getUserName() {
return userName;
}
public String getUserId() {
return userId;
}
public String getSessionId() {
return sessionId;
}
}
一切都很好。然而,过滤器在集成测试中不起作用,我需要模拟当前用户。我搜索了很多关于如何嘲笑用户的信息,但都没有帮助我。我终于找到了这个指南,它可能接近我想要的:https://aggarwalarpit.wordpress.com/2017/05/17/mocking-spring-security-context-for-unit-testing/以下是我遵循该指南的测试课程:
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT)
public class PersonalLoanPreApprovalTest {
@Before
public void initDB() throws Exception {
MockitoAnnotations.initMocks(this);
}
@Test
public void testRequestPersonalLoanPreApproval_Me() {
AuthenticatedUser applicationUser = new
AuthenticatedUser("test@abc.com", "2d1b5ae3", "123");
UsernamePasswordAuthenticationToken authentication = new ApiKeyAuthentication(applicationUser);
SecurityContext securityContext = mock(SecurityContext.class);
when(securityContext.getAuthentication()).thenReturn(authentication);
SecurityContextHolder.setContext(securityContext);
// error at this line
when(securityContext.getAuthentication().getPrincipal()) .thenReturn(applicationUser);
// The controller for this api has the advice to get the userId
MyResponse response = restTemplate.getForObject(url.toString(), MyResponse.class);
}
}
我得到了这个错误:
org.mockito.exceptions.misusing.WrongTypeOfReturnValue:
AuthenticatedUser cannot be returned by getAuthentication()
getAuthentication() should return Authentication
我已经为此花了几天时间,尝试了很多建议,但仍然失败了。我还试图删除导致错误的行,但当错误消失时,我仍然无法在控制器建议中获得当前用户信息。
任何建议都将不胜感激。
UPDATE1:只是想在代码中进行一些修改后得到我的结果。
在@glitch的建议下,我更改了代码,以模拟我的测试方法中的身份验证和用户,如下所示:
@Test
public void testRequestPersonalLoanPreApproval_Me() {
AuthenticatedUser applicationUser = new AuthenticatedUser("testtu_free@cs.com", "2d1b5ae3-cf04-44f5-9493-f0518cab4554", "123");
Authentication authentication = Mockito.mock(Authentication.class);
SecurityContext securityContext = Mockito.mock(SecurityContext.class);
Mockito.when(securityContext.getAuthentication()).thenReturn(authentication);
SecurityContextHolder.setContext(securityContext);
Mockito.when(authentication.getPrincipal()).thenReturn(applicationUser);
// The controller for this api has the advice to get the userId
MyResponse response = restTemplate.getForObject(url.toString(), MyResponse.class);
}
}
我现在可以消除测试类中的错误了。我调试到代码中,当我在测试类中时,看到securityContext有值。但当我跳到控制器建议中的代码时,下面的get返回null:
SecurityContextHolder.getContext().getAuthentication().getPrincipal()
有一个Spring测试注释(org.springframework.security.test.context.support.WithMockUser
)可以为您完成这项工作。。。
@Test
@WithMockUser(username = "myUser", roles = { "myAuthority" })
public void aTest(){
// any usage of `Authentication` in this test invocation will get an instance with the user name "myUser" and a granted authority "myAuthority"
// ...
}
或者,您可以通过模仿Spring的Authentication
来继续使用当前的方法。例如,在您的测试用例中:
Authentication authentication = Mockito.mock(Authentication.class);
然后告诉Spring的SecurityContextHolder
存储这个Authentication
实例:
SecurityContext securityContext = Mockito.mock(SecurityContext.class);
Mockito.when(securityContext.getAuthentication()).thenReturn(auth);
SecurityContextHolder.setContext(securityContext);
现在,如果您的代码需要Authentication
返回一些东西(可能是用户名),您只需以通常的方式对模拟的Authentication
实例设置一些期望值,例如
Mockito.when(authentication.getName()).thenReturn("aName");
这与你已经在做的非常接近,但你只是嘲笑了错误的类型。
更新1:以响应对OP:的此更新
我现在可以消除测试类中的错误了。我调试到代码中,当我在测试类中时,看到securityContext有值。但当我跳到控制器建议中的代码时,下面的get返回null:
SecurityContextHolder.getContext().getAuthentication().getPrincipal()
您只需要在模拟的Authentication
上设置一个期望值,例如:
UsernamePasswordAuthenticationToken principal = new UsernamePasswordAuthenticationToken("aUserName", "aPassword");
Mockito.when(authentication.getPrincipal()).thenReturn(principal);
有了上面的代码,这一行。。。
SecurityContextHolder.getContext().getAuthentication().getPrincipal();
将返回该CCD_ 9。
既然您使用自定义类型(ApiKeyAuthentication
,我认为?),那么您应该让authentication.getPrincipal()
返回该类型,而不是UsernamePasswordAuthenticationToken
。
除了glytching的答案,我在嘲笑时还添加了以下行:
SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_GLOBAL);
这是因为spring启动测试代码与您正在测试的spring启动应用程序不在同一个线程中运行,并且默认策略是ThreadLocal。使用MODE_GLOBAL可以确保在应用程序中实际返回模拟的SecurityContext对象。