appium-espresso-driver 1.46.0

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/AutofillHelpers.kt

@@ -0,0 +1,44 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import android.os.Build
+import android.view.View
+import android.view.autofill.AutofillManager
+
+import androidx.test.espresso.UiController
+import androidx.test.espresso.ViewAction
+
+import org.hamcrest.Matcher
+import org.hamcrest.Matchers
+
+class DisableAutofillAction : ViewAction {
+
+    override fun getConstraints(): Matcher<View> {
+        return Matchers.any(View::class.java)
+    }
+
+    override fun getDescription(): String {
+        return "Dismissing autofill picker"
+    }
+
+    override fun perform(uiController: UiController, view: View) {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            view.context.getSystemService(AutofillManager::class.java)?.cancel()
+        }
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/BackdoorUtils.java

@@ -0,0 +1,49 @@
+package io.appium.espressoserver.lib.helpers;
+
+public class BackdoorUtils {
+
+    public static Object parseValue(Object o, Class<?> c) {
+        if (o == null) return null;
+        String value = o.toString();
+        if (c.equals(boolean.class) || c.equals(Boolean.class)) return Boolean.parseBoolean(value);
+        if (c.equals(byte.class) || c.equals(Byte.class)) return Byte.parseByte(value);
+        if (c.equals(short.class) || c.equals(Short.class)) return Short.parseShort(value);
+        if (c.equals(int.class) || c.equals(Integer.class)) return Integer.parseInt(value);
+        if (c.equals(long.class) || c.equals(Long.class)) return Long.parseLong(value);
+        if (c.equals(float.class) || c.equals(Float.class)) return Float.parseFloat(value);
+        if (c.equals(double.class) || c.equals(Double.class)) return Double.parseDouble(value);
+        if (c.equals(char.class) || c.equals(Character.class)) return value.charAt(0);
+        return o;
+    }
+
+    public static Class<?> parseType(final String className) {
+        switch (className) {
+            case "boolean":
+                return boolean.class;
+            case "byte":
+                return byte.class;
+            case "short":
+                return short.class;
+            case "int":
+                return int.class;
+            case "long":
+                return long.class;
+            case "float":
+                return float.class;
+            case "double":
+                return double.class;
+            case "char":
+                return char.class;
+            case "void":
+                return void.class;
+            default:
+                String fqn = className.contains(".") ? className : "java.lang." + className;
+                try {
+                    return Class.forName(fqn);
+                } catch (ClassNotFoundException ex) {
+                    throw new IllegalArgumentException("Class not found: " + fqn, ex);
+                }
+        }
+    }
+
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/ClipboardHelper.kt

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import android.content.ClipData
+import android.content.ClipboardManager
+import android.content.Context
+
+class ClipboardHelper(private val context: Context) {
+    private val DEFAULT_LABEL_LEN = 10
+
+    private val manager: ClipboardManager
+        get() = context.getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
+
+    val textData: String
+        get() {
+            val cm = manager
+            if (!cm.hasPrimaryClip()) {
+                return ""
+            }
+            val cd = cm.primaryClip
+            if (cd == null || cd.itemCount == 0) {
+                return ""
+            }
+            val text = cd.getItemAt(0).coerceToText(context)
+            return text?.toString() ?: ""
+        }
+
+    fun setTextData(label: String?, data: String) {
+        val cm = manager
+        val labelToSet = label ?: if (data.length >= DEFAULT_LABEL_LEN)
+            data.substring(0, DEFAULT_LABEL_LEN)
+        else
+            data
+        cm.setPrimaryClip(ClipData.newPlainText(labelToSet, data))
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/ComposeNodeFinder.kt

@@ -0,0 +1,59 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import androidx.compose.ui.semantics.SemanticsNode
+import androidx.compose.ui.test.*
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidSelectorException
+import io.appium.espressoserver.lib.model.Strategy
+import io.appium.espressoserver.EspressoServerRunnerTest
+import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidArgumentException
+import io.appium.espressoserver.lib.handlers.exceptions.StaleElementException
+import io.appium.espressoserver.lib.model.Locator
+import java.util.NoSuchElementException
+
+/**
+ * Retrieve cached node and return the SemanticsNodeInteraction
+ */
+fun getNodeInteractionById(elementId: String?): SemanticsNodeInteraction =
+    elementId?.let { ComposeViewCache.get(it) ?: throw StaleElementException(it) }
+        ?: throw InvalidArgumentException("Cannot find 'null' element")
+
+
+fun SemanticsNodeInteraction.findDescendantNodeInteractions(locator: Locator): SemanticsNodeInteractionCollection =
+    this.onChildren().filter(semanticsMatcherForLocator(locator))
+
+fun semanticsMatcherForLocator(locator: Locator): SemanticsMatcher =
+    when (locator.using) {
+        Strategy.VIEW_TAG -> hasTestTag(locator.value!!)
+        Strategy.TEXT -> hasText(locator.value!!)
+        Strategy.LINK_TEXT -> hasText(locator.value!!)
+        Strategy.ACCESSIBILITY_ID -> hasContentDescription(locator.value!!)
+        else -> throw InvalidSelectorException(
+            "Can't use non-Compose selectors. " +
+                    "Only ${Strategy.VIEW_TAG}, ${Strategy.TEXT}, ${Strategy.LINK_TEXT} and " +
+                    "${Strategy.ACCESSIBILITY_ID} are supported"
+        )
+    }
+
+fun getSemanticsNode(elementId: String): SemanticsNode =
+    try {
+        getNodeInteractionById(elementId).fetchSemanticsNode()
+    } catch (e: AssertionError) {
+        throw StaleElementException(elementId)
+    }

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/DeviceInfoHelper.kt

@@ -0,0 +1,148 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import android.annotation.SuppressLint
+import android.content.Context
+import android.os.Build
+import android.provider.Settings.Secure
+import android.telephony.TelephonyManager
+import android.util.DisplayMetrics
+import android.view.Display
+import android.view.WindowManager
+import java.util.TimeZone
+import java.util.Locale
+
+class DeviceInfoHelper(private val context: Context) {
+
+    private val defaultDisplay: Display?
+        get() {
+            val windowManager = context.getSystemService(Context.WINDOW_SERVICE)
+            return (windowManager as? WindowManager)?.defaultDisplay;
+        }
+
+    /**
+     * A unique serial number identifying a device, if a device has multiple users,  each user appears as a
+     * completely separate device, so the ANDROID_ID value is unique to each user.
+     * See https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID
+     * for more info.
+     *
+     * @return ANDROID_ID A 64-bit number (as a hex string) that is uniquely generated when the user
+     * first sets up the device and should remain constant for the lifetime of the user's device. The value
+     * may change if a factory reset is performed on the device.
+     */
+    val androidId: String
+        @SuppressLint("HardwareIds")
+        get() = Secure.getString(context.contentResolver, Secure.ANDROID_ID)
+
+    /**
+     * @return Build.MANUFACTURER value
+     */
+    val manufacturer: String
+        get() = Build.MANUFACTURER
+
+    /**
+     * @return Build.MODEL value
+     */
+    val modelName: String
+        get() = Build.MODEL
+
+    /**
+     * @return Build.BRAND value
+     */
+    val brand: String
+        get() = Build.BRAND
+
+    /**
+     * Current running OS's API VERSION
+     *
+     * @return the os version as String
+     */
+    val apiVersion: String
+        get() = Integer.toString(Build.VERSION.SDK_INT)
+
+    /**
+     * @return The current version string, for example "1.0" or "3.4b5"
+     */
+    val platformVersion: String
+        get() = Build.VERSION.RELEASE
+
+    /**
+     * @return The logical density of the display in Density Independent Pixel units.
+     */
+    val displayDensity: Int?
+        get() {
+            val display = defaultDisplay ?: return null
+            val metrics = DisplayMetrics()
+            display.getRealMetrics(metrics)
+            return (metrics.density * 160).toInt()
+        }
+
+    /**
+     * Retrievs the name of the current celluar network carrier
+     *
+     * @return carrier name or null if it cannot be retrieved
+     */
+    val carrierName: String?
+        get() {
+            val telephonyManager = context
+                    .getSystemService(Context.TELEPHONY_SERVICE) as? TelephonyManager
+            try {
+                return telephonyManager?.networkOperatorName
+            } catch (e: Exception) {
+                e.printStackTrace()
+                return null
+            }
+
+        }
+
+    /**
+     * Retrieves the real size of the default display
+     *
+     * @return The display size in 'WxH' format
+     */
+    val realDisplaySize: String?
+        get() {
+            val display = defaultDisplay ?: return null
+            val p = android.graphics.Point()
+            display.getRealSize(p)
+            return "${p.x}x${p.y}"
+        }
+
+    /**
+     * Get current system locale
+     *
+     * @return The locale as string
+     */
+    val locale: String
+        get() = Locale.getDefault().toString()
+
+    /**
+     * Get current system timezone
+     * e.g. "Asia/Tokyo", "America/Caracas"
+     *
+     * @return The timezone as string
+     */
+    val timeZone: String
+        get() {
+            return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+                TimeZone.getDefault().toZoneId().id
+            } else {
+                TimeZone.getDefault().id
+            }
+        }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/EspressoViewsCache.kt

@@ -0,0 +1,57 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import android.util.LruCache
+import android.view.View
+import androidx.compose.ui.test.SemanticsNodeInteraction
+
+const val MAX_CACHE_SIZE = 500
+
+data class ViewState(val view: View, val initialContentDescription: CharSequence?)
+
+object EspressoViewsCache {
+    private val cache = LruCache<String, ViewState>(MAX_CACHE_SIZE)
+
+    fun put(id: String, view: View) {
+        cache.put(id, ViewState(view, view.contentDescription))
+    }
+
+    fun get(id: String): ViewState? = cache.get(id)
+
+    fun has(id: String): Boolean = cache.get(id) != null
+
+    fun reset() {
+        cache.evictAll()
+    }
+}
+
+/** Compose does not have stable instances, use locator again. */
+object ComposeViewCache {
+    private val cache = LruCache<String, SemanticsNodeInteraction>(MAX_CACHE_SIZE)
+
+    fun put(id: String, composeNode: SemanticsNodeInteraction) {
+        cache.put(id, composeNode)
+    }
+
+    fun get(id: String?): SemanticsNodeInteraction? =
+        cache.get(id)
+
+    fun reset() {
+        cache.evictAll()
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/GsonParserHelpers.kt

@@ -0,0 +1,72 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import com.google.gson.JsonArray
+import com.google.gson.JsonObject
+import com.google.gson.JsonParseException
+import com.google.gson.JsonPrimitive
+
+object GsonParserHelpers {
+
+    inline fun <reified T : Enum<T>> parseEnum(jsonObj: JsonObject, propName: String,
+                                               helperMessage: String = "", defaultValue: T? = null): T? {
+        val property = jsonObj.get(propName)
+        if (property != null) {
+            val propValueAsString = property.asString.toUpperCase()
+            try {
+                return enumValueOf<T>(propValueAsString)
+            } catch (e: IllegalArgumentException) {
+                throw JsonParseException(""""
+                    '${propValueAsString}' is not a valid '${propName}' type. $helperMessage
+                """.trimIndent())
+            }
+        }
+        return defaultValue
+    }
+
+    fun parsePrimitive(jsonPrimitive: JsonPrimitive): Any = when {
+        jsonPrimitive.isNumber -> {
+            val hasDecimal = jsonPrimitive.asString.contains(".")
+            if (hasDecimal) {
+                jsonPrimitive.asDouble
+            } else {
+                val candidate = jsonPrimitive.asLong
+                if (Int.MIN_VALUE <= candidate && candidate <= Int.MAX_VALUE) {
+                    candidate.toInt()
+                } else {
+                    candidate
+                }
+            }
+        }
+        jsonPrimitive.isBoolean -> jsonPrimitive.asBoolean
+        jsonPrimitive.isString -> jsonPrimitive.asString
+        else -> throw JsonParseException("Could not parse primitive '${jsonPrimitive}'")
+    }
+
+    fun asArray (jsonObj: JsonObject, key: String): JsonArray {
+        jsonObj.get(key)?.let {
+            if (it.isJsonArray) {
+                return it.asJsonArray
+            }
+            val jsonArr = JsonArray()
+            jsonArr.add(it)
+            return jsonArr
+        }
+        return JsonArray()
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/IMEHelpers.kt

@@ -0,0 +1,88 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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.appium.espressoserver.lib.helpers
+
+import android.view.inputmethod.EditorInfo
+import androidx.test.espresso.Espresso.onView
+import androidx.test.espresso.NoMatchingViewException
+import androidx.test.espresso.PerformException
+import androidx.test.espresso.ViewInteraction
+import androidx.test.espresso.action.ViewActions.pressImeActionButton
+import androidx.test.espresso.matcher.ViewMatchers.hasFocus
+import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidArgumentException
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidElementStateException
+import io.appium.espressoserver.lib.viewaction.ViewGetter
+
+object IMEHelpers {
+    private val ACTION_CODES_MAP = mapOf(
+            "normal" to 0,
+            "unspecified" to 0,
+            "none" to 1,
+            "go" to 2,
+            "search" to 3,
+            "send" to 4,
+            "next" to 5,
+            "done" to 6,
+            "previous" to 7
+    )
+
+    @Throws(AppiumException::class)
+    private fun toActionCode(action: Any): Int {
+        if (action is Long) {
+            return action.toInt()
+        }
+        if (action is String) {
+            return ACTION_CODES_MAP[action.toLowerCase()]
+                    ?: throw InvalidArgumentException(
+                            "The action value can be one of ${ACTION_CODES_MAP.keys}. '$action' is given instead")
+        }
+        throw InvalidArgumentException(
+                "The action value can be either an integer action code or one of ${ACTION_CODES_MAP.keys}. " +
+                        "'$action' is given instead")
+    }
+
+    @Throws(AppiumException::class)
+    fun performEditorAction(action: Any?) {
+        val viewInteraction: ViewInteraction
+        try {
+            viewInteraction = onView(hasFocus())
+        } catch (e: NoMatchingViewException) {
+            throw InvalidElementStateException(
+                    "Currently there is no focused element to perform ${action
+                            ?: "the default"} editor action on", e)
+        }
+
+        if (action == null) {
+            AndroidLogger.debug("Performing the default editor action on the focused element")
+            try {
+                viewInteraction.perform(pressImeActionButton())
+                return
+            } catch (e: PerformException) {
+                throw InvalidElementStateException("Cannot perform the default action on the focused element")
+            }
+        }
+
+        val actionCode = toActionCode(action)
+        AndroidLogger.debug("Performing editor action $actionCode on the focused element")
+        val view = ViewGetter().getView(viewInteraction)
+        val ic = view.onCreateInputConnection(EditorInfo())
+        if (!ic.performEditorAction(actionCode)) {
+            throw InvalidElementStateException("Cannot perform editor action $action on the focused element")
+        }
+    }
+}