Capture Android and Codename One screenshots in UI test

Author: shai-almog

scripts/build-android-app.sh

@@ -364,18 +364,49 @@ else
 fi
 export JAVA_HOME="$ORIGINAL_JAVA_HOME"
 
-SCREENSHOT_FILE=$(find "$SCREENSHOT_OUTPUT_DIR" -maxdepth 1 -name '*.png' | head -n 1 || true)
+readarray -t SCREENSHOT_FILES < <(find "$SCREENSHOT_OUTPUT_DIR" -maxdepth 1 -type f -name '*.png' -print | sort)
 SCREENSHOT_STATUS=0
-if [ -z "$SCREENSHOT_FILE" ]; then
+if [ "${#SCREENSHOT_FILES[@]}" -eq 0 ]; then
   ba_log "UI test completed but no screenshot was produced in $SCREENSHOT_OUTPUT_DIR" >&2
   SCREENSHOT_STATUS=1
 else
-  FINAL_SCREENSHOT="$FINAL_ARTIFACT_DIR/ui-test-screenshot.png"
-  cp "$SCREENSHOT_FILE" "$FINAL_SCREENSHOT"
+  DEFAULT_SCREENSHOT=""
+  ANDROID_SCREENSHOT=""
+  CODENAMEONE_SCREENSHOT=""
+  for src in "${SCREENSHOT_FILES[@]}"; do
+    base=$(basename "$src")
+    dest="$FINAL_ARTIFACT_DIR/$base"
+    cp "$src" "$dest"
+    label="UI test"
+    case "$base" in
+      *-android-*.png)
+        ANDROID_SCREENSHOT="$dest"
+        label="Android"
+        ;;
+      *-codenameone-*.png)
+        CODENAMEONE_SCREENSHOT="$dest"
+        label="Codename One"
+        ;;
+    esac
+    if [ -z "$DEFAULT_SCREENSHOT" ]; then
+      DEFAULT_SCREENSHOT="$dest"
+    fi
+    ba_log "$label screenshot copied to $dest"
+  done
+  if [ -n "$ANDROID_SCREENSHOT" ]; then
+    DEFAULT_SCREENSHOT="$ANDROID_SCREENSHOT"
+  fi
   if [ -n "${GITHUB_ENV:-}" ]; then
-    printf 'CN1_UI_TEST_SCREENSHOT=%s\n' "$FINAL_SCREENSHOT" >> "$GITHUB_ENV"
+    if [ -n "$DEFAULT_SCREENSHOT" ]; then
+      printf 'CN1_UI_TEST_SCREENSHOT=%s\n' "$DEFAULT_SCREENSHOT" >> "$GITHUB_ENV"
+    fi
+    if [ -n "$ANDROID_SCREENSHOT" ]; then
+      printf 'CN1_UI_TEST_ANDROID_SCREENSHOT=%s\n' "$ANDROID_SCREENSHOT" >> "$GITHUB_ENV"
+    fi
+    if [ -n "$CODENAMEONE_SCREENSHOT" ]; then
+      printf 'CN1_UI_TEST_CODENAMEONE_SCREENSHOT=%s\n' "$CODENAMEONE_SCREENSHOT" >> "$GITHUB_ENV"
+    fi
   fi
-  ba_log "UI test screenshot available at $FINAL_SCREENSHOT"
 fi
 unset CN1_TEST_SCREENSHOT_DIR
 

scripts/templates/HelloCodenameOneUiTest.java.tmpl

@@ -11,10 +11,14 @@ import android.view.View;
 
 import com.codename1.ui.Display;
 import com.codename1.ui.Form;
+import com.codename1.ui.Image;
+import com.codename1.ui.util.ImageIO;
 
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.util.concurrent.Callable;
+import java.util.concurrent.FutureTask;
 
 import org.junit.After;
 import org.junit.Before;
@@ -34,6 +38,7 @@ public class @MAIN_NAME@UiTest {
 
     private static final long STARTUP_TIMEOUT_MS = 30_000L;
     private static final long LAYOUT_TIMEOUT_MS = 5_000L;
+    private static final long EDT_TIMEOUT_MS = 10_000L;
 
     private ActivityController<@MAIN_NAME@Stub> controller;
     private @MAIN_NAME@Stub activity;
@@ -61,16 +66,32 @@ public class @MAIN_NAME@UiTest {
 
         ensureViewHasLayout(decorView);
 
-        Bitmap screenshot = captureBitmap(decorView);
-        assertTrue("Screenshot width should be positive", screenshot.getWidth() > 0);
-        assertTrue("Screenshot height should be positive", screenshot.getHeight() > 0);
+        ShadowLooper.runUiThreadTasksIncludingDelayedTasks();
+        Bitmap androidScreenshot = captureBitmap(decorView);
+        assertTrue("Android screenshot width should be positive", androidScreenshot.getWidth() > 0);
+        assertTrue("Android screenshot height should be positive", androidScreenshot.getHeight() > 0);
         assertTrue(
-                "Screenshot should contain rendered content beyond the background",
-                hasRenderableContent(screenshot));
-
-        File screenshotFile = saveScreenshot(screenshot);
-        assertTrue("Screenshot file should exist", screenshotFile.isFile());
-        assertTrue("Screenshot file should not be empty", screenshotFile.length() > 0L);
+                "Android screenshot should contain rendered content beyond the background",
+                hasRenderableContent(androidScreenshot));
+
+        File androidScreenshotFile = saveBitmap(androidScreenshot, "@[email protected]");
+        assertTrue("Android screenshot file should exist", androidScreenshotFile.isFile());
+        assertTrue("Android screenshot file should not be empty", androidScreenshotFile.length() > 0L);
+
+        ShadowLooper.runUiThreadTasksIncludingDelayedTasks();
+        Image codenameOneScreenshot = captureCodenameOneScreenshot();
+        assertNotNull("Codename One screenshot should be available", codenameOneScreenshot);
+        assertTrue("Codename One screenshot width should be positive", codenameOneScreenshot.getWidth() > 0);
+        assertTrue("Codename One screenshot height should be positive", codenameOneScreenshot.getHeight() > 0);
+        assertTrue(
+                "Codename One screenshot should contain rendered content beyond the background",
+                hasRenderableContent(codenameOneScreenshot));
+
+        File codenameOneScreenshotFile = saveCodenameOneScreenshot(
+                codenameOneScreenshot,
+                "@[email protected]");
+        assertTrue("Codename One screenshot file should exist", codenameOneScreenshotFile.isFile());
+        assertTrue("Codename One screenshot file should not be empty", codenameOneScreenshotFile.length() > 0L);
     }
 
     private static Bitmap captureBitmap(View view) {
@@ -101,12 +122,20 @@ public class @MAIN_NAME@UiTest {
     private static boolean hasRenderableContent(Bitmap screenshot) {
         int width = screenshot.getWidth();
         int height = screenshot.getHeight();
-        if (width <= 0 || height <= 0) {
-            return false;
-        }
         int[] pixels = new int[width * height];
         screenshot.getPixels(pixels, 0, width, 0, 0, width, height);
-        if (pixels.length == 0) {
+        return hasRenderableContent(pixels, width, height);
+    }
+
+    private static boolean hasRenderableContent(Image screenshot) throws Exception {
+        int width = screenshot.getWidth();
+        int height = screenshot.getHeight();
+        int[] pixels = callOnEdt(screenshot::getRGB);
+        return hasRenderableContent(pixels, width, height);
+    }
+
+    private static boolean hasRenderableContent(int[] pixels, int width, int height) {
+        if (width <= 0 || height <= 0 || pixels == null || pixels.length == 0) {
             return false;
         }
         int background = pixels[0];
@@ -126,17 +155,32 @@ public class @MAIN_NAME@UiTest {
         return false;
     }
 
-    private static File saveScreenshot(Bitmap screenshot) throws IOException {
+    private static File saveBitmap(Bitmap screenshot, String fileName) throws IOException {
         File outputDir = resolveArtifactDirectory();
-        File screenshotFile = new File(outputDir, "@[email protected]");
+        File screenshotFile = new File(outputDir, fileName);
         try (FileOutputStream out = new FileOutputStream(screenshotFile)) {
             if (!screenshot.compress(Bitmap.CompressFormat.PNG, 100, out)) {
-                throw new IOException("Failed to encode screenshot as PNG");
+                throw new IOException("Failed to encode Android screenshot as PNG");
             }
         }
         return screenshotFile;
     }
 
+    private static File saveCodenameOneScreenshot(Image screenshot, String fileName) throws Exception {
+        File outputDir = resolveArtifactDirectory();
+        File screenshotFile = new File(outputDir, fileName);
+        ImageIO io = callOnEdt(() -> Display.getInstance().getImageIO());
+        assertNotNull("Codename One ImageIO should be available", io);
+        try (FileOutputStream out = new FileOutputStream(screenshotFile)) {
+            FileOutputStream stream = out;
+            callOnEdt(() -> {
+                io.save(screenshot, stream, ImageIO.FORMAT_PNG, 1.0f);
+                return null;
+            });
+        }
+        return screenshotFile;
+    }
+
     private static File resolveArtifactDirectory() throws IOException {
         String directory = System.getenv("CN1_TEST_SCREENSHOT_DIR");
         File outputDir = (directory != null && !directory.isEmpty())
@@ -162,4 +206,22 @@ public class @MAIN_NAME@UiTest {
         }
         throw new AssertionError("Timed out waiting for Codename One main form to be displayed");
     }
+
+    private static Image captureCodenameOneScreenshot() throws Exception {
+        return callOnEdt(() -> Display.getInstance().captureScreen());
+    }
+
+    private static <T> T callOnEdt(Callable<T> callable) throws Exception {
+        FutureTask<T> task = new FutureTask<>(callable);
+        Display.getInstance().callSerially(task);
+        long deadline = SystemClock.uptimeMillis() + EDT_TIMEOUT_MS;
+        while (!task.isDone() && SystemClock.uptimeMillis() < deadline) {
+            ShadowLooper.runUiThreadTasksIncludingDelayedTasks();
+            SystemClock.sleep(4L);
+        }
+        if (!task.isDone()) {
+            throw new AssertionError("Timed out waiting for Codename One EDT task to finish");
+        }
+        return task.get();
+    }
 }