Get informative errors in tests (#320)

DzmitryFomchyn · web-flow · commit 4eebb0a02d86 · 2025-03-13T13:42:35.000+03:00
* Get informative values comparison error message in tests

* Enable debug logs

* More info
diff --git a/MapboxSearch/base/src/main/java/com/mapbox/search/base/utils/extension/Expected.kt b/MapboxSearch/base/src/main/java/com/mapbox/search/base/utils/extension/Expected.kt
@@ -1,8 +1,10 @@
 package com.mapbox.search.base.utils.extension
 
+import androidx.annotation.RestrictTo
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
 
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
 fun <E, V, V1> Expected<E, V>.flatMap(transformer: (V) -> Expected<E, V1>): Expected<E, V1> {
     return if (isValue) {
         transformer(requireNotNull(value))
@@ -11,6 +13,7 @@ fun <E, V, V1> Expected<E, V>.flatMap(transformer: (V) -> Expected<E, V1>): Expe
     }
 }
 
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
 suspend fun <E, V, V1> Expected<E, V>.suspendFlatMap(transformer: suspend (V) -> Expected<E, V1>): Expected<E, V1> {
     return if (isValue) {
         transformer(requireNotNull(value))
@@ -19,10 +22,22 @@ suspend fun <E, V, V1> Expected<E, V>.suspendFlatMap(transformer: suspend (V) ->
     }
 }
 
-fun <E, V> Expected<E, V>.realToString(): String {
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
+fun <E, V> Expected<E, V>.toPrettyString(): String {
     return if (isValue) {
         "Value: $value"
     } else {
         "Error: $error"
     }
 }
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
+fun <E, V> Expected<E, V>.equalsTo(e: Expected<E, V>): Boolean {
+    return if (isValue && e.isValue) {
+        value == e.value
+    } else if (isError && e.isError) {
+        error == e.error
+    } else {
+        false
+    }
+}
diff --git a/MapboxSearch/common-tests/src/main/java/com/mapbox/search/common/tests/Assertions.kt b/MapboxSearch/common-tests/src/main/java/com/mapbox/search/common/tests/Assertions.kt
@@ -0,0 +1,28 @@
+package com.mapbox.search.common.tests
+
+import com.mapbox.bindgen.Expected
+import org.junit.Assert.fail
+
+private fun <E, V> Expected<E, V>.toPrettyString(): String {
+    return if (isValue) {
+        "Value: $value"
+    } else {
+        "Error: $error"
+    }
+}
+
+private fun <E, V> Expected<E, V>.equalsTo(e: Expected<E, V>): Boolean {
+    return if (isValue && e.isValue) {
+        value == e.value
+    } else if (isError && e.isError) {
+        error == e.error
+    } else {
+        false
+    }
+}
+
+fun <E, V> assertEqualsExpected(expected: Expected<E, V>, actual: Expected<E, V>) {
+    if (!expected.equalsTo(actual)) {
+        fail("Expected ${expected.toPrettyString()}, but was ${actual.toPrettyString()}")
+    }
+}
diff --git a/MapboxSearch/discover/build.gradle b/MapboxSearch/discover/build.gradle
@@ -84,11 +84,11 @@ dependencies {
 
     testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_5_version"
     testImplementation "org.junit.jupiter:junit-jupiter-engine:$junit_5_version"
-
     testImplementation project(":common-tests")
 
     androidTestImplementation "androidx.test:runner:$androidx_test_runner_version"
     androidTestImplementation "androidx.test.ext:junit:$androidx_junit_version"
     androidTestImplementation "androidx.test.espresso:espresso-core:$espresso_core_version"
     androidTestImplementation "com.squareup.okhttp3:mockwebserver:$okhttp3_version"
+    androidTestImplementation project(":common-tests")
 }
diff --git a/MapboxSearch/discover/src/androidTest/java/com/mapbox/search/discover/DiscoverIntegrationTest.kt b/MapboxSearch/discover/src/androidTest/java/com/mapbox/search/discover/DiscoverIntegrationTest.kt
@@ -4,6 +4,9 @@ import android.app.Application
 import android.content.Context
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
+import com.mapbox.bindgen.ExpectedFactory
+import com.mapbox.common.LogConfiguration
+import com.mapbox.common.LoggingLevel
 import com.mapbox.common.MapboxOptions
 import com.mapbox.geojson.BoundingBox
 import com.mapbox.geojson.Point
@@ -21,13 +24,15 @@ import com.mapbox.search.common.IsoLanguageCode
 import com.mapbox.search.common.RoutablePoint
 import com.mapbox.search.common.SearchRequestException
 import com.mapbox.search.common.concurrent.SearchSdkMainThreadWorker
+import com.mapbox.search.common.tests.assertEqualsExpected
 import com.mapbox.search.internal.bindgen.ApiType
 import kotlinx.coroutines.runBlocking
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertTrue
 import org.junit.Before
+import org.junit.BeforeClass
 import org.junit.Test
 import org.junit.runner.RunWith
 import java.util.Locale
@@ -220,8 +225,10 @@ internal class DiscoverIntegrationTest {
             )
         }
 
-        assertTrue(response.isValue)
-        assertEquals(0, requireNotNull(response.value).size)
+        assertEqualsExpected(
+            ExpectedFactory.createValue(emptyList()),
+            response,
+        )
     }
 
     @Test
@@ -391,5 +398,11 @@ internal class DiscoverIntegrationTest {
                 .setResponseCode(200)
                 .setBody(readFileFromAssets(bodyContentPath))
         }
+
+        @BeforeClass
+        @JvmStatic
+        fun enableDebugLogs() {
+            LogConfiguration.setLoggingLevel(LoggingLevel.DEBUG)
+        }
     }
 }
