appium-espresso-driver 2.13.11 → 2.14.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.14.0](https://github.com/appium/appium-espresso-driver/compare/v2.13.11...v2.14.0) (2023-01-13)
+
+
+### Features
+
+* Add compose element screenshot ([#847](https://github.com/appium/appium-espresso-driver/issues/847)) ([95bded7](https://github.com/appium/appium-espresso-driver/commit/95bded7e1816eb42ded501efcbca24b07b283f35))
+
 ## [2.13.11](https://github.com/appium/appium-espresso-driver/compare/v2.13.10...v2.13.11) (2023-01-13)
 
 

package/README.md

@@ -202,6 +202,7 @@ In order to change between subdrivers use the [driver](#settings-api) setting. S
 - getPageSource: The returned page source is retrieved from Compose and all elements there contain [Compose-specific](#compose-element-attributes) attributes.
 - click, isDisplayed, isEnabled, clear, getText, sendKeys, getElementRect, getValue, isSelected: These commands should properly support compose elements.
 - getAttribute: Accepts and returns Compose-specific element attributes. See [Compose Element Attributes](#compose-element-attributes) for the full list of supported Compose element attributes.
+- getElementScreenshot: Fetches a screenshot of the given Compose element. Available since driver version *2.14.0*
 
 Calling other driver element-specific APIs not listed above would most likely throw an exception as Compose and Espresso elements are being stored in completely separated internal caches and must not be mixed.
 

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/handlers/ElementScreenshot.kt

@@ -16,16 +16,17 @@
 
 package io.appium.espressoserver.lib.handlers
 
-import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
-import io.appium.espressoserver.lib.helpers.ScreenshotsHelper
+import io.appium.espressoserver.lib.helpers.getNodeInteractionById
+import io.appium.espressoserver.lib.helpers.takeComposeNodeScreenshot
+import io.appium.espressoserver.lib.helpers.takeEspressoViewScreenshot
 import io.appium.espressoserver.lib.model.AppiumParams
 import io.appium.espressoserver.lib.model.EspressoElement
 
 class ElementScreenshot : RequestHandler<AppiumParams, String> {
 
-    @Throws(AppiumException::class)
-    override fun handleInternal(params: AppiumParams): String {
-        val view = EspressoElement.getCachedViewStateById(params.elementId).view
-        return ScreenshotsHelper(view).screenshot
-    }
+    override fun handleEspresso(params: AppiumParams): String =
+        takeEspressoViewScreenshot(EspressoElement.getCachedViewStateById(params.elementId).view)
+
+    override fun handleCompose(params: AppiumParams): String =
+        takeComposeNodeScreenshot(getNodeInteractionById(params.elementId!!))
 }

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/handlers/ScreenshotHandler.kt

@@ -16,14 +16,9 @@
 
 package io.appium.espressoserver.lib.handlers
 
-import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
-import io.appium.espressoserver.lib.helpers.ScreenshotsHelper
+import io.appium.espressoserver.lib.helpers.takeScreenshot
 import io.appium.espressoserver.lib.model.AppiumParams
 
 class ScreenshotHandler : RequestHandler<AppiumParams, String> {
-
-    @Throws(AppiumException::class)
-    override fun handleInternal(params: AppiumParams): String {
-        return ScreenshotsHelper().screenshot
-    }
+    override fun handleInternal(params: AppiumParams): String = takeScreenshot()
 }

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/handlers/exceptions/ScreenCaptureException.kt

@@ -19,7 +19,11 @@ package io.appium.espressoserver.lib.handlers.exceptions
 import fi.iki.elonen.NanoHTTPD
 
 
-class ScreenCaptureException(reason: String) : AppiumException(reason) {
+class ScreenCaptureException : AppiumException {
+    constructor(reason: String) : super(reason)
+
+    constructor(reason: String, e: Throwable) : super(reason, e)
+
     override fun error(): String {
         return "unable to capture screen"
     }

package/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/ScreenshotHelpers.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 android.graphics.Bitmap
+import android.util.Base64
+import android.view.View
+import androidx.compose.ui.graphics.asAndroidBitmap
+import androidx.compose.ui.test.SemanticsNodeInteraction
+import androidx.compose.ui.test.captureToImage
+
+import java.io.ByteArrayOutputStream
+import androidx.test.runner.screenshot.Screenshot
+import io.appium.espressoserver.lib.handlers.exceptions.ScreenCaptureException
+
+private fun encodeBitmap(bitmap: Bitmap?, targetNameSupplier: () -> String): String {
+    if (bitmap == null || bitmap.height == 0 || bitmap.width == 0) {
+        throw ScreenCaptureException("Cannot capture a shot of the ${targetNameSupplier()}. " +
+                "Make sure none of the currently visible " +
+                "views have FLAG_SECURE set and that it is possible to take a screenshot manually")
+    }
+    val outputStream = ByteArrayOutputStream()
+    bitmap.compress(Bitmap.CompressFormat.PNG, 100, outputStream)
+    return Base64.encodeToString(outputStream.toByteArray(), Base64.NO_WRAP)
+}
+
+fun takeScreenshot(): String {
+    return encodeBitmap(Screenshot.capture().bitmap) { "current screen" }
+}
+
+fun takeEspressoViewScreenshot(view: View): String =
+    try {
+        encodeBitmap(Screenshot.capture(view).bitmap) { view.javaClass.name }
+    } catch (e: RuntimeException) {
+        throw ScreenCaptureException("Cannot take a screenshot of a view", e)
+    }
+
+fun takeComposeNodeScreenshot(nodeInteraction: SemanticsNodeInteraction): String =
+    try {
+        encodeBitmap(
+            nodeInteraction.captureToImage().asAndroidBitmap()
+        ) { nodeInteraction.fetchSemanticsNode().toString() }
+    } catch (e: RuntimeException) {
+        throw ScreenCaptureException("Cannot take a screenshot of a node", e)
+    }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-espresso-driver",
-  "version": "2.13.11",
+  "version": "2.14.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-espresso-driver",
-      "version": "2.13.11",
+      "version": "2.14.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@babel/runtime": "^7.4.3",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "2.13.11",
+  "version": "2.14.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

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

@@ -1,59 +0,0 @@
-/*
- * 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.graphics.Bitmap
-import android.util.Base64
-import android.view.View
-
-import java.io.ByteArrayOutputStream
-import androidx.test.runner.screenshot.Screenshot
-import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
-import io.appium.espressoserver.lib.handlers.exceptions.ElementNotVisibleException
-import io.appium.espressoserver.lib.handlers.exceptions.ScreenCaptureException
-import io.appium.espressoserver.lib.model.ViewElement
-
-class ScreenshotsHelper @JvmOverloads constructor(private val view: View? = null) {
-
-    /**
-     * Makes a screenshot of the particular view.
-     *
-     * @return the screenshot of the view as base-64 encoded string.
-     * @throws ElementNotVisibleException if the view has no visible area.
-     * @throws ScreenCaptureException if it is impossible to take a screenshot.
-     */
-    val screenshot: String
-        @Throws(AppiumException::class)
-        get() {
-            if (view != null && ViewElement(view).bounds.isEmpty) {
-                throw ElementNotVisibleException(
-                        String.format("Cannot get a screenshot of the invisible %s", view.javaClass.name))
-            }
-
-            val screenCap = if (view == null) Screenshot.capture() else Screenshot.capture(view)
-            val bitmapScreenCap = screenCap.bitmap
-            if (bitmapScreenCap == null || bitmapScreenCap.height == 0 || bitmapScreenCap.width == 0) {
-                throw ScreenCaptureException("Cannot capture a shot of the " +
-                        "${if (view == null) "current screen" else view.javaClass.name}. " +
-                        "Make sure none of the currently visible " +
-                        "views have FLAG_SECURE set and that it is possible to take a screenshot manually")
-            }
-            val outputStream = ByteArrayOutputStream()
-            bitmapScreenCap.compress(Bitmap.CompressFormat.PNG, 100, outputStream)
-            return Base64.encodeToString(outputStream.toByteArray(), Base64.NO_WRAP)
-        }
-}