From 65d04db3748fcc37f891ac487110cf721604afa4 Mon Sep 17 00:00:00 2001
From: Gergely Hegedus <hegedusgergely@yahoo.com>
Date: Tue, 4 Jan 2022 15:14:54 +0200
Subject: [PATCH] issue#6 Add GIVEN-WHEN-THEN as documentation and simplify
 testNames in robolectricTests of app module

---
 .../FavouriteContentLocalStorageImplTest.kt          | 12 ++++++++----
 .../FavouriteContentLocalStorageImplTest.kt          | 12 ++++++++----
 2 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/app/src/robolectricTestHilt/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt b/app/src/robolectricTestHilt/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
index 7166b68..b58f4a3 100644
--- a/app/src/robolectricTestHilt/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
+++ b/app/src/robolectricTestHilt/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
@@ -40,8 +40,9 @@ internal class FavouriteContentLocalStorageImplTest {
         hiltRule.inject()
     }
 
+    /** GIVEN content_id WHEN added to Favourite THEN it can be read out */
     @Test
-    fun GIVEN_content_id_WHEN_added_to_Favourite_THEN_it_can_be_read_out() = runBlocking {
+    fun addingContentIdToFavouriteCanBeLaterReadOut() = runBlocking {
         val expected = listOf(ContentId("a"))
 
         sut.markAsFavourite(ContentId("a"))
@@ -50,8 +51,9 @@ internal class FavouriteContentLocalStorageImplTest {
         Assert.assertEquals(expected, actual)
     }
 
+    /** GIVEN content_id added WHEN removed to Favourite THEN it no longer can be read out */
     @Test
-    fun GIVEN_content_id_added_WHEN_removed_to_Favourite_THEN_it_no_longer_can_be_read_out() =
+    fun contentIdAddedThenRemovedCanNoLongerBeReadOut() =
         runBlocking {
             val expected = listOf<ContentId>()
             sut.markAsFavourite(ContentId("b"))
@@ -62,8 +64,9 @@ internal class FavouriteContentLocalStorageImplTest {
             Assert.assertEquals(expected, actual)
         }
 
+    /** GIVEN empty database WHILE observing content WHEN favourite added THEN change is emitted */
     @Test
-    fun GIVEN_empty_database_WHILE_observing_content_WHEN_favourite_added_THEN_change_is_emitted() =
+    fun addingFavouriteUpdatesExistingObservers() =
         runBlocking<Unit> {
             val expected = listOf(listOf(), listOf(ContentId("a")))
 
@@ -78,8 +81,9 @@ internal class FavouriteContentLocalStorageImplTest {
             Assert.assertEquals(expected, actual.await())
         }
 
+    /** GIVEN non empty database WHILE observing content WHEN favourite removed THEN change is emitted */
     @Test
-    fun GIVEN_non_empty_database_WHILE_observing_content_WHEN_favourite_removed_THEN_change_is_emitted() =
+    fun removingFavouriteUpdatesExistingObservers() =
         runBlocking<Unit> {
             val expected = listOf(listOf(ContentId("a")), listOf())
             sut.markAsFavourite(ContentId("a"))
diff --git a/app/src/robolectricTestKoin/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt b/app/src/robolectricTestKoin/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
index 4434ed6..dc5073e 100644
--- a/app/src/robolectricTestKoin/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
+++ b/app/src/robolectricTestKoin/java/org/fnives/test/showcase/favourite/FavouriteContentLocalStorageImplTest.kt
@@ -39,8 +39,9 @@ internal class FavouriteContentLocalStorageImplTest : KoinTest {
         stopKoin()
     }
 
+    /** GIVEN content_id WHEN added to Favourite THEN it can be read out */
     @Test
-    fun GIVEN_content_id_WHEN_added_to_Favourite_THEN_it_can_be_read_out() = runBlocking {
+    fun addingContentIdToFavouriteCanBeLaterReadOut() = runBlocking {
         val expected = listOf(ContentId("a"))
 
         sut.markAsFavourite(ContentId("a"))
@@ -49,8 +50,9 @@ internal class FavouriteContentLocalStorageImplTest : KoinTest {
         Assert.assertEquals(expected, actual)
     }
 
+    /** GIVEN content_id added WHEN removed to Favourite THEN it no longer can be read out */
     @Test
-    fun GIVEN_content_id_added_WHEN_removed_to_Favourite_THEN_it_no_longer_can_be_read_out() =
+    fun contentIdAddedThenRemovedCanNoLongerBeReadOut() =
         runBlocking {
             val expected = listOf<ContentId>()
             sut.markAsFavourite(ContentId("b"))
@@ -61,8 +63,9 @@ internal class FavouriteContentLocalStorageImplTest : KoinTest {
             Assert.assertEquals(expected, actual)
         }
 
+    /** GIVEN empty database WHILE observing content WHEN favourite added THEN change is emitted */
     @Test
-    fun GIVEN_empty_database_WHILE_observing_content_WHEN_favourite_added_THEN_change_is_emitted() =
+    fun addingFavouriteUpdatesExistingObservers() =
         runBlocking<Unit> {
             val expected = listOf(listOf(), listOf(ContentId("a")))
 
@@ -77,8 +80,9 @@ internal class FavouriteContentLocalStorageImplTest : KoinTest {
             Assert.assertEquals(expected, actual.await())
         }
 
+    /** GIVEN non empty database WHILE observing content WHEN favourite removed THEN change is emitted */
     @Test
-    fun GIVEN_non_empty_database_WHILE_observing_content_WHEN_favourite_removed_THEN_change_is_emitted() =
+    fun removingFavouriteUpdatesExistingObservers() =
         runBlocking<Unit> {
             val expected = listOf(listOf(ContentId("a")), listOf())
             sut.markAsFavourite(ContentId("a"))