Allow to inject mocked @ConfigProperties classes in quarkus test

Description

It’s currently not possible to mock a config class that was annotated with the @ConfigProperties annotation. Let’s assume, we have the following setup:

1.) config properties class

@ConfigProperties(prefix = "user-settings")
class UserConfigSnapshot {
    lateinit var minAge: Int
}

2.) service that uses the config class

@ApplicationScoped
class UserService(private val configSnapshot: UserConfigSnapshot) {

}

3.) a test

@QuarkusTest
class UserConfigServiceTest {

    private val configSnapshot = mockk<UserConfigSnapshot>()

    @Inject
    lateinit var service: UserConfigService

    @BeforeEach
    fun setupMocks() {
        QuarkusMock.installMockForType(configSnapshot, UserConfigSnapshot::class.java)
    }
}

The test fails with the message UserConfig@2b4a250d is not a normal scoped CDI bean, make sure the bean is a normal scope like @ApplicationScoped or @RequestScoped. If I annotate the UserConfig with a @ApplicationScoped annotation, another error message appears though.

[geoand]

I’ll go ahead and close this for now as won't fix, but let’s keep it in mind if needed for the future

[radcortez]

@maslakov you have a couple of options:

You can use @TestProfile like documented here: https://quarkus.io/guides/getting-started-testing#testing_different_profiles

Or you can make a proxy of @ConfigMapping like this: https://github.com/ivannov/mocking-config-mappers/pull/1/files. I’ll document this piece later.

@ConfigProperties was deprecated for 2.0 in favour of @ConfigMapping.