How to properly inject & mock a repository class' AgroalDataSource dependency?

[jehrenzweig-leagueapps]

I've created a Quarkus 2.16.2.Final API in Kotlin & the endpoints work as expected. Now I'm trying to write my first automated tests (using Mockk), and I'm running into a problem that I believe relates to how I'm injecting a datasource into a repository class.

Here's what my repository class declaration looks like:

@ApplicationScoped
class WidgetRepositoryImpl @Inject constructor(
    @DataSource("localstorage") private val localstorage: AgroalDataSource
) : WidgetRepository {
    // ... public repository method implementation code...   
}

WidgetRepository is an interface with two methods that the WidgetRepositoryImpl class implements -- nothing fancy there.

The first hint that I might be doing something wrong is that IntelliJ displays the warning tooltip above my localstorage dependency variable:

Unsatisfied dependency: no bean matches the injection point

I have the following code in my application.yml file, which declares the localstorage datasource:

"%localhost":
  quarkus:
    swagger-ui:
      always-include: true
      enable: true
    datasource:
      localstorage:
        devservices:
          enabled: true
          image-name: mysql:8.0.32
          username: root
          password: 12345
          db-name: WIDGET_DB
          port: 54111

Finally, I have the following VM options added to my Quarkus run/debug configuration, to ensure the localhost profile runs when Quarkus runs in non-test mode:

-Dquarkus.profile=localhost

However, when I run my first API endpoint test, I get the following exception:

java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkus.arc.deployment.ArcProcessor#validate threw an exception: javax.enterprise.inject.spi.DeploymentException: javax.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type io.agroal.api.AgroalDataSource and qualifiers [@DataSource("localstorage")]
	- java member: com.example.services.widget.dataaccess.WidgetRepositoryImpl():localstorage
	- declared on CLASS bean [types=[com.example.services.widget.dataaccess.WidgetRepositoryImpl, com.example.services.widget.abstractions.dataaccess.WidgetRepository, java.lang.Object], qualifiers=[@Default, @Any], target=com.example.services.widget.dataaccess.WidgetRepositoryImpl]
	The following beans match by type, but none have matching qualifiers:
		- Bean [class=io.agroal.api.AgroalDataSource, qualifiers=[@javax.enterprise.inject.Default, @Any]]
	at io.quarkus.arc.processor.BeanDeployment.processErrors(BeanDeployment.java:1223)
	at io.quarkus.arc.processor.BeanDeployment.init(BeanDeployment.java:288)
	at io.quarkus.arc.processor.BeanProcessor.initialize(BeanProcessor.java:148)
	at io.quarkus.arc.deployment.ArcProcessor.validate(ArcProcessor.java:526)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:909)
	at io.quarkus.builder.BuildContext.run(BuildContext.java:281)
	at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
	at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2449)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1478)
	at java.base/java.lang.Thread.run(Thread.java:833)
	at org.jboss.threads.JBossThread.run(JBossThread.java:501)
Caused by: javax.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type io.agroal.api.AgroalDataSource and qualifiers [@DataSource("localstorage")]
	- java member: com.example.services.widget.dataaccess.WidgetRepositoryImpl():localstorage
	- declared on CLASS bean [types=[com.example.services.widget.dataaccess.WidgetRepositoryImpl, com.example.services.widget.abstractions.dataaccess.WidgetRepository, java.lang.Object], qualifiers=[@Default, @Any], target=com.example.services.widget.dataaccess.WidgetRepositoryImpl]
	The following beans match by type, but none have matching qualifiers:
		- Bean [class=io.agroal.api.AgroalDataSource, qualifiers=[@javax.enterprise.inject.Default, @Any]]
	at io.quarkus.arc.processor.Beans.resolveInjectionPoint(Beans.java:440)
	at io.quarkus.arc.processor.BeanInfo.init(BeanInfo.java:539)
	at io.quarkus.arc.processor.BeanDeployment.init(BeanDeployment.java:276)

