Add principal name to oauth2Client Test Support

Fixes gh-8054

Author: jzheaux

test/src/main/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurers.java

@@ -783,6 +783,7 @@ public void beforeServerCreated(WebHttpHandlerBuilder builder) {
 			mockOAuth2Client()
 					.accessToken(this.accessToken)
 					.clientRegistration(this.clientRegistration)
+					.principalName(token.getPrincipal().getName())
 					.beforeServerCreated(builder);
 			mockAuthentication(getToken()).beforeServerCreated(builder);
 		}
@@ -1028,6 +1029,7 @@ private OidcUser defaultPrincipal() {
 	public final static class OAuth2ClientMutator implements WebTestClientConfigurer, MockServerConfigurer {
 		private String registrationId = "test";
 		private ClientRegistration clientRegistration;
+		private String principalName = "user";
 		private OAuth2AccessToken accessToken = new OAuth2AccessToken(OAuth2AccessToken.TokenType.BEARER,
 				"access-token", null, null, Collections.singleton("read"));
 
@@ -1068,6 +1070,18 @@ public OAuth2ClientMutator clientRegistration(ClientRegistration clientRegistrat
 			return this;
 		}
 
+		/**
+		 * Use this as the resource owner's principal name
+		 *
+		 * @param principalName the resource owner's principal name
+		 * @return the {@link OAuth2ClientMutator} for further configuration
+		 */
+		public OAuth2ClientMutator principalName(String principalName) {
+			Assert.notNull(principalName, "principalName cannot be null");
+			this.principalName = principalName;
+			return this;
+		}
+
 		/**
 		 * Use this {@link OAuth2AccessToken}
 		 *
@@ -1110,7 +1124,7 @@ private OAuth2AuthorizedClient getClient() {
 				throw new IllegalArgumentException("Please specify a ClientRegistration via one " +
 						"of the clientRegistration methods");
 			}
-			return new OAuth2AuthorizedClient(this.clientRegistration, "user", this.accessToken);
+			return new OAuth2AuthorizedClient(this.clientRegistration, this.principalName, this.accessToken);
 		}
 
 		private ClientRegistration.Builder clientRegistrationBuilder() {

test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessors.java

@@ -1401,6 +1401,7 @@ public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request)
 			request = new AuthenticationRequestPostProcessor(token).postProcessRequest(request);
 			return new OAuth2ClientRequestPostProcessor()
 					.clientRegistration(this.clientRegistration)
+					.principalName(oauth2User.getName())
 					.accessToken(this.accessToken)
 					.postProcessRequest(request);
 		}
@@ -1587,6 +1588,7 @@ private OidcUser defaultPrincipal() {
 	public final static class OAuth2ClientRequestPostProcessor implements RequestPostProcessor {
 		private String registrationId = "test";
 		private ClientRegistration clientRegistration;
+		private String principalName = "user";
 		private OAuth2AccessToken accessToken = new OAuth2AccessToken(OAuth2AccessToken.TokenType.BEARER,
 				"access-token", null, null, Collections.singleton("read"));
 
@@ -1624,6 +1626,18 @@ public OAuth2ClientRequestPostProcessor clientRegistration(ClientRegistration cl
 			return this;
 		}
 
+		/**
+		 * Use this as the resource owner's principal name
+		 *
+		 * @param principalName the resource owner's principal name
+		 * @return the {@link OAuth2ClientRequestPostProcessor} for further configuration
+		 */
+		public OAuth2ClientRequestPostProcessor principalName(String principalName) {
+			Assert.notNull(principalName, "principalName cannot be null");
+			this.principalName = principalName;
+			return this;
+		}
+
 		/**
 		 * Use this {@link OAuth2AccessToken}
 		 *
@@ -1642,7 +1656,7 @@ public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request)
 						"of the clientRegistration methods");
 			}
 			OAuth2AuthorizedClient client = new OAuth2AuthorizedClient
-					(this.clientRegistration, "user", this.accessToken);
+					(this.clientRegistration, this.principalName, this.accessToken);
 			OAuth2AuthorizedClientRepository authorizedClientRepository =
 					new HttpSessionOAuth2AuthorizedClientRepository();
 			authorizedClientRepository.saveAuthorizedClient(client, null, request, new MockHttpServletResponse());

test/src/test/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurersOAuth2ClientTests.java

@@ -134,6 +134,16 @@ public void oauth2ClientWhenClientRegistrationConsumerThenUses()
 		assertThat(client.getRefreshToken()).isNull();
 	}
 
+	@Test
+	public void oauth2ClientWhenPrincipalNameThenUses() throws Exception {
+		this.client.mutateWith(mockOAuth2Client("registration-id")
+				.principalName("test-subject"))
+				.get().uri("/client")
+				.exchange()
+				.expectStatus().isOk()
+				.expectBody(String.class).isEqualTo("test-subject");
+	}
+
 	@Test
 	public void oauth2ClientWhenAccessTokenThenUses()
 			throws Exception {

test/src/test/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessorsOAuth2ClientTests.java

@@ -123,6 +123,13 @@ public void oauth2ClientWhenClientRegistrationConsumerThenUses()
 				.andExpect(content().string("client-id"));
 	}
 
+	@Test
+	public void oauth2ClientWhenPrincipalNameThenUses() throws Exception {
+		this.mvc.perform(get("/principal-name")
+				.with(oauth2Client("registration-id").principalName("test-subject")))
+				.andExpect(content().string("test-subject"));
+	}
+
 	@Test
 	public void oauth2ClientWhenAccessTokenThenUses() throws Exception {
 		OAuth2AccessToken accessToken = noScopes();
@@ -161,6 +168,11 @@ String accessToken(@RegisteredOAuth2AuthorizedClient("registration-id") OAuth2Au
 				return authorizedClient.getAccessToken().getTokenValue();
 			}
 
+			@GetMapping("/principal-name")
+			String principalName(@RegisteredOAuth2AuthorizedClient("registration-id") OAuth2AuthorizedClient authorizedClient) {
+				return authorizedClient.getPrincipalName();
+			}
+
 			@GetMapping("/client-id")
 			String clientId(@RegisteredOAuth2AuthorizedClient("registration-id") OAuth2AuthorizedClient authorizedClient) {
 				return authorizedClient.getClientRegistration().getClientId();