added route preview test

Author: vadzim-vys

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/core/PreviewRoutesTest.kt

@@ -0,0 +1,77 @@
+package com.mapbox.navigation.instrumentation_tests.core
+
+import android.location.Location
+import com.mapbox.api.directions.v5.DirectionsCriteria
+import com.mapbox.api.directions.v5.models.RouteOptions
+import com.mapbox.navigation.base.options.NavigationOptions
+import com.mapbox.navigation.base.route.NavigationRoute
+import com.mapbox.navigation.base.route.RouterOrigin
+import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.core.MapboxNavigationProvider
+import com.mapbox.navigation.core.RoutesSetError
+import com.mapbox.navigation.core.directions.session.RoutesExtra
+import com.mapbox.navigation.instrumentation_tests.activity.EmptyTestActivity
+import com.mapbox.navigation.instrumentation_tests.utils.MapboxNavigationRule
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.sdkTest
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.setNavigationRoutesAsync
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.waitForNewRoute
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.waitForPreviewRoute
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.withLogOnTimeout
+import com.mapbox.navigation.instrumentation_tests.utils.routes.RoutesProvider
+import com.mapbox.navigation.instrumentation_tests.utils.routes.RoutesProvider.toNavigationRoutes
+import com.mapbox.navigation.testing.ui.BaseTest
+import com.mapbox.navigation.testing.ui.utils.getMapboxAccessTokenFromResources
+import com.mapbox.navigation.testing.ui.utils.runOnMainSync
+import kotlinx.coroutines.async
+import kotlinx.coroutines.delay
+import org.junit.Assert
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertTrue
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import java.util.concurrent.TimeUnit
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
+
+class PreviewRoutesTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.java) {
+
+    override fun setupMockLocation(): Location = mockLocationUpdatesRule.generateLocationUpdate {
+        latitude = 38.894721
+        longitude = -77.031991
+    }
+
+    @get:Rule
+    val mapboxNavigationRule = MapboxNavigationRule()
+    private lateinit var mapboxNavigation: MapboxNavigation
+
+    @Before
+    fun setUp() {
+        runOnMainSync {
+            mapboxNavigation = MapboxNavigationProvider.create(
+                NavigationOptions.Builder(activity)
+                    .accessToken(getMapboxAccessTokenFromResources(activity))
+                    .build()
+            )
+        }
+    }
+
+    @Test
+    fun preview_routes() = sdkTest {
+        val routes = RoutesProvider.dc_very_short(activity).toNavigationRoutes()
+        mapboxNavigation.startTripSession()
+        val routeObserverDeffer = async {
+            mapboxNavigation.waitForPreviewRoute()
+        }
+
+        mapboxNavigation.previewNavigationRoutes(routes)
+
+        val currentRoutes = mapboxNavigation.getNavigationRoutes()
+        val routeFromCallback = routeObserverDeffer.await()
+        assertEquals(routes, currentRoutes)
+        assertEquals(routes, routeFromCallback.navigationRoutes)
+        assertEquals(RoutesExtra.ROUTES_UPDATE_REASON_PREVIEW, routeFromCallback.reason)
+    }
+
+}

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/utils/coroutines/TestUtils.kt

@@ -108,10 +108,14 @@ suspend fun MapboxNavigation.waitForAlternativeRoute() {
     waitForRoutesUpdate(RoutesExtra.ROUTES_UPDATE_REASON_ALTERNATIVE)
 }
 
+suspend fun MapboxNavigation.waitForPreviewRoute(): RoutesUpdatedResult {
+    return waitForRoutesUpdate(RoutesExtra.ROUTES_UPDATE_REASON_PREVIEW)
+}
+
 private suspend fun MapboxNavigation.waitForRoutesUpdate(
     @RoutesExtra.RoutesUpdateReason reason: String
-) {
-    routesUpdates()
+): RoutesUpdatedResult {
+    return routesUpdates()
         .filter { it.reason == reason }
         .first()
 }

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

@@ -23,6 +23,7 @@ import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions
 import com.mapbox.navigation.base.extensions.applyLanguageAndVoiceUnitOptions
 import com.mapbox.navigation.base.internal.NavigationRouterV2
+import com.mapbox.navigation.base.internal.route.nativeRoute
 import com.mapbox.navigation.base.internal.trip.notification.TripNotificationInterceptorOwner
 import com.mapbox.navigation.base.options.HistoryRecorderOptions
 import com.mapbox.navigation.base.options.NavigationOptions
@@ -130,6 +131,7 @@ import com.mapbox.navigator.FallbackVersionsObserver
 import com.mapbox.navigator.IncidentsOptions
 import com.mapbox.navigator.NavigatorConfig
 import com.mapbox.navigator.PollingConfig
+import com.mapbox.navigator.RouteParser
 import com.mapbox.navigator.RouterInterface
 import com.mapbox.navigator.TileEndpointConfiguration
 import com.mapbox.navigator.TilesConfig
@@ -837,16 +839,17 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         initialLegIndex: Int = 0,
     ) {
         //TODO: parse alternatives metadata using NN and set it route alternatives controller
-        directionsSession.setRoutes(routes, initialLegIndex, RoutesExtra.ROUTES_UPDATE_REASON_NEW)
+        directionsSession.setRoutes(routes, BasicSetRoutesInfo(RoutesExtra.ROUTES_UPDATE_REASON_PREVIEW, initialLegIndex))
     }
 
     fun setPreviewedRoute() {
         val routes = directionsSession.routes
         if (routes.isNotEmpty()) {
             internalSetNavigationRoutes(
                 routes,
-                directionsSession.initialLegIndex,
-                RoutesExtra.ROUTES_UPDATE_REASON_NEW
+                BasicSetRoutesInfo(
+                    RoutesExtra.ROUTES_UPDATE_REASON_NEW
+                )
             )
         }
     }

libnavigation-core/src/main/java/com/mapbox/navigation/core/directions/session/RoutesExtra.kt

@@ -19,6 +19,9 @@ object RoutesExtra {
      */
     const val ROUTES_UPDATE_REASON_NEW = "ROUTES_UPDATE_REASON_NEW"
 
+
+    const val ROUTES_UPDATE_REASON_PREVIEW = "ROUTES_UPDATE_REASON_PREVIEW"
+
     /**
      * Routes update reason is **alternative routes**.
      * @see [RoutesObserver]
@@ -48,6 +51,7 @@ object RoutesExtra {
         ROUTES_UPDATE_REASON_ALTERNATIVE,
         ROUTES_UPDATE_REASON_REROUTE,
         ROUTES_UPDATE_REASON_REFRESH,
+        ROUTES_UPDATE_REASON_PREVIEW,
     )
     annotation class RoutesUpdateReason
 }