Seems like I'm doing something wrong somewhere... any idea what it might be? I'm gonna try and get a reproducer project going, so that it's easier to point at functional code. But I figured I'd try and explain the problem first, in case it was easy for more experienced eyes to notice what I'm doing wrong.

As always, thanks in advance!

[quarkus-bot[bot]]

/cc @Sanne (agroal), @barreiro (agroal), @evanchooly (kotlin), @geoand (kotlin), @yrodiere (agroal)

[jehrenzweig-leagueapps]

If it's of any help, here's what my test code looks like:

@InjectSpy
private lateinit var widgetManager : WidgetManager

@InjectSpy
private lateinit var widgetRepository: WidgetRepository

@InjectMock
@DataSource("localstorage")
private lateinit var localstorage: AgroalDataSource

@QuarkusTest
internal class WidgetControllerImplTest {
    @BeforeEach
    fun setupMocks() {
        QuarkusMock.installMockForType(localstorage, AgroalDataSource::class.java)
    }

    @Test
    fun `DERP`() {
        // Arrange
        every { widgetRepository.getById(1) } returns WidgetSettings(1, "foo", "bar")

        // Act & Assert
        given()
            .`when`()
                .get("/widgets/1/settings")
            .then()
                .statusCode(200)
    }
}

[yrodiere]

