improve tests

Author: kmadsen

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

@@ -0,0 +1,8 @@
+package com.mapbox.navigation.core.history
+
+import androidx.annotation.VisibleForTesting
+
+@VisibleForTesting
+internal object MapboxHistoryReaderProvider {
+    fun create(filePath: String) = MapboxHistoryReader(filePath)
+}

libnavigation-core/src/main/java/com/mapbox/navigation/core/replay/history/ReplayHistorySession.kt

@@ -3,6 +3,7 @@ package com.mapbox.navigation.core.replay.history
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.history.MapboxHistoryReader
+import com.mapbox.navigation.core.history.MapboxHistoryReaderProvider
 import com.mapbox.navigation.core.history.MapboxHistoryRecorder
 import com.mapbox.navigation.core.history.model.HistoryEvent
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
@@ -71,8 +72,9 @@ class ReplayHistorySession : MapboxNavigationObserver {
         this.mapboxNavigation = mapboxNavigation
         this.lastHistoryEvent = null
         mapboxNavigation.startReplayTripSession()
-        observeStateFlow(mapboxNavigation).launchIn(coroutineScope)
+        mapboxNavigation.mapboxReplayer.stop()
         mapboxNavigation.mapboxReplayer.registerObserver(replayEventsObserver)
+        observeStateFlow(mapboxNavigation).launchIn(coroutineScope)
     }
 
     /**
@@ -113,7 +115,7 @@ class ReplayHistorySession : MapboxNavigationObserver {
         return optionsFlow.mapDistinct { it.filePath }.onEach { historyFile ->
             mapboxNavigation.mapboxReplayer.clearEvents()
             mapboxNavigation.setNavigationRoutes(emptyList())
-            mapboxHistoryReader = historyFile?.let { MapboxHistoryReader(it) }
+            mapboxHistoryReader = historyFile?.let { MapboxHistoryReaderProvider.create(it) }
             mapboxNavigation.resetTripSession {
                 mapboxNavigation.mapboxReplayer.play()
                 pushMorePoints()

libnavigation-core/src/test/java/com/mapbox/navigation/core/replay/history/ReplayHistorySessionTest.kt

@@ -6,15 +6,22 @@ import com.mapbox.navigation.base.options.NavigationOptions
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.TripSessionResetCallback
 import com.mapbox.navigation.core.directions.session.RoutesObserver
+import com.mapbox.navigation.core.history.MapboxHistoryReader
+import com.mapbox.navigation.core.history.MapboxHistoryReaderProvider
 import com.mapbox.navigation.core.replay.MapboxReplayer
 import com.mapbox.navigation.core.trip.session.RouteProgressObserver
 import com.mapbox.navigation.testing.LoggingFrontendTestRule
 import io.mockk.every
 import io.mockk.just
 import io.mockk.mockk
+import io.mockk.mockkObject
 import io.mockk.runs
 import io.mockk.slot
+import io.mockk.unmockkAll
 import io.mockk.verify
+import io.mockk.verifyOrder
+import org.junit.After
+import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
@@ -25,25 +32,113 @@ class ReplayHistorySessionTest {
     val loggerRule = LoggingFrontendTestRule()
 
     private val replayer: MapboxReplayer = mockk(relaxed = true)
+    private val historyReader: MapboxHistoryReader = mockk(relaxed = true)
 
     private val sut = ReplayHistorySession()
 
+    @Before
+    fun setup() {
+        mockkObject(MapboxHistoryReaderProvider)
+        every { MapboxHistoryReaderProvider.create(any()) } returns historyReader
+    }
+
+    @After
+    fun teardown() {
+        unmockkAll()
+    }
+
+    @Test
+    fun `onAttached will call startReplayTripSession`() {
+        val mapboxNavigation = mockMapboxNavigation()
+
+        sut.onAttached(mapboxNavigation)
+
+        verify(exactly = 1) { mapboxNavigation.startReplayTripSession() }
+    }
+
     @Test
-    fun `onAttached with startReplayTripSession`() {
+    fun `onAttached will call MapboxReplayer#play`() {
         val mapboxNavigation = mockMapboxNavigation()
 
         sut.onAttached(mapboxNavigation)
 
-        verify { mapboxNavigation.startReplayTripSession() }
+        verify(exactly = 1) { replayer.play() }
     }
 
     @Test
-    fun `onAttached with call MapboxReplayer#play`() {
+    fun `setHistoryFile after onAttached will clear events and reset the trip`() {
         val mapboxNavigation = mockMapboxNavigation()
 
         sut.onAttached(mapboxNavigation)
+        sut.setHistoryFile("test_file_path")
+
+        verifyOrder {
+            mapboxNavigation.startReplayTripSession()
+            replayer.clearEvents()
+            mapboxNavigation.setNavigationRoutes(emptyList())
+            mapboxNavigation.resetTripSession(any())
+            replayer.play()
+            // setHistoryFile was called
+            replayer.clearEvents()
+            mapboxNavigation.setNavigationRoutes(emptyList())
+            MapboxHistoryReaderProvider.create("test_file_path")
+            mapboxNavigation.resetTripSession(any())
+            replayer.play()
+        }
+        verify(exactly = 1) {
+            mapboxNavigation.startReplayTripSession()
+            MapboxHistoryReaderProvider.create(any())
+        }
+    }
 
-        verify { replayer.play() }
+    @Test
+    fun `setHistoryFile before onAttached will initialize once`() {
+        val mapboxNavigation = mockMapboxNavigation()
+
+        sut.setHistoryFile("test_file_path")
+        sut.onAttached(mapboxNavigation)
+
+        verifyOrder {
+            mapboxNavigation.startReplayTripSession()
+            replayer.clearEvents()
+            mapboxNavigation.setNavigationRoutes(emptyList())
+            MapboxHistoryReaderProvider.create("test_file_path")
+            mapboxNavigation.resetTripSession(any())
+            replayer.play()
+        }
+        verify(exactly = 1) {
+            mapboxNavigation.startReplayTripSession()
+            replayer.clearEvents()
+            mapboxNavigation.setNavigationRoutes(any())
+            MapboxHistoryReaderProvider.create(any())
+            mapboxNavigation.resetTripSession(any())
+            replayer.play()
+        }
+    }
+
+    @Test
+    fun `onDetached will clean up but will not stopTripSession`() {
+        val mapboxNavigation = mockMapboxNavigation()
+
+        sut.onAttached(mapboxNavigation)
+        sut.onDetached(mapboxNavigation)
+
+        verifyOrder {
+            mapboxNavigation.startReplayTripSession()
+            replayer.stop()
+            replayer.registerObserver(any())
+            replayer.clearEvents()
+            mapboxNavigation.setNavigationRoutes(emptyList())
+            mapboxNavigation.resetTripSession(any())
+            replayer.play()
+            // onDetached called
+            replayer.unregisterObserver(any())
+            replayer.stop()
+            replayer.clearEvents()
+        }
+        verify(exactly = 1) {
+            replayer.play()
+        }
     }
 
     private fun mockMapboxNavigation(): MapboxNavigation {