Coverage report by Jacoco

.github/workflows/android_ci.yml

@@ -11,7 +11,8 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+#    runs-on: ubuntu-latest
+    runs-on: self-hosted
 
     steps:
     - name: Checkout repository
@@ -32,15 +33,13 @@ jobs:
     - name: Generate coverage report
       run: ./gradlew jacocoTestReport
 
-    - name: Check coverage
-      run: |
-        min_coverage=80
-        actual_coverage=$(grep -oP '(?<=total=")[0-9]*\.[0-9]*(?=%")' app/build/reports/jacoco/jacocoTestReport/html/index.xml)
-        is_less=$(echo "$actual_coverage < $min_coverage" | bc)
-        if [ $is_less -eq 1 ]; then
-          echo "error: coverage ($actual_coverage%) is below the minimum required ($min_coverage%)"
-          exit 1
-        else
-          echo "success: coverage ($actual_coverage%) is above the minimum required ($min_coverage%)"
-        fi
-
+    - name: Add coverage to PR
+      id: jacoco
+      uses: takumi-saito/jacoco-report@v1.7
+      with:
+        paths: ${{ github.workspace }}/app/build/reports/jacocoTestReport/jacocoTestReport.xml
+        token: ${{ secrets.GITHUB_TOKEN }}
+        min-coverage-overall: 40
+        min-coverage-changed-files: 60
+        merge-block: false
+        debug-mode: true

README.md

@@ -0,0 +1,4 @@
+This is a sample of commenting a coverage report to PR using an Android app.
+
+- [Coverage report by Jacoco](https://github.com/takumi-saito/UTSampleApp/pull/4)
+- [Coverage report by Kover](https://github.com/takumi-saito/UTSampleApp/pull/5)

app/build.gradle

@@ -60,8 +60,12 @@ task jacocoTestReport(type: JacocoReport, dependsOn: ['testDebugUnitTest']) {
         csv.enabled false
     }
 
-    def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*', 'android/**/*.*']
-    def debugTree = fileTree(dir: "$buildDir/tmp/kotlin-classes/debug", excludes: fileFilter)
+    def excludes = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*', 'android/**/*.*']
+    def debugTree = fileTree(
+            dir: "$buildDir/tmp/kotlin-classes/debug",
+            include: '**/*UseCase.*',
+            excludes: excludes
+    )
     def mainSrc = "$project.projectDir/src/main/java"
 
     sourceDirectories.from = files([mainSrc])

app/src/main/java/com/kireaji/utsampleapp/AddItemUseCase.kt

@@ -4,4 +4,8 @@ class AddItemUseCase(private val itemRepository: ItemRepository) {
     fun execute(item: String): List<String> {
         return itemRepository.addItem(item)
     }
+
+    fun execute(items: List<String>): List<String> {
+        return itemRepository.addAllItems(items)
+    }
 }

app/src/main/java/com/kireaji/utsampleapp/FindItemUseCase.kt

@@ -1,7 +1,19 @@
 package com.kireaji.utsampleapp
 
 class FindItemUseCase(private val itemRepository: ItemRepository) {
-    fun execute(item: String): String? {
+    fun findItem(item: String): String? {
         return itemRepository.findItem(item)
     }
+
+    fun takeItems(take: Int): List<String> {
+        return itemRepository.takeItems(take)
+    }
+
+    fun firstItem(): String? {
+        return itemRepository.firstItem()
+    }
+
+    fun lastItem(): String? {
+        return itemRepository.lastItem()
+    }
 }

app/src/main/java/com/kireaji/utsampleapp/ItemRepository.kt

@@ -2,6 +2,10 @@ package com.kireaji.utsampleapp
 
 interface ItemRepository {
     fun addItem(item: String): List<String>
+    fun addAllItems(items: List<String>): List<String>
     fun removeItem(item: String): List<String>
     fun findItem(item: String): String?
+    fun takeItems(take: Int): List<String>
+    fun firstItem(): String?
+    fun lastItem(): String?
 }

app/src/main/java/com/kireaji/utsampleapp/ItemRepositoryImpl.kt

@@ -0,0 +1,37 @@
+package com.kireaji.utsampleapp
+
+class ItemRepositoryImpl: ItemRepository{
+
+    private val itemList: MutableList<String> = mutableListOf()
+
+    override fun addItem(item: String): List<String> {
+        itemList.add(item)
+        return itemList
+    }
+
+    override fun addAllItems(items: List<String>): List<String> {
+        itemList.addAll(items)
+        return itemList
+    }
+
+    override fun removeItem(item: String): List<String> {
+        itemList.remove(item)
+        return itemList
+    }
+
+    override fun findItem(item: String): String? {
+        return itemList.find { it == item }
+    }
+
+    override fun takeItems(take: Int): List<String> {
+        return itemList.take(take)
+    }
+
+    override fun firstItem(): String? {
+        return itemList.firstOrNull()
+    }
+
+    override fun lastItem(): String? {
+        return itemList.lastOrNull()
+    }
+}

app/src/main/java/com/kireaji/utsampleapp/MainActivity.kt

@@ -2,10 +2,28 @@ package com.kireaji.utsampleapp
 
 import androidx.appcompat.app.AppCompatActivity
 import android.os.Bundle
+import android.util.Log
 
 class MainActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
+
+        val repository = ItemRepositoryImpl()
+        val findItemUseCase = FindItemUseCase(repository)
+        val addItemUseCase = AddItemUseCase(repository)
+        val removeItemUseCase = RemoveItemUseCase(repository)
+
+        addItemUseCase.execute("item1")
+        addItemUseCase.execute(listOf(
+            "item2",
+            "item3",
+        ))
+        Log.d("test", "firstItem: ${findItemUseCase.firstItem()}")
+        Log.d("test", "findItem: ${findItemUseCase.findItem("item2")}")
+        Log.d("test", "lastItem: ${findItemUseCase.lastItem()}")
+        Log.d("test", "takeItems: ${findItemUseCase.takeItems(3)}")
+        removeItemUseCase.execute("item1")
+        Log.d("test", "takeItems: ${findItemUseCase.takeItems(3)}")
     }
 }

app/src/test/java/com/kireaji/utsampleapp/AddItemUseCaseTest.kt

@@ -45,7 +45,7 @@ class AddItemUseCaseTest {
         `when`(itemRepository.findItem(item)).thenReturn(item)
 
         val findItemUseCase = FindItemUseCase(itemRepository)
-        val result = findItemUseCase.execute(item)
+        val result = findItemUseCase.findItem(item)
 
         assertEquals(item, result)
     }
@@ -57,7 +57,7 @@ class AddItemUseCaseTest {
         `when`(itemRepository.findItem(item)).thenReturn(null)
 
         val findItemUseCase = FindItemUseCase(itemRepository)
-        val result = findItemUseCase.execute(item)
+        val result = findItemUseCase.findItem(item)
 
         assertNull(result)
     }