Improve consistency across unit tests

michaelbull · Mar 5, 2024 · bfcb0d7 · bfcb0d7
1 parent 84b8ccb
commit bfcb0d7
Show file tree

Hide file tree

Showing 14 changed files with 289 additions and 366 deletions.
diff --git a/...monTest/kotlin/com.github.michaelbull.result.coroutines/binding/SuspendableBindingTest.kt b/...monTest/kotlin/com.github.michaelbull.result.coroutines/binding/SuspendableBindingTest.kt
@@ -36,7 +36,7 @@ class SuspendableBindingTest {
 
         assertEquals(
             expected = Ok(3),
-            actual = result
+            actual = result,
         )
     }
 
@@ -60,7 +60,7 @@ class SuspendableBindingTest {
 
         assertEquals(
             expected = Ok(3),
-            actual = result
+            actual = result,
         )
     }
 
@@ -90,7 +90,7 @@ class SuspendableBindingTest {
 
         assertEquals(
             expected = Err(BindingError),
-            actual = result
+            actual = result,
         )
     }
 
@@ -127,7 +127,7 @@ class SuspendableBindingTest {
 
         assertEquals(
             expected = Err(BindingError),
-            actual = result
+            actual = result,
         )
 
         assertTrue(xStateChange)
@@ -161,7 +161,7 @@ class SuspendableBindingTest {
 
         assertEquals(
             expected = Err(BindingError),
-            actual = result
+            actual = result,
         )
     }
 }
diff --git a/...st/kotlin/com.github.michaelbull.result.coroutines/binding/AsyncSuspendableBindingTest.kt b/...st/kotlin/com.github.michaelbull.result.coroutines/binding/AsyncSuspendableBindingTest.kt
@@ -15,9 +15,9 @@ import kotlin.test.assertTrue
 @ExperimentalCoroutinesApi
 class AsyncSuspendableBindingTest {
 
-    private sealed class BindingError {
-        object BindingErrorA : BindingError()
-        object BindingErrorB : BindingError()
+    private sealed interface BindingError {
+        data object BindingErrorA : BindingError
+        data object BindingErrorB : BindingError
     }
 
     @Test
@@ -32,15 +32,15 @@ class AsyncSuspendableBindingTest {
             return Ok(2)
         }
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = async { provideX().bind() }
             val y = async { provideY().bind() }
             x.await() + y.await()
         }
 
         assertEquals(
             expected = Ok(3),
-            actual = result
+            actual = result,
         )
     }
 
@@ -61,7 +61,7 @@ class AsyncSuspendableBindingTest {
             return Err(BindingError.BindingErrorB)
         }
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = async { provideX().bind() }
             val y = async { provideY().bind() }
             val z = async { provideZ().bind() }
@@ -98,7 +98,7 @@ class AsyncSuspendableBindingTest {
             return Err(BindingError.BindingErrorB)
         }
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = async { provideX().bind() }
             val y = async { provideY().bind() }
             val z = async { provideZ().bind() }
@@ -108,7 +108,7 @@ class AsyncSuspendableBindingTest {
 
         assertEquals(
             expected = Err(BindingError.BindingErrorB),
-            actual = result
+            actual = result,
         )
 
         assertFalse(xStateChange)

diff --git a/...nes/src/jvmTest/kotlin/com/github/michaelbull/result/coroutines/RunSuspendCatchingTest.kt b/...nes/src/jvmTest/kotlin/com/github/michaelbull/result/coroutines/RunSuspendCatchingTest.kt
@@ -49,7 +49,7 @@ class RunSuspendCatchingTest {
 
         assertEquals(
             expected = Ok("example"),
-            actual = result
+            actual = result,
         )
     }
 
@@ -61,7 +61,7 @@ class RunSuspendCatchingTest {
 
         assertEquals(
             expected = Err(exception),
-            actual = result
+            actual = result,
         )
     }
 }
