appium-espresso-driver 1.46.0

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/OrientationChange.kt

@@ -0,0 +1,47 @@
+/*
+ * 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.viewaction
+
+import android.content.pm.ActivityInfo
+import android.view.View
+import androidx.test.espresso.UiController
+import androidx.test.espresso.ViewAction
+import androidx.test.espresso.matcher.ViewMatchers
+import io.appium.espressoserver.lib.model.ViewElement
+import org.hamcrest.Matcher
+
+class OrientationChange constructor(private val orientation: Int) : ViewAction {
+    override fun getConstraints(): Matcher<View> {
+        return ViewMatchers.isRoot()
+    }
+
+    override fun getDescription(): String {
+        return "change orientation to $orientation"
+    }
+
+    override fun perform(uiController: UiController, view: View) {
+        uiController.loopMainThreadUntilIdle()
+        ViewElement(view).extractActivity()!!.requestedOrientation = orientation
+    }
+}
+
+fun orientationLandscape(): ViewAction {
+    return OrientationChange(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE)
+}
+
+fun orientationPortrait(): ViewAction {
+    return OrientationChange(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT)
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/ScrollTo.kt

@@ -0,0 +1,48 @@
+/*
+ * 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.viewaction
+
+import android.view.View
+import android.widget.AbsListView
+import androidx.test.espresso.UiController
+import androidx.test.espresso.ViewAction
+import androidx.test.espresso.matcher.ViewMatchers
+import org.hamcrest.Matcher
+
+class ScrollTo : ViewAction {
+    private var xOffset = 0
+    private var yOffset = 0
+
+    override fun getConstraints(): Matcher<View> {
+        // This is a hack constraint that passes any view through
+        return ViewMatchers.isDescendantOfA(ViewMatchers.isRoot())
+    }
+
+    override fun getDescription(): String {
+        return "scrolling by [$xOffset, $yOffset] vector"
+    }
+
+    override fun perform(uiController: UiController, view: View) {
+        val x = view.left + xOffset
+        val y = view.top + view.height + yOffset
+        val viewParent = view.parent as View
+        if (viewParent is AbsListView) {
+            viewParent.smoothScrollToPosition(y)
+        } else {
+            viewParent.scrollTo(x, y)
+        }
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/UiControllerPerformer.kt

@@ -0,0 +1,67 @@
+/*
+ * 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.viewaction
+
+import android.view.View
+import androidx.test.espresso.Espresso
+import androidx.test.espresso.NoMatchingViewException
+import androidx.test.espresso.UiController
+import androidx.test.espresso.ViewAction
+import androidx.test.espresso.action.ViewActions
+import androidx.test.espresso.matcher.ViewMatchers
+import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
+import io.appium.espressoserver.lib.helpers.AndroidLogger
+import io.appium.espressoserver.lib.viewmatcher.withView
+import org.hamcrest.Matcher
+
+class UiControllerPerformer<T>(private val runnable: UiControllerRunnable<T>) : ViewAction {
+    private var appiumException: AppiumException? = null
+    private var runResult: T? = null
+
+    override fun getConstraints(): Matcher<View> {
+        return ViewMatchers.isRoot()
+    }
+
+    override fun getDescription(): String {
+        return "applying W3C actions "
+    }
+
+    override fun perform(uiController: UiController, view: View) {
+        try {
+            runResult = runnable.run(uiController)
+        } catch (e: AppiumException) {
+            appiumException = e
+        }
+    }
+
+    @Throws(AppiumException::class)
+    fun run(): T? {
+        // Get the root view because it doesn't matter what we perform this interaction on
+        val rootView = ViewGetter().rootView
+        val viewInteraction = Espresso.onView(withView(rootView))
+        AndroidLogger.info("Performing W3C actions sequence")
+        try {
+            viewInteraction.perform(this, ViewActions.closeSoftKeyboard())
+        } catch (nme: NoMatchingViewException) {
+            // Ignore this. The viewMatcher is a hack to begin with
+        }
+        if (appiumException != null) {
+            throw appiumException!!
+        }
+        return runResult
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/UiControllerRunnable.kt

@@ -0,0 +1,25 @@
+/*
+ * 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.viewaction
+
+import androidx.test.espresso.UiController
+import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
+
+interface UiControllerRunnable<T> {
+    @Throws(AppiumException::class)
+    fun run(uiController: UiController): T
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/ViewGetter.kt

@@ -0,0 +1,79 @@
+/*
+ * 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.viewaction
+
+import android.view.View
+import androidx.test.espresso.*
+import androidx.test.espresso.matcher.ViewMatchers
+import org.hamcrest.Description
+import org.hamcrest.Matcher
+import org.hamcrest.TypeSafeMatcher
+
+/**
+ * Get a View in an the Android App
+ * Hack solution that makes use of Espresso ViewActions
+ */
+class ViewGetter {
+    private val views = arrayOf<View?>(null)
+
+    /**
+     * To get the root view we implement a custom ViewAction that simply takes the View
+     * and then saves it to an array in it's parent class.
+     */
+    private inner class GetViewAction : ViewAction {
+        override fun getConstraints(): Matcher<View> {
+            // This is a hack constraint that passes any view through
+            return object : TypeSafeMatcher<View>() {
+                override fun describeTo(description: Description) {
+                    description.appendText("always matches to: ")
+                }
+
+                override fun matchesSafely(item: View?): Boolean {
+                    return true
+                }
+            }
+        }
+
+        override fun getDescription(): String {
+            return "getting view in application"
+        }
+
+        override fun perform(uiController: UiController, view: View) {
+            views[0] = view
+        }
+    }
+
+    /**
+     * This function calls the above view action which saves the view to 'views' array
+     * and then returns it
+     * @return The root
+     */
+    val rootView: View
+        get() {
+            Espresso.onView(ViewMatchers.isRoot()).perform(GetViewAction())
+            return views[0]!!
+        }
+
+    fun getView(viewInteraction: ViewInteraction): View {
+        viewInteraction.perform(GetViewAction())
+        return views[0]!!
+    }
+
+    fun getView(dataInteraction: DataInteraction): View {
+        dataInteraction.perform(GetViewAction())
+        return views[0]!!
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewaction/ViewTextGetter.kt

@@ -0,0 +1,31 @@
+/*
+ * 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.viewaction
+
+import androidx.test.espresso.ViewInteraction
+import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
+import io.appium.espressoserver.lib.model.ViewElement
+import io.appium.espressoserver.lib.model.ViewText
+
+class ViewTextGetter {
+    @Throws(AppiumException::class)
+    operator fun get(viewInteraction: ViewInteraction): ViewText {
+        val view = ViewGetter().getView(viewInteraction)
+        return ViewElement(view).text
+                ?: throw AppiumException("Views of class type ${view.javaClass.name} have no 'text' property")
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewmatcher/RegexpTextMatcher.kt

@@ -0,0 +1,38 @@
+/*
+ * 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.viewmatcher
+
+import android.view.View
+import android.widget.TextView
+import androidx.test.espresso.matcher.BoundedMatcher
+import org.hamcrest.Description
+import java.util.regex.Pattern
+
+class RegexpTextMatcher constructor(private val pattern: Pattern)
+    : BoundedMatcher<View?, TextView>(TextView::class.java) {
+    override fun matchesSafely(item: TextView): Boolean {
+        val text = item.text ?: return false
+        return pattern.matcher(text).find()
+    }
+
+    override fun describeTo(description: Description) {
+        description.appendText("with regexp: ").appendValue(pattern.toString())
+    }
+}
+
+fun withRegexp(pattern: Pattern): RegexpTextMatcher {
+    return RegexpTextMatcher(pattern)
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewmatcher/WithView.kt

@@ -0,0 +1,33 @@
+/*
+ * 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.viewmatcher
+
+import android.view.View
+import org.hamcrest.Description
+import org.hamcrest.Matcher
+import org.hamcrest.TypeSafeMatcher
+
+fun withView(view: View): Matcher<View> {
+    return object : TypeSafeMatcher<View>() {
+        override fun matchesSafely(item: View): Boolean {
+            return item == view
+        }
+
+        override fun describeTo(description: Description) {
+            description.appendText("Looked for element with View $view")
+        }
+    }
+}

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewmatcher/WithXPath.kt

@@ -0,0 +1,55 @@
+/*
+ * 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.viewmatcher
+
+import android.view.View
+import io.appium.espressoserver.lib.model.SourceDocument
+import io.appium.espressoserver.lib.model.ViewAttributesEnum
+import org.hamcrest.Description
+import org.hamcrest.Matcher
+import org.hamcrest.TypeSafeMatcher
+
+fun fetchIncludedAttributes(xpath: String): Set<ViewAttributesEnum>? {
+    if (xpath.contains("@*")) {
+        return null
+    }
+
+    return ViewAttributesEnum.values().fold(mutableSetOf()) { acc, value ->
+        if (xpath.contains("@$value")) {
+            acc.add(value)
+        }
+        acc
+    }
+}
+
+fun withXPath(root: View?, xpath: String, index: Int? = null): Matcher<View> {
+    // Get a list of the Views that match the provided xpath
+    val matchedXPathViews = SourceDocument(root, fetchIncludedAttributes(xpath)).findViewsByXPath(xpath)
+    return object : TypeSafeMatcher<View>() {
+        override fun matchesSafely(item: View): Boolean {
+            return if (index != null) {
+                // If index is not null, match it with the xpath in the list at the provided index
+                index < matchedXPathViews.size && matchedXPathViews[index] == item
+            } else
+                // If index is null, then we only check that the view is contained in the list of matched xpaths
+                matchedXPathViews.contains(item)
+        }
+
+        override fun describeTo(description: Description) {
+            description.appendText("looked for element with XPath $xpath, root: $root, index: $index")
+        }
+    }
+}

package/espresso-server/app/src/main/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="io.appium.espressoserver">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+</manifest>

package/espresso-server/app/src/test/java/io/appium/espressoserver/test/assets/Helpers.kt

@@ -0,0 +1,20 @@
+package io.appium.espressoserver.test.assets
+
+import java.io.File
+import java.io.IOException
+import java.util.*
+
+@Throws(IOException::class)
+fun readAssetFile(filename: String?): String {
+    val projectDir = System.getProperty("user.dir")
+    val assetPath = "$projectDir/src/test/java/io/appium/espressoserver/test/assets/"
+    val file = File("$assetPath/$filename")
+    val fileContents = StringBuilder(file.length().toInt())
+    Scanner(file).use { scanner ->
+        val lineSeparator = System.getProperty("line.separator")
+        while (scanner.hasNextLine()) {
+            fileContents.append(scanner.nextLine()).append(lineSeparator)
+        }
+        return fileContents.toString()
+    }
+}

package/espresso-server/app/src/test/java/io/appium/espressoserver/test/assets/backdoor-methods.json

@@ -0,0 +1,51 @@
+{
+  "target": "activity",
+  "methods": [
+    {
+      "name": "firstMethod",
+      "args": [
+        {
+          "value": "true",
+          "type": "boolean"
+        },
+        {
+          "value": "1",
+          "type": "int"
+        },
+        {
+          "value": "20",
+          "type": "byte"
+        },
+        {
+          "value": "X",
+          "type": "char"
+        }
+      ]
+    },
+    {
+      "name": "secondMethod",
+      "args": [
+        {
+          "value": true,
+          "type": "boolean"
+        },
+        {
+          "value": 1,
+          "type": "int"
+        },
+        {
+          "value": 20,
+          "type": "byte"
+        },
+        {
+          "value": "X",
+          "type": "Character"
+        },
+        {
+          "value": "Y",
+          "type": "java.lang.String"
+        }
+      ]
+    }
+  ]
+}

package/espresso-server/app/src/test/java/io/appium/espressoserver/test/assets/key-actions.json

@@ -0,0 +1,15 @@
+{
+  "actions": [
+    {
+      "type": "key",
+      "id": "keyboard",
+      "actions": [
+        {"type": "keyDown", "value": "\uE009"},
+        {"type": "pause", "duration": 500},
+        {"type": "keyDown", "value": "s"},
+        {"type": "keyUp", "value": "\uE009"},
+        {"type": "keyUp", "value": "s"}
+      ]
+    }
+  ]
+}

package/espresso-server/app/src/test/java/io/appium/espressoserver/test/assets/multi-touch-actions.json

@@ -0,0 +1,28 @@
+{
+  "actions": [
+    {
+      "type": "pointer",
+      "id": "finger1",
+      "parameters": {"pointerType": "touch"},
+      "actions": [
+        {"type": "pointerMove", "duration": 0, "x": 100, "y": 100},
+        {"type": "pointerDown", "button": 0},
+        {"type": "pause", "duration": 500},
+        {"type": "pointerMove", "duration": 1000, "origin": "pointer", "x": 20, "y": 0},
+        {"type": "pointerUp", "button": 0}
+      ]
+    }, {
+      "type": "pointer",
+      "id": "finger2",
+      "parameters": {"pointerType": "touch"},
+      "actions": [
+        {"type": "pointerMove", "duration": 10, "x": 200, "y": 400},
+        {"type": "pointerDown", "button": 0},
+        {"type": "pause", "duration": 1000},
+        {"type": "pointerMove", "duration": 1000, "origin": "pointer", "x": 50, "y": 0},
+        {"type": "pointerUp", "button": 0},
+        {"type": "pause", "duration": 0}
+      ]
+    }
+  ]
+}

package/espresso-server/app/src/test/java/io/appium/espressoserver/test/helpers/GsonParserHelpersTest.kt

@@ -0,0 +1,41 @@
+package io.appium.espressoserver.test.helpers
+
+import com.google.gson.JsonObject
+import com.google.gson.JsonParseException
+import com.google.gson.JsonPrimitive
+import io.appium.espressoserver.lib.helpers.GsonParserHelpers
+import org.junit.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
+
+class GsonParserHelpersTest {
+    enum class BasicEnum { A, B, C }
+
+    @Test
+    fun shouldParseEnumsFromJsonObj() {
+        val jsonObj = JsonObject()
+        jsonObj.add("b", JsonPrimitive("b"))
+        val enumValue = GsonParserHelpers.parseEnum<BasicEnum>(jsonObj, "b", "")
+        assertEquals(enumValue, BasicEnum.B)
+    }
+
+    @Test
+    fun shouldReturnNullIfNoObject() {
+        val jsonObj = JsonObject()
+        val enumValue = GsonParserHelpers.parseEnum<BasicEnum>(jsonObj, "b", "")
+        assertNull(enumValue)
+    }
+
+    @Test
+    fun shouldThrowExceptionIfBadValue() {
+        try {
+            val jsonObj = JsonObject()
+            jsonObj.add("b", JsonPrimitive("z"))
+            GsonParserHelpers.parseEnum<BasicEnum>(jsonObj, "b", "")
+        } catch (jpe:JsonParseException) {
+            return assertTrue(true);
+        }
+        assertTrue(false);
+    }
+}