Streamlined use case stubbing using extension functions. (#386)

Author: EranBoudjnah

architecture/presentation-test/src/main/java/com/mitteloupe/whoami/architecture/presentation/viewmodel/BaseViewModelTest.kt

@@ -47,8 +47,7 @@ abstract class BaseViewModelTest<
         Dispatchers.resetMain()
     }
 
-    protected fun <REQUEST> givenFailedUseCaseExecution(
-        useCase: UseCase<REQUEST, *>,
+    protected fun <REQUEST> UseCase<REQUEST, *>.givenFailedExecution(
         input: REQUEST,
         domainException: DomainException
     ) {
@@ -59,57 +58,52 @@ abstract class BaseViewModelTest<
                 onException(domainException)
             }.given(useCaseExecutor)
                 .execute(
-                    useCase = eq(useCase),
+                    useCase = eq(this@givenFailedExecution),
                     value = eq(input),
                     onResult = any(),
                     onException = any()
                 )
         }
     }
 
-    protected fun <REQUEST, RESULT> givenSuccessfulUseCaseExecution(
-        useCase: UseCase<REQUEST, RESULT>,
+    protected fun <REQUEST, RESULT> UseCase<REQUEST, RESULT>.givenSuccessfulExecution(
         input: REQUEST,
         result: RESULT
     ) {
         willAnswer { invocationOnMock ->
             val onResult: (RESULT) -> Unit = invocationOnMock.getArgument(2)
             onResult(result)
         }.given(useCaseExecutor).execute(
-            useCase = eq(useCase),
+            useCase = eq(this@givenSuccessfulExecution),
             value = eq(input),
             onResult = any(),
             onException = any()
         )
     }
 
-    protected fun <REQUEST> givenSuccessfulNoResultUseCaseExecution(
-        useCase: UseCase<REQUEST, Unit>,
+    protected fun <REQUEST> UseCase<REQUEST, Unit>.givenSuccessfulNoResultExecution(
         input: REQUEST
     ) {
-        givenSuccessfulUseCaseExecution(useCase, input, Unit)
+        givenSuccessfulExecution(input, Unit)
     }
 
-    protected fun <RESULT> givenSuccessfulUseCaseExecution(
-        useCase: UseCase<Unit, RESULT>,
-        result: RESULT
-    ) {
+    protected fun <RESULT> UseCase<Unit, RESULT>.givenSuccessfulExecution(result: RESULT) {
         willAnswer { invocationOnMock ->
             val onResult: (RESULT) -> Unit = invocationOnMock.getArgument(1)
             onResult(result)
         }.given(useCaseExecutor).execute(
-            useCase = eq(useCase),
+            useCase = eq(this@givenSuccessfulExecution),
             onResult = any(),
             onException = any()
         )
     }
 
-    protected fun givenSuccessfulNoArgumentNoResultUseCaseExecution(useCase: UseCase<Unit, Unit>) {
+    protected fun UseCase<Unit, Unit>.givenSuccessfulNoArgumentNoResultExecution() {
         willAnswer { invocationOnMock ->
             val onResult: (Unit) -> Unit = invocationOnMock.getArgument(2)
             onResult(Unit)
         }.given(useCaseExecutor).execute(
-            useCase = eq(useCase),
+            useCase = eq(this@givenSuccessfulNoArgumentNoResultExecution),
             onResult = any(),
             onException = any()
         )

history/presentation/src/test/java/com/mitteloupe/whoami/history/presentation/viewmodel/HistoryViewModelTest.kt

@@ -73,7 +73,7 @@ class HistoryViewModelTest :
                 givenIpAddressRecord2 = givenIpAddressRecord2
             )
             val givenHistory = setOf(givenIpAddressRecord1, givenIpAddressRecord2)
-            givenSuccessfulUseCaseExecution(getHistoryUseCase, givenHistory)
+            getHistoryUseCase.givenSuccessfulExecution(givenHistory)
             val highlightedIpAddress: String? = null
 
             val deferredViewState = async(start = UNDISPATCHED) {
@@ -108,7 +108,7 @@ class HistoryViewModelTest :
         val givenIpAddressRecord1 = domainHistoryRecord("0.0.0.0")
         val givenIpAddressRecord2 = domainHistoryRecord("1.1.1.1")
         val givenHistory = setOf(givenIpAddressRecord1, givenIpAddressRecord2)
-        givenSuccessfulUseCaseExecution(getHistoryUseCase, givenHistory)
+        getHistoryUseCase.givenSuccessfulExecution(givenHistory)
         val highlightedIpAddress = "0.0.0.0"
         val deferredViewState = async(start = UNDISPATCHED) {
             classUnderTest.viewState.take(2).toList()

home/presentation/src/test/java/com/mitteloupe/whoami/home/presentation/viewmodel/HomeViewModelTest.kt

@@ -65,10 +65,7 @@ class HomeViewModelTest :
     fun `Given disconnected when onEnter then presents disconnected state`() = runTest {
         // Given
         val givenConnectionState = Disconnected
-        givenSuccessfulUseCaseExecution(
-            getConnectionDetailsUseCase,
-            givenConnectionState
-        )
+        getConnectionDetailsUseCase.givenSuccessfulExecution(givenConnectionState)
         val expectedViewState = HomeViewState.Disconnected
         given { connectionDetailsPresentationMapper.toPresentation(givenConnectionState) }
             .willReturn(expectedViewState)
@@ -93,10 +90,7 @@ class HomeViewModelTest :
             val domainConnectionDetails = domainConnectionDetails(ipAddress)
             given { connectionDetailsDomainMapper.toDomain(givenConnectionDetails) }
                 .willReturn(domainConnectionDetails)
-            givenSuccessfulNoResultUseCaseExecution(
-                saveConnectionDetailsUseCase,
-                domainConnectionDetails
-            )
+            saveConnectionDetailsUseCase.givenSuccessfulNoResultExecution(domainConnectionDetails)
             val deferredNotification = async(start = UNDISPATCHED) {
                 classUnderTest.notification.first()
             }
@@ -123,10 +117,7 @@ class HomeViewModelTest :
         val domainConnectionDetails = domainConnectionDetails(ipAddress)
         given { connectionDetailsDomainMapper.toDomain(givenConnectionDetails) }
             .willReturn(domainConnectionDetails)
-        givenSuccessfulNoResultUseCaseExecution(
-            saveConnectionDetailsUseCase,
-            domainConnectionDetails
-        )
+        saveConnectionDetailsUseCase.givenSuccessfulNoResultExecution(domainConnectionDetails)
 
         // When
         classUnderTest.onSaveDetailsAction(givenConnectionDetails)
@@ -147,10 +138,7 @@ class HomeViewModelTest :
         val domainConnectionDetails = domainConnectionDetails(ipAddress)
         given { connectionDetailsDomainMapper.toDomain(givenConnectionDetails) }
             .willReturn(domainConnectionDetails)
-        givenSuccessfulNoResultUseCaseExecution(
-            saveConnectionDetailsUseCase,
-            domainConnectionDetails
-        )
+        saveConnectionDetailsUseCase.givenSuccessfulNoResultExecution(domainConnectionDetails)
         val deferredNotification = async(start = UNDISPATCHED) {
             classUnderTest.notification.first()
         }
@@ -172,10 +160,7 @@ class HomeViewModelTest :
             val domainConnectionDetails = domainConnectionDetails(ipAddress)
             given { connectionDetailsDomainMapper.toDomain(givenConnectionDetails) }
                 .willReturn(domainConnectionDetails)
-            givenSuccessfulNoResultUseCaseExecution(
-                saveConnectionDetailsUseCase,
-                domainConnectionDetails
-            )
+            saveConnectionDetailsUseCase.givenSuccessfulNoResultExecution(domainConnectionDetails)
             val deferredNavigationEvent = async(start = UNDISPATCHED) {
                 classUnderTest.navigationEvent.first()
             }