From ee8dadf577657ed491c83d12fc93c1fa86f7cead Mon Sep 17 00:00:00 2001
From: Thore Goebel <goebel.thore@gmail.com>
Date: Sun, 14 Apr 2024 16:06:26 +0200
Subject: [PATCH] Explain what is being tested

---
 .../src/test/java/org/fdroid/repo/RepoAdderTest.kt        | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/libs/database/src/test/java/org/fdroid/repo/RepoAdderTest.kt b/libs/database/src/test/java/org/fdroid/repo/RepoAdderTest.kt
index d2181cbc6..7653d9fc5 100644
--- a/libs/database/src/test/java/org/fdroid/repo/RepoAdderTest.kt
+++ b/libs/database/src/test/java/org/fdroid/repo/RepoAdderTest.kt
@@ -860,7 +860,7 @@ internal class RepoAdderTest {
 
     private suspend fun expectMinRepoPreview(
         repoName: String?,
-        fetchResult: FetchResult,
+        expectedFetchResult: FetchResult,
         canAdd: Boolean = true,
         block: suspend () -> Unit = {},
     ) {
@@ -874,6 +874,7 @@ internal class RepoAdderTest {
                 block()
             }
 
+            // early empty state
             val state1 = awaitItem()
             assertIs<Fetching>(state1)
             assertNull(state1.repo)
@@ -881,17 +882,19 @@ internal class RepoAdderTest {
             assertFalse(state1.canAdd)
             assertFalse(state1.done)
 
+            // onRepoReceived
             val state2 = awaitItem()
             assertIs<Fetching>(state2)
             val repo = state2.repo ?: fail()
             assertEquals(TestDataMinV2.repo.address, repo.address)
             assertEquals(repoName, repo.getName(localeList))
             val result = state2.fetchResult ?: fail()
-            assertEquals(fetchResult, result)
+            assertEquals(expectedFetchResult, result)
             assertTrue(state2.apps.isEmpty())
             assertEquals(canAdd, state2.canAdd)
             assertFalse(state2.done)
 
+            // onAppReceived
             val state3 = awaitItem()
             assertIs<Fetching>(state3)
             assertEquals(TestDataMinV2.packages.size, state3.apps.size)
@@ -899,6 +902,7 @@ internal class RepoAdderTest {
             assertEquals(canAdd, state3.canAdd)
             assertFalse(state3.done)
 
+            // final result
             val state4 = awaitItem()
             assertIs<Fetching>(state4)
             assertEquals(canAdd, state4.canAdd)