测试方法安全

本节演示如何使用 Spring Security 的测试支持来测试基于方法的安全。我们首先介绍一个 MessageService，它要求用户经过身份验证才能访问它

Java
Kotlin

public class HelloMessageService implements MessageService {

	@PreAuthorize("authenticated")
	public String getMessage() {
		Authentication authentication = SecurityContextHolder.getContext()
			.getAuthentication();
		return "Hello " + authentication;
	}
}

class HelloMessageService : MessageService {
    @PreAuthorize("authenticated")
    fun getMessage(): String {
        val authentication: Authentication = SecurityContextHolder.getContext().authentication
        return "Hello $authentication"
    }
}

getMessage 的结果是一个 String，它向当前 Spring Security Authentication 说“Hello”。以下清单显示了示例输出

Hello org.springframework.security.authentication.UsernamePasswordAuthenticationToken@ca25360: Principal: org.springframework.security.core.userdetails.User@36ebcb: Username: user; Password: [PROTECTED]; Enabled: true; AccountNonExpired: true; credentialsNonExpired: true; AccountNonLocked: true; Granted Authorities: ROLE_USER; Credentials: [PROTECTED]; Authenticated: true; Details: null; Granted Authorities: ROLE_USER

安全测试设置

在我们使用 Spring Security 测试支持之前，我们必须执行一些设置

Java
Kotlin

@ExtendWith(SpringExtension.class) (1)
@ContextConfiguration (2)
public class WithMockUserTests {
	// ...
}

@ExtendWith(SpringExtension.class)
@ContextConfiguration
class WithMockUserTests {
    // ...
}

1	`@ExtendWith` 指示 spring-test 模块它应该创建一个 `ApplicationContext`。有关更多信息，请参阅 Spring 参考。
2	`@ContextConfiguration` 指示 spring-test 用于创建 `ApplicationContext` 的配置。由于没有指定配置，因此将尝试默认配置位置。这与使用现有的 Spring Test 支持没有什么不同。有关更多信息，请参阅 Spring 参考。

Spring Security 通过 WithSecurityContextTestExecutionListener 连接到 Spring Test 支持，它确保我们的测试以正确的用户运行。它通过在运行我们的测试之前填充 SecurityContextHolder 来做到这一点。如果您使用反应式方法安全，您还需要 ReactorContextTestExecutionListener，它填充 ReactiveSecurityContextHolder。测试完成后，它会清除 SecurityContextHolder。如果您只需要 Spring Security 相关的支持，您可以用 @SecurityTestExecutionListeners 替换 @ContextConfiguration。

请记住，我们在 HelloMessageService 中添加了 @PreAuthorize 注解，因此它需要经过身份验证的用户才能调用它。如果我们运行测试，我们预计以下测试将通过

Java
Kotlin

@Test(expected = AuthenticationCredentialsNotFoundException.class)
public void getMessageUnauthenticated() {
	messageService.getMessage();
}

@Test(expected = AuthenticationCredentialsNotFoundException::class)
fun getMessageUnauthenticated() {
    messageService.getMessage()
}

@WithMockUser

问题是“我们如何最轻松地以特定用户身份运行测试？”答案是使用 @WithMockUser。以下测试将以用户名为“user”，密码为“password”，角色为“ROLE_USER”的用户身份运行。

Java
Kotlin

@Test
@WithMockUser
public void getMessageWithMockUser() {
String message = messageService.getMessage();
...
}

@Test
@WithMockUser
fun getMessageWithMockUser() {
    val message: String = messageService.getMessage()
    // ...
}

具体来说，以下情况属实

用户名为user的用户不必存在，因为我们模拟了用户对象。
填充到SecurityContext中的Authentication类型为UsernamePasswordAuthenticationToken。
Authentication上的主体是Spring Security的User对象。
User的用户名为user。
User的密码为password。
使用了一个名为ROLE_USER的单个GrantedAuthority。

前面的示例非常方便，因为它允许我们使用许多默认值。如果我们想使用不同的用户名运行测试怎么办？以下测试将使用customUser作为用户名运行（同样，用户实际上不必存在）。

Java
Kotlin

@Test
@WithMockUser("customUsername")
public void getMessageWithMockUserCustomUsername() {
	String message = messageService.getMessage();
...
}

