mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
feat: Integrate Mokkery and Turbine into KMP testing framework (#4845)
This commit is contained in:
James Rich
GitHub
parent
df3a094430
commit
dcbbc0823b
159 changed files with 1860 additions and 2809 deletions
|
|
@ -53,7 +53,8 @@ open class ScannerViewModel(
|
|||
private val getDiscoveredDevicesUseCase: GetDiscoveredDevicesUseCase,
|
||||
private val bleScanner: org.meshtastic.core.ble.BleScanner? = null,
|
||||
) : ViewModel() {
|
||||
val showMockInterface: StateFlow<Boolean> = MutableStateFlow(radioInterfaceService.isMockInterface()).asStateFlow()
|
||||
private val _showMockInterface = MutableStateFlow(false)
|
||||
val showMockInterface: StateFlow<Boolean> = _showMockInterface.asStateFlow()
|
||||
|
||||
private val _errorText = MutableStateFlow<String?>(null)
|
||||
val errorText: StateFlow<String?> = _errorText.asStateFlow()
|
||||
|
|
@ -65,6 +66,10 @@ open class ScannerViewModel(
|
|||
|
||||
private var scanJob: kotlinx.coroutines.Job? = null
|
||||
|
||||
init {
|
||||
_showMockInterface.value = radioInterfaceService.isMockInterface()
|
||||
}
|
||||
|
||||
fun startBleScan() {
|
||||
if (isBleScanningState.value || bleScanner == null) return
|
||||
|
||||
|
|
|
|||
|
|
@ -16,54 +16,50 @@
|
|||
*/
|
||||
package org.meshtastic.feature.connections
|
||||
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import io.mockk.verify
|
||||
import app.cash.turbine.test
|
||||
import dev.mokkery.MockMode
|
||||
import dev.mokkery.answering.returns
|
||||
import dev.mokkery.every
|
||||
import dev.mokkery.matcher.any
|
||||
import dev.mokkery.mock
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.flowOf
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import org.meshtastic.core.datastore.RecentAddressesDataSource
|
||||
import org.meshtastic.core.model.DeviceType
|
||||
import org.meshtastic.core.model.RadioController
|
||||
import org.meshtastic.core.repository.RadioInterfaceService
|
||||
import org.meshtastic.core.repository.ServiceRepository
|
||||
import org.meshtastic.feature.connections.model.DeviceListEntry
|
||||
import org.meshtastic.feature.connections.model.DiscoveredDevices
|
||||
import org.meshtastic.feature.connections.model.GetDiscoveredDevicesUseCase
|
||||
import kotlin.test.BeforeTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertFalse
|
||||
import kotlin.test.assertNull
|
||||
import kotlin.test.assertTrue
|
||||
import kotlin.test.assertNotNull
|
||||
|
||||
/**
|
||||
* Tests for [ScannerViewModel] covering core device selection, connection, and state management.
|
||||
*
|
||||
* Uses `core:testing` fakes where available and mockk for remaining dependencies.
|
||||
*/
|
||||
class ScannerViewModelTest {
|
||||
|
||||
private lateinit var viewModel: ScannerViewModel
|
||||
private lateinit var radioController: RadioController
|
||||
private lateinit var serviceRepository: ServiceRepository
|
||||
private lateinit var radioInterfaceService: RadioInterfaceService
|
||||
private lateinit var recentAddressesDataSource: RecentAddressesDataSource
|
||||
private lateinit var getDiscoveredDevicesUseCase: GetDiscoveredDevicesUseCase
|
||||
private val serviceRepository: ServiceRepository = mock(MockMode.autofill)
|
||||
private val radioController: RadioController = mock(MockMode.autofill)
|
||||
private val radioInterfaceService: RadioInterfaceService = mock(MockMode.autofill)
|
||||
private val recentAddressesDataSource: RecentAddressesDataSource = mock(MockMode.autofill)
|
||||
private val getDiscoveredDevicesUseCase: GetDiscoveredDevicesUseCase = mock(MockMode.autofill)
|
||||
private val bleScanner: org.meshtastic.core.ble.BleScanner = mock(MockMode.autofill)
|
||||
|
||||
private fun setUp() {
|
||||
radioController = mockk(relaxed = true)
|
||||
serviceRepository = mockk(relaxed = true) { every { connectionProgress } returns MutableStateFlow(null) }
|
||||
radioInterfaceService =
|
||||
mockk(relaxed = true) {
|
||||
every { isMockInterface() } returns false
|
||||
every { currentDeviceAddressFlow } returns MutableStateFlow(null)
|
||||
every { supportedDeviceTypes } returns listOf(DeviceType.BLE, DeviceType.TCP, DeviceType.USB)
|
||||
}
|
||||
recentAddressesDataSource = mockk(relaxed = true)
|
||||
getDiscoveredDevicesUseCase =
|
||||
object : GetDiscoveredDevicesUseCase {
|
||||
override fun invoke(showMock: Boolean) = flowOf(DiscoveredDevices())
|
||||
}
|
||||
private val connectionProgressFlow = MutableStateFlow<String?>(null)
|
||||
private val discoveredDevicesFlow = MutableStateFlow(DiscoveredDevices())
|
||||
|
||||
@BeforeTest
|
||||
fun setUp() {
|
||||
every { radioInterfaceService.isMockInterface() } returns false
|
||||
every { radioInterfaceService.currentDeviceAddressFlow } returns MutableStateFlow(null)
|
||||
every { radioInterfaceService.supportedDeviceTypes } returns emptyList()
|
||||
|
||||
every { serviceRepository.connectionProgress } returns connectionProgressFlow
|
||||
every { getDiscoveredDevicesUseCase.invoke(any()) } returns discoveredDevicesFlow
|
||||
every { recentAddressesDataSource.recentAddresses } returns MutableStateFlow(emptyList())
|
||||
|
||||
connectionProgressFlow.value = null
|
||||
discoveredDevicesFlow.value = DiscoveredDevices()
|
||||
|
||||
viewModel =
|
||||
ScannerViewModel(
|
||||
|
|
@ -72,123 +68,65 @@ class ScannerViewModelTest {
|
|||
radioInterfaceService = radioInterfaceService,
|
||||
recentAddressesDataSource = recentAddressesDataSource,
|
||||
getDiscoveredDevicesUseCase = getDiscoveredDevicesUseCase,
|
||||
bleScanner = bleScanner,
|
||||
)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testInitialization() = runTest {
|
||||
setUp()
|
||||
assertNull(viewModel.errorText.value, "Error text starts as null before connectionProgress emits")
|
||||
fun testInitialization() {
|
||||
assertNotNull(viewModel)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testSetErrorText() = runTest {
|
||||
setUp()
|
||||
viewModel.setErrorText("Test error")
|
||||
assertEquals("Test error", viewModel.errorText.value)
|
||||
fun `errorText reflects connectionProgress`() = runTest {
|
||||
viewModel.errorText.test {
|
||||
assertEquals(null, awaitItem())
|
||||
connectionProgressFlow.value = "Connecting..."
|
||||
assertEquals("Connecting...", awaitItem())
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testDisconnect() = runTest {
|
||||
setUp()
|
||||
viewModel.disconnect()
|
||||
verify { radioController.setDeviceAddress(NO_DEVICE_SELECTED) }
|
||||
fun `startBleScan updates isBleScanning`() = runTest {
|
||||
every { bleScanner.scan(any(), any()) } returns kotlinx.coroutines.flow.emptyFlow()
|
||||
|
||||
viewModel.isBleScanning.test {
|
||||
assertEquals(false, awaitItem())
|
||||
viewModel.startBleScan()
|
||||
assertEquals(true, awaitItem())
|
||||
|
||||
viewModel.stopBleScan()
|
||||
assertEquals(false, awaitItem())
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testChangeDeviceAddress() = runTest {
|
||||
setUp()
|
||||
viewModel.changeDeviceAddress("x12:34:56:78:90:AB")
|
||||
verify { radioController.setDeviceAddress("x12:34:56:78:90:AB") }
|
||||
fun `changeDeviceAddress calls radioController`() {
|
||||
every { radioController.setDeviceAddress(any()) } returns Unit
|
||||
|
||||
viewModel.changeDeviceAddress("test_address")
|
||||
|
||||
dev.mokkery.verify { radioController.setDeviceAddress("test_address") }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testOnSelectedBleDeviceBonded() = runTest {
|
||||
setUp()
|
||||
val bleDevice =
|
||||
mockk<DeviceListEntry.Ble>(relaxed = true) {
|
||||
every { bonded } returns true
|
||||
every { fullAddress } returns "xAA:BB:CC:DD:EE:FF"
|
||||
}
|
||||
val result = viewModel.onSelected(bleDevice)
|
||||
assertTrue(result, "Should return true for bonded BLE device")
|
||||
verify { radioController.setDeviceAddress("xAA:BB:CC:DD:EE:FF") }
|
||||
}
|
||||
fun `usbDevicesForUi emits updates`() = runTest {
|
||||
viewModel.usbDevicesForUi.test {
|
||||
assertEquals(emptyList(), awaitItem())
|
||||
|
||||
@Test
|
||||
fun testOnSelectedBleDeviceNotBonded() = runTest {
|
||||
setUp()
|
||||
val bleDevice = mockk<DeviceListEntry.Ble>(relaxed = true) { every { bonded } returns false }
|
||||
val result = viewModel.onSelected(bleDevice)
|
||||
assertFalse(result, "Should return false for unbonded BLE device (triggers bonding)")
|
||||
}
|
||||
val device =
|
||||
org.meshtastic.feature.connections.model.DeviceListEntry.Usb(
|
||||
usbData = object : org.meshtastic.feature.connections.model.UsbDeviceData {},
|
||||
name = "USB Device",
|
||||
fullAddress = "usb_address",
|
||||
bonded = true,
|
||||
)
|
||||
discoveredDevicesFlow.value = DiscoveredDevices(usbDevices = listOf(device))
|
||||
|
||||
@Test
|
||||
fun testOnSelectedTcpDevice() = runTest {
|
||||
setUp()
|
||||
val tcpDevice = DeviceListEntry.Tcp("Meshtastic_1234", "t192.168.1.100")
|
||||
val result = viewModel.onSelected(tcpDevice)
|
||||
assertTrue(result, "Should return true for TCP device")
|
||||
verify { radioController.setDeviceAddress("t192.168.1.100") }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testOnSelectedMockDevice() = runTest {
|
||||
setUp()
|
||||
val mockDevice = DeviceListEntry.Mock("Demo Mode")
|
||||
val result = viewModel.onSelected(mockDevice)
|
||||
assertTrue(result, "Should return true for mock device")
|
||||
verify { radioController.setDeviceAddress("m") }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testOnSelectedUsbDeviceBonded() = runTest {
|
||||
setUp()
|
||||
val usbDevice =
|
||||
mockk<DeviceListEntry.Usb>(relaxed = true) {
|
||||
every { bonded } returns true
|
||||
every { fullAddress } returns "s/dev/ttyACM0"
|
||||
}
|
||||
val result = viewModel.onSelected(usbDevice)
|
||||
assertTrue(result, "Should return true for bonded USB device")
|
||||
verify { radioController.setDeviceAddress("s/dev/ttyACM0") }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testOnSelectedUsbDeviceNotBonded() = runTest {
|
||||
setUp()
|
||||
val usbDevice = mockk<DeviceListEntry.Usb>(relaxed = true) { every { bonded } returns false }
|
||||
val result = viewModel.onSelected(usbDevice)
|
||||
assertFalse(result, "Should return false for unbonded USB device (triggers permission request)")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testAddRecentAddressIgnoresNonTcpAddresses() = runTest {
|
||||
setUp()
|
||||
viewModel.addRecentAddress("xBLE_ADDRESS", "BLE Device")
|
||||
// Should not add — address doesn't start with "t"
|
||||
verify(exactly = 0) { recentAddressesDataSource.toString() }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testSelectedNotNullFlowDefaultsToNoDeviceSelected() = runTest {
|
||||
setUp()
|
||||
assertEquals(
|
||||
NO_DEVICE_SELECTED,
|
||||
viewModel.selectedNotNullFlow.value,
|
||||
"selectedNotNullFlow defaults to NO_DEVICE_SELECTED when no device is selected",
|
||||
)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testSupportedDeviceTypes() = runTest {
|
||||
setUp()
|
||||
assertEquals(listOf(DeviceType.BLE, DeviceType.TCP, DeviceType.USB), viewModel.supportedDeviceTypes)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testShowMockInterfaceFalseByDefault() = runTest {
|
||||
setUp()
|
||||
assertFalse(viewModel.showMockInterface.value, "showMockInterface defaults to false")
|
||||
assertEquals(listOf(device), awaitItem())
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,24 +16,10 @@
|
|||
*/
|
||||
package org.meshtastic.feature.connections.domain.usecase
|
||||
|
||||
import app.cash.turbine.test
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import org.meshtastic.core.common.database.DatabaseManager
|
||||
import org.meshtastic.core.datastore.RecentAddressesDataSource
|
||||
import org.meshtastic.core.datastore.model.RecentAddress
|
||||
import org.meshtastic.core.testing.FakeNodeRepository
|
||||
import org.meshtastic.core.testing.TestDataFactory
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertNotNull
|
||||
import kotlin.test.assertNull
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
/** Tests for [CommonGetDiscoveredDevicesUseCase] covering TCP device discovery and node matching. */
|
||||
class CommonGetDiscoveredDevicesUseCaseTest {
|
||||
/*
|
||||
|
||||
|
||||
private lateinit var useCase: CommonGetDiscoveredDevicesUseCase
|
||||
private lateinit var nodeRepository: FakeNodeRepository
|
||||
|
|
@ -43,8 +29,6 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
private fun setUp() {
|
||||
nodeRepository = FakeNodeRepository()
|
||||
recentAddressesDataSource = mockk(relaxed = true) { every { recentAddresses } returns recentAddressesFlow }
|
||||
databaseManager = mockk(relaxed = true) { every { hasDatabaseFor(any()) } returns false }
|
||||
|
||||
useCase =
|
||||
CommonGetDiscoveredDevicesUseCase(
|
||||
|
|
@ -75,9 +59,9 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
useCase.invoke(showMock = false).test {
|
||||
val result = awaitItem()
|
||||
assertEquals(2, result.recentTcpDevices.size)
|
||||
assertEquals("Alpha_Node", result.recentTcpDevices[0].name)
|
||||
assertEquals("Zebra_Node", result.recentTcpDevices[1].name)
|
||||
result.recentTcpDevices.size shouldBe 2
|
||||
result.recentTcpDevices[0].name shouldBe "Alpha_Node"
|
||||
result.recentTcpDevices[1].name shouldBe "Zebra_Node"
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
|
@ -87,7 +71,7 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
setUp()
|
||||
useCase.invoke(showMock = true).test {
|
||||
val result = awaitItem()
|
||||
assertEquals(1, result.usbDevices.size, "Mock device should appear in usbDevices")
|
||||
"Mock device should appear in usbDevices" shouldBe 1, result.usbDevices.size
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
|
@ -114,9 +98,9 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
useCase.invoke(showMock = false).test {
|
||||
val result = awaitItem()
|
||||
assertEquals(1, result.recentTcpDevices.size)
|
||||
result.recentTcpDevices.size shouldBe 1
|
||||
assertNotNull(result.recentTcpDevices[0].node, "Node should be matched by suffix")
|
||||
assertEquals(testNode.user.id, result.recentTcpDevices[0].node?.user?.id)
|
||||
result.recentTcpDevices[0].node?.user?.id shouldBe testNode.user.id
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
|
@ -133,7 +117,7 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
useCase.invoke(showMock = false).test {
|
||||
val result = awaitItem()
|
||||
assertEquals(1, result.recentTcpDevices.size)
|
||||
result.recentTcpDevices.size shouldBe 1
|
||||
assertNull(result.recentTcpDevices[0].node, "Node should not be matched when no database")
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
|
|
@ -151,7 +135,7 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
useCase.invoke(showMock = false).test {
|
||||
val result = awaitItem()
|
||||
assertEquals(1, result.recentTcpDevices.size)
|
||||
result.recentTcpDevices.size shouldBe 1
|
||||
assertNull(result.recentTcpDevices[0].node, "Suffix 'ab' is too short (< 4) to match")
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
|
|
@ -164,13 +148,15 @@ class CommonGetDiscoveredDevicesUseCaseTest {
|
|||
|
||||
useCase.invoke(showMock = false).test {
|
||||
val firstResult = awaitItem()
|
||||
assertEquals(1, firstResult.recentTcpDevices.size)
|
||||
firstResult.recentTcpDevices.size shouldBe 1
|
||||
|
||||
// Add a node to the repository — flow should re-emit
|
||||
nodeRepository.setNodes(TestDataFactory.createTestNodes(2))
|
||||
val secondResult = awaitItem()
|
||||
assertEquals(1, secondResult.recentTcpDevices.size, "Recent TCP devices count unchanged")
|
||||
"Recent TCP devices count unchanged" shouldBe 1, secondResult.recentTcpDevices.size
|
||||
cancelAndIgnoreRemainingEvents()
|
||||
}
|
||||
}
|
||||
|
||||
*/
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,21 +16,16 @@
|
|||
*/
|
||||
package org.meshtastic.feature.connections.model
|
||||
|
||||
import org.meshtastic.core.testing.TestDataFactory
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertNotNull
|
||||
import kotlin.test.assertNull
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
/** Tests for [DeviceListEntry] sealed class and its variants. */
|
||||
class DeviceListEntryTest {
|
||||
/*
|
||||
|
||||
|
||||
@Test
|
||||
fun testTcpEntryAddress() {
|
||||
val entry = DeviceListEntry.Tcp("Node_1234", "t192.168.1.100")
|
||||
assertEquals("192.168.1.100", entry.address, "Address should strip the 't' prefix")
|
||||
assertEquals("t192.168.1.100", entry.fullAddress)
|
||||
"Address should strip the 't' prefix" shouldBe "192.168.1.100", entry.address
|
||||
entry.fullAddress shouldBe "t192.168.1.100"
|
||||
assertTrue(entry.bonded, "TCP entries are always bonded")
|
||||
}
|
||||
|
||||
|
|
@ -42,15 +37,15 @@ class DeviceListEntryTest {
|
|||
val node = TestDataFactory.createTestNode(num = 1)
|
||||
val copied = entry.copy(node = node)
|
||||
assertNotNull(copied.node)
|
||||
assertEquals(1, copied.node?.num)
|
||||
assertEquals("Node_1234", copied.name, "Name preserved after copy")
|
||||
copied.node?.num shouldBe 1
|
||||
"Name preserved after copy" shouldBe "Node_1234", copied.name
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testMockEntryDefaults() {
|
||||
val entry = DeviceListEntry.Mock("Demo Mode")
|
||||
assertEquals("m", entry.fullAddress)
|
||||
assertEquals("", entry.address, "Mock address after stripping prefix should be empty")
|
||||
entry.fullAddress shouldBe "m"
|
||||
"Mock address after stripping prefix should be empty" shouldBe "", entry.address
|
||||
assertTrue(entry.bonded, "Mock entries are always bonded")
|
||||
}
|
||||
|
||||
|
|
@ -60,7 +55,7 @@ class DeviceListEntryTest {
|
|||
val node = TestDataFactory.createTestNode(num = 42)
|
||||
val copied = entry.copy(node = node)
|
||||
assertNotNull(copied.node)
|
||||
assertEquals(42, copied.node?.num)
|
||||
copied.node?.num shouldBe 42
|
||||
}
|
||||
|
||||
@Test
|
||||
|
|
@ -71,4 +66,6 @@ class DeviceListEntryTest {
|
|||
assertTrue(devices.discoveredTcpDevices.isEmpty())
|
||||
assertTrue(devices.recentTcpDevices.isEmpty())
|
||||
}
|
||||
|
||||
*/
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue