Contents

Unit testing with coroutines

Contents

https://1.bp.blogspot.com/-7_lhiR915Ek/Xa2jYhwlyRI/AAAAAAAAQAc/8bJT8qOl7WA7TUdM4B20VPQOZ6p2TNuigCLcBGAsYHQ/s1600/adi-goldstein-B2sNfHkjagM-unsplash.jpg

The coroutines API has already brought some innovation in the Android and Kotlin world. I always loved the idea of keeping it as simple as we all can. There is a saying around here that “Whoever talks to much, makes too much mistakes” and I see this a little bit related to Java’s verbosity and also in the world of concurrency. It’s said over and over again that concurrency is not simple and I couldn’t agree more: You have to care about context, jobs running in parallel, cancelation, returning values etc.

I hope I gave my best in one of my previous articles explaining Kotlin Coroutines, therefore I will cover the testing tool of them today.

As usual, some might still fear testing, but I really find it so entertaining. But there is no new concept to add to software testing when talking about coroutines, except just defining a “default” TestCoroutineDispatcher which is only a CoroutineDispatcher which runs immediate and lazy code the same way. In other words, a Test Double for CoroutineDispatcher (not sure if it is a Fake).

So let’s test. As explained we should be able to do it, once we have the dependency in our module:

testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.3.2'

After that we only need to add some small configurations for our testing to start, as described above:

@RunWith(JUnit4::class)
@ExperimentalCoroutinesApi //mark the class better, otherwise you should mark all variables and methods where coroutines testing is involved
class HomeRepositoryTest {
    private lateinit var homeRepository: HomeRepository
    private lateinit var someApi: SomeApi
    private val testDispatcher = TestCoroutineDispatcher() // the dispatcher

    @Before
    fun setUp() {
        //...... mocs and initialisations here
        Dispatchers.setMain(testDispatcher) //set the coroutine context
    }

    @After
    fun tearDown() {
        print("Test has finished")
        Dispatchers.resetMain() //reset
        testDispatcher.cleanupTestCoroutines() // clear all
    }
   }
Note
Note: The coroutines testing API is still experimental,  so in order not to annotate all variables and methods with @ExperimentalCoroutinesApi just annotate the class under test (should save you time).

After that, the only new thing around here is the runBlockingTest clause (i like to call lambdas this way but it’s a method) which of course is an imitation of  the runBlocking. You should be able to pass the testDispatcher as an argument but it’s not mandatory:

    @Test
    fun `my awful unit test should do something`() = runBlockingTest(testDispatcher) {
        `when`(rocket.readInt(GREGORIAN_DAY_KEY)).thenReturn(0)

        val day = homeRepository.getCurrentRegisteredDay() //this method is marked with suspend

        assertEquals(0, day)
    }

And that’s it.

Note
Note: If you don’t trust experimental API’s yet, you are free to test with runBlocking even if it is not very much recommended that way (it could be a little redundant for this case).

Conclusion

Since I already mentioned that concurrency is hard, and coroutines made it simple, there should be a nice tool to make testing them simple also. And the coroutines testing API is the answer. More about the dependency in the documentation page.

Stavro Xhardha.