Add unit test

.github/workflows/build.yml

@@ -10,25 +10,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    
-    - name: Set up JDK
-      uses: actions/setup-java@v2
-      with:
-        distribution: 'zulu'
-        java-version: '11'
-    
-    - name: Make gradlew executable
-      run: chmod +x ./gradlew
-      
-    - name: Spotless check
-      run: ./gradlew spotlessCheck
-    
-    - name: Build debug APK
-      run: ./gradlew assembleDebug --warning-mode all --stacktrace
-    
-    - name: Upload APK
-      uses: actions/upload-artifact@v2
-      with:
-        name: app-debug
-        path: app/build/outputs/apk/debug/app-debug.apk
+      - uses: actions/checkout@v2
+
+      - name: Set up JDKd
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+
+      - name: Make gradlew executable
+        run: chmod +x ./gradlew
+
+      - name: Spotless check
+        run: ./gradlew spotlessCheck
+
+      - name: Build debug APK
+        run: ./gradlew assembleDebug --warning-mode all --stacktrace
+
+      - name: Upload APK
+        uses: actions/upload-artifact@v2
+        with:
+          name: app-debug
+          path: app/build/outputs/apk/debug/app-debug.apk

.github/workflows/unit-test.yml

@@ -0,0 +1,31 @@
+name: Unit Tests CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up JDK
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+
+      - name: Make gradlew executable
+        run: chmod +x ./gradlew
+
+      - name: Run Android Debug Unit Test
+        run: ./gradlew jacocoTestReportDebug --warning-mode all --stacktrace
+
+      - name: Run Java/Kotlin Unit Test
+        run: ./gradlew jacocoTestReport --warning-mode all --stacktrace
+
+      - name: Upload Test Report
+        uses: codecov/codecov-action@v2.1.0

app/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
   androidApplication
   kotlinAndroid
+  jacoco
 }
 
 android {
@@ -26,6 +27,10 @@ android {
         "proguard-rules.pro"
       )
     }
+
+//    getByName("debug") {
+//      isTestCoverageEnabled = true
+//    }
   }
 
   compileOptions {
@@ -34,6 +39,11 @@ android {
   }
   kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() }
   buildFeatures { viewBinding = true }
