Merge pull request #1526 from vector-im/feature/bma/konsist

Konsist

Author: bmarty

.idea/dictionaries/shared.xml

@@ -18,6 +18,7 @@
     * [knit](#knit)
     * [lint](#lint)
   * [Unit tests](#unit-tests)
+    * [konsist](#konsist)
   * [Tests](#tests)
   * [Accessibility](#accessibility)
   * [Jetpack Compose](#jetpack-compose)
@@ -156,6 +157,10 @@ Make sure the following commands execute without any error:
 ./gradlew test
 </pre>
 
+#### konsist
+
+[konsist](https://github.com/LemonAppDev/konsist) is setup in the project to check that the architecture and the naming rules are followed. Konsist tests are classical Unit tests.
+
 ### Tests
 
 Element X is currently supported on Android Marshmallow (API 23+): please test your change on an Android device (or Android emulator) running with API 23. Many issues can happen (including crashes) on older devices.

CONTRIBUTING.md

@@ -230,6 +230,7 @@ dependencies {
     testImplementation(libs.test.truth)
     testImplementation(libs.test.turbine)
     testImplementation(projects.libraries.matrix.test)
+    testImplementation(libs.test.konsist)
 
     ksp(libs.showkase.processor)
 }

app/build.gradle.kts

@@ -34,7 +34,7 @@ import com.bumble.appyx.core.integrationpoint.NodeComponentActivity
 import com.bumble.appyx.core.plugin.NodeReadyObserver
 import io.element.android.libraries.architecture.bindings
 import io.element.android.libraries.core.log.logger.LoggerTag
-import io.element.android.libraries.designsystem.utils.LocalSnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.LocalSnackbarDispatcher
 import io.element.android.libraries.theme.ElementTheme
 import io.element.android.x.di.AppBindings
 import io.element.android.x.intent.SafeUriHandler

app/src/main/kotlin/io/element/android/x/MainActivity.kt

@@ -18,7 +18,7 @@ package io.element.android.x.di
 
 import com.squareup.anvil.annotations.ContributesTo
 import io.element.android.features.rageshake.api.reporter.BugReporter
-import io.element.android.libraries.designsystem.utils.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.matrix.api.tracing.TracingService
 

app/src/main/kotlin/io/element/android/x/di/AppBindings.kt

@@ -28,7 +28,7 @@ import io.element.android.features.messages.impl.timeline.components.customreact
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.meta.BuildMeta
 import io.element.android.libraries.core.meta.BuildType
-import io.element.android.libraries.designsystem.utils.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.di.DefaultPreferences

app/src/main/kotlin/io/element/android/x/di/AppModule.kt

@@ -0,0 +1,139 @@
+/*
+ * 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.app
+
+import androidx.compose.runtime.Composable
+import com.lemonappdev.konsist.api.KoModifier
+import com.lemonappdev.konsist.api.Konsist
+import com.lemonappdev.konsist.api.ext.list.constructors
+import com.lemonappdev.konsist.api.ext.list.modifierprovider.withoutModifier
+import com.lemonappdev.konsist.api.ext.list.modifierprovider.withoutOverrideModifier
+import com.lemonappdev.konsist.api.ext.list.parameters
+import com.lemonappdev.konsist.api.ext.list.properties
+import com.lemonappdev.konsist.api.ext.list.withAllAnnotationsOf
+import com.lemonappdev.konsist.api.ext.list.withAllParentsOf
+import com.lemonappdev.konsist.api.ext.list.withNameEndingWith
+import com.lemonappdev.konsist.api.ext.list.withReturnType
+import com.lemonappdev.konsist.api.ext.list.withTopLevel
+import com.lemonappdev.konsist.api.ext.list.withoutName
+import com.lemonappdev.konsist.api.ext.list.withoutNameEndingWith
+import com.lemonappdev.konsist.api.verify.assertFalse
+import com.lemonappdev.konsist.api.verify.assertTrue
+import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.designsystem.preview.PreviewsDayNight
+import org.junit.Test
+
+class KonsistTest {
+
+    @Test
+    fun `Classes extending 'Presenter' should have 'Presenter' suffix`() {
+        Konsist.scopeFromProject()
+            .classes()
+            .withAllParentsOf(Presenter::class)
+            .assertTrue {
+                it.name.endsWith("Presenter")
+            }
+    }
+
+    @Test
+    fun `Functions with '@PreviewsDayNight' annotation should have 'Preview' suffix`() {
+        Konsist
+            .scopeFromProject()
+            .functions()
+            .withAllAnnotationsOf(PreviewsDayNight::class)
+            .assertTrue {
+                it.hasNameEndingWith("Preview") &&
+                    it.hasNameEndingWith("LightPreview").not() &&
+                    it.hasNameEndingWith("DarkPreview").not()
+            }
+    }
+
+    @Test
+    fun `Top level function with '@Composable' annotation starting with a upper case should be placed in a file with the same name`() {
+        Konsist
+            .scopeFromProject()
+            .functions()
+            .withTopLevel()
+            .withoutModifier(KoModifier.PRIVATE)
+            .withoutNameEndingWith("Preview")
+            .withAllAnnotationsOf(Composable::class)
+            .withoutName(
+                // Add some exceptions...
+                "OutlinedButton",
+                "TextButton",
+                "SimpleAlertDialogContent",
+            )
+            .assertTrue(
+                additionalMessage =
+                """
+                Please check the filename. It should match the top level Composable function. If the filename is correct:
+                - consider making the Composable private or moving it to its own file
+                - at last resort, you can add an exception in the Konsist test
+                """.trimIndent()
+            ) {
+                if (it.name.first().isLowerCase()) {
+                    true
+                } else {
+                    val fileName = it.containingFile.name.removeSuffix(".kt")
+                    fileName == it.name
+                }
+            }
+    }
+
+    @Test
+    fun `Data class state MUST not have default value`() {
+        Konsist
+            .scopeFromProject()
+            .classes()
+            .withNameEndingWith("State")
+            .withoutName(
+                "CameraPositionState",
+            )
+            .constructors
+            .parameters
+            .assertTrue { parameterDeclaration ->
+                parameterDeclaration.defaultValue == null &&
+                    // Using parameterDeclaration.defaultValue == null is not enough apparently,
+                    // Also check that the text does not contain an equal sign
+                    parameterDeclaration.text.contains("=").not()
+            }
+    }
+
+    @Test
+    fun `Function which creates Presenter in test MUST be named 'createPresenterName'`() {
+        Konsist
+            .scopeFromTest()
+            .functions()
+            .withReturnType { it.name.endsWith("Presenter") }
+            .withoutOverrideModifier()
+            .assertTrue { functionDeclaration ->
+                functionDeclaration.name == "create${functionDeclaration.returnType?.name}"
+            }
+    }
+
+    @Test
+    fun `no field should have 'm' prefix`() {
+        Konsist
+            .scopeFromProject()
+            .classes()
+            .properties()
+            .assertFalse {
+                val secondCharacterIsUppercase = it.name.getOrNull(1)?.isUpperCase() ?: false
+                it.name.startsWith('m') && secondCharacterIsUppercase
+            }
+    }
+}

app/src/test/kotlin/io/element/android/app/KonsistTest.kt

@@ -16,8 +16,8 @@
 
 package io.element.android.appnav
 
-import io.element.android.libraries.designsystem.utils.SnackbarDispatcher
-import io.element.android.libraries.designsystem.utils.SnackbarMessage
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarMessage
 import io.element.android.libraries.matrix.api.room.RoomMembershipObserver
 import io.element.android.libraries.matrix.api.verification.SessionVerificationService
 import io.element.android.libraries.matrix.api.verification.VerificationFlowState

appnav/src/main/kotlin/io/element/android/appnav/LoggedInEventProcessor.kt

@@ -58,7 +58,7 @@ import io.element.android.libraries.architecture.animation.rememberDefaultTransi
 import io.element.android.libraries.architecture.createNode
 import io.element.android.libraries.architecture.waitForChildAttached
 import io.element.android.libraries.deeplink.DeeplinkData
-import io.element.android.libraries.designsystem.utils.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.MAIN_SPACE

appnav/src/main/kotlin/io/element/android/appnav/LoggedInFlowNode.kt

@@ -42,7 +42,7 @@ class RootPresenterTest {
 
     @Test
     fun `present - initial state`() = runTest {
-        val presenter = createPresenter()
+        val presenter = createRootPresenter()
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -54,7 +54,7 @@ class RootPresenterTest {
 
     @Test
     fun `present - passes app error state`() = runTest {
-        val presenter = createPresenter(
+        val presenter = createRootPresenter(
             appErrorService = DefaultAppErrorStateService().apply {
                 showError("Bad news", "Something bad happened")
             }
@@ -75,7 +75,7 @@ class RootPresenterTest {
         }
     }
 
-    private fun createPresenter(
+    private fun createRootPresenter(
         appErrorService: AppErrorStateService = DefaultAppErrorStateService()
     ): RootPresenter {
         val crashDataStore = FakeCrashDataStore()

appnav/src/test/kotlin/io/element/android/appnav/RootPresenterTest.kt

@@ -42,7 +42,7 @@ class LoggedInPresenterTest {
 
     @Test
     fun `present - initial state`() = runTest {
-        val presenter = createPresenter()
+        val presenter = createLoggedInPresenter()
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -54,7 +54,7 @@ class LoggedInPresenterTest {
     @Test
     fun `present - show sync spinner`() = runTest {
         val roomListService = FakeRoomListService()
-        val presenter = createPresenter(roomListService, NetworkStatus.Online)
+        val presenter = createLoggedInPresenter(roomListService, NetworkStatus.Online)
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -66,7 +66,7 @@ class LoggedInPresenterTest {
         }
     }
 
-    private fun createPresenter(
+    private fun createLoggedInPresenter(
         roomListService: RoomListService = FakeRoomListService(),
         networkStatus: NetworkStatus = NetworkStatus.Offline
     ): LoggedInPresenter {

appnav/src/test/kotlin/io/element/android/appnav/loggedin/LoggedInPresenterTest.kt

@@ -0,0 +1 @@
+Add some Konsist tests.

changelog.d/1526.misc

@@ -84,7 +84,7 @@ fun AddPeopleView(
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun AddPeopleViewTopBar(
+private fun AddPeopleViewTopBar(
     hasSelectedUsers: Boolean,
     modifier: Modifier = Modifier,
     onBackPressed: () -> Unit = {},

features/createroom/impl/src/main/kotlin/io/element/android/features/createroom/impl/addpeople/AddPeopleView.kt

@@ -181,7 +181,7 @@ fun ConfigureRoomView(
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun ConfigureRoomToolbar(
+private fun ConfigureRoomToolbar(
     isNextActionEnabled: Boolean,
     modifier: Modifier = Modifier,
     onBackPressed: () -> Unit = {},
@@ -207,7 +207,7 @@ fun ConfigureRoomToolbar(
 }
 
 @Composable
-fun RoomNameWithAvatar(
+private fun RoomNameWithAvatar(
     avatarUri: Uri?,
     roomName: String,
     modifier: Modifier = Modifier,
@@ -235,7 +235,7 @@ fun RoomNameWithAvatar(
 }
 
 @Composable
-fun RoomTopic(
+private fun RoomTopic(
     topic: String,
     modifier: Modifier = Modifier,
     onTopicChanged: (String) -> Unit = {},
@@ -254,7 +254,7 @@ fun RoomTopic(
 }
 
 @Composable
-fun RoomPrivacyOptions(
+private fun RoomPrivacyOptions(
     selected: RoomPrivacy?,
     modifier: Modifier = Modifier,
     onOptionSelected: (RoomPrivacyItem) -> Unit = {},

features/createroom/impl/src/main/kotlin/io/element/android/features/createroom/impl/configureroom/ConfigureRoomView.kt

@@ -126,7 +126,7 @@ fun CreateRoomRootView(
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun CreateRoomRootViewTopBar(
+private fun CreateRoomRootViewTopBar(
     modifier: Modifier = Modifier,
     onClosePressed: () -> Unit = {},
 ) {
@@ -148,7 +148,7 @@ fun CreateRoomRootViewTopBar(
 }
 
 @Composable
-fun CreateRoomActionButtonsList(
+private fun CreateRoomActionButtonsList(
     state: CreateRoomRootState,
     modifier: Modifier = Modifier,
     onNewRoomClicked: () -> Unit = {},
@@ -169,7 +169,7 @@ fun CreateRoomActionButtonsList(
 }
 
 @Composable
-fun CreateRoomActionButton(
+private fun CreateRoomActionButton(
     @DrawableRes iconRes: Int,
     text: String,
     modifier: Modifier = Modifier,

features/createroom/impl/src/main/kotlin/io/element/android/features/createroom/impl/root/CreateRoomRootView.kt

@@ -25,10 +25,10 @@ import kotlinx.collections.immutable.ImmutableList
 @Immutable
 data class InviteListState(
     val inviteList: ImmutableList<InviteListInviteSummary>,
-    val declineConfirmationDialog: InviteDeclineConfirmationDialog = InviteDeclineConfirmationDialog.Hidden,
-    val acceptedAction: Async<RoomId> = Async.Uninitialized,
-    val declinedAction: Async<Unit> = Async.Uninitialized,
-    val eventSink: (InviteListEvents) -> Unit = {}
+    val declineConfirmationDialog: InviteDeclineConfirmationDialog,
+    val acceptedAction: Async<RoomId>,
+    val declinedAction: Async<Unit>,
+    val eventSink: (InviteListEvents) -> Unit
 )
 
 sealed interface InviteDeclineConfirmationDialog {

features/invitelist/impl/src/main/kotlin/io/element/android/features/invitelist/impl/InviteListState.kt

@@ -39,6 +39,10 @@ open class InviteListStateProvider : PreviewParameterProvider<InviteListState> {
 
 internal fun aInviteListState() = InviteListState(
     inviteList = aInviteListInviteSummaryList(),
+    declineConfirmationDialog = InviteDeclineConfirmationDialog.Hidden,
+    acceptedAction = Async.Uninitialized,
+    declinedAction = Async.Uninitialized,
+    eventSink = {},
 )
 
 internal fun aInviteListInviteSummaryList(): ImmutableList<InviteListInviteSummary> {

features/invitelist/impl/src/main/kotlin/io/element/android/features/invitelist/impl/InviteListStateProvider.kt

@@ -111,7 +111,7 @@ fun InviteListView(
 
 @OptIn(ExperimentalMaterial3Api::class, ExperimentalLayoutApi::class)
 @Composable
-fun InviteListContent(
+private fun InviteListContent(
     state: InviteListState,
     modifier: Modifier = Modifier,
     onBackClicked: () -> Unit = {},

features/invitelist/impl/src/main/kotlin/io/element/android/features/invitelist/impl/InviteListView.kt

@@ -77,7 +77,7 @@ internal fun InviteSummaryRow(
 }
 
 @Composable
-internal fun DefaultInviteSummaryRow(
+private fun DefaultInviteSummaryRow(
     invite: InviteListInviteSummary,
     onAcceptClicked: () -> Unit = {},
     onDeclineClicked: () -> Unit = {},