Koin - how to provide mock ViewModel for espresso test?

Question

How can we inject mocked viewModel into Activity for espresso test? Using declareMock I get mock object in Test class but Activity receives regular viewModel object.

@RunWith(AndroidJUnit4::class)
class SomeActivityTest : KoinTest {
    @Rule
    @JvmField
    val rule = ActivityTestRule(SomeActivity::class.java, true, true)
    val viewModel: MyViewModel by inject()

    @Before
    fun setup() {
        declareMock<MyViewModel>(isFactory = true, binds = listOf(ViewModel::class))
    }

    @After
    fun cleanUp() {
        stopKoin()
    }

    @Test
    fun shouldHaveTextViewVisible() {
        `when`(viewModel.sayHello())
                .thenReturn("hello view-model")
        onView(withId(R.id.tv_homescreen_message))
                .check(matches(isDisplayed()))
        onView(withId(R.id.tv_homescreen_message))
                .check(matches(withText("hello view-model")))
    }
}

score 15 · Accepted Answer · answered Oct 16 '18 at 17:42

In this case, Espresso test were still using main application class which declares all koin module required for app.

Starting koin without any modules, allows us to load only required modules during test.

// application class for espresso tests
class TestApp : Application() {
    override fun onCreate() {
        super.onCreate()
        startKoin(this, emptyList())
    }
}

class TestAppJUnitRunner : AndroidJUnitRunner() {
    override fun newApplication(cl: ClassLoader?, className: String?, context: Context?): Application {
        return super.newApplication(cl, TestApp::class.java.name, context)
    }
}

// app module build.gradle
android {
    defaultConfig {
        testInstrumentationRunner "com.package.TestAppJUnitRunner"
    }
}

It is important to declare mock method before starting activity

@RunWith(AndroidJUnit4::class)
class SomeActivityTest : KoinTest {
    @Rule
    @JvmField
    val rule = ActivityTestRule(SomeActivity::class.java, true, false)

    lateinit var mockVm: MyViewModel


    @Before
    fun setup() {
        mockVm = mock(MyViewModel::class.java)

        loadKoinModules(module {
            viewModel {
                mockVm
            }
        })
    }

    @After
    fun cleanUp() {
        stopKoin()
    }

    @Test
    fun shouldHaveTextViewWithMessage() {
        // 1. declare mock method
        val message = "hello view-model"
        Mockito.`when`(mockVm.sayHello())
                .thenReturn(message)

        // 2. start activity
        rule.launchActivity(null)


        // 3. test
        onView(withId(R.id.tv_message))
                .check(matches(isDisplayed()))

        onView(withId(R.id.tv_message))
                .check(matches(withText(message)))
    }
}

Sample code

I received this : `Mockito cannot mock/spy because : - final class` — milad salimi, Nov 01 '21 at 12:32
@miladsalimi I've annotated it with `@OpenForTesting`. check the source code I've shared. — Rohit Karadkar, Nov 02 '21 at 05:46
How can i use this annotated ? with all-open compiler plugin? — milad salimi, Nov 02 '21 at 06:54
Thanks , please see https://stackoverflow.com/questions/69808166/donothing-does-not-work-when-i-want-to-mock-data-and-test-ui-fragment — milad salimi, Nov 02 '21 at 10:14

Koin - how to provide mock ViewModel for espresso test?

1 Answers1