@Test
@WithMockUser("customUsername")
fun getMessageWithMockUserCustomUsername() {
    val message: String = messageService.getMessage()
    // ...
}

我们也可以轻松地自定义角色。例如，以下测试使用admin作为用户名，并使用ROLE_USER和ROLE_ADMIN作为角色进行调用。

Java
Kotlin

@Test
@WithMockUser(username="admin",roles={"USER","ADMIN"})
public void getMessageWithMockUserCustomUser() {
	String message = messageService.getMessage();
	...
}

@Test
@WithMockUser(username="admin",roles=["USER","ADMIN"])
fun getMessageWithMockUserCustomUser() {
    val message: String = messageService.getMessage()
    // ...
}

如果我们不希望值自动以ROLE_为前缀，可以使用authorities属性。例如，以下测试使用admin作为用户名，并使用USER和ADMIN权限进行调用。

Java
Kotlin

@Test
@WithMockUser(username = "admin", authorities = { "ADMIN", "USER" })
public void getMessageWithMockUserCustomAuthorities() {
	String message = messageService.getMessage();
	...
}

@Test
@WithMockUser(username = "admin", authorities = ["ADMIN", "USER"])
fun getMessageWithMockUserCustomUsername() {
    val message: String = messageService.getMessage()
    // ...
}

在每个测试方法上放置注释可能有点繁琐。相反，我们可以在类级别放置注释。然后，每个测试都使用指定的用户。以下示例使用用户名为admin、密码为password且具有ROLE_USER和ROLE_ADMIN角色的用户运行每个测试。

Java
Kotlin

@ExtendWith(SpringExtension.class)
@ContextConfiguration
@WithMockUser(username="admin",roles={"USER","ADMIN"})
public class WithMockUserTests {
	// ...
}

@ExtendWith(SpringExtension.class)
@ContextConfiguration
@WithMockUser(username="admin",roles=["USER","ADMIN"])
class WithMockUserTests {
    // ...
}

如果您使用JUnit 5的@Nested测试支持，您也可以将注释放在封闭类上以应用于所有嵌套类。以下示例使用用户名为admin、密码为password且具有ROLE_USER和ROLE_ADMIN角色的用户运行每个测试方法。

Java
Kotlin

@ExtendWith(SpringExtension.class)
@ContextConfiguration
@WithMockUser(username="admin",roles={"USER","ADMIN"})
public class WithMockUserTests {

	@Nested
	public class TestSuite1 {
		// ... all test methods use admin user
	}

	@Nested
	public class TestSuite2 {
		// ... all test methods use admin user
	}
}

@ExtendWith(SpringExtension::class)
@ContextConfiguration
@WithMockUser(username = "admin", roles = ["USER", "ADMIN"])
class WithMockUserTests {
    @Nested
    inner class TestSuite1 { // ... all test methods use admin user
    }

    @Nested
    inner class TestSuite2 { // ... all test methods use admin user
    }
}

默认情况下，SecurityContext在TestExecutionListener.beforeTestMethod事件期间设置。这相当于在JUnit的@Before之前发生。您可以将其更改为在TestExecutionListener.beforeTestExecution事件期间发生，该事件发生在JUnit的@Before之后，但在调用测试方法之前。

@WithMockUser(setupBefore = TestExecutionEvent.TEST_EXECUTION)

@WithAnonymousUser

使用 @WithAnonymousUser 允许以匿名用户身份运行。这在您希望使用特定用户运行大多数测试，但又想以匿名用户身份运行一些测试时特别方便。以下示例使用 @WithMockUser 运行 withMockUser1 和 withMockUser2，并使用 anonymous 作为匿名用户

Java
Kotlin

@ExtendWith(SpringExtension.class)
@WithMockUser
public class WithUserClassLevelAuthenticationTests {

	@Test
	public void withMockUser1() {
	}

	@Test
	public void withMockUser2() {
	}

	@Test
	@WithAnonymousUser
	public void anonymous() throws Exception {
		// override default to run as anonymous user
	}
}

@ExtendWith(SpringExtension.class)
@WithMockUser
class WithUserClassLevelAuthenticationTests {
    @Test
    fun withMockUser1() {
    }

