add tests

Author: korshaknn

CHANGELOG.md

@@ -17,7 +17,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with `NavigationView` that caused unexpected camera movements when switching between navigation states. [#6487](https://github.com/mapbox/mapbox-navigation-android/pull/6487)
 - Supported changing `MapboxVoiceInstructionsPlayer` language in runtime via `updateLanguage` method. [#6491](https://github.com/mapbox/mapbox-navigation-android/pull/6491)
 - Deprecated `MapboxVoiceInstructionsPlayer` constructors that accept access token and introduced the ones without it. [#6491](https://github.com/mapbox/mapbox-navigation-android/pull/6491)
-- Updated `NavigationViewApi` and `MapboxAudioGuidance`. Introduced `currentVoiceInstructionsPlayer` which allows playing customers voice instructions. [#6475](https://github.com/mapbox/mapbox-navigation-android/pull/6475)
+- Introduced `NavigationViewApi.getCurrentVoiceInstructionsPlayer()` which can be used to play custom voice instructions. [#6475](https://github.com/mapbox/mapbox-navigation-android/pull/6475)
 
 ## Mapbox Navigation SDK 2.9.0-beta.2 - 14 October, 2022
 ### Changelog

libnavui-dropin/api/current.txt

@@ -48,7 +48,6 @@ package com.mapbox.navigation.dropin {
     method public abstract void startFreeDrive();
     method public abstract com.mapbox.bindgen.Expected<com.mapbox.navigation.dropin.NavigationViewApiError,kotlin.Unit> startRoutePreview();
     method public abstract com.mapbox.bindgen.Expected<com.mapbox.navigation.dropin.NavigationViewApiError,kotlin.Unit> startRoutePreview(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes);
-    property public abstract com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? currentVoiceInstructionsPlayer;
   }
 
   public final class NavigationViewApiError extends java.lang.Throwable {

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewApi.kt

@@ -115,7 +115,7 @@ abstract class NavigationViewApi {
     abstract fun routeReplayEnabled(enabled: Boolean)
 
     /**
-     * Current instance of a voice instructions player.
+     * Access the current instance of [MapboxVoiceInstructionsPlayer] created by [NavigationView].
      */
-    abstract val currentVoiceInstructionsPlayer: MapboxVoiceInstructionsPlayer?
+    abstract fun getCurrentVoiceInstructionsPlayer(): MapboxVoiceInstructionsPlayer?
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/navigationview/MapboxNavigationViewApi.kt

@@ -20,6 +20,7 @@ import com.mapbox.navigation.ui.app.internal.startActiveNavigation
 import com.mapbox.navigation.ui.app.internal.startArrival
 import com.mapbox.navigation.ui.app.internal.tripsession.TripSessionStarterAction
 import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer
 
 @ExperimentalPreviewMapboxNavigationAPI
 internal class MapboxNavigationViewApi(
@@ -101,8 +102,9 @@ internal class MapboxNavigationViewApi(
         }
     }
 
-    override val currentVoiceInstructionsPlayer
-        get() = MapboxAudioGuidance.getRegisteredInstance().currentVoiceInstructionsPlayer
+    override fun getCurrentVoiceInstructionsPlayer(): MapboxVoiceInstructionsPlayer? {
+        return MapboxAudioGuidance.getRegisteredInstance().getCurrentVoiceInstructionsPlayer()
+    }
 
     @Throws(NavigationViewApiError::class)
     private fun checkDestination() {

libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/navigationview/MapboxNavigationViewApiTest.kt

@@ -14,12 +14,18 @@ import com.mapbox.navigation.ui.app.internal.routefetch.RoutePreviewAction
 import com.mapbox.navigation.ui.app.internal.routefetch.RoutePreviewState
 import com.mapbox.navigation.ui.app.internal.routefetch.RoutesAction
 import com.mapbox.navigation.ui.app.internal.tripsession.TripSessionStarterAction
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer
 import io.mockk.every
 import io.mockk.mockk
+import io.mockk.mockkObject
 import io.mockk.spyk
+import io.mockk.unmockkObject
 import io.mockk.verify
+import org.junit.After
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertFalse
+import org.junit.Assert.assertNull
 import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
@@ -30,6 +36,7 @@ class MapboxNavigationViewApiTest {
     private lateinit var sut: MapboxNavigationViewApi
 
     private lateinit var testStore: TestStore
+    private var audioGuidance: MapboxAudioGuidance = mockk(relaxed = true)
 
     @Before
     fun setUp() {
@@ -48,9 +55,18 @@ class MapboxNavigationViewApiTest {
                 }
             }
         )
+
+        mockkObject(MapboxAudioGuidance.Companion)
+        every { MapboxAudioGuidance.getRegisteredInstance() } returns audioGuidance
+
         sut = MapboxNavigationViewApi(testStore)
     }
 
+    @After
+    fun cleanUp() {
+        unmockkObject(MapboxAudioGuidance.Companion)
+    }
+
     @Test
     @Suppress("MaxLineLength")
     fun `startFreeDrive should clear routes and preview routes and set FreeDrive NavigationState`() {
@@ -334,6 +350,16 @@ class MapboxNavigationViewApiTest {
         verify { testStore.dispatch(TripSessionStarterAction.EnableTripSession) }
     }
 
+    @Test
+    fun `getCurrentVoiceInstructionsPlayer returns valid player instance`() {
+        every { audioGuidance.getCurrentVoiceInstructionsPlayer() } returns null
+        assertNull(sut.getCurrentVoiceInstructionsPlayer())
+
+        val player: MapboxVoiceInstructionsPlayer = mockk()
+        every { audioGuidance.getCurrentVoiceInstructionsPlayer() } returns player
+        assertEquals(player, sut.getCurrentVoiceInstructionsPlayer())
+    }
+
     private fun navigationRoute(vararg waypoints: Point): NavigationRoute {
         return mockk {
             every { routeOptions } returns mockk(relaxed = true) {

libnavui-voice/api/current.txt

@@ -31,7 +31,6 @@ package com.mapbox.navigation.ui.voice.api {
     method public kotlinx.coroutines.flow.StateFlow<com.mapbox.navigation.ui.voice.api.MapboxAudioGuidanceState> stateFlow();
     method public void toggle();
     method public void unmute();
-    property public final com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? currentVoiceInstructionsPlayer;
     field public static final com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance.Companion Companion;
   }
 

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidance.kt

@@ -52,7 +52,7 @@ internal constructor(
     /**
      * Current instance of a [VoiceInstructionsPlayer].
      */
-    val currentVoiceInstructionsPlayer get() = audioGuidanceServices.voiceInstructionsPlayer
+    fun getCurrentVoiceInstructionsPlayer() = audioGuidanceServices.voiceInstructionsPlayer
 
     /**
      * @see [MapboxNavigationApp]

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/internal/impl/MapboxAudioGuidanceServices.kt

@@ -12,6 +12,7 @@ import com.mapbox.navigation.ui.voice.internal.MapboxVoiceInstructions
 class MapboxAudioGuidanceServices {
 
     var voiceInstructionsPlayer: MapboxVoiceInstructionsPlayer? = null
+        private set
 
     fun mapboxAudioGuidanceVoice(
         mapboxNavigation: MapboxNavigation,

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidanceTest.kt

@@ -211,4 +211,17 @@ class MapboxAudioGuidanceTest {
             }
             carAppAudioGuidance.onDetached(mapboxNavigation)
         }
+
+    @Test
+    fun `getCurrentVoiceInstructionsPlayer returns valid player instance`() {
+        val mapboxAudioGuidanceServices =
+            testMapboxAudioGuidanceServices.mapboxAudioGuidanceServices
+
+        every { mapboxAudioGuidanceServices.voiceInstructionsPlayer } returns null
+        assertNull(carAppAudioGuidance.getCurrentVoiceInstructionsPlayer())
+
+        val player: MapboxVoiceInstructionsPlayer = mockk()
+        every { mapboxAudioGuidanceServices.voiceInstructionsPlayer } returns player
+        assertEquals(player, carAppAudioGuidance.getCurrentVoiceInstructionsPlayer())
+    }
 }

qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/customnavview/MapboxNavigationViewCustomizedActivity.kt

@@ -85,6 +85,7 @@ import com.mapbox.navigation.qa_test_app.view.base.DrawerActivity
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
 import com.mapbox.navigation.ui.base.lifecycle.UIComponent
 import com.mapbox.navigation.ui.maps.NavigationStyles
+import com.mapbox.navigation.ui.voice.model.SpeechAnnouncement
 import com.mapbox.navigation.utils.internal.toPoint
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
@@ -147,6 +148,13 @@ class MapboxNavigationViewCustomizedActivity : DrawerActivity() {
                 binding.navigationView.api.routeReplayEnabled(isChecked)
             }
         )
+        menuBinding.buttonVoiceInstruction.setOnClickListener {
+            binding.navigationView.api.getCurrentVoiceInstructionsPlayer()?.play(
+                SpeechAnnouncement.Builder("This is a test voice instruction").build()
+            ) {
+                // no op
+            }
+        }
         initActivityOptions()
         initGeneralOptions()
         initMapOptions()