diff --git a/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/AndTest.kt b/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/AndTest.kt
@@ -2,43 +2,44 @@ package com.github.michaelbull.result
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertSame
 
 class AndTest {
     private object AndError
 
     class And {
+
         @Test
         fun returnsValueIfOk() {
             assertEquals(
-                expected = 500,
-                actual = Ok(230).and(Ok(500)).get()
+                expected = Ok(500),
+                actual = Ok(230).and(Ok(500)),
             )
         }
 
         @Test
         fun returnsValueIfErr() {
             assertEquals(
-                expected = "hello world",
-                actual = Ok(300).and(Err("hello world")).getError()
+                expected = Err("hello world"),
+                actual = Ok(300).and(Err("hello world")),
             )
         }
     }
 
     class AndThen {
+
         @Test
         fun returnsTransformedValueIfOk() {
             assertEquals(
-                expected = 12,
-                actual = Ok(5).andThen { Ok(it + 7) }.get()
+                expected = Ok(12),
+                actual = Ok(5).andThen { Ok(it + 7) },
             )
         }
 
         @Test
         fun returnsErrorIfErr() {
-            assertSame(
-                expected = AndError,
-                actual = Ok(20).andThen { Ok(it + 43) }.andThen { Err(AndError) }.getError()!!
+            assertEquals(
+                expected = Err(AndError),
+                actual = Ok(20).andThen { Ok(it + 43) }.andThen { Err(AndError) },
             )
         }
     }

diff --git a/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/BindingTest.kt b/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/BindingTest.kt
@@ -2,7 +2,6 @@ package com.github.michaelbull.result
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertTrue
 
 class BindingTest {
 
@@ -13,29 +12,33 @@ class BindingTest {
         fun provideX(): Result<Int, BindingError> = Ok(1)
         fun provideY(): Result<Int, BindingError> = Ok(2)
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = provideX().bind()
             val y = provideY().bind()
             x + y
         }
 
-        assertTrue(result is Ok)
-        assertEquals(3, result.value)
+        assertEquals(
+            expected = Ok(3),
+            actual = result,
+        )
     }
 
     @Test
     fun returnsOkIfAllBindsOfDifferentTypeAreSuccessful() {
         fun provideX(): Result<String, BindingError> = Ok("1")
         fun provideY(x: Int): Result<Int, BindingError> = Ok(x + 2)
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = provideX().bind()
             val y = provideY(x.toInt()).bind()
             y
         }
 
-        assertTrue(result is Ok)
-        assertEquals(3, result.value)
+        assertEquals(
+            expected = Ok(3),
+            actual = result,
+        )
     }
 
     @Test
@@ -44,15 +47,17 @@ class BindingTest {
         fun provideY(): Result<Int, BindingError> = Err(BindingError)
         fun provideZ(): Result<Int, BindingError> = Ok(2)
 
-        val result = binding<Int, BindingError> {
+        val result = binding {
             val x = provideX().bind()
             val y = provideY().bind()
             val z = provideZ().bind()
             x + y + z
         }
 
-        assertTrue(result is Err)
-        assertEquals(BindingError, result.error)
+        assertEquals(
+            expected = Err(BindingError),
+            actual = result,
+        )
     }
 
     @Test
@@ -68,7 +73,9 @@ class BindingTest {
             x + y.toInt() + z
         }
 
-        assertTrue(result is Err)
-        assertEquals(BindingError, result.error)
+        assertEquals(
+            expected = Err(BindingError),
+            actual = result,
+        )
     }
 }
diff --git a/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/FactoryTest.kt b/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/FactoryTest.kt
@@ -2,52 +2,45 @@ package com.github.michaelbull.result
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertSame
 
 class FactoryTest {
     class RunCatching {
+
         @Test
         fun returnsOkIfInvocationSuccessful() {
-            val callback = { "example" }
-            val result = runCatching(callback)
-
             assertEquals(
-                expected = "example",
-                actual = result.get()
+                expected = Ok("example"),
+                actual = runCatching { "example" },
             )
         }
 
         @Test
+        @Suppress("UNREACHABLE_CODE")
         fun returnsErrIfInvocationFails() {
             val exception = IllegalArgumentException("throw me")
-            val callback = { throw exception }
-            val result = runCatching(callback)
 
-            assertSame(
-                expected = exception,
-                actual = result.getError()
+            assertEquals(
+                expected = Err(exception),
+                actual = runCatching { throw exception },
             )
         }
     }
 
     class ToResultOr {
+
         @Test
         fun returnsOkfIfNonNull() {
-            val result = "ok".toResultOr { "err" }
-
             assertEquals(
                 expected = "ok",
-                actual = result.get()
+                actual = "ok".toResultOr { "err" }.get()
             )
         }
 
         @Test
         fun returnsErrIfNull() {
-            val result = "ok".toLongOrNull().toResultOr { "err" }
-
             assertEquals(
-                expected = "err",
-                actual = result.getError()
+                expected = Err("err"),
+                actual = "ok".toLongOrNull().toResultOr { "err" }
             )
         }
     }

diff --git a/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/GetTest.kt b/kotlin-result/src/commonTest/kotlin/com/github/michaelbull/result/GetTest.kt
@@ -86,7 +86,7 @@ class GetTest {
         @Test
         fun throwsTransformedErrorIfErr() {
             assertFailsWith<CustomException> {
-                Err("error").getOrThrow { error -> CustomException(error) }
+                Err("error").getOrThrow(::CustomException)
             }
         }
 
@@ -148,19 +148,43 @@ class GetTest {
     }
 
     class Merge {
+        interface Direction
+        object Left : Direction
+        object Right : Direction
+
         @Test
         fun returnsValueIfOk() {
+            val left: Result<Left, Left> = Ok(Left)
+            val right: Result<Right, Right> = Ok(Right)
+
+            val result: Result<Direction, Direction> = left.flatMapEither(
+                success = { left },
+                failure = { right },
+            )
+
+            val direction: Direction = result.merge()
+
             assertEquals(
-                expected = setOf(4, 5, 6),
-                actual = Ok(listOf(1, 2, 3)).and(Ok(setOf(4, 5, 6))).merge()
+                expected = Left,
+                actual = direction
             )
         }
 
         @Test
         fun returnsErrorIfErr() {
+            val left: Result<Left, Left> = Err(Left)
+            val right: Result<Right, Right> = Err(Right)
+
+            val result: Result<Direction, Direction> = left.flatMapEither(
+                success = { left },
+                failure = { right },
+            )
+
+            val direction: Direction = result.merge()
+
             assertEquals(
-                expected = listOf(1, 2, 3),
-                actual = Err(listOf(1, 2, 3)).and(Err(setOf(4, 5, 6))).merge()
+                expected = Right,
+                actual = direction
             )
         }
     }