Merge branch 'add-konsist-vm-checks'

1 files changed, 24 insertions, 2 deletions

diff --git a/android/test/arch/src/test/kotlin/net/mullvad/mullvadvpn/test/arch/ViewModelTests.kt b/android/test/arch/src/test/kotlin/net/mullvad/mullvadvpn/test/arch/ViewModelTests.kt
index 35ffe52c31..8347c799d7 100644
--- a/android/test/arch/src/test/kotlin/net/mullvad/mullvadvpn/test/arch/ViewModelTests.kt
+++ b/android/test/arch/src/test/kotlin/net/mullvad/mullvadvpn/test/arch/ViewModelTests.kt
@@ -2,15 +2,37 @@ package net.mullvad.mullvadvpn.test.arch
 
 import androidx.lifecycle.ViewModel
 import com.lemonappdev.konsist.api.Konsist
+import com.lemonappdev.konsist.api.ext.list.functions
+import com.lemonappdev.konsist.api.ext.list.modifierprovider.withPublicOrDefaultModifier
+import com.lemonappdev.konsist.api.ext.list.properties
 import com.lemonappdev.konsist.api.ext.list.withAllParentsOf
 import com.lemonappdev.konsist.api.verify.assert
+import com.lemonappdev.konsist.api.verify.assertNot
 import org.junit.Test
 
 class ViewModelTests {
     @Test
     fun ensureViewModelsHaveViewModelSuffix() {
-        Konsist.scopeFromProject().classes().withAllParentsOf(ViewModel::class).assert {
-            it.name.endsWith("ViewModel")
+        allViewModels().assert { it.name.endsWith("ViewModel") }
+    }
+
+    // The purpose of this check is to both keep the naming consistent and also to avoid exposing
+    // properties that shouldn't be exposed.
+    @Test
+    fun ensurePublicPropertiesUsePermittedNames() {
+        allViewModels().properties(includeNested = false).withPublicOrDefaultModifier().assert {
+            property ->
+            property.name == "uiState" || property.name == "uiSideEffect"
+        }
+    }
+
+    @Test
+    fun ensurePublicFunctionsHaveNoReturnType() {
+        allViewModels().functions().withPublicOrDefaultModifier().assertNot { function ->
+            function.hasReturnType()
         }
     }
+
+    private fun allViewModels() =
+        Konsist.scopeFromProject().classes().withAllParentsOf(ViewModel::class)
 }