update log tests

Author: hoc081098

.github/workflows/build.yml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches: [ master ]
 
+env:
+  CI: true
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/review-suggest.yml

@@ -2,6 +2,10 @@ name: reviewdog-suggester
 on:
   pull_request:
     types: [opened, synchronize, reopened]
+
+env:
+  CI: true
+
 jobs:
   kotlin:
     name: runner / suggester / spotless

.github/workflows/unit-test.yml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches: [ master ]
 
+env:
+  CI: true
+
 jobs:
   build:
     runs-on: ubuntu-latest

buildSrc/src/main/kotlin/deps.kt

@@ -1,5 +1,6 @@
 @file:Suppress("unused", "ClassName", "SpellCheckingInspection")
 
+import org.gradle.api.Project
 import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.kotlin.dsl.project
 import org.gradle.plugin.use.PluginDependenciesSpec
@@ -114,3 +115,8 @@ fun DependencyHandler.addUnitTest(testImplementation: Boolean = true) {
   add(configName, deps.test.kotlinJUnit)
   add(configName, deps.coroutines.test)
 }
+
+val Project.isCiBuild: Boolean
+  get() = providers.environmentVariable("CI")
+    .forUseAtConfigurationTime()
+    .orNull == "true"

mvi/mvi-testing/build.gradle.kts

@@ -16,12 +16,28 @@ android {
   }
 
   buildTypes {
+    debug {
+      (!isCiBuild).let {
+        buildConfigField(
+          type = it::class.java.simpleName,
+          name = "ENABLE_LOG_TEST",
+          value = it.toString(),
+        )
+      }
+    }
     release {
       isMinifyEnabled = false
       proguardFiles(
         getDefaultProguardFile("proguard-android-optimize.txt"),
         "proguard-rules.pro"
       )
+      false.let {
+        buildConfigField(
+          type = it::class.java.simpleName,
+          name = "ENABLE_LOG_TEST",
+          value = it.toString(),
+        )
+      }
     }
   }
   compileOptions {

mvi/mvi-testing/src/main/java/com/flowmvi/mvi_testing/BaseMviViewModelTest.kt

@@ -14,6 +14,7 @@ import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.flow.onCompletion
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.test.runBlockingTest
@@ -54,26 +55,37 @@ abstract class BaseMviViewModelTest<
     expectedStates: List<Either<(S) -> Unit, S>>,
     expectedEvents: List<Either<(E) -> Unit, E>>,
     delayAfterDispatchingIntents: Duration = Duration.ZERO,
-    logging: Boolean = true,
+    logging: Boolean = BuildConfig.ENABLE_LOG_TEST,
     intentsBeforeCollecting: Flow<I>? = null,
     otherAssertions: (suspend () -> Unit)? = null,
   ) = testDispatcher.runBlockingTest {
+    fun logIfEnabled(s: () -> String) = if (logging) println(s()) else Unit
+
     val vm = vmProducer()
-    intentsBeforeCollecting?.collect { vm.processIntent(it) }
+    intentsBeforeCollecting
+      ?.onCompletion { logIfEnabled { "---------------" } }
+      ?.collect {
+        vm.processIntent(it)
+        logIfEnabled { "[BEFORE] Dispatch $it -> $vm" }
+      }
+
+    logIfEnabled { "[START] $vm" }
 
     val states = mutableListOf<S>()
     val events = mutableListOf<E>()
 
     val stateJob = launch(start = CoroutineStart.UNDISPATCHED) { vm.viewState.toList(states) }
     val eventJob = launch(start = CoroutineStart.UNDISPATCHED) { vm.singleEvent.toList(events) }
 
-    intents.collect { vm.processIntent(it) }
+    intents.collect {
+      vm.processIntent(it)
+      logIfEnabled { "[DISPATCH] Dispatch $it -> $vm" }
+    }
     delay(delayAfterDispatchingIntents)
+    logIfEnabled { "---------------" }
 
-    if (logging) {
-      println(states)
-      println(events)
-    }
+    logIfEnabled { "[DONE] states=${states.joinToStringWithIndex()}" }
+    logIfEnabled { "[DONE] events=${events.joinToStringWithIndex()}" }
 
     assertEquals(expectedStates.size, states.size, "States size")
     expectedStates.withIndex().zip(states).forEach { (indexedValue, state) ->
@@ -112,3 +124,13 @@ abstract class BaseMviViewModelTest<
 }
 
 fun <T> Iterable<T>.mapRight(): List<Either<(T) -> Unit, T>> = map { it.right() }
+
+private fun <T> List<T>.joinToStringWithIndex(): String {
+  return withIndex().joinToString(
+    separator = ",\n",
+    prefix = "[\n",
+    postfix = "]",
+  ) { (i, v) ->
+    "   [$i]: $v"
+  }
+}

test-utils/src/main/java/com/hoc/flowmvi/test_utils/TestCoroutineDispatcherRule.kt

@@ -13,12 +13,10 @@ class TestCoroutineDispatcherRule(val testCoroutineDispatcher: TestCoroutineDisp
   TestWatcher() {
   override fun starting(description: Description) {
     Dispatchers.setMain(testCoroutineDispatcher)
-    println("$this::starting $description")
   }
 
   override fun finished(description: Description) {
     Dispatchers.resetMain()
     testCoroutineDispatcher.cleanupTestCoroutines()
-    println("$this::finished $description")
   }
 }