Looking at the javadoc of QuarkusMock, you can pass qualifiers:

    /**
     * Installs a mock for a CDI normal scoped bean
     *
     * @param mock The mock object
     * @param instance The type of the CDI normal scoped bean to replace
     * @param qualifiers The CDI qualifiers of the bean to mock
     * @param <T> The bean type
     */
    public static <T> void installMockForType(T mock, Class<? super T> instance, Annotation... qualifiers) {

So, do something like this in order to mock the "missing" bean?

import io.quarkus.agroal.DataSource;

// ...

        QuarkusMock.installMockForType(localstorage, AgroalDataSource::class.java,
                new DataSource.DataSourceLiteral("localstorage"));

EDIT: That may not be valid Kotlin code, but you get the idea.

[jehrenzweig-leagueapps]

I tried updating that statement & adjusting it for Kotlin syntax (i.e. removing the new keyword):

QuarkusMock.installMockForType(localstorage, AgroalDataSource::class.java,
    DataSource.DataSourceLiteral("localstorage"))

No change -- same exception message.

[jehrenzweig-leagueapps]

FWIW I came across a previously reported bug whose exception message is similar/identical to the one I'm seeing:

#13180

So I tried adding an H2 datasource to my application.yml file, just to see what happened:

"%test":
  quarkus:
    swagger-ui:
      always-include: true
      enable: true
    datasource:
      localstorage:
        devservices:
          enabled: false
          db-kind: h2
          username: root
          password: 12345
          db-name: WIDGET_DB
          port: 54111
          jdbc:
            url: jdbc:h2:tcp://localhost/mem:default
            driver: org.h2.Driver

And now I'm getting a far more concise exception:

lateinit property localstorage has not been initialized
kotlin.UninitializedPropertyAccessException: lateinit property localstorage has not been initialized
	at com.leagueapps.services.brandingtheme.controllers.WidgetControllerImplTest.setupMocks(WidgetControllerImplTest.kt:39)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at io.quarkus.test.junit.QuarkusTestExtension.runExtensionMethod(QuarkusTestExtension.java:1002)
	...

I'm not saying I want to do this; I assumed I wouldn't have to set datasource settings if I only plan on using a mocked datasource. I just figured it was worth mentioning, in case it helps triangulate on what might be happening & why.

[yrodiere]

In that case the failure probably happens before your setupMocks method gets executed. You're probably in a very specific case since I think QuarkusMock was intended to replace existing beans, while in your case you want your mock to fill in for a missing bean.

Try:

1. installing mocks in @BeforeAll as shown in the documentation
2. @InjectMock
3. CDI @Alternative.

Not sure about #1 and #2, but #3 should get you past this error for sure.

[jehrenzweig-leagueapps]

I just tried using @BeforeAll; still doesn't work. Nor does moving the QuarkusMock.installMockForType() call to the test itself and foregoing use of @BeforeAll & @BeforeEach.

FWIW my code is already using @InjectMock; it isn't working the way I'd expect.

Regarding CDI @Alternative: I just tried creating the following class in /src/test/kotlin, which uses the io.quarkus.test.Mock annotation recommended by the documentation:

MockLocalstorageDatasource.kt

import io.agroal.api.AgroalDataSource
import io.agroal.api.AgroalDataSourceMetrics
import io.agroal.api.AgroalPoolInterceptor
import io.agroal.api.configuration.AgroalDataSourceConfiguration
import io.quarkus.agroal.DataSource
import io.quarkus.test.Mock
import java.io.PrintWriter
import java.sql.Connection
import java.util.logging.Logger
import javax.enterprise.context.ApplicationScoped

@Mock
@ApplicationScoped
@DataSource("localstorage")
public class MockLocalstorageDatasource : AgroalDataSource {
    override fun close() {
        TODO("Not yet implemented")
    }

    override fun getLogWriter(): PrintWriter {
        TODO("Not yet implemented")
    }

    override fun setLogWriter(out: PrintWriter?) {
        TODO("Not yet implemented")
    }

    override fun setLoginTimeout(seconds: Int) {
        TODO("Not yet implemented")
    }

    override fun getLoginTimeout(): Int {
        TODO("Not yet implemented")
    }

    override fun getParentLogger(): Logger {
        TODO("Not yet implemented")
    }

    override fun <T : Any?> unwrap(iface: Class<T>?): T {
        TODO("Not yet implemented")
    }

    override fun isWrapperFor(iface: Class<*>?): Boolean {
        TODO("Not yet implemented")
    }

    override fun getConnection(): Connection {
        TODO("Not yet implemented")
    }

    override fun getConnection(username: String?, password: String?): Connection {
        TODO("Not yet implemented")
    }

    override fun getConfiguration(): AgroalDataSourceConfiguration {
        TODO("Not yet implemented")
    }

    override fun getMetrics(): AgroalDataSourceMetrics {
        TODO("Not yet implemented")
    }

    override fun flush(mode: AgroalDataSource.FlushMode?) {
        TODO("Not yet implemented")
    }

    override fun setPoolInterceptors(interceptors: MutableCollection<out AgroalPoolInterceptor>?) {
        TODO("Not yet implemented")
    }

    override fun getPoolInterceptors(): MutableList<AgroalPoolInterceptor> {
        TODO("Not yet implemented")
    }
}

Now I'm getting a different exception:

java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkus.datasource.deployment.devservices.DevServicesDatasourceProcessor#launchDatabases threw an exception: java.lang.IllegalStateException: Please configure the datasource URL for the default datasource or ensure the Docker daemon is up and running.
	at io.quarkus.datasource.deployment.devservices.DevServicesDatasourceProcessor.startDevDb(DevServicesDatasourceProcessor.java:253)
	at io.quarkus.datasource.deployment.devservices.DevServicesDatasourceProcessor.launchDatabases(DevServicesDatasourceProcessor.java:136)

[jehrenzweig-leagueapps]

Aight, I added the %test profile's H2 localstorage datasource declaration back in. Now I'm getting this compile-time exception:

lateinit property widgetRepository has not been initialized
kotlin.UninitializedPropertyAccessException: lateinit property widgetRepository has not been initialized
	at com.leagueapps.services.widget.controllers.WidgetControllerImplTest.setupMocks(WidgetControllerImplTest.kt:31)

What additional code do I need add, to ensure the test class is satisfied? Here's what it currently looks like:

WidgetControllerImplTest.kit

@InjectSpy
private lateinit var WidgetManager : WidgetApiManager

@InjectMock
private lateinit var WidgetRepository: WidgetRepository

@QuarkusTest
internal class WidgetControllerImplTest {
    @BeforeEach
    fun setupMocks() {
        QuarkusMock.installMockForType(WidgetRepository, WidgetRepository::class.java)
    }

    @Test
    fun `DERP`() {
        every { WidgetRepository.getWidgetSettingsById(1) } returns WidgetSettings(1, "foo", "bar")

        given()
            .`when`()
                .get("/widgets/1/settings")
            .then()
                .statusCode(200)
    }
}

[yrodiere]

I'm not really the person to ask about Kotlin... it's a miracle I even know what lateinit means :)