    @Test
    fun withMockUser2() {
    }

    @Test
    @WithAnonymousUser
    fun anonymous() {
        // override default to run as anonymous user
    }
}

@WithAnonymousUser(setupBefore = TestExecutionEvent.TEST_EXECUTION)

@WithUserDetails

虽然 @WithMockUser 是一个方便的入门方法，但它可能并不适用于所有情况。例如，某些应用程序期望 Authentication 主体为特定类型。这样做是为了使应用程序能够将主体引用为自定义类型，并减少对 Spring Security 的耦合。

自定义主体通常由自定义 UserDetailsService 返回，该服务返回一个同时实现 UserDetails 和自定义类型的对象。对于这种情况，使用自定义 UserDetailsService 创建测试用户非常有用。这正是 @WithUserDetails 所做的。

假设我们有一个作为 bean 公开的 UserDetailsService，则以下测试将使用类型为 UsernamePasswordAuthenticationToken 的 Authentication 和从 UserDetailsService 返回的用户名为 user 的主体进行调用

Java
Kotlin

@Test
@WithUserDetails
public void getMessageWithUserDetails() {
	String message = messageService.getMessage();
	...
}

@Test
@WithUserDetails
fun getMessageWithUserDetails() {
    val message: String = messageService.getMessage()
    // ...
}

我们还可以自定义用于从我们的 UserDetailsService 中查找用户的用户名。例如，此测试可以使用从 UserDetailsService 返回的用户名为 customUsername 的主体运行

Java
Kotlin

@Test
@WithUserDetails("customUsername")
public void getMessageWithUserDetailsCustomUsername() {
	String message = messageService.getMessage();
	...
}

@Test
@WithUserDetails("customUsername")
fun getMessageWithUserDetailsCustomUsername() {
    val message: String = messageService.getMessage()
    // ...
}

我们还可以提供一个显式 bean 名称来查找 UserDetailsService。以下测试使用 bean 名称为 myUserDetailsService 的 UserDetailsService 查找用户名 customUsername

Java
Kotlin

@Test
@WithUserDetails(value="customUsername", userDetailsServiceBeanName="myUserDetailsService")
public void getMessageWithUserDetailsServiceBeanName() {
	String message = messageService.getMessage();
	...
}

@Test
@WithUserDetails(value="customUsername", userDetailsServiceBeanName="myUserDetailsService")
fun getMessageWithUserDetailsServiceBeanName() {
    val message: String = messageService.getMessage()
    // ...
}

与 @WithMockUser 一样，我们也可以将注释放在类级别，以便每个测试都使用相同的用户。但是，与 @WithMockUser 不同，@WithUserDetails 要求用户存在。

@WithUserDetails(setupBefore = TestExecutionEvent.TEST_EXECUTION)

@WithSecurityContext

我们已经看到，如果我们不使用自定义的 Authentication 主体，@WithMockUser 是一个很好的选择。接下来，我们发现 @WithUserDetails 允许我们使用自定义的 UserDetailsService 来创建我们的 Authentication 主体，但要求用户存在。现在我们看到一个选项，它提供了最大的灵活性。

我们可以创建自己的注释，它使用 @WithSecurityContext 来创建我们想要的任何 SecurityContext。例如，我们可以创建一个名为 @WithMockCustomUser 的注释。

Java
Kotlin

@Retention(RetentionPolicy.RUNTIME)
@WithSecurityContext(factory = WithMockCustomUserSecurityContextFactory.class)
public @interface WithMockCustomUser {

	String username() default "rob";

	String name() default "Rob Winch";
}

@Retention(AnnotationRetention.RUNTIME)
@WithSecurityContext(factory = WithMockCustomUserSecurityContextFactory::class)
annotation class WithMockCustomUser(val username: String = "rob", val name: String = "Rob Winch")

您可以看到 @WithMockCustomUser 使用 @WithSecurityContext 注释进行了注释。这就是向 Spring Security 测试支持发出信号，表明我们打算为测试创建一个 SecurityContext。@WithSecurityContext 注释要求我们指定一个 SecurityContextFactory 来创建一个新的 SecurityContext，给定我们的 @WithMockCustomUser 注释。以下清单显示了我们的 WithMockCustomUserSecurityContextFactory 实现。

