在测试中替换OAuth2 WebClient

Question

我有一个小型的spring boot 2.2批处理，它编写了一个OAuth2 REST API。

我已经能够按照https://medium.com/@asce4s/oauth2-with--webclient-761d16f89cdd配置webclient并且它能够正常工作。

java prettyprint-override">    @Configuration
    public class MyRemoteServiceClientOauth2Config {

        @Bean("myRemoteService")
        WebClient webClient(ReactiveClientRegistrationRepository clientRegistrations) {
            ServerOAuth2AuthorizedClientExchangeFilterFunction oauth =
                    new ServerOAuth2AuthorizedClientExchangeFilterFunction(
                            clientRegistrations,
                            new UnAuthenticatedServerOAuth2AuthorizedClientRepository());
            oauth.setDefaultClientRegistrationId("myRemoteService");

            return WebClient.builder()
                    .filter(oauth)
                    .build();
        }

    }

但是，现在我想为我的批处理编写一个集成测试，我想避免使用“真正的”授权服务器来获得一个令牌：如果一个外部服务器宕机，我不希望我的测试失败。我希望我的测试是“自主”的。

在测试期间，我调用的远程服务被mockserver假服务替换。

在这种情况下，最佳做法是什么？

• 对我有效的方法是仅在使用@profile（“！test”）的测试之外启用上述配置，并使用@activeprofiles（“test”）运行我的测试。我还在测试中导入特定于测试的配置:

    @Configuration
    @Profile("test")
    public class BatchTestConfiguration {

        @Bean("myRemoteService")
        public WebClient webClientForTest() {

            return WebClient.create();
        }

    }

但我觉得必须在我的生产配置中添加@profile（“！test”）并不是很好。

• 有没有一种‘更干净’的方法来替换我正在使用的WebClient bean，它将调用我的假远程服务而不首先尝试获取令牌？我试图将@primary放在webClientForTest bean上，但这不起作用：生产bean仍然启用，而我得到一个异常:

没有“org.springframework.security.oauth2.client.registration.reactiveClientRegistrationRepository”类型的合格bean

这是生产bean需要的参数类型

• 我是否需要启动一个假授权服务器作为测试的一部分，并配置WebClient以从中获取虚拟令牌？是否有一个库提供这一点，尽可能开箱即用？

Answer 1

我和你的处境一样，也找到了解决办法。首先，为了查看它的实际运行情况，我创建了一个存储库，其中包含下面解释的所有内容的展示实现。

有没有一种“更干净”的方法来替换我正在使用的WebClient bean，它将调用我的假远程服务，而不必先尝试获取令牌？

我不会在您的测试中替换WebClientbean，而是将ReactiveOAuth2AuthorizedClientManagerbean替换为一个mock。为此，您必须稍微修改MyRemoteServiceClientoAuth2Config。与使用unauthenticatedserveroauth2authorizedclientrepository的方法相比，您可以这样配置它（这也更符合servlet堆栈上的文档配置）：

@Configuration
public class MyRemoteServiceClientOauth2Config {

    @Bean
    public WebClient webClient(ReactiveOAuth2AuthorizedClientManager reactiveOAuth2AuthorizedClientManager) {
        ServerOAuth2AuthorizedClientExchangeFilterFunction oauth2ClientCredentialsFilter =
                new ServerOAuth2AuthorizedClientExchangeFilterFunction(reactiveOAuth2AuthorizedClientManager);
        oauth2ClientCredentialsFilter.setDefaultClientRegistrationId("myRemoteService");

        return WebClient.builder()
                .filter(oauth2ClientCredentialsFilter)
                .build();
    }

    @Bean
    public ReactiveOAuth2AuthorizedClientManager reactiveOAuth2AuthorizedClientManager(ReactiveClientRegistrationRepository clientRegistrations,
                                                                                       ReactiveOAuth2AuthorizedClientService authorizedClients) {
        AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager authorizedClientManager =
                new AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(clientRegistrations, authorizedClients);

        authorizedClientManager.setAuthorizedClientProvider(
                new ClientCredentialsReactiveOAuth2AuthorizedClientProvider());

        return authorizedClientManager;
    }
}

然后可以创建ReactiveOauth2AuthorizedClientManager的模拟，该模拟始终返回Oauth2AuthorizedClient的Mono，如下所示：

@TestComponent
@Primary
public class AlwaysAuthorizedOAuth2AuthorizedClientManager implements ReactiveOAuth2AuthorizedClientManager {

    @Value("${spring.security.oauth2.client.registration.myRemoteService.client-id}")
    String clientId;

    @Value("${spring.security.oauth2.client.registration.myRemoteService.client-secret}")
    String clientSecret;

    @Value("${spring.security.oauth2.client.provider.some-keycloak.token-uri}")
    String tokenUri;

    /**
     * {@inheritDoc}
     *
     * @return
     */
    @Override
    public Mono<OAuth2AuthorizedClient> authorize(final OAuth2AuthorizeRequest authorizeRequest) {
        return Mono.just(
                new OAuth2AuthorizedClient(
                        ClientRegistration
                                .withRegistrationId("myRemoteService")
                                .clientId(clientId)
                                .clientSecret(clientSecret)
                                .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS)
                                .tokenUri(tokenUri)
                                .build(),
                        "some-keycloak",
                        new OAuth2AccessToken(TokenType.BEARER,
                                "c29tZS10b2tlbg==",
                                Instant.now().minus(Duration.ofMinutes(1)),
                                Instant.now().plus(Duration.ofMinutes(4)))));
    }
}

最后@import在您的测试中：

@SpringBootTest
@Import(AlwaysAuthorizedOAuth2AuthorizedClientManager.class)
class YourIntegrationTestClass {

  // here is your test code

}

对应的src/test/resources/application.yml如下所示：

spring:
  security:
    oauth2:
      client:
        registration:
          myRemoteService:
            authorization-grant-type: client_credentials
            client-id: test-client
            client-secret: 6b30087f-65e2-4d89-a69e-08cb3c9f34d2 # bogus
            provider: some-keycloak
        provider:
          some-keycloak:
            token-uri: https://some.bogus/token/uri

您还可以使用已经用于模拟REST资源的mockserver来模拟授权服务器并响应令牌请求。为此，您可以将mockServer配置为src/test/resources/application.yml中的token-uri或用于分别为测试提供属性的任何文件。

在bean中提供WebClient的推荐方法是注入WebClient.builder，它由spring boot预配置。这也保证了测试中的webclient与生产中的配置完全相同。您可以声明WebClientCustomizerbean来进一步配置此构建器。这就是上面提到的在我的showcase存储库中实现它的方式。

我也试过了，发现它并不总是按照预期的方式工作，可能是因为spring加载和实例化bean定义的顺序。例如，ReactiveOAuth2AuthorizedClientManager模拟仅在@TestConfiguration是测试类内部的静态嵌套类时才使用，但如果它是@ImportED则不使用。在接口上使用静态嵌套的@testconfiguration并用测试类实现它也是不起作用的。因此，为了避免将静态嵌套类放在我需要的每个集成测试中，我宁愿选择这里介绍的@TestComponent方法。

我只测试了client credentials授予类型的方法，但我认为它也可以适用于其他授予类型。