Add UI test on RoomDetailsEditView

features/roomdetails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/edit/RoomDetailsEditStateProvider.kt

@@ -39,7 +39,7 @@ open class RoomDetailsEditStateProvider : PreviewParameterProvider<RoomDetailsEd
         )
 }
 
-private fun aRoomDetailsEditState(
+fun aRoomDetailsEditState(
     roomId: RoomId = RoomId("!aRoomId:aDomain"),
     roomRawName: String = "Marketing",
     canChangeName: Boolean = true,

features/roomdetails/impl/src/test/kotlin/io/element/android/features/roomdetails/edit/RoomDetailsEditViewTest.kt

@@ -0,0 +1,239 @@
+/*
+ * Copyright (c) 2024 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.roomdetails.edit
+
+import androidx.activity.ComponentActivity
+import androidx.annotation.StringRes
+import androidx.compose.ui.test.assertHasClickAction
+import androidx.compose.ui.test.assertHasNoClickAction
+import androidx.compose.ui.test.hasTestTag
+import androidx.compose.ui.test.junit4.AndroidComposeTestRule
+import androidx.compose.ui.test.junit4.createAndroidComposeRule
+import androidx.compose.ui.test.onNodeWithText
+import androidx.compose.ui.test.performClick
+import androidx.compose.ui.test.performTextInput
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import io.element.android.features.roomdetails.impl.edit.RoomDetailsEditEvents
+import io.element.android.features.roomdetails.impl.edit.RoomDetailsEditState
+import io.element.android.features.roomdetails.impl.edit.RoomDetailsEditView
+import io.element.android.features.roomdetails.impl.edit.aRoomDetailsEditState
+import io.element.android.libraries.architecture.AsyncAction
+import io.element.android.libraries.matrix.ui.media.AvatarAction
+import io.element.android.libraries.testtags.TestTags
+import io.element.android.libraries.ui.strings.CommonStrings
+import io.element.android.tests.testutils.EnsureNeverCalled
+import io.element.android.tests.testutils.EventsRecorder
+import io.element.android.tests.testutils.clickOn
+import io.element.android.tests.testutils.ensureCalledOnce
+import io.element.android.tests.testutils.pressBack
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.TestRule
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+class RoomDetailsEditViewTest {
+    @get:Rule val rule = createAndroidComposeRule<ComponentActivity>()
+
+    @Test
+    fun `clicking on back invoke back callback`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        ensureCalledOnce { callback ->
+            rule.setRoomDetailsEditView(
+                aRoomDetailsEditState(
+                    eventSink = eventsRecorder
+                ),
+                onBackPressed = callback,
+            )
+            rule.pressBack()
+        }
+    }
+
+    @Test
+    fun `when edition is successful, the expected callback is invoked`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        ensureCalledOnce { callback ->
+            rule.setRoomDetailsEditView(
+                aRoomDetailsEditState(
+                    eventSink = eventsRecorder,
+                    saveAction = AsyncAction.Success(Unit)
+                ),
+                onRoomEdited = callback,
+            )
+        }
+    }
+
+    @Test
+    fun `when name is changed, the expected Event is emitted`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>()
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                roomRawName = "Marketing",
+            ),
+        )
+        rule.onNodeWithText("Marketing").assertHasClickAction()
+        rule.onNodeWithText("Marketing").performTextInput("A")
+        eventsRecorder.assertSingle(RoomDetailsEditEvents.UpdateRoomName("AMarketing"))
+    }
+
+    @Test
+    fun `when user cannot change name, nothing happen`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                roomRawName = "Marketing",
+                canChangeName = false,
+            ),
+        )
+        rule.onNodeWithText("Marketing").assertHasNoClickAction()
+    }
+
+    @Test
+    fun `when topic is changed, the expected Event is emitted`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>()
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                roomTopic = "My Topic",
+            ),
+        )
+        rule.onNodeWithText("My Topic").assertHasClickAction()
+        rule.onNodeWithText("My Topic").performTextInput("A")
+        eventsRecorder.assertSingle(RoomDetailsEditEvents.UpdateRoomTopic("AMy Topic"))
+    }
+
+    @Test
+    fun `when user cannot change topic, nothing happen`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                roomTopic = "My Topic",
+                canChangeTopic = false,
+            ),
+        )
+        rule.onNodeWithText("My Topic").assertHasNoClickAction()
+    }
+
+    @Test
+    fun `when avatar is changed with action to take photo, the expected Event is emitted`() {
+        testAvatarChange(
+            stringActionRes = CommonStrings.action_take_photo,
+            expectedEvent = RoomDetailsEditEvents.HandleAvatarAction(AvatarAction.TakePhoto),
+        )
+    }
+
+    @Test
+    fun `when avatar is changed with action to choose photo, the expected Event is emitted`() {
+        testAvatarChange(
+            stringActionRes = CommonStrings.action_choose_photo,
+            expectedEvent = RoomDetailsEditEvents.HandleAvatarAction(AvatarAction.ChoosePhoto),
+        )
+    }
+
+    @Test
+    fun `when avatar is changed with action to remove photo, the expected Event is emitted`() {
+        testAvatarChange(
+            stringActionRes = CommonStrings.action_remove,
+            expectedEvent = RoomDetailsEditEvents.HandleAvatarAction(AvatarAction.Remove),
+        )
+    }
+
+    private fun testAvatarChange(
+        @StringRes stringActionRes: Int,
+        expectedEvent: RoomDetailsEditEvents.HandleAvatarAction,
+    ) {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>()
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+            ),
+        )
+        // Open the bottom sheet
+        rule.onNode(hasTestTag(TestTags.editAvatar.value)).performClick()
+        rule.onNodeWithText(rule.activity.getString(stringActionRes)).assertExists()
+        rule.clickOn(stringActionRes)
+        eventsRecorder.assertSingle(expectedEvent)
+    }
+
+    @Test
+    fun `when user cannot change avatar, nothing happen`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                canChangeAvatar = false,
+            ),
+        )
+        rule.onNode(hasTestTag(TestTags.editAvatar.value)).performClick()
+        rule.onNodeWithText(rule.activity.getString(CommonStrings.action_take_photo)).assertDoesNotExist()
+    }
+
+    @Test
+    fun `when save is clicked, the expected Event is emitted`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>()
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                saveButtonEnabled = true,
+            ),
+        )
+        rule.clickOn(CommonStrings.action_save)
+        eventsRecorder.assertSingle(RoomDetailsEditEvents.Save)
+    }
+
+    @Test
+    fun `when save is clicked, but nothing need to be saved, nothing happens`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>(expectEvents = false)
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                saveButtonEnabled = false,
+            ),
+        )
+        rule.clickOn(CommonStrings.action_save)
+    }
+
+    @Test
+    fun `when error is shown, closing the dialog emit the expected Event`() {
+        val eventsRecorder = EventsRecorder<RoomDetailsEditEvents>()
+        rule.setRoomDetailsEditView(
+            aRoomDetailsEditState(
+                eventSink = eventsRecorder,
+                saveAction = AsyncAction.Failure(Throwable("Whelp")),
+            ),
+        )
+        rule.clickOn(CommonStrings.action_ok)
+        eventsRecorder.assertSingle(RoomDetailsEditEvents.CancelSaveChanges)
+    }
+}
+
+private fun <R : TestRule> AndroidComposeTestRule<R, ComponentActivity>.setRoomDetailsEditView(
+    state: RoomDetailsEditState,
+    onBackPressed: () -> Unit = EnsureNeverCalled(),
+    onRoomEdited: () -> Unit = EnsureNeverCalled(),
+) {
+    setContent {
+        RoomDetailsEditView(
+            state = state,
+            onBackPressed = onBackPressed,
+            onRoomEdited = onRoomEdited,
+        )
+    }
+}

libraries/matrixui/build.gradle.kts

@@ -39,6 +39,7 @@ dependencies {
     implementation(projects.libraries.designsystem)
     implementation(projects.libraries.core)
     implementation(projects.libraries.uiStrings)
+    implementation(projects.libraries.testtags)
     implementation(libs.coil.compose)
     implementation(libs.coil.gif)
     implementation(libs.jsoup)

libraries/matrixui/src/main/kotlin/io/element/android/libraries/matrix/ui/components/EditableAvatarView.kt

@@ -43,6 +43,8 @@ import io.element.android.libraries.designsystem.components.avatar.AvatarSize
 import io.element.android.libraries.designsystem.preview.ElementPreview
 import io.element.android.libraries.designsystem.preview.PreviewsDayNight
 import io.element.android.libraries.designsystem.theme.components.Icon
+import io.element.android.libraries.testtags.TestTags
+import io.element.android.libraries.testtags.testTag
 
 @Composable
 fun EditableAvatarView(
@@ -53,7 +55,10 @@ fun EditableAvatarView(
     onAvatarClicked: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
-    Column(modifier = modifier.fillMaxWidth(), horizontalAlignment = Alignment.CenterHorizontally) {
+    Column(
+        modifier = modifier.fillMaxWidth(),
+        horizontalAlignment = Alignment.CenterHorizontally,
+    ) {
         Box(
             modifier = Modifier
                 .size(avatarSize.dp)
@@ -62,6 +67,7 @@ fun EditableAvatarView(
                     onClick = onAvatarClicked,
                     indication = rememberRipple(bounded = false),
                 )
+                .testTag(TestTags.editAvatar)
         ) {
             when (avatarUrl?.scheme) {
                 null, "mxc" -> {

libraries/testtags/src/main/kotlin/io/element/android/libraries/testtags/TestTags.kt

@@ -64,6 +64,11 @@ object TestTags {
      */
     val memberDetailAvatar = TestTag("member_detail-avatar")
 
+    /**
+     * Edit avatar.
+     */
+    val editAvatar = TestTag("edit-avatar")
+
     /**
      * Welcome screen.
      */