appium-espresso-driver 1.46.0

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/UiautomatorParams.kt

@@ -0,0 +1,123 @@
+/*
+ * 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.model
+
+import com.google.gson.annotations.SerializedName
+
+class UiautomatorParams : AppiumParams() {
+    val strategy: Strategy? = null
+    val locator: String? = null
+    val index: Int? = null
+    val action: Action? = null
+
+    enum class Strategy constructor(val strategyName: String) {
+        @SerializedName("clazz")
+        CLASS_NAME("clazz"),
+
+        @SerializedName("res")
+        ID("res"),
+
+        @SerializedName("text")
+        TEXT("text"),
+
+        @SerializedName("textContains")
+        TEXT_CONTAIN("textContains"),
+
+        @SerializedName("textEndsWith")
+        TEXT_ENDS_WITH("textEndsWith"),
+
+        @SerializedName("textStartsWith")
+        TEXT_STARTS_WITH("textStartsWith"),
+
+        @SerializedName("desc")
+        DESC("desc"),
+
+        @SerializedName("descContains")
+        DESC_CONTAINS("descContains"),
+
+        @SerializedName("descEndsWith")
+        DESC_ENDS_WITH("descEndsWith"),
+
+        @SerializedName("descStartsWith")
+        DESC_STARTS_WITH("descStartsWith"),
+
+        @SerializedName("pkg")
+        APPLICATION_PACKAGE("pkg");
+    }
+
+    enum class Action constructor(val actionName: String) {
+        @SerializedName("click")
+        CLICK("click"),
+
+        @SerializedName("longClick")
+        LONG_CLICK("longClick"),
+
+        @SerializedName("getText")
+        GET_TEXT("getText"),
+
+        @SerializedName("getContentDescription")
+        GET_CONTENT_DESCRIPTION("getContentDescription"),
+
+        @SerializedName("getClassName")
+        GET_CLASS_NAME("getClassName"),
+
+        @SerializedName("getResourceName")
+        GET_RESOURCE_NAME("getResourceName"),
+
+        @SerializedName("getVisibleBounds")
+        GET_VISIBLE_BOUNDS("getVisibleBounds"),
+
+        @SerializedName("getVisibleCenter")
+        GET_VISIBLE_CENTER("getVisibleCenter"),
+
+        @SerializedName("getApplicationPackage")
+        GET_APPLICATION_PACKAGE("getApplicationPackage"),
+
+        @SerializedName("getChildCount")
+        GET_CHILD_COUNT("getChildCount"),
+
+        @SerializedName("clear")
+        CLEAR("clear"),
+
+        @SerializedName("isCheckable")
+        IS_CHECKABLE("isCheckable"),
+
+        @SerializedName("isChecked")
+        IS_CHECKED("isChecked"),
+
+        @SerializedName("isClickable")
+        IS_CLICKABLE("isClickable"),
+
+        @SerializedName("isEnabled")
+        IS_ENABLED("isEnabled"),
+
+        @SerializedName("isFocusable")
+        IS_FOCUSABLE("isFocusable"),
+
+        @SerializedName("isFocused")
+        IS_FOCUSED("isFocused"),
+
+        @SerializedName("isLongClickable")
+        IS_LONG_CLICKABLE("isLongClickable"),
+
+        @SerializedName("isScrollable")
+        IS_SCROLLABLE("isScrollable"),
+
+        @SerializedName("isSelected")
+        IS_SELECTED("isSelected");
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/ViewAttributesEnum.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.model
+
+enum class ViewAttributesEnum {
+
+    CONTENT_DESC,
+    CLASS,
+    TEXT,
+    PACKAGE,
+    CHECKABLE,
+    CHECKED,
+    CLICKABLE,
+    ENABLED,
+    FOCUSABLE,
+    FOCUSED,
+    SCROLLABLE,
+    LONG_CLICKABLE,
+    PASSWORD,
+    SELECTED,
+    VISIBLE,
+    NO_MULTILINE_BUTTONS,
+    NO_OVERLAPS,
+    NO_ELLIPSIZED_TEXT,
+    BOUNDS,
+    RESOURCE_ID,
+    INSTANCE,
+    INDEX,
+    ADAPTERS,
+    ADAPTER_TYPE,
+    HINT,
+    VIEW_TAG;
+
+    override fun toString(): String {
+        return this.name.replace("_", "-").toLowerCase()
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/ViewElement.kt

@@ -0,0 +1,204 @@
+/*
+ * 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.model
+
+import android.app.Activity
+import android.content.Context
+import android.content.ContextWrapper
+import android.content.res.Resources
+import android.graphics.Rect
+import android.view.View
+import android.view.View.NO_ID
+import android.view.ViewGroup
+import android.view.inputmethod.EditorInfo
+import android.widget.Checkable
+import android.widget.NumberPicker
+import android.widget.ProgressBar
+import android.widget.TextView
+import androidx.test.core.app.ApplicationProvider.getApplicationContext
+import androidx.test.espresso.matcher.ViewMatchers
+
+class ViewElement(private val view: View) {
+    private var activity: Activity? = null
+
+    val contentDescription: CharSequence?
+        get() = view.contentDescription
+
+    val bounds: Rect
+        get() {
+            val l = IntArray(2)
+            view.getLocationOnScreen(l)
+            return Rect(l[0], l[1], l[0] + view.width, l[1] + view.height)
+        }
+
+    val isClickable: Boolean
+        get() = ViewMatchers.isClickable().matches(view)
+
+    val isLongClickable: Boolean
+        get() = view.isLongClickable
+
+    val isCheckable: Boolean
+        get() = view is Checkable
+
+    val isChecked: Boolean
+        get() = ViewMatchers.isChecked().matches(view)
+
+    val isFocused: Boolean
+        get() = isFocusable && view.isAccessibilityFocused
+
+    val isVisible: Boolean
+        get() = ViewMatchers.isDisplayed().matches(view)
+
+    val id: Int
+        get() = view.id
+
+    // ignore
+    val resourceId: String?
+        get() {
+            val id = id
+            if (id != NO_ID) {
+                val r = view.resources
+                if (id > 0 && r != null) {
+                    try {
+                        val pkgname: String
+                        when (id and -0x1000000) {
+                            0x7f000000 -> pkgname = "app"
+                            0x01000000 -> pkgname = "android"
+                            else -> pkgname = r.getResourcePackageName(id)
+                        }
+                        return String.format("%s:%s/%s", pkgname,
+                                r.getResourceTypeName(id), r.getResourceEntryName(id))
+                    } catch (e: Resources.NotFoundException) {
+                    }
+
+                }
+            }
+            return null
+        }
+
+    // we want the index of the inner class
+    // if this isn't an inner class, just find the start of the
+    // top level class name.
+    val className: String
+        get() {
+            var nameCopy = view.javaClass.name
+            nameCopy = nameCopy.replace("\\$[0-9]+".toRegex(), "\\$")
+            val start = nameCopy.lastIndexOf('$')
+            return if (start < 0) {
+                nameCopy
+            } else nameCopy.substring(0, start)
+        }
+
+    val index: Int
+        get() {
+            val parentView = view.parent
+            if (parentView is ViewGroup) {
+                for (index in 0 until parentView.childCount) {
+                    if (view == parentView.getChildAt(index)) {
+                        return index
+                    }
+                }
+            }
+            return 0
+        }
+
+    val text: ViewText?
+        get() {
+            if (view is ProgressBar) {
+                return ViewText(view.progress)
+            }
+            if (view is NumberPicker) {
+                return ViewText(view.value)
+            }
+            if (view is TextView) {
+                val textValue = view.text
+                val hintValue = view.hint
+                return if ((textValue == null || textValue.toString().isEmpty())
+                        && hintValue != null && !hintValue.toString().isEmpty()) {
+                    ViewText(hintValue.toString(), true)
+                } else ViewText(textValue.toString(), false)
+            }
+
+            return null
+        }
+
+    val isEnabled: Boolean
+        get() = ViewMatchers.isEnabled().matches(view)
+
+    val isFocusable: Boolean
+        get() = ViewMatchers.isFocusable().matches(view)
+
+    val isScrollable: Boolean
+        get() = view.isScrollContainer
+
+    val isPassword: Boolean
+        get() = view is TextView && isPasswordInputType(view.inputType)
+
+    val isSelected: Boolean
+        get() = ViewMatchers.isSelected().matches(view)
+
+    val relativeLeft: Int
+        get() = view.left
+
+    val relativeTop: Int
+        get() = view.top
+
+    val packageName: String
+        get() = getApplicationContext<Context>().packageName
+
+    val viewTag: String?
+        get() {
+            val tag = view.tag
+            return tag?.toString()
+        }
+
+    @Synchronized
+    fun extractActivity(): Activity? {
+        this.activity?.let {
+            return it
+        }
+
+        var result = getActivity(view.context)
+        if (result == null && view is ViewGroup) {
+            var i = 0
+            while (i < view.childCount && result == null) {
+                result = getActivity(view.getChildAt(i).context)
+                ++i
+            }
+        }
+        this.activity = result
+        return result
+    }
+
+    private fun getActivity(ctx: Context): Activity? {
+        var context = ctx
+        while (context is ContextWrapper) {
+            if (context is Activity) {
+                return context
+            }
+            context = context.baseContext
+        }
+        return null
+    }
+
+    private fun isPasswordInputType(inputType: Int): Boolean {
+        val variation = inputType and (EditorInfo.TYPE_MASK_CLASS or EditorInfo.TYPE_MASK_VARIATION)
+        return (variation == EditorInfo.TYPE_CLASS_TEXT or EditorInfo.TYPE_TEXT_VARIATION_PASSWORD
+                || variation == EditorInfo.TYPE_CLASS_TEXT or EditorInfo.TYPE_TEXT_VARIATION_WEB_PASSWORD
+                || variation == EditorInfo.TYPE_CLASS_NUMBER or EditorInfo.TYPE_NUMBER_VARIATION_PASSWORD)
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/ViewFlashParams.kt

@@ -0,0 +1,9 @@
+package io.appium.espressoserver.lib.model
+
+val DURATION_MILLIS = 30
+val REPEAT_COUNT = 15
+
+data class ViewFlashParams(
+    val durationMillis: Int = DURATION_MILLIS,
+    val repeatCount: Int = REPEAT_COUNT
+) : AppiumParams()

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/ViewText.kt

@@ -0,0 +1,12 @@
+package io.appium.espressoserver.lib.model
+
+data class ViewText(
+    val rawText: String = "",
+    val isHint: Boolean = false
+) {
+    constructor(rawText: Int) : this(Integer.toString(rawText), false)
+
+    override fun toString(): String {
+        return rawText
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/WindowRect.kt

@@ -0,0 +1,24 @@
+/*
+ * 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.model
+
+data class WindowRect(
+    val width: Int,
+    val height: Int,
+    val x: Int,
+    val y: Int
+) : AppiumParams()

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/WindowSize.kt

@@ -0,0 +1,22 @@
+/*
+ * 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.model
+
+data class WindowSize(
+    val width: Int,
+    val height: Int
+) : AppiumParams()

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/settings/AbstractSetting.kt

@@ -0,0 +1,23 @@
+/*
+ * 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.model.settings
+
+abstract class AbstractSetting {
+    abstract var name: String
+    abstract fun value(): Any?
+    abstract fun apply(value: Any?)
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/settings/DriverSetting.kt

@@ -0,0 +1,40 @@
+/*
+ * 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.model.settings
+
+import io.appium.espressoserver.EspressoServerRunnerTest
+import io.appium.espressoserver.lib.drivers.DriverContext
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidArgumentException
+
+class DriverSetting : AbstractSetting() {
+    override var name: String = "driver"
+
+    override fun value(): String {
+        return EspressoServerRunnerTest.context.driverStrategy.name.toString().toLowerCase()
+    }
+
+    override fun apply(value: Any?) {
+        val driverStrategy =
+            DriverContext.StrategyType.values().find { it.toString().toLowerCase() == value }
+                ?: throw InvalidArgumentException(
+                    "driver type must be one of ${
+                        DriverContext.StrategyType.values().map { it.toString().toLowerCase() }
+                    }"
+                )
+        EspressoServerRunnerTest.context.setDriverStrategy(driverStrategy)
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/settings/SettingType.kt

@@ -0,0 +1,21 @@
+/*
+ * 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.model.settings
+
+enum class SettingType(var setting: AbstractSetting) {
+    DRIVER(DriverSetting())
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/web/WebAtom.kt

@@ -0,0 +1,26 @@
+/*
+ * 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.model.web
+
+import com.google.gson.annotations.JsonAdapter
+import io.appium.espressoserver.lib.model.AppiumParams
+
+@JsonAdapter(WebAtomDeserializer::class)
+data class WebAtom(
+    val name: String,
+    val args: Array<Any> = emptyArray()
+) : AppiumParams()

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/web/WebAtomDeserializer.kt

@@ -0,0 +1,99 @@
+package io.appium.espressoserver.lib.model.web
+
+import androidx.test.espresso.web.webdriver.Locator
+import com.google.gson.JsonDeserializationContext
+import com.google.gson.JsonDeserializer
+import com.google.gson.JsonElement
+import com.google.gson.JsonParseException
+import io.appium.espressoserver.lib.handlers.exceptions.InvalidSelectorException
+import io.appium.espressoserver.lib.helpers.AssertHelpers
+import io.appium.espressoserver.lib.helpers.GsonParserHelpers
+import java.lang.reflect.Type
+
+
+// Deserializer for WebAtom
+class WebAtomDeserializer : JsonDeserializer<WebAtom> {
+    @Throws(JsonParseException::class)
+    override fun deserialize(json: JsonElement, paramType: Type?,
+                             paramJsonDeserializationContext: JsonDeserializationContext?): WebAtom {
+
+        if (json.isJsonObject) {
+            val jsonObj = json.asJsonObject
+
+            // Parse the name of the Atom
+            AssertHelpers.assertIsPrimitive(jsonObj, "name")
+            val webAtomName = jsonObj.get("name").asString
+
+            // Parse the Locator shorthand. If it was provided.
+            jsonObj.get("locator")?.let {
+                // Validate the locator
+                if (!it.isJsonObject) {
+                    throw JsonParseException("'locator' must be an object with properties 'using' and 'value'")
+                }
+
+                // Validate that the locator contains "using" and "value"
+                val locator = it.asJsonObject
+                if (!locator.has("using") || !locator.has("value")) {
+                    throw JsonParseException("'locator' must have properties 'using' and 'value'")
+                }
+
+                // Validate that "using" and "value" are primitives
+                val using = locator.get("using")
+                val value = locator.get("value")
+
+                if (!using.isJsonPrimitive || !value.isJsonPrimitive) {
+                    throw JsonParseException("'using' and 'value' must be primitive types. " +
+                            "Found 'using=${locator.get("using")}, value=${locator.get("value")}'")
+                }
+
+                val supportedLocatorNames = Locator.values().map { v -> v.name }
+                if (using.asString.toUpperCase() !in supportedLocatorNames) {
+                    throw InvalidSelectorException("Only the following locator types are supported: " +
+                            "$supportedLocatorNames (case-insensitive). '${locator.get("using")}' is given instead")
+                }
+
+                // Set the args as locator
+                return WebAtom(webAtomName, arrayOf(
+                        Locator.valueOf(using.asString.toUpperCase()),
+                        value.asString
+                ))
+            }
+
+            // Parse the args
+            jsonObj.get("args")?.let { args ->
+                when {
+                    args.isJsonPrimitive -> {
+                        return WebAtom(webAtomName, arrayOf(GsonParserHelpers.parsePrimitive(args.asJsonPrimitive)))
+                    }
+                    args.isJsonArray -> {
+                        val argsAsList = args.asJsonArray.map { arg ->
+                            if (arg.isJsonPrimitive)
+                                GsonParserHelpers.parsePrimitive(arg.asJsonPrimitive)
+                            else
+                                throw JsonParseException("'${arg}' is not a valid 'arg' type")
+                        }
+
+                        return WebAtom(webAtomName, argsAsList.toTypedArray())
+                    }
+                    else -> {
+                        throw JsonParseException(
+                                "'args' must be an array or a single, primitive JSON type. Found '${args}'"
+                        )
+                    }
+                }
+            }
+
+            // If no args provided, treat it as a function call with no parameters
+            if (!jsonObj.has("args")) {
+                return WebAtom(webAtomName, emptyArray())
+            }
+
+        } else if (json.isJsonPrimitive) {
+            // If JSON was provided as a String, treat it as a function call with no parameters
+            return WebAtom(json.asString, emptyArray())
+        }
+
+        // This block is unreachable
+        throw JsonParseException("Expected atom to be a string or an object. Found '${json}'")
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/web/WebAtomsMethods.kt

@@ -0,0 +1,4 @@
+package io.appium.espressoserver.lib.model.web
+
+
+data class WebAtomsMethod(val name: String, val atom: WebAtom)

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/web/WebAtomsParams.kt

@@ -0,0 +1,9 @@
+package io.appium.espressoserver.lib.model.web
+
+import io.appium.espressoserver.lib.model.AppiumParams
+
+data class WebAtomsParams(
+        val webviewElement: String,
+        val forceJavascriptEnabled: Boolean,
+        val methodChain: List<WebAtomsMethod> = emptyList()
+) : AppiumParams()