+
+  testOptions {
+    unitTests.isIncludeAndroidResources = true
+    unitTests.isReturnDefaultValues = true
+  }
 }
 
 dependencies {
@@ -61,4 +71,6 @@ dependencies {
   testImplementation(deps.test.junit)
   androidTestImplementation(deps.test.androidxJunit)
   androidTestImplementation(deps.test.androidXSspresso)
+
+  addUnitTest()
 }

app/src/test/java/com/hoc/flowmvi/ExampleUnitTest.kt

@@ -1,7 +1,7 @@
 package com.hoc.flowmvi
 
-import org.junit.Assert.assertEquals
-import org.junit.Test
+import kotlin.test.Test
+import kotlin.test.assertEquals
 
 /**
  * Example local unit test, which will execute on the development machine (host).

build.gradle.kts

@@ -7,17 +7,21 @@ buildscript {
     google()
     mavenCentral()
     gradlePluginPortal()
+    maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
   }
   dependencies {
     classpath("com.android.tools.build:gradle:7.0.2")
     classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
     classpath("com.diffplug.spotless:spotless-plugin-gradle:5.15.1")
     classpath("dev.ahmedmourad.nocopy:nocopy-gradle-plugin:1.4.0")
+    classpath("org.jacoco:org.jacoco.core:0.8.7")
+    classpath("com.vanniktech:gradle-android-junit-jacoco-plugin:0.17.0-SNAPSHOT")
   }
 }
 
 subprojects {
   apply(plugin = "com.diffplug.spotless")
+  apply(plugin = "com.vanniktech.android.junit.jacoco")
 
   configure<com.diffplug.gradle.spotless.SpotlessExtension> {
     kotlin {
@@ -59,6 +63,26 @@ subprojects {
       endWithNewline()
     }
   }
+
+  configure<com.vanniktech.android.junit.jacoco.JunitJacocoExtension> {
+    jacocoVersion = "0.8.7"
+    includeNoLocationClasses = true
+    includeInstrumentationCoverageInMergedReport = true
+    csv.isEnabled = false
+    xml.isEnabled = true
+    html.isEnabled = true
+  }
+
+  afterEvaluate {
+    tasks.withType<Test> {
+      extensions
+        .getByType<JacocoTaskExtension>()
+        .run {
+          isIncludeNoLocationClasses = true
+          excludes = listOf("jdk.internal.*")
+        }
+    }
+  }
 }
 
 allprojects {

buildSrc/src/main/kotlin/deps.kt

@@ -1,6 +1,7 @@
 @file:Suppress("unused", "ClassName", "SpellCheckingInspection")
 
 import org.gradle.api.artifacts.dsl.DependencyHandler
+import org.gradle.kotlin.dsl.DependencyHandlerScope
 import org.gradle.kotlin.dsl.project
 import org.gradle.plugin.use.PluginDependenciesSpec
 import org.gradle.plugin.use.PluginDependencySpec
@@ -11,8 +12,8 @@ const val kotlinVersion = "1.5.21"
 object appConfig {
   const val applicationId = "com.hoc.flowmvi"
 
-  const val compileSdkVersion = 30
-  const val buildToolsVersion = "30.0.3"
+  const val compileSdkVersion = 31
+  const val buildToolsVersion = "31.0.0"
 
   const val minSdkVersion = 21
   const val targetSdkVersion = 30
@@ -51,6 +52,7 @@ object deps {
 
     const val core = "org.jetbrains.kotlinx:kotlinx-coroutines-core:$version"
     const val android = "org.jetbrains.kotlinx:kotlinx-coroutines-android:$version"
+    const val test = "org.jetbrains.kotlinx:kotlinx-coroutines-test:$version"
   }
 
   object koin {
@@ -65,9 +67,12 @@ object deps {
   const val flowExt = "io.github.hoc081098:FlowExt:0.0.7-SNAPSHOT"
 
   object test {
-    const val junit = "junit:junit:4.13"
+    const val junit = "junit:junit:4.13.2"
     const val androidxJunit = "androidx.test.ext:junit:1.1.2"
     const val androidXSspresso = "androidx.test.espresso:espresso-core:3.3.0"
+
+    const val mockk = "io.mockk:mockk:1.12.0"
+    const val kotlinJUnit = "org.jetbrains.kotlin:kotlin-test-junit:$kotlinVersion"
   }
 }
 
@@ -85,3 +90,10 @@ inline val DependencyHandler.data get() = project(":data")
 inline val DependencyHandler.featureMain get() = project(":feature-main")
 inline val DependencyHandler.featureAdd get() = project(":feature-add")
 inline val DependencyHandler.featureSearch get() = project(":feature-search")
+
+fun DependencyHandler.addUnitTest() {
+  add("testImplementation", deps.test.junit)
+  add("testImplementation", deps.test.mockk)
+  add("testImplementation", deps.test.kotlinJUnit)
+  add("testImplementation", deps.coroutines.test)
+}

core/build.gradle.kts

@@ -29,6 +29,11 @@ android {
     targetCompatibility = JavaVersion.VERSION_1_8
   }
   kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() }
+
+  testOptions {
+    unitTests.isIncludeAndroidResources = true
+    unitTests.isReturnDefaultValues = true
+  }
 }
 
 dependencies {
@@ -42,4 +47,6 @@ dependencies {
 
   implementation(deps.lifecycle.commonJava8)
   implementation(deps.lifecycle.runtimeKtx)
+
+  addUnitTest()
 }

core/src/test/java/com/hoc/flowmvi/core/ExampleUnitTest.kt

@@ -1 +1,11 @@
 package com.hoc.flowmvi.core
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ExampleUnitTest {
+  @Test
+  fun addition_isCorrect() {
+    assertEquals(4, 2 + 2)
+  }
+}

coverage.gradle.kts

@@ -0,0 +1,36 @@
+apply(plugin = "jacoco")
+
+tasks {
+  val debugCoverageReport by registering(JacocoReport::class)
+  debugCoverageReport {
+    dependsOn("testDebugUnitTest")
+
+    reports {
+      xml.run {
+        required.value(true)
+        outputLocation.set(file("$buildDir/reports/jacoco/test/jacocoTestReport.xml"))
+      }
+      html.required.value(true)
+    }
+
+    val kotlinClasses = fileTree("$buildDir/tmp/kotlin-classes/debug")
+    val coverageSourceDirs = arrayOf(
+      "src/main/java",
+      "src/debug/java"
+    )
+    val executionDataDirs = fileTree("$buildDir") {
+      setIncludes(
+        listOf(
+          "jacoco/testDebugUnitTest.exec",
+          "outputs/code_coverage/debugAndroidTest/connected/*.ec",
+          "outputs/code-coverage/connected/*coverage.ec"
+        )
+      )
+    }
+
+    classDirectories.setFrom(files(kotlinClasses))
+    sourceDirectories.setFrom(coverageSourceDirs)
+    additionalSourceDirs.setFrom(files(coverageSourceDirs))
+    executionData.setFrom(executionDataDirs)
+  }
+}

data/build.gradle.kts

@@ -29,6 +29,11 @@ android {
     targetCompatibility = JavaVersion.VERSION_1_8
   }
   kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() }
+
+  testOptions {
+    unitTests.isIncludeAndroidResources = true
+    unitTests.isReturnDefaultValues = true
+  }
 }
 
 dependencies {
@@ -43,4 +48,6 @@ dependencies {
   implementation(deps.squareup.loggingInterceptor)
 
   implementation(deps.koin.core)
+
+  addUnitTest()
 }

data/src/test/java/com/hoc/flowmvi/data/ExampleUnitTest.kt

@@ -1,12 +1,8 @@
 package com.hoc.flowmvi.data
 
-import org.junit.Test
+import kotlin.test.Test
+import kotlin.test.assertEquals
 
-/**
- * Example local unit test, which will execute on the development machine (host).
- *
- * See [testing documentation](http://d.android.com/tools/testing).
- */
 class ExampleUnitTest {
   @Test
   fun addition_isCorrect() {

domain/build.gradle.kts

@@ -5,4 +5,6 @@ plugins {
 dependencies {
   implementation(deps.coroutines.core)
   implementation(deps.koin.core)
+
+  addUnitTest()
 }

domain/src/test/java/com/hoc/flowmvi/domain/ExampleTest.kt

@@ -0,0 +1,11 @@
+package com.hoc.flowmvi.domain
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ExampleTest {
+  @Test
+  fun example() {
+    assertEquals(1, 1)
+  }
+}

feature-add/build.gradle.kts

@@ -29,8 +29,12 @@ android {
     targetCompatibility = JavaVersion.VERSION_1_8
   }
   kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() }
-
   buildFeatures { viewBinding = true }
+
+  testOptions {
+    unitTests.isIncludeAndroidResources = true
+    unitTests.isReturnDefaultValues = true
+  }
 }
 
 dependencies {
@@ -51,4 +55,6 @@ dependencies {
 
   implementation(deps.viewBindingDelegate)
   implementation(deps.flowExt)
+
+  addUnitTest()
 }