ReactiveOAuth2AccessTokenResponseClients should support setting a custom WebClient

[jzheaux]

WebClientReactiveAuthorizationCodeTokenResponseClient would be more convenient to use if their respective webClient properties could be set.

Let's add a setter, like:

/**
  Use the given {@link WebClient}.
  @param webClient The {@link WebClient} to use
  @since 5.2
*/
public void setWebClient(WebClient webClient) {
    Assert.notNull(webClient, "webClient cannot be null");
    this.webClient = webClient;
}

As well as tests to confirm that the setter works.

Related to #6051

[shraiysh]

Hey! I am a first timer and would like to handle this issue!

[rwinch]

@shraiysh Thanks! The issue is yours. If you have any questions, please don't hesitate to let us know!

[shraiysh]

Hi, @rwinch I have never worked with spring boot applications. Can you please provide me a link to an example that could possibly use the required getter function, for testing?

Thanks!

[rwinch]

@shraiysh You do not need a getter. The tests will be like those in WebClientReactiveClientCredentialsTokenResponseClientTests Does that help?

[richardvaldiviesomacias]

When there is another first time...I would love to try!

[rwinch]

@richardvaldiviesomacias We'd love for you to contribute! Given the high degree of interest we post the first timer only tickets and let it be a first come first serve system, so keep an eye out for tickets flagged as first-timers-only.

PS: If you find another ticket you are interested in, don't let the lack of first-timers-only flag discourage you. We are glad to help you contribute to other tickets too. There is a Help Wanted label that are typically fairly simple issues too.

[shraiysh]

Hey @rwinch ! Thanks, that helped. I'm sorry for the typo there; I meant setter instead of getter! :D

[shraiysh]

Hey, @rwinch I might take a little longer to solve this issue because many things are new to me, but I will do it. If you have anything to guide me, that'll help. Right now, I'm reading about Tests and the docs on Spring security for this class. I will be trying to understand the working and then write the tests for this.

[richardvaldiviesomacias]

Thanks, @rwinch. I will take a look. Is any documentation for sending a PR. I mean is there any particular way to send a PR (Format, new of branch, etc.)

[shraiysh]

@richardvaldiviesomacias, I think this is the link you're looking for! Hope that helps.

[shraiysh]

Hi, I need some help! For testing custom webClient, I have written the following function

public void setCustomWebClientThenCustomWebClientIsUsed() {
	WebClient customClient = mock(WebClient.class);
	// This way, customClient.post() gives NullPointerException
	// So, I guess I want to use mock over WebClient.builder().build()

	this.tokenResponseClient.setWebClient(customClient);

	Mono<OAuth2AccessTokenResponse> response = this.tokenResponseClient.getTokenResponse(authorizationCodeGrantRequest());
	verify(customClient, atLeastOnce()).post();
}

I don't understand how I mock over it without changing the other classes. Also, if I use WebClient.builder().build(), verify cannot this object.

The solution that I came to was surrounding the Mono<OAuth2AccessTokenResponse> response = this.tokenResponseClient.getTokenResponse(authorizationCodeGrantRequest()); by a try-catch block.

WebClient customClient = mock(WebClient.class);
tokenResponseClient.setWebClient(customClient);
try {
	OAuth2AccessTokenResponse response = this.tokenResponseClient.getTokenResponse(authorizationCodeGrantRequest()).block();
} catch(Exception e) {
	// Do Nothing!
}
verify(customClient, atLeastOnce()).post();

Please let me know if this is right! Or if there's any other way!
Thanks

[richardvaldiviesomacias]

@richardvaldiviesomacias, I think this is the link you're looking for! Hope that helps.
Thanks @shraiysh

[rwinch]

@shraiysh You can use something like this to ensure you don't get a null value and then verify it was used here

[shraiysh]

Hey, @rwinch I am sorry for creating a mess with so many commits... Please check it (the last one - I have squashed others) and let me know if I should submit a pull request.

[rwinch]

@shraiysh Thanks for the fast turnaround!

Can you please update the commit message to align with the Spring Security conventions?

A few notes:

• Try to keep the subject as short as possible. This can be difficult or even impossible but try to keep it meaningful and concise
• There is no need to add anything in the message about the tests since tests are required (thus implied)
• Ensure the commit ends with Fixes: gh-6182

Add WebClientReactiveAuthorizationCodeTokenResponseClient.setWebClient

Fixes: gh-6182

[shraiysh]

Thanks for the comment @rwinch. I have updated the commit message to

Add WebClientReactiveAuthorizationCodeTokenResponseClient.setWebClient

Fixes: gh-6182

Please let me know if there's an issue.

[rwinch]

Looks good. Can you submit a pull request?