Testing OAuth2 client with SB4 and Addons 9

[totterman]

Bonjour!

I have a small private project that is heavily based on the BFF tutorial for the authentication part. Now I am trying to upgrade to Spring Boot 4.0.6 and Spring-Addons 9.1.3. On the BFF server the integration tests that worked with SB3 do not build anymore. I guess I have messed the dependencies as I have tried a bunch of different combinations, and would be grateful for any advice.

For this BFF server application, am I correct in that with SB4, both spring-boot-starter-security-oauth2-client and spring-boot-starter-security-oauth2-resource-server should be included in the dependencies?

Error message:

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'fi.smartbass.ycbr.BffServerApplicationIntegrationTests': Unsatisfied dependency expressed through field 'api': No qualifying bean of type 'com.c4_soft.springaddons.security.oauth2.test.webflux.WebTestClientSupport' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
...
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.c4_soft.springaddons.security.oauth2.test.webflux.WebTestClientSupport' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

The problematic test code:

@SpringBootTest(properties = "spring.main.web-application-type=reactive", webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@EnableConfigurationProperties({OAuth2ClientProperties.class})
@AutoConfigureWebTestClient
@Import(TestSecurityConf.class)
class BffServerApplicationIntegrationTests {

    @Autowired
    private WebTestClientSupport api;

    @Test
    @WithAnonymousUser
    void givenRequestIsAnonymous_whenGetLoginOptions_thenOk() throws Exception {
        api.get("/login-options")
                .expectStatus()
                .isOk()
                .expectBody()
                .jsonPath("$")
                .isArray()
                .jsonPath("$[0].label")
                .isEqualTo("ycbr")
                .jsonPath("$[0].loginUri")
                .isEqualTo("http://localhost:7080/bff/oauth2/authorization/ycbr")
                .jsonPath("$[0].isSameAuthority")
                .isEqualTo(true);
    }

Dependencies in build.gradle:

ext {
	set('springAddonsVersion', "9.1.3")
    set('springCloudVersion', "2025.1.1")
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-actuator'
    implementation 'org.springframework.boot:spring-boot-starter-cache'
	implementation 'org.springframework.boot:spring-boot-starter-security-oauth2-client'
	implementation 'org.springframework.boot:spring-boot-starter-security-oauth2-resource-server'
	implementation 'org.springframework.cloud:spring-cloud-starter-gateway-server-webflux'
    implementation "com.c4-soft.springaddons:spring-addons-starter-oidc:${springAddonsVersion}"

	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
	testImplementation 'org.springframework.boot:spring-boot-starter-webflux-test'
	testImplementation 'org.springframework.boot:spring-boot-webflux-test'
	testImplementation 'org.springframework.boot:spring-boot-webtestclient'
	testImplementation 'org.springframework.boot:spring-boot-starter-security-test'
    testImplementation 'io.projectreactor:reactor-test'
    testImplementation "com.c4-soft.springaddons:spring-addons-starter-oidc-test:${springAddonsVersion}"

    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

Thank you all for using your time to read this!

[ch4mpy]

I see spring-boot-starter-webflux-test among your testImplementation dependencies, but not spring-boot-starter-webflux among implementation ones. Is it intended?

Regarding your issue, to auto-wire a WebTestClientSupport, you need AddonsWebfluxTestConf to be scanned. In a regular @WebFluxTest, use @AutoConfigureAddonsWebfluxClientSecurity. In an integration test, you may just add it to your import statement:@Import({TestSecurityConf.class, AddonsWebfluxTestConf.class}).

Look at AddonsWebfluxTestConf sources to see other test beans it creates. You may also copy just the WebTestClientSupport bean definition from this source and add it to your TestSecurityConf)

[totterman]

Thank you @ch4mpy for a quick reply!
I have updated Spring Boot to 4.0.7, Spring Addons to 9.1.4 and added spring-boot-starter-webflux which brought me a little bit further. WebTestClientSupport bean is still missing and now the error message is

Factory method 'webTestClientSupport' threw exception with message: Cannot invoke "org.springframework.web.server.adapter.WebHttpHandlerBuilder.filters(java.util.function.Consumer)" because "httpHandlerBuilder" is null
at org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers$CsrfMutator.afterConfigurerAdded(SecurityMockServerConfigurers.java:264)
	at org.springframework.test.web.reactive.server.DefaultWebTestClientBuilder.apply(DefaultWebTestClientBuilder.java:269)

SecurityMockServerConfigurers.java lines 258-265 here:

		@NullUnmarked
		@Override
		public void afterConfigurerAdded(WebTestClient.Builder builder,
				@Nullable WebHttpHandlerBuilder httpHandlerBuilder, @Nullable ClientHttpConnector connector) {
			CsrfWebFilter filter = new CsrfWebFilter();
			filter.setRequireCsrfProtectionMatcher((e) -> ServerWebExchangeMatcher.MatchResult.notMatch());
			httpHandlerBuilder.filters((filters) -> filters.add(0, filter));
		}

It seems obvious that the last line will fail when httpHandlerBuilder is null, but i wonder why it is annotated @Nullable in the first place.

Anyway, I have these annotations:

@SpringBootTest(properties = "spring.main.web-application-type=reactive", webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@EnableConfigurationProperties({OAuth2ClientProperties.class})
@AutoConfigureWebTestClient
@Import({TestSecurityConf.class, AddonsWebfluxTestConf.class})
class BffServerApplicationIntegrationTests {

    @Autowired
    private WebTestClientSupport api;
    ...

As far as I can understand SB documents, this should be sufficient to autoconfigure a WebTestClient bean. Or, more likely, I am completely on the wrong track.

Any suggestions would be appreciated!

[totterman]

This fixed my issue:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)

Defining WebEnvironment.RANDOM_PORT apparently requires additional dependencies which eventually caused my issue. Lesson learned.

And, thank you @ch4mpy for this outstanding project!