Merge pull request #57 from rootstrap/unit_test

agustinkoll-rootstrap · web-flow · commit 8b06b7f8c8a6 · 2022-01-11T09:49:12.000-03:00
Unit test examples with coroutines
diff --git a/app/build.gradle b/app/build.gradle
@@ -141,9 +141,10 @@ android {
 dependencies {
     def room_version = "2.3.0"
     def lifecycle_version = "2.4.0"
+    def mockkVersion = '1.12.0'
 
     implementation fileTree(include: ['*.jar'], dir: 'libs')
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.0'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.1'
     implementation 'androidx.appcompat:appcompat:1.3.1'
     implementation 'androidx.core:core-ktx:1.7.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
@@ -152,6 +153,10 @@ dependencies {
     implementation 'com.google.android.material:material:1.4.0'
     testImplementation 'junit:junit:4.13.1'
     testImplementation 'org.mockito:mockito-core:2.28.2'
+    testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.5.1"
+    testImplementation 'android.arch.core:core-testing:1.1.1'
+    testImplementation "io.mockk:mockk:$mockkVersion"
+
     androidTestImplementation 'androidx.test:runner:1.4.0'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
     androidTestImplementation 'androidx.test.espresso:espresso-intents:3.4.0'
diff --git a/app/src/main/java/com/rootstrap/android/ui/activity/main/SignInActivityViewModel.kt b/app/src/main/java/com/rootstrap/android/ui/activity/main/SignInActivityViewModel.kt
@@ -8,6 +8,7 @@ import com.rootstrap.android.network.managers.user.UserManager
 import com.rootstrap.android.network.models.User
 import com.rootstrap.android.ui.base.BaseViewModel
 import com.rootstrap.android.util.NetworkState
+import com.rootstrap.android.util.dispatcher.DispatcherProvider
 import com.rootstrap.android.util.extensions.ApiErrorType
 import com.rootstrap.android.util.extensions.ApiException
 import dagger.hilt.android.lifecycle.HiltViewModel
@@ -17,7 +18,8 @@ import javax.inject.Inject
 @HiltViewModel
 open class SignInActivityViewModel @Inject constructor(
     private val sessionManager: SessionManager,
-    private val userManager: UserManager
+    private val userManager: UserManager,
+    private val dispatcher: DispatcherProvider
 ) : BaseViewModel() {
 
     private val _state = MutableLiveData<SignInState>()
@@ -26,7 +28,8 @@ open class SignInActivityViewModel @Inject constructor(
 
     fun signIn(user: User) {
         _networkState.value = NetworkState.loading
-        viewModelScope.launch {
+        // Avoid using hardcoded dispatcher this way can be mocked later
+        viewModelScope.launch(dispatcher.io) {
             val result = userManager.signIn(user = user)
             if (result.isSuccess) {
                 result.getOrNull()?.value?.user?.let { user ->
@@ -46,7 +49,6 @@ open class SignInActivityViewModel @Inject constructor(
             exception.message
         } else null
 
-        _networkState.value = NetworkState.idle
         _networkState.value = NetworkState.error
         _state.value = SignInState.signInFailure
     }
diff --git a/app/src/main/java/com/rootstrap/android/ui/activity/main/SignUpActivityViewModel.kt b/app/src/main/java/com/rootstrap/android/ui/activity/main/SignUpActivityViewModel.kt
@@ -8,6 +8,7 @@ import com.rootstrap.android.network.managers.user.UserManager
 import com.rootstrap.android.network.models.User
 import com.rootstrap.android.ui.base.BaseViewModel
 import com.rootstrap.android.util.NetworkState
+import com.rootstrap.android.util.dispatcher.DispatcherProvider
 import com.rootstrap.android.util.extensions.ApiErrorType
 import com.rootstrap.android.util.extensions.ApiException
 import dagger.hilt.android.lifecycle.HiltViewModel
@@ -17,7 +18,8 @@ import javax.inject.Inject
 @HiltViewModel
 open class SignUpActivityViewModel @Inject constructor(
     private val sessionManager: SessionManager,
-    private val userManager: UserManager
+    private val userManager: UserManager,
+    private val dispatcher: DispatcherProvider
 ) : BaseViewModel() {
 
     private val _state = MutableLiveData<SignUpState>()
@@ -26,7 +28,8 @@ open class SignUpActivityViewModel @Inject constructor(
 
     fun signUp(user: User) {
         _networkState.value = NetworkState.loading
-        viewModelScope.launch {
+        // Avoid using hardcoded dispatcher this way can be mocked later
+        viewModelScope.launch(dispatcher.io) {
             val result = userManager.signUp(user = user)
 
             if (result.isSuccess) {
@@ -47,7 +50,6 @@ open class SignUpActivityViewModel @Inject constructor(
             exception.message
         } else null
 
-        _networkState.value = NetworkState.idle
         _networkState.value = NetworkState.error
         _state.value = SignUpState.signUpFailure
     }
diff --git a/app/src/main/java/com/rootstrap/android/util/UtilModule.kt b/app/src/main/java/com/rootstrap/android/util/UtilModule.kt
@@ -7,6 +7,8 @@ import android.security.keystore.KeyProperties
 import androidx.security.crypto.EncryptedSharedPreferences
 import androidx.security.crypto.MasterKey
 import com.rootstrap.android.BuildConfig
+import com.rootstrap.android.util.dispatcher.AppDispatcherProvider
+import com.rootstrap.android.util.dispatcher.DispatcherProvider
 import com.squareup.otto.Bus
 import dagger.Module
 import dagger.Provides
@@ -48,4 +50,8 @@ class UtilModule {
     @Provides
     @Singleton
     fun provideBus(): Bus = Bus()
+
+    @Provides
+    @Singleton
+    fun provideDispatcher(): DispatcherProvider = AppDispatcherProvider()
 }
diff --git a/app/src/main/java/com/rootstrap/android/util/dispatcher/AppDispatcherProvider.kt b/app/src/main/java/com/rootstrap/android/util/dispatcher/AppDispatcherProvider.kt
@@ -0,0 +1,11 @@
+package com.rootstrap.android.util.dispatcher
+
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+
+class AppDispatcherProvider : DispatcherProvider {
+    override val io: CoroutineDispatcher = Dispatchers.IO
+    override val default: CoroutineDispatcher = Dispatchers.Default
+    override val main: CoroutineDispatcher = Dispatchers.Main
+    override val unconfined: CoroutineDispatcher = Dispatchers.Unconfined
+}
diff --git a/app/src/main/java/com/rootstrap/android/util/dispatcher/DispatcherProvider.kt b/app/src/main/java/com/rootstrap/android/util/dispatcher/DispatcherProvider.kt
@@ -0,0 +1,10 @@
+package com.rootstrap.android.util.dispatcher
+
+import kotlinx.coroutines.CoroutineDispatcher
+
+interface DispatcherProvider {
+    val io: CoroutineDispatcher
+    val default: CoroutineDispatcher
+    val main: CoroutineDispatcher
+    val unconfined: CoroutineDispatcher
+}
diff --git a/app/src/test/java/com/rootstrap/android/SignInActivityViewModelTest.kt b/app/src/test/java/com/rootstrap/android/SignInActivityViewModelTest.kt
@@ -0,0 +1,89 @@
+package com.rootstrap.android
+
+import com.rootstrap.android.network.managers.session.SessionManager
+import com.rootstrap.android.network.managers.user.UserManager
+import com.rootstrap.android.network.models.User
+import com.rootstrap.android.network.models.UserSerializer
+import com.rootstrap.android.test.TestDispatcherProvider
+import com.rootstrap.android.test.UnitTestBase
+import com.rootstrap.android.ui.activity.main.SignInActivityViewModel
+import com.rootstrap.android.ui.activity.main.SignInState
+import com.rootstrap.android.util.NetworkState
+import com.rootstrap.android.util.extensions.ApiException
+import com.rootstrap.android.util.extensions.Data
+import io.mockk.coEvery
+import io.mockk.coVerify
+import io.mockk.every
+import io.mockk.impl.annotations.MockK
+import io.mockk.impl.annotations.RelaxedMockK
+import io.mockk.verify
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Test
+
+@ExperimentalCoroutinesApi
+class SignInActivityViewModelTest : UnitTestBase() {
+
+    private lateinit var viewModel: SignInActivityViewModel
+
+    @RelaxedMockK
+    lateinit var sessionManager: SessionManager
+
+    @RelaxedMockK
+    lateinit var userManager: UserManager
+
+    @MockK
+    lateinit var user: User
+
+    @MockK
+    lateinit var userSerializer: UserSerializer
+
+    companion object {
+        const val ERROR_EXAMPLE_TEXT = "Time out example"
+    }
+
+    @Before
+    override fun setup() {
+        super.setup()
+        every { userSerializer.user } returns user
+        viewModel = SignInActivityViewModel(sessionManager, userManager, TestDispatcherProvider())
+    }
+
+    // reading: naming standards for unit testing https://osherove.com/blog/2005/4/3/naming-standards-for-unit-tests.html
+    @Test
+    fun `signIn success assert signInSuccess and network idle`() {
+        var state: SignInState? = null
+        coEvery { userManager.signIn(user = user) } returns Result.success(Data(userSerializer))
+
+        viewModel.signIn(user)
+        viewModel.state.observeForever {
+            state = it
+        }
+
+        assertEquals(state, SignInState.signInSuccess)
+        assertEquals(viewModel.networkState.value, NetworkState.idle)
+        verify { sessionManager.signIn(user) }
+        coVerify { userManager.signIn(user = user) }
+    }
+
+    @Test
+    fun `signIn fail assert signInFailure and network error`() {
+        var state: SignInState? = null
+        coEvery { userManager.signIn(user = user) } returns Result.failure(
+            ApiException(
+                ERROR_EXAMPLE_TEXT
+            )
+        )
+
+        viewModel.signIn(user)
+        viewModel.state.observeForever {
+            state = it
+        }
+
+        assertEquals(state, SignInState.signInFailure)
+        assertEquals(viewModel.networkState.value, NetworkState.error)
+        assertEquals(viewModel.error, ERROR_EXAMPLE_TEXT)
+        coVerify { userManager.signIn(user = user) }
+    }
+}
diff --git a/app/src/test/java/com/rootstrap/android/SignUpActivityViewModelTest.kt b/app/src/test/java/com/rootstrap/android/SignUpActivityViewModelTest.kt
@@ -0,0 +1,88 @@
+package com.rootstrap.android
+
+import com.rootstrap.android.network.managers.session.SessionManager
+import com.rootstrap.android.network.managers.user.UserManager
+import com.rootstrap.android.network.models.User
+import com.rootstrap.android.network.models.UserSerializer
+import com.rootstrap.android.test.TestDispatcherProvider
+import com.rootstrap.android.test.UnitTestBase
+import com.rootstrap.android.ui.activity.main.SignUpActivityViewModel
+import com.rootstrap.android.ui.activity.main.SignUpState
+import com.rootstrap.android.util.NetworkState
+import com.rootstrap.android.util.extensions.ApiException
+import com.rootstrap.android.util.extensions.Data
+import io.mockk.coEvery
+import io.mockk.coVerify
+import io.mockk.every
+import io.mockk.impl.annotations.MockK
+import io.mockk.impl.annotations.RelaxedMockK
+import io.mockk.verify
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Test
+
+@ExperimentalCoroutinesApi // This annotation is required to use TestDispatcherProvider is still an experiment
+class SignUpActivityViewModelTest : UnitTestBase() {
+
+    private lateinit var viewModel: SignUpActivityViewModel
+
+    @RelaxedMockK
+    lateinit var sessionManager: SessionManager
+
+    @RelaxedMockK
+    lateinit var userManager: UserManager
+
+    @MockK
+    lateinit var user: User
+
+    @MockK
+    lateinit var userSerializer: UserSerializer
+
+    companion object {
+        const val ERROR_EXAMPLE_TEXT = "Time out example"
+    }
+
+    @Before
+    override fun setup() {
+        super.setup()
+        every { userSerializer.user } returns user
+        viewModel = SignUpActivityViewModel(sessionManager, userManager, TestDispatcherProvider())
+    }
+
+    @Test
+    fun `signUp success assert signUpSuccess and network idle`() {
+        var state: SignUpState? = null
+        coEvery { userManager.signUp(user = user) } returns Result.success(Data(userSerializer))
+
+        viewModel.signUp(user)
+        viewModel.state.observeForever {
+            state = it
+        }
+
+        assertEquals(state, SignUpState.signUpSuccess)
+        assertEquals(viewModel.networkState.value, NetworkState.idle)
+        verify { sessionManager.signIn(user) }
+        coVerify { userManager.signUp(user = user) }
+    }
+
+    @Test
+    fun `signUp fail assert signUpFailure and network error`() {
+        var state: SignUpState? = null
+        coEvery { userManager.signUp(user = user) } returns Result.failure(
+            ApiException(
+                ERROR_EXAMPLE_TEXT
+            )
+        )
+
+        viewModel.signUp(user)
+        viewModel.state.observeForever {
+            state = it
+        }
+
+        assertEquals(state, SignUpState.signUpFailure)
+        assertEquals(viewModel.networkState.value, NetworkState.error)
+        assertEquals(viewModel.error, ERROR_EXAMPLE_TEXT)
+        coVerify { userManager.signUp(user = user) }
+    }
+}
diff --git a/app/src/test/java/com/rootstrap/android/ValidationTests.kt b/app/src/test/java/com/rootstrap/android/ValidationTests.kt
@@ -4,7 +4,7 @@ import com.rootstrap.android.util.extensions.isEmail
 import org.junit.Assert.assertEquals
 import org.junit.Test
 
-public class ValidationTests {
+class ValidationTests {
     @Test
     fun checkEmailTest() {
         assertEquals(true, "email@mkdi.com".isEmail())
diff --git a/app/src/test/java/com/rootstrap/android/test/TestDispatcherProvider.kt b/app/src/test/java/com/rootstrap/android/test/TestDispatcherProvider.kt
@@ -0,0 +1,15 @@
+package com.rootstrap.android.test
+
+import com.rootstrap.android.util.dispatcher.DispatcherProvider
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.TestCoroutineDispatcher
+
+@ExperimentalCoroutinesApi
+class TestDispatcherProvider(testCoroutineDispatcher: TestCoroutineDispatcher = TestCoroutineDispatcher()) :
+    DispatcherProvider {
+    override val default: CoroutineDispatcher = testCoroutineDispatcher
+    override val main: CoroutineDispatcher = testCoroutineDispatcher
+    override val io: CoroutineDispatcher = testCoroutineDispatcher
+    override val unconfined: CoroutineDispatcher = testCoroutineDispatcher
+}
diff --git a/app/src/test/java/com/rootstrap/android/test/UnitTestBase.kt b/app/src/test/java/com/rootstrap/android/test/UnitTestBase.kt
@@ -0,0 +1,19 @@
+package com.rootstrap.android.test
+
+import androidx.annotation.CallSuper
+import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import io.mockk.MockKAnnotations
+import org.junit.Before
+import org.junit.Rule
+
+abstract class UnitTestBase {
+
+    @get:Rule
+    val instantExecutorRule = InstantTaskExecutorRule()
+
+    @CallSuper
+    @Before
+    open fun setup() {
+        MockKAnnotations.init(this)
+    }
+}
