Running a Test as a User in Spring MVC Test

通常需要以特定用户身份运行测试。有两种简单的方法填充用户：

Running as a User in Spring MVC Test with RequestPostProcessor

您有许多选项可用于将用户与当前 HttpServletRequest 关联起来。以下示例以一个用户（无需存在）的身份运行，该用户的用户名为 user、密码为 password、角色为 ROLE_USER：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(user("user")))
mvc.get("/") {
    with(user("user"))
}

该支持通过将用户与 HttpServletRequest 关联起来而起作用。要将请求与 SecurityContextHolder 关联起来，您需要确保 SecurityContextPersistenceFilter 与 MockMvc 实例关联起来。您可以通过许多方式这样做：

  • Invoking apply(springSecurity())

  • 将 Spring Security 的 FilterChainProxy 添加到 MockMvc 中

  • 当使用 MockMvcBuilders.standaloneSetup 时，手动将 SecurityContextPersistenceFilter 添加到 MockMvc 实例可能是有意义的

您可以轻松进行定制。例如，以下项将以一个用户（无需存在）的身份运行，该用户的用户名为“admin”、密码为“pass”，角色为“ROLE_USER”和“ROLE_ADMIN”。

  • Java

  • Kotlin

mvc
	.perform(get("/admin").with(user("admin").password("pass").roles("USER","ADMIN")))
mvc.get("/admin") {
    with(user("admin").password("pass").roles("USER","ADMIN"))
}

如果您有自定义的 UserDetails 想要使用，则也可以轻松指定。例如，以下项将使用指定的 UserDetails（无需存在）来使用具有指定 UserDetails 主体的 UsernamePasswordAuthenticationToken 运行：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(user(userDetails)))
mvc.get("/") {
    with(user(userDetails))
}

您可以使用以下项以匿名用户身份运行：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(anonymous()))
mvc.get("/") {
    with(anonymous())
}

如果您使用默认用户运行并且希望作为匿名用户处理一些请求，这将特别有用。

如果您想要一个自定义的 Authentication（无需存在），则可以使用以下内容：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(authentication(authentication)))
mvc.get("/") {
    with(authentication(authentication))
}

您甚至可以使用以下项自定义 SecurityContext：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(securityContext(securityContext)))
mvc.get("/") {
    with(securityContext(securityContext))
}

我们还可以确保使用 MockMvcBuilders 的默认请求针对每个请求运行为特定用户。例如，以下将作为用户名为“admin”、密码为“password”和角色为“ROLE_ADMIN”的用户（无需存在）运行：

  • Java

  • Kotlin

mvc = MockMvcBuilders
		.webAppContextSetup(context)
		.defaultRequest(get("/").with(user("user").roles("ADMIN")))
		.apply(springSecurity())
		.build();
mvc = MockMvcBuilders
    .webAppContextSetup(context)
    .defaultRequest<DefaultMockMvcBuilder>(get("/").with(user("user").roles("ADMIN")))
    .apply<DefaultMockMvcBuilder>(springSecurity())
    .build()

如果您发现正在许多测试中使用同一个用户，建议将用户移至方法。例如，您可以在名为 CustomSecurityMockMvcRequestPostProcessors 的自定义类中指定以下内容：

  • Java

  • Kotlin

public static RequestPostProcessor rob() {
	return user("rob").roles("ADMIN");
}
fun rob(): RequestPostProcessor {
    return user("rob").roles("ADMIN")
}

现在，您可以在 CustomSecurityMockMvcRequestPostProcessors 上执行静态导入，并在测试中使用它：

  • Java

  • Kotlin

import static sample.CustomSecurityMockMvcRequestPostProcessors.*;

...

mvc
	.perform(get("/").with(rob()))
import sample.CustomSecurityMockMvcRequestPostProcessors.*

//...

mvc.get("/") {
    with(rob())
}

Running as a User in Spring MVC Test with Annotations

作为使用 RequestPostProcessor 创建用户的替代方法，可以使用 Testing Method Security 中描述的注释。例如，使用用户名“user”、密码“password”和角色“ROLE_USER”的用户运行该测试的代码：

  • Java

  • Kotlin

@Test
@WithMockUser
public void requestProtectedUrlWithUser() throws Exception {
mvc
		.perform(get("/"))
		...
}
@Test
@WithMockUser
fun requestProtectedUrlWithUser() {
    mvc
        .get("/")
        // ...
}

或者，以下将使用用户名“user”、密码“password”和角色“ROLE_ADMIN”的用户运行测试：

  • Java

  • Kotlin

@Test
@WithMockUser(roles="ADMIN")
public void requestProtectedUrlWithUser() throws Exception {
mvc
		.perform(get("/"))
		...
}
@Test
@WithMockUser(roles = ["ADMIN"])
fun requestProtectedUrlWithUser() {
    mvc
        .get("/")
        // ...
}