Konsist: add test Data class state MUST not have default value, and fix existing issues

2023-10-10 17:29:58 +02:00
parent 308a0c0f57
commit de31f8a73a
13 changed files with 135 additions and 56 deletions
--- a/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/common/permissions/PermissionsState.kt
+++ b/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/common/permissions/PermissionsState.kt
@@ -17,9 +17,9 @@
 package io.element.android.features.location.impl.common.permissions

 data class PermissionsState(
-    val permissions: Permissions = Permissions.NoneGranted,
-    val shouldShowRationale: Boolean = false,
-    val eventSink: (PermissionsEvents) -> Unit = {},
+    val permissions: Permissions,
+    val shouldShowRationale: Boolean,
+    val eventSink: (PermissionsEvents) -> Unit,
 ) {
    sealed interface Permissions {
        data object AllGranted : Permissions
--- a/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/send/SendLocationState.kt
+++ b/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/send/SendLocationState.kt
@@ -17,11 +17,11 @@
 package io.element.android.features.location.impl.send

 data class SendLocationState(
-    val permissionDialog: Dialog = Dialog.None,
-    val mode: Mode = Mode.PinLocation,
-    val hasLocationPermission: Boolean = false,
-    val appName: String = "AppName",
-    val eventSink: (SendLocationEvents) -> Unit = {},
+    val permissionDialog: Dialog,
+    val mode: Mode,
+    val hasLocationPermission: Boolean,
+    val appName: String,
+    val eventSink: (SendLocationEvents) -> Unit,
 ) {
    sealed interface Mode {
        data object SenderLocation : Mode
--- a/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/send/SendLocationStateProvider.kt
+++ b/features/location/impl/src/main/kotlin/io/element/android/features/location/impl/send/SendLocationStateProvider.kt
@@ -23,35 +23,44 @@ private const val APP_NAME = "ApplicationName"
 class SendLocationStateProvider : PreviewParameterProvider<SendLocationState> {
    override val values: Sequence<SendLocationState>
        get() = sequenceOf(
-            SendLocationState(
+            aSendLocationState(
                permissionDialog = SendLocationState.Dialog.None,
                mode = SendLocationState.Mode.PinLocation,
                hasLocationPermission = false,
-                appName = APP_NAME,
            ),
-            SendLocationState(
+            aSendLocationState(
                permissionDialog = SendLocationState.Dialog.PermissionDenied,
                mode = SendLocationState.Mode.PinLocation,
                hasLocationPermission = false,
-                appName = APP_NAME,
            ),
-            SendLocationState(
+            aSendLocationState(
                permissionDialog = SendLocationState.Dialog.PermissionRationale,
                mode = SendLocationState.Mode.PinLocation,
                hasLocationPermission = false,
-                appName = APP_NAME,
            ),
-            SendLocationState(
+            aSendLocationState(
                permissionDialog = SendLocationState.Dialog.None,
                mode = SendLocationState.Mode.PinLocation,
                hasLocationPermission = true,
-                appName = APP_NAME,
            ),
-            SendLocationState(
+            aSendLocationState(
                permissionDialog = SendLocationState.Dialog.None,
                mode = SendLocationState.Mode.SenderLocation,
                hasLocationPermission = true,
-                appName = APP_NAME,
            ),
        )
 }
+
+private fun aSendLocationState(
+    permissionDialog: SendLocationState.Dialog,
+    mode: SendLocationState.Mode,
+    hasLocationPermission: Boolean,
+): SendLocationState {
+    return SendLocationState(
+        permissionDialog = permissionDialog,
+        mode = mode,
+        hasLocationPermission = hasLocationPermission,
+        appName = APP_NAME,
+        eventSink = {}
+    )
+}
--- a/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/PermissionsStateFactory.kt
+++ b/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/PermissionsStateFactory.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.features.location.impl
+
+import io.element.android.features.location.impl.common.permissions.PermissionsState
+
+fun aPermissionsState(
+    permissions: PermissionsState.Permissions = PermissionsState.Permissions.NoneGranted,
+    shouldShowRationale: Boolean = false,
+): PermissionsState {
+    return PermissionsState(
+        permissions = permissions,
+        shouldShowRationale = shouldShowRationale,
+        eventSink = {},
+    )
+}
--- a/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/common/permissions/PermissionsPresenterFake.kt
+++ b/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/common/permissions/PermissionsPresenterFake.kt
@@ -26,7 +26,11 @@ class PermissionsPresenterFake : PermissionsPresenter {
        events += event
    }

-    private var state = PermissionsState(eventSink = ::handleEvent)
+    private var state = PermissionsState(
+        permissions = PermissionsState.Permissions.NoneGranted,
+        shouldShowRationale = false,
+        eventSink = ::handleEvent
+    )
        set(value) {
            field = value.copy(eventSink = ::handleEvent)
        }
--- a/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/send/SendLocationPresenterTest.kt
+++ b/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/send/SendLocationPresenterTest.kt
@@ -22,6 +22,7 @@ import app.cash.turbine.test
 import com.google.common.truth.Truth
 import im.vector.app.features.analytics.plan.Composer
 import io.element.android.features.location.api.Location
+import io.element.android.features.location.impl.aPermissionsState
 import io.element.android.features.location.impl.common.actions.FakeLocationActions
 import io.element.android.features.location.impl.common.permissions.PermissionsEvents
 import io.element.android.features.location.impl.common.permissions.PermissionsPresenter
@@ -65,7 +66,7 @@ class SendLocationPresenterTest {
    @Test
    fun `initial state with permissions granted`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.AllGranted,
                shouldShowRationale = false,
            )
@@ -92,7 +93,7 @@ class SendLocationPresenterTest {
    @Test
    fun `initial state with permissions partially granted`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.SomeGranted,
                shouldShowRationale = false,
            )
@@ -119,7 +120,7 @@ class SendLocationPresenterTest {
    @Test
    fun `initial state with permissions denied`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -145,7 +146,7 @@ class SendLocationPresenterTest {
    @Test
    fun `initial state with permissions denied once`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -171,7 +172,7 @@ class SendLocationPresenterTest {
    @Test
    fun `rationale dialog dismiss`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -202,7 +203,7 @@ class SendLocationPresenterTest {
    @Test
    fun `rationale dialog continue`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -230,7 +231,7 @@ class SendLocationPresenterTest {
    @Test
    fun `permission denied dialog dismiss`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -261,7 +262,7 @@ class SendLocationPresenterTest {
    @Test
    fun `share sender location`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.AllGranted,
                shouldShowRationale = false,
            )
@@ -317,7 +318,7 @@ class SendLocationPresenterTest {
    @Test
    fun `share pin location`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -373,7 +374,7 @@ class SendLocationPresenterTest {
    @Test
    fun `composer context passes through analytics`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -419,7 +420,7 @@ class SendLocationPresenterTest {
    @Test
    fun `open settings activity`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
--- a/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/show/ShowLocationPresenterTest.kt
+++ b/features/location/impl/src/test/kotlin/io/element/android/features/location/impl/show/ShowLocationPresenterTest.kt
@@ -21,6 +21,7 @@ import app.cash.molecule.moleculeFlow
 import app.cash.turbine.test
 import com.google.common.truth.Truth
 import io.element.android.features.location.api.Location
+import io.element.android.features.location.impl.aPermissionsState
 import io.element.android.features.location.impl.common.actions.FakeLocationActions
 import io.element.android.features.location.impl.common.permissions.PermissionsEvents
 import io.element.android.features.location.impl.common.permissions.PermissionsPresenter
@@ -55,7 +56,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `emits initial state with no location permission`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -75,7 +76,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `emits initial state location permission denied once`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -94,7 +95,7 @@ class ShowLocationPresenterTest {

    @Test
    fun `emits initial state with location permission`() = runTest {
-        permissionsPresenterFake.givenState(PermissionsState(permissions = PermissionsState.Permissions.AllGranted))
+        permissionsPresenterFake.givenState(aPermissionsState(permissions = PermissionsState.Permissions.AllGranted))

        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
@@ -109,7 +110,7 @@ class ShowLocationPresenterTest {

    @Test
    fun `emits initial state with partial location permission`() = runTest {
-        permissionsPresenterFake.givenState(PermissionsState(permissions = PermissionsState.Permissions.SomeGranted))
+        permissionsPresenterFake.givenState(aPermissionsState(permissions = PermissionsState.Permissions.SomeGranted))

        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
@@ -137,7 +138,7 @@ class ShowLocationPresenterTest {

    @Test
    fun `centers on user location`() = runTest {
-        permissionsPresenterFake.givenState(PermissionsState(permissions = PermissionsState.Permissions.AllGranted))
+        permissionsPresenterFake.givenState(aPermissionsState(permissions = PermissionsState.Permissions.AllGranted))

        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
@@ -166,7 +167,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `rationale dialog dismiss`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -197,7 +198,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `rationale dialog continue`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = true,
            )
@@ -225,7 +226,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `permission denied dialog dismiss`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -256,7 +257,7 @@ class ShowLocationPresenterTest {
    @Test
    fun `open settings activity`() = runTest {
        permissionsPresenterFake.givenState(
-            PermissionsState(
+            aPermissionsState(
                permissions = PermissionsState.Permissions.NoneGranted,
                shouldShowRationale = false,
            )
@@ -290,7 +291,6 @@ class ShowLocationPresenterTest {
        }
    }

-
    companion object {
        private const val A_DESCRIPTION = "My happy place"
    }