Java
Kotlin

public class WithMockCustomUserSecurityContextFactory
	implements WithSecurityContextFactory<WithMockCustomUser> {
	@Override
	public SecurityContext createSecurityContext(WithMockCustomUser customUser) {
		SecurityContext context = SecurityContextHolder.createEmptyContext();

		CustomUserDetails principal =
			new CustomUserDetails(customUser.name(), customUser.username());
		Authentication auth =
			UsernamePasswordAuthenticationToken.authenticated(principal, "password", principal.getAuthorities());
		context.setAuthentication(auth);
		return context;
	}
}

class WithMockCustomUserSecurityContextFactory : WithSecurityContextFactory<WithMockCustomUser> {
    override fun createSecurityContext(customUser: WithMockCustomUser): SecurityContext {
        val context = SecurityContextHolder.createEmptyContext()
        val principal = CustomUserDetails(customUser.name, customUser.username)
        val auth: Authentication =
            UsernamePasswordAuthenticationToken(principal, "password", principal.authorities)
        context.authentication = auth
        return context
    }
}

现在，我们可以使用我们的新注释和 Spring Security 的 WithSecurityContextTestExecutionListener 来注释测试类或测试方法，以确保我们的 SecurityContext 被适当地填充。

在创建您自己的 WithSecurityContextFactory 实现时，很高兴知道它们可以使用标准的 Spring 注释进行注释。例如，WithUserDetailsSecurityContextFactory 使用 @Autowired 注释来获取 UserDetailsService。

Java
Kotlin

final class WithUserDetailsSecurityContextFactory
	implements WithSecurityContextFactory<WithUserDetails> {

	private UserDetailsService userDetailsService;

	@Autowired
	public WithUserDetailsSecurityContextFactory(UserDetailsService userDetailsService) {
		this.userDetailsService = userDetailsService;
	}

	public SecurityContext createSecurityContext(WithUserDetails withUser) {
		String username = withUser.value();
		Assert.hasLength(username, "value() must be non-empty String");
		UserDetails principal = userDetailsService.loadUserByUsername(username);
		Authentication authentication = UsernamePasswordAuthenticationToken.authenticated(principal, principal.getPassword(), principal.getAuthorities());
		SecurityContext context = SecurityContextHolder.createEmptyContext();
		context.setAuthentication(authentication);
		return context;
	}
}

class WithUserDetailsSecurityContextFactory @Autowired constructor(private val userDetailsService: UserDetailsService) :
    WithSecurityContextFactory<WithUserDetails> {
    override fun createSecurityContext(withUser: WithUserDetails): SecurityContext {
        val username: String = withUser.value
        Assert.hasLength(username, "value() must be non-empty String")
        val principal = userDetailsService.loadUserByUsername(username)
        val authentication: Authentication =
            UsernamePasswordAuthenticationToken(principal, principal.password, principal.authorities)
        val context = SecurityContextHolder.createEmptyContext()
        context.authentication = authentication
        return context
    }
}

@WithSecurityContext(setupBefore = TestExecutionEvent.TEST_EXECUTION)

测试元注释

如果您在测试中经常重复使用同一个用户，那么不得不重复指定属性并不是理想的。例如，如果您有许多与用户名为 admin 且角色为 ROLE_USER 和 ROLE_ADMIN 的管理用户相关的测试，您必须编写

Java
Kotlin

@WithMockUser(username="admin",roles={"USER","ADMIN"})

@WithMockUser(username="admin",roles=["USER","ADMIN"])

与其在所有地方重复此操作，我们可以使用元注释。例如，我们可以创建一个名为 WithMockAdmin 的元注释。

Java
Kotlin

@Retention(RetentionPolicy.RUNTIME)
@WithMockUser(value="rob",roles="ADMIN")
public @interface WithMockAdmin { }

@Retention(AnnotationRetention.RUNTIME)
@WithMockUser(value = "rob", roles = ["ADMIN"])
annotation class WithMockAdmin

现在，我们可以像使用更详细的 @WithMockUser 一样使用 @WithMockAdmin。

元注释适用于上面描述的任何测试注释。例如，这意味着我们可以为 @WithUserDetails("admin") 创建一个元注释。