Maybe trying moving those things inside WidgetControllerImplTest? Also, make them package-protected (is that a thing in Kotlin) or public?

[jehrenzweig-leagueapps]

@yrodiere hehe... yeah, I'm still relatively new to Kotlin, too. Anyway, I moved the lateinit statements inside my test class as suggested -- and now the test class runs green! FWIW I only had those lateinit statements outside the test because this relatively recent article on Quarkus testing w/ Kotlin + Mockk used that approach. I'm used to having dependencies declared as private fields inside my Java classes anyway, so I'll make sure I keep doing that in Kotlin going forward.

Thank you so much for sticking with me on this -- I greatly appreciate your patience & help. I'm sure there's still a bunch of challenges that await me, as I try to write my first set of API tests, but at least this blocking problem is solved. Cheers!

[yrodiere]

No problem, glad you solved it :)

[jehrenzweig-leagueapps]

A quick summary on the solution to my problem, for anyone else who comes this way looking for answers:

• Do not mock the AgroalDatasource dependency that's injected into the repository class; that workflow isn't supported.
• Declare the variables to be injected as dependencies into the test class as private lateinit fields inside the class. That's very important.
• Make sure you declare a datasource for your test profile in application.yml or application.properties, just like you do for your other production and pre-production profiles (e.g. %prod, %localhost), even though you may not activate need or choose to use it in your test. Quarkus needs some datasource to inject to satisfy the repository class' datasource dependency.

Here's what my working test class looks like:

WidgetControllerImplTest.kit

import com.leagueapps.services.widget.abstractions.dataaccess.WidgetRepository
import com.leagueapps.services.widget.abstractions.managers.WidgetManager
import com.leagueapps.services.widget.models.db.entities.WidgetSettings
import io.mockk.*
import io.quarkiverse.test.junit.mockk.InjectMock
import io.quarkiverse.test.junit.mockk.InjectSpy
import io.quarkus.test.junit.QuarkusMock
import io.quarkus.test.junit.QuarkusTest
import io.restassured.RestAssured.given
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test

@QuarkusTest
internal class WidgetControllerImplTest {
    @InjectSpy
    private lateinit var WidgetManager : WidgetApiManager

    @InjectMock
    private lateinit var WidgetRepository: WidgetRepository

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

    @Test
    fun `DERP`() {
        every { WidgetRepository.getWidgetSettingsById(1) } returns WidgetSettings(1, "foo", "bar")

        given()
            .`when`()
                .get("/widgets/1/settings")
            .then()
                .statusCode(200)
    }
}

[cleutonleagueapps]

Hi, I worked with @jehrenzweig-leagueapps to find a solution to this problem. AgroalDatasource cannot be mocked. If you need to mock low level objects, like: Connection, PreparedStatement, and ResultSet, you need to mock the Datasource. So, create an ApplicationScoped bean that receives the AgroalDatasource in constructor, and have a method that returns the datasoure cast as java.sql.Datasource (not AgroalDatasource).
Inject this bean in the class you create connections and use the returned Datasource.
On your test script, you can mock the connection and datasource using mockito and quarkusmock, like this:

    @Test
    fun  `test statusCode 200`() {
        var mockDs: DataSource = Mockito.mock()
        var mockDsp: DataSourceProvider = Mockito.mock()
        QuarkusMock.installMockForType(mockDsp, DataSourceProvider::class.java)
...

This way you can mock persistence on your tests. When you run "quarkus test" you'll be using your mocks. When you run "quarkus dev" you'll be using your dev database config.