Issue 630 bump UI automator (#641)

* ISSUE-630: add new UiAutomatorViewer matchers
KasperskyLab · May 16, 2024 · 0aad56b · 0aad56b
1 parent 40b6cdd
commit 0aad56b
Show file tree

Hide file tree

Showing 13 changed files with 204 additions and 3 deletions.
diff --git a/build-logic/android/src/main/kotlin/convention.android-base.gradle.kts b/build-logic/android/src/main/kotlin/convention.android-base.gradle.kts
@@ -11,7 +11,7 @@ configure<BaseExtension> {
     }
 
     defaultConfig {
-        minSdk = 18
+        minSdk = 21
         targetSdk = 30
     }
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -45,7 +45,7 @@ kotson = "com.github.salomonbrys.kotson:kotson:2.5.0"
 
 espressoCore = { module = "androidx.test.espresso:espresso-core", version.ref = "espresso" }
 espressoWeb = { module = "androidx.test.espresso:espresso-web", version.ref = "espresso" }
-uiAutomator = "androidx.test.uiautomator:uiautomator:2.2.0"
+uiAutomator = "androidx.test.uiautomator:uiautomator:2.3.0"
 robolectric = "org.robolectric:robolectric:4.8.2"
 kakao = { module = "io.github.kakaocup:kakao", version.ref = "kakao" }
 kakaoCompose = { module = "io.github.kakaocup:compose", version.ref = "kakaoCompose" }

diff --git a/kaspresso/src/main/kotlin/com/kaspersky/kaspresso/device/permissions/PermissionsImpl.kt b/kaspresso/src/main/kotlin/com/kaspersky/kaspresso/device/permissions/PermissionsImpl.kt
@@ -112,10 +112,11 @@ class PermissionsImpl(
      */
     private fun getPermissionDialogButtonAsUiObject(button: Permissions.Button): UiObject? {
         return try {
+            val buttonResId = buttonResNameMap[button] ?: return null
             val btnSelector = UiSelector()
                 .clickable(true)
                 .checkable(false)
-                .resourceId(buttonResNameMap[button])
+                .resourceId(buttonResId)
             uiDevice.findObject(btnSelector)
         } catch (e: UiObjectNotFoundException) {
             logger.e("There are no permissions dialog to interact with.")

diff --git a/...ain/kotlin/com/kaspersky/components/kautomator/component/common/builders/UiViewBuilder.kt b/...ain/kotlin/com/kaspersky/components/kautomator/component/common/builders/UiViewBuilder.kt
@@ -1,7 +1,9 @@
 @file:Suppress("unused")
 package com.kaspersky.components.kautomator.component.common.builders
 
+import android.os.Build
 import androidx.annotation.IdRes
+import androidx.annotation.RequiresApi
 import androidx.annotation.StringRes
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.uiautomator.BySelector
@@ -315,6 +317,41 @@ class UiViewBuilder {
      */
     fun withMaxDepth(max: Int) = addSelector { maxDepth(max) }
 
+    /**
+     * Matches the view being on the display with the provided id
+     */
+    @RequiresApi(Build.VERSION_CODES.R)
+    fun withDisplayId(id: Int) = addSelector { displayId(id) }
+
+    /**
+     * Matches the view that has parent which fits the given matcher
+     */
+    fun withParent(function: UiViewBuilder.() -> Unit) = addSelector { hasParent(UiViewBuilder().apply(function).build().bySelector) }
+
+    /**
+     * Matches the view with given hint
+     *
+     * @param text Text to match
+     */
+    @RequiresApi(Build.VERSION_CODES.O)
+    fun withHint(text: String) = addSelector { hint(text) }
+
+    /**
+     * Matches the view with given hint
+     *
+     * @param textRes Text to match
+     */
+    @RequiresApi(Build.VERSION_CODES.O)
+    fun withHint(@StringRes textRes: Int) = addSelector { hint(KString.getString(textRes)) }
+
+    /**
+     * Matches the view with given hint
+     *
+     * @param text Text to match
+     */
+    @RequiresApi(Build.VERSION_CODES.O)
+    fun withHint(text: Pattern) = addSelector { hint(text) }
+
     /**
      * Matches the view which has child of given matcher
      *

diff --git a/...idTest/java/com/kaspersky/kaspresso/kautomatorsample/kaspresso/sanity/HintMatchersTest.kt b/...idTest/java/com/kaspersky/kaspresso/kautomatorsample/kaspresso/sanity/HintMatchersTest.kt
@@ -0,0 +1,27 @@
+package com.kaspersky.kaspresso.kautomatorsample.kaspresso.sanity
+
+import android.os.Build
+import androidx.test.ext.junit.rules.activityScenarioRule
+import com.kaspersky.kaspresso.kautomatorsample.ComponentsActivity
+import com.kaspersky.kaspresso.kautomatorsample.screen.ComponentsScreen
+import com.kaspersky.kaspresso.testcases.api.testcase.TestCase
+import org.junit.Assume
+import org.junit.Rule
+import org.junit.Test
+
+class HintMatchersTest : TestCase() {
+
+    @get:Rule
+    val activityRule = activityScenarioRule<ComponentsActivity>()
+
+    @Test
+    fun test() = run {
+        Assume.assumeTrue("Hint matchers are available on API 26+", Build.VERSION.SDK_INT >= Build.VERSION_CODES.O)
+
+        ComponentsScreen {
+            editTextByHintResId { isDisplayed() }
+            editTextByHintText { isDisplayed() }
+            editTextByHintPattern { isDisplayed() }
+        }
+    }
+}
diff --git a/.../src/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/screen/ComponentsScreen.kt b/.../src/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/screen/ComponentsScreen.kt
@@ -4,8 +4,10 @@ import com.kaspersky.components.kautomator.component.bottomnav.UiBottomNavigatio
 import com.kaspersky.components.kautomator.component.check.UiCheckBox
 import com.kaspersky.components.kautomator.component.chip.UiChipGroup
 import com.kaspersky.components.kautomator.component.dialog.UiAlertDialog
+import com.kaspersky.components.kautomator.component.edit.UiEditText
 import com.kaspersky.components.kautomator.component.text.UiButton
 import com.kaspersky.components.kautomator.screen.UiScreen
+import com.kaspersky.kaspresso.kautomatorsample.R
 
 object ComponentsScreen : UiScreen<ComponentsScreen>() {
 
@@ -16,4 +18,8 @@ object ComponentsScreen : UiScreen<ComponentsScreen>() {
     val chipGroup = UiChipGroup { withId(this@ComponentsScreen.packageName, "chipGroup") }
     val showDialogBtn = UiButton { withId(this@ComponentsScreen.packageName, "showDialogBtn") }
     val dialog = UiAlertDialog(packageName)
+
+    val editTextByHintResId = UiEditText { withHint(R.string.hint) }
+    val editTextByHintText = UiEditText { withHint("Some hint") }
+    val editTextByHintPattern = UiEditText { withHint("Some.*".toPattern()) }
 }
diff --git a/...rc/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/screen/ParentSearchScreen.kt b/...rc/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/screen/ParentSearchScreen.kt
@@ -0,0 +1,21 @@
+package com.kaspersky.kaspresso.kautomatorsample.screen
+
+import com.kaspersky.components.kautomator.component.text.UiTextView
+import com.kaspersky.components.kautomator.screen.UiScreen
+import com.kaspersky.kaspresso.kautomatorsample.R
+
+object ParentSearchScreen : UiScreen<ParentSearchScreen>() {
+    override val packageName = "com.kaspersky.kaspresso.kautomatorsample"
+
+    val textByParentId = UiTextView {
+        isFocusable()
+        withParent { withId(R.id.container1) }
+    }
+
+    val textByParentChild = UiTextView {
+        isFocusable()
+        withParent {
+            withChild { withId(R.id.title2) }
+        }
+    }
+}
diff --git a/...le/src/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/test/ParentSearchTest.kt b/...le/src/androidTest/java/com/kaspersky/kaspresso/kautomatorsample/test/ParentSearchTest.kt
@@ -0,0 +1,28 @@
+package com.kaspersky.kaspresso.kautomatorsample.test
+
+import androidx.test.ext.junit.rules.activityScenarioRule
+import com.kaspersky.kaspresso.kautomatorsample.ParentSearchActivity
+import com.kaspersky.kaspresso.kautomatorsample.screen.ParentSearchScreen
+import com.kaspersky.kaspresso.testcases.api.testcase.TestCase
+import org.junit.Rule
+import org.junit.Test
+import com.kaspersky.kaspresso.kautomatorsample.R
+
+class ParentSearchTest : TestCase() {
+    @get:Rule
+    val activityRule = activityScenarioRule<ParentSearchActivity>()
+
+    @Test
+    fun test() = run {
+        ParentSearchScreen {
+            textByParentId {
+                val text1 = device.targetContext.resources.getString(R.string.parent_search_value1)
+                hasText(text1)
+            }
+            textByParentChild {
+                val text2 = device.targetContext.resources.getString(R.string.parent_search_value2)
+                hasText(text2)
+            }
+        }
+    }
+}
diff --git a/samples/kautomator-sample/src/main/AndroidManifest.xml b/samples/kautomator-sample/src/main/AndroidManifest.xml
@@ -29,6 +29,7 @@
         <activity android:name=".autoscroll.AutoScrollActivity" />
         <activity android:name=".flaky.FlakyActivity" />
         <activity android:name=".systemdialogs.SystemDialogsActivity" />
+        <activity android:name=".ParentSearchActivity" />
     </application>
 
 </manifest>
diff --git a/...tor-sample/src/main/java/com/kaspersky/kaspresso/kautomatorsample/ParentSearchActivity.kt b/...tor-sample/src/main/java/com/kaspersky/kaspresso/kautomatorsample/ParentSearchActivity.kt
@@ -0,0 +1,11 @@
+package com.kaspersky.kaspresso.kautomatorsample
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+
+class ParentSearchActivity : AppCompatActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_parent_search)
+    }
+}
diff --git a/samples/kautomator-sample/src/main/res/layout/activity_parent_search.xml b/samples/kautomator-sample/src/main/res/layout/activity_parent_search.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ScrollView xmlns:android="http://schemas.android.com/apk/res/android"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:fillViewport="true">
+    <LinearLayout
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:orientation="vertical">
+
+        <LinearLayout
+            android:id="@+id/container1"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:orientation="vertical"
+            android:padding="16dp">
+            <TextView
+                android:id="@+id/title"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                android:textAppearance="@style/TextAppearance.AppCompat.Headline"
+                android:text="Some title" />
+            <TextView
+                android:focusable="true"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                android:textAppearance="@style/TextAppearance.AppCompat.Body1"
+                android:text="@string/parent_search_value1" />
+        </LinearLayout>
+
+        <com.google.android.material.divider.MaterialDivider
+            android:layout_width="match_parent"
+            android:layout_height="1dp" />
+
+        <LinearLayout
+            android:id="@+id/container2"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:orientation="vertical"
+            android:padding="16dp">
+            <TextView
+                android:id="@+id/title2"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                android:textAppearance="@style/TextAppearance.AppCompat.Headline"
+                android:text="Some title" />
+            <TextView
+                android:focusable="true"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                android:textAppearance="@style/TextAppearance.AppCompat.Body1"
+                android:text="@string/parent_search_value2" />
+        </LinearLayout>
+    </LinearLayout>
+</ScrollView>
diff --git a/samples/kautomator-sample/src/main/res/layout/activity_ui_components.xml b/samples/kautomator-sample/src/main/res/layout/activity_ui_components.xml
@@ -68,6 +68,16 @@
             app:layout_constraintStart_toStartOf="parent"
             app:layout_constraintTop_toBottomOf="@id/chipGroup" />
 
+        <EditText
+            android:id="@+id/edit"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:layout_marginTop="8dp"
+            android:hint="@string/hint"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toBottomOf="@id/showDialogBtn" />
+
     </androidx.constraintlayout.widget.ConstraintLayout>
 
     <com.google.android.material.navigation.NavigationView

diff --git a/samples/kautomator-sample/src/main/res/values/strings.xml b/samples/kautomator-sample/src/main/res/values/strings.xml
@@ -13,4 +13,8 @@
     <string name="chip_2">Chip 2</string>
     <string name="chip_3">Chip 3</string>
     <string name="dialog">Dialog</string>
+    <string name="hint">Some hint</string>
+
+    <string name="parent_search_value1">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor </string>
+    <string name="parent_search_value2">Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium</string>
 </resources>