diff --git a/MapboxSearch/place-autocomplete/build.gradle b/MapboxSearch/place-autocomplete/build.gradle
@@ -83,11 +83,11 @@ dependencies {
 
     testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_5_version"
     testImplementation "org.junit.jupiter:junit-jupiter-engine:$junit_5_version"
-
     testImplementation project(":common-tests")
 
     androidTestImplementation "androidx.test:runner:$androidx_test_runner_version"
     androidTestImplementation "androidx.test.ext:junit:$androidx_junit_version"
     androidTestImplementation "androidx.test.espresso:espresso-core:$espresso_core_version"
     androidTestImplementation "com.squareup.okhttp3:mockwebserver:$okhttp3_version"
+    androidTestImplementation project(':common-tests')
 }
diff --git a/MapboxSearch/place-autocomplete/src/androidTest/java/com/mapbox/search/autocomplete/PlaceAutocompleteIntegrationTest.kt b/MapboxSearch/place-autocomplete/src/androidTest/java/com/mapbox/search/autocomplete/PlaceAutocompleteIntegrationTest.kt
@@ -4,6 +4,9 @@ import android.app.Application
 import android.content.Context
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
+import com.mapbox.bindgen.ExpectedFactory
+import com.mapbox.common.LogConfiguration
+import com.mapbox.common.LoggingLevel
 import com.mapbox.common.MapboxOptions
 import com.mapbox.common.location.LocationProvider
 import com.mapbox.geojson.BoundingBox
@@ -26,6 +29,7 @@ import com.mapbox.search.common.metadata.OpenHours
 import com.mapbox.search.common.metadata.OpenPeriod
 import com.mapbox.search.common.metadata.WeekDay
 import com.mapbox.search.common.metadata.WeekTimestamp
+import com.mapbox.search.common.tests.assertEqualsExpected
 import com.mapbox.search.internal.bindgen.ApiType
 import kotlinx.coroutines.runBlocking
 import okhttp3.mockwebserver.Dispatcher
@@ -38,6 +42,7 @@ import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertTrue
 import org.junit.Before
+import org.junit.BeforeClass
 import org.junit.Test
 import org.junit.runner.RunWith
 import java.io.IOException
@@ -137,8 +142,10 @@ internal class PlaceAutocompleteIntegrationTest {
             placeAutocomplete.suggestions(TEST_QUERY)
         }
 
-        assertTrue(response.isValue)
-        assertTrue(requireNotNull(response.value).isEmpty())
+        assertEqualsExpected(
+            ExpectedFactory.createValue(emptyList()),
+            response,
+        )
     }
 
     @Test
@@ -559,5 +566,11 @@ internal class PlaceAutocompleteIntegrationTest {
                 .setResponseCode(200)
                 .setBody(readFileFromAssets(bodyContentPath))
         }
+
+        @BeforeClass
+        @JvmStatic
+        fun enableDebugLogs() {
+            LogConfiguration.setLoggingLevel(LoggingLevel.DEBUG)
+        }
     }
 }
diff --git a/MapboxSearch/sample/src/main/java/com/mapbox/search/sample/SampleApplication.kt b/MapboxSearch/sample/src/main/java/com/mapbox/search/sample/SampleApplication.kt
@@ -14,6 +14,8 @@ import com.mapbox.common.HttpServiceFactory
 import com.mapbox.common.HttpServiceInterceptorInterface
 import com.mapbox.common.HttpServiceInterceptorRequestContinuation
 import com.mapbox.common.HttpServiceInterceptorResponseContinuation
+import com.mapbox.common.LogConfiguration
+import com.mapbox.common.LoggingLevel
 
 open class SampleApplication : Application() {
 
@@ -31,6 +33,8 @@ open class SampleApplication : Application() {
             return
         }
 
+        LogConfiguration.setLoggingLevel(LoggingLevel.DEBUG)
+
         fun filter(url: String): Boolean {
             return !onlySearchLogs || SEARCH_ENDPOINTS_URL.any { url.startsWith(it) }
         }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ import com.mapbox.common.HttpServiceFactory`
`14`	`14`	`import com.mapbox.common.HttpServiceInterceptorInterface`
`15`	`15`	`import com.mapbox.common.HttpServiceInterceptorRequestContinuation`
`16`	`16`	`import com.mapbox.common.HttpServiceInterceptorResponseContinuation`
	`17`	`+import com.mapbox.common.LogConfiguration`
	`18`	`+import com.mapbox.common.LoggingLevel`
`17`	`19`
`18`	`20`	`open class SampleApplication : Application() {`
`19`	`21`
`@@ -31,6 +33,8 @@ open class SampleApplication : Application() {`
`31`	`33`	`return`
`32`	`34`	`}`
`33`	`35`
	`36`	`+ LogConfiguration.setLoggingLevel(LoggingLevel.DEBUG)`
	`37`	`+`
`34`	`38`	`fun filter(url: String): Boolean {`
`35`	`39`	`return !onlySearchLogs \|\| SEARCH_ENDPOINTS_URL.any { url.startsWith(it) }`
`36`	`40`	`}`