Add tests for message data encoding/decoding

hotwired · Aug 10, 2023 · 4ff3378 · 4ff3378
1 parent 7603568
commit 4ff3378
Show file tree

Hide file tree

Showing 4 changed files with 148 additions and 4 deletions.
diff --git a/strada/build.gradle b/strada/build.gradle
@@ -84,6 +84,7 @@ dependencies {
 
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'androidx.test:core:1.5.0'
+    testImplementation 'org.assertj:assertj-core:3.24.2'
     testImplementation 'androidx.lifecycle:lifecycle-runtime-testing:2.6.1'
     testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.4"
     testImplementation 'org.robolectric:robolectric:4.9.2'

diff --git a/strada/src/main/kotlin/dev/hotwire/strada/StradaJsonConverter.kt b/strada/src/main/kotlin/dev/hotwire/strada/StradaJsonConverter.kt
@@ -11,7 +11,7 @@ abstract class StradaJsonConverter {
             "A Strada.config.jsonConverter must be set to encode or decode json"
 
         const val INVALID_CONVERTER =
-            "The configured json converter must be a StradaJsonTypeConverter " +
+            "The configured json converter must implement a StradaJsonTypeConverter " +
                 "or use the provided KotlinXJsonConverter."
 
         inline fun <reified T> toObject(jsonData: String): T? {

diff --git a/strada/src/test/kotlin/dev/hotwire/strada/BridgeComponentTest.kt b/strada/src/test/kotlin/dev/hotwire/strada/BridgeComponentTest.kt
@@ -1,6 +1,9 @@
 package dev.hotwire.strada
 
 import com.nhaarman.mockito_kotlin.*
+import kotlinx.serialization.Serializable
+import org.assertj.core.api.Assertions
+import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
 import org.junit.Before
@@ -21,6 +24,7 @@ class BridgeComponentTest {
 
     @Before
     fun setup() {
+        Strada.config.jsonConverter = KotlinXJsonConverter()
         component = TestData.OneBridgeComponent("one", delegate)
         whenever(delegate.bridge).thenReturn(bridge)
     }
@@ -81,7 +85,7 @@ class BridgeComponentTest {
     }
 
     @Test
-    fun replyToReplacingData() {
+    fun replyToReplacingJsonData() {
         val newJsonData = """{"title":"Page-title"}"""
         val newMessage = message.replacing(jsonData = newJsonData)
 
@@ -92,6 +96,29 @@ class BridgeComponentTest {
         verify(bridge).replyWith(eq(newMessage))
     }
 
+    @Test
+    fun replyToReplacingData() {
+        val newJsonData = """{"title":"Page-title"}"""
+        val newMessage = message.replacing(jsonData = newJsonData)
+
+        component.didReceive(message)
+
+        val replied = component.replyTo("connect", MessageData(title = "Page-title"))
+        assertEquals(true, replied)
+        verify(bridge).replyWith(eq(newMessage))
+    }
+
+    @Test
+    fun replyToReplacingDataWithNoConverter() {
+        Strada.config.jsonConverter = null
+
+        component.didReceive(message)
+
+        assertThatThrownBy { component.replyTo("connect", MessageData(title = "Page-title")) }
+            .isInstanceOf(IllegalArgumentException::class.java)
+            .hasMessage(StradaJsonConverter.NO_CONVERTER)
+    }
+
     @Test
     fun replyToIgnoresNotReceived() {
         val replied = component.replyTo("connect")
@@ -100,11 +127,14 @@ class BridgeComponentTest {
     }
 
     @Test
-    fun replyToReplacingDataIgnoresNotReceived() {
+    fun replyToReplacingJsonDataIgnoresNotReceived() {
         val newJsonData = """{"title":"Page-title"}"""
 
         val replied = component.replyTo("connect", newJsonData)
         assertEquals(false, replied)
         verify(bridge, never()).replyWith(any())
     }
+
+    @Serializable
+    private class MessageData(val title: String)
 }
diff --git a/strada/src/test/kotlin/dev/hotwire/strada/MessageTest.kt b/strada/src/test/kotlin/dev/hotwire/strada/MessageTest.kt
@@ -1,11 +1,54 @@
 package dev.hotwire.strada
 
+import kotlinx.serialization.Serializable
+import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNull
+import org.junit.Before
 import org.junit.Test
 
 class MessageTest {
+
+    @Before
+    fun setup() {
+        Strada.config.jsonConverter = KotlinXJsonConverter()
+    }
+
+    @Test
+    fun dataDecodesToObject() {
+        val metadata = Metadata("https://37signals.com")
+        val message = Message(
+            id = "1",
+            component = "page",
+            event = "connect",
+            metadata = metadata,
+            jsonData = """{"title":"Page-title","subtitle":"Page-subtitle"}"""
+        )
+
+        val data = message.data<MessageData>()
+
+        assertEquals("Page-title", data?.title)
+        assertEquals("Page-subtitle", data?.subtitle)
+    }
+
     @Test
-    fun replacing() {
+    fun dataDoesNotDecodeToInvalidObject() {
+        val metadata = Metadata("https://37signals.com")
+        val message = Message(
+            id = "1",
+            component = "page",
+            event = "connect",
+            metadata = metadata,
+            jsonData = """{"title":"Page-title","subtitle":"Page-subtitle"}"""
+        )
+
+        val data = message.data<InvalidMessageData>()
+
+        assertNull(data)
+    }
+
+    @Test
+    fun replacingJsonData() {
         val metadata = Metadata("https://37signals.com")
         val message = Message(
             id = "1",
@@ -26,4 +69,74 @@ class MessageTest {
         assertEquals(metadata, newMessage.metadata)
         assertEquals("{}", newMessage.jsonData)
     }
+
+    @Test
+    fun replacingData() {
+        val metadata = Metadata("https://37signals.com")
+        val message = Message(
+            id = "1",
+            component = "page",
+            event = "connect",
+            metadata = metadata,
+            jsonData = "{}"
+        )
+
+        val data = MessageData(title = "New-title", subtitle = "New-subtitle")
+
+        val newMessage = message.replacing(
+            event = "disconnect",
+            data = data
+        )
+
+        assertEquals("1", newMessage.id)
+        assertEquals("page", newMessage.component)
+        assertEquals("disconnect", newMessage.event)
+        assertEquals(metadata, newMessage.metadata)
+        assertEquals("""{"title":"New-title","subtitle":"New-subtitle"}""", newMessage.jsonData)
+    }
+
+    @Test
+    fun replacingDataWithNoConverter() {
+        Strada.config.jsonConverter = null
+
+        val message = Message(
+            id = "1",
+            component = "page",
+            event = "connect",
+            metadata = Metadata("https://37signals.com"),
+            jsonData = "{}"
+        )
+
+        val data = MessageData(title = "New-title", subtitle = "New-subtitle")
+
+        assertThatThrownBy { message.replacing(data = data) }
+            .isInstanceOf(IllegalArgumentException::class.java)
+            .hasMessage(StradaJsonConverter.NO_CONVERTER)
+    }
+
+    @Test
+    fun replacingDataWithInvalidConverter() {
+        Strada.config.jsonConverter = InvalidJsonConverter()
+
+        val message = Message(
+            id = "1",
+            component = "page",
+            event = "connect",
+            metadata = Metadata("https://37signals.com"),
+            jsonData = "{}"
+        )
+
+        val data = MessageData(title = "New-title", subtitle = "New-subtitle")
+
+        assertThatThrownBy { message.replacing(data = data) }
+            .isInstanceOf(IllegalStateException::class.java)
+            .hasMessage(StradaJsonConverter.INVALID_CONVERTER)
+    }
+
+    @Serializable
+    private class MessageData(val title: String, val subtitle: String)
+
+    private class InvalidMessageData()
+
+    private class InvalidJsonConverter : StradaJsonConverter()
 }