Question

我使用的是Spring Boot 1.4.2，我是Spring Boot的新手。我有一个验证过滤器，用于在用户登录时设置当前用户信息。在对控制器的建议中，我调用了当前的userId，如下所示：

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()

Answer 1

有一个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();

...将返回UsernamePasswordAuthenticationToken。

由于您使用的是自定义类型（ApiKeyAuthentication，我认为？），您应该让authentication.getPrincipal()返回该类型而不是UsernamePasswordAuthenticationToken。

Answer 2

除了 glytching 的答案之外，我还必须在模拟时添加以下行：

SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_GLOBAL);

那是因为spring boot测试代码和你测试的spring boot应用不在同一个线程中运行，默认策略是ThreadLocal。使用 MODE_GLOBAL，您可以确保在您的应用程序中实际返回模拟的 SecurityContext 对象。

具有自定义用户的SpringBootTest模拟身份验证主体不起作用

2 个答案: