Unify CN1 screenshot extraction for Android and iOS tests

scripts/ios/tests/HelloCodenameOneUITests.swift.tmpl

@@ -1,8 +1,13 @@
 import XCTest
+import UIKit
 
 final class HelloCodenameOneUITests: XCTestCase {
     private var app: XCUIApplication!
     private var outputDirectory: URL!
+    private let chunkSize = 2000
+    private let previewChannel = "PREVIEW"
+    private let previewQualities: [CGFloat] = [0.60, 0.50, 0.40, 0.35, 0.30, 0.25, 0.20, 0.18, 0.16, 0.14, 0.12, 0.10, 0.08, 0.06, 0.05, 0.04, 0.03, 0.02, 0.01]
+    private let maxPreviewBytes = 20 * 1024
 
     override func setUpWithError() throws {
         continueAfterFailure = false
@@ -43,6 +48,8 @@ final class HelloCodenameOneUITests: XCTestCase {
         att.name = name
         att.lifetime = .keepAlways
         add(att)
+
+        emitScreenshotPayloads(for: shot, name: name)
     }
 
     /// Wait for foreground + a short settle time
@@ -71,4 +78,82 @@ final class HelloCodenameOneUITests: XCTestCase {
         RunLoop.current.run(until: Date(timeIntervalSinceNow: 2.0))
         try captureScreenshot(named: "BrowserComponent")
     }
-}
+
+    private func sanitizeTestName(_ name: String) -> String {
+        let allowed = CharacterSet(charactersIn: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_.-")
+        let underscore: UnicodeScalar = "_"
+        var scalars: [UnicodeScalar] = []
+        scalars.reserveCapacity(name.unicodeScalars.count)
+        for scalar in name.unicodeScalars {
+            scalars.append(allowed.contains(scalar) ? scalar : underscore)
+        }
+        return String(String.UnicodeScalarView(scalars))
+    }
+
+    private func emitScreenshotPayloads(for shot: XCUIScreenshot, name: String) {
+        let safeName = sanitizeTestName(name)
+        let pngData = shot.pngRepresentation
+        print("CN1SS:INFO:test=\(safeName) png_bytes=\(pngData.count)")
+        emitScreenshotChannel(data: pngData, name: safeName, channel: "")
+
+        if let preview = makePreviewJPEG(from: shot, pngData: pngData) {
+            print("CN1SS:INFO:test=\(safeName) preview_jpeg_bytes=\(preview.data.count) preview_quality=\(preview.quality)")
+            if preview.data.count > maxPreviewBytes {
+                print("CN1SS:WARN:test=\(safeName) preview_exceeds_limit_bytes=\(preview.data.count) max_preview_bytes=\(maxPreviewBytes)")
+            }
+            emitScreenshotChannel(data: preview.data, name: safeName, channel: previewChannel)
+        } else {
+            print("CN1SS:INFO:test=\(safeName) preview_jpeg_bytes=0 preview_quality=0")
+        }
+    }
+
+    private func makePreviewJPEG(from shot: XCUIScreenshot, pngData: Data) -> (data: Data, quality: Int)? {
+        guard let image = UIImage(data: pngData) else {
+            return nil
+        }
+        var chosenData: Data?
+        var chosenQuality = 0
+        var smallest = Int.max
+        for quality in previewQualities {
+            guard let jpeg = image.jpegData(compressionQuality: quality) else { continue }
+            let length = jpeg.count
+            if length < smallest {
+                smallest = length
+                chosenData = jpeg
+                chosenQuality = Int((quality * 100).rounded())
+            }
+            if length <= maxPreviewBytes {
+                break
+            }
+        }
+        guard let finalData = chosenData, !finalData.isEmpty else {
+            return nil
+        }
+        return (finalData, chosenQuality)
+    }
+
+    private func emitScreenshotChannel(data: Data, name: String, channel: String) {
+        var prefix = "CN1SS"
+        if !channel.isEmpty {
+            prefix += channel
+        }
+        guard !data.isEmpty else {
+            print("\(prefix):END:\(name)")
+            return
+        }
+        let base64 = data.base64EncodedString()
+        var current = base64.startIndex
+        var position = 0
+        var chunkCount = 0
+        while current < base64.endIndex {
+            let next = base64.index(current, offsetBy: chunkSize, limitedBy: base64.endIndex) ?? base64.endIndex
+            let chunk = base64[current..<next]
+            print("\(prefix):\(name):\(String(format: "%06d", position)):\(chunk)")
+            chunkCount += 1
+            position += chunk.count
+            current = next
+        }
+        print("CN1SS:INFO:test=\(name) chunks=\(chunkCount) total_b64_len=\(base64.count)")
+        print("\(prefix):END:\(name)")
+    }
+}

scripts/lib/cn1ss.sh

@@ -0,0 +1,288 @@
+#!/usr/bin/env bash
+# Shared helpers for Codename One screenshot (CN1SS) chunk processing
+
+# Default class names used by the Java source helpers
+: "${CN1SS_MAIN_CLASS:=Cn1ssChunkTools}"
+: "${CN1SS_PROCESS_CLASS:=ProcessScreenshots}"
+: "${CN1SS_RENDER_CLASS:=RenderScreenshotReport}"
+: "${CN1SS_POST_COMMENT_CLASS:=PostPrComment}"
+
+CN1SS_INITIALIZED=0
+CN1SS_JAVA_BIN=""
+CN1SS_JAVAC_BIN=""
+CN1SS_SOURCE_PATH=""
+CN1SS_CACHE_ROOT=""
+CN1SS_CLASS_DIR=""
+CN1SS_STAMP_FILE=""
+CN1SS_JAVA_CLASSPATH=""
+
+if ! declare -p CN1SS_JAVA_OPTS >/dev/null 2>&1; then
+  declare -a CN1SS_JAVA_OPTS=()
+fi
+if [ "${#CN1SS_JAVA_OPTS[@]}" -eq 0 ]; then
+  CN1SS_JAVA_OPTS+=(-Djava.awt.headless=true)
+fi
+
+cn1ss_setup() {
+  CN1SS_JAVA_BIN="$1"
+  CN1SS_SOURCE_PATH="$2"
+  local cache_override="${3:-}" tmp_root
+
+  if [ -z "$CN1SS_JAVA_BIN" ] || [ ! -x "$CN1SS_JAVA_BIN" ]; then
+    cn1ss_log "CN1SS setup failed: java binary not executable ($CN1SS_JAVA_BIN)"
+    return 1
+  fi
+  if [ -z "$CN1SS_SOURCE_PATH" ] || [ ! -d "$CN1SS_SOURCE_PATH" ]; then
+    cn1ss_log "CN1SS setup failed: source directory missing ($CN1SS_SOURCE_PATH)"
+    return 1
+  fi
+
+  if [ -z "$CN1SS_JAVAC_BIN" ]; then
+    local java_dir
+    java_dir="$(dirname "$CN1SS_JAVA_BIN")"
+    if [ -x "$java_dir/javac" ]; then
+      CN1SS_JAVAC_BIN="$java_dir/javac"
+    elif command -v javac >/dev/null 2>&1; then
+      CN1SS_JAVAC_BIN="$(command -v javac)"
+    else
+      cn1ss_log "CN1SS setup failed: unable to locate javac"
+      return 1
+    fi
+  fi
+
+  tmp_root="${TMPDIR:-/tmp}"
+  tmp_root="${tmp_root%/}"
+  CN1SS_CACHE_ROOT="${cache_override:-${CN1SS_CACHE_DIR:-$tmp_root/cn1ss-java-cache}}"
+  CN1SS_CLASS_DIR="$CN1SS_CACHE_ROOT/classes"
+  CN1SS_STAMP_FILE="$CN1SS_CACHE_ROOT/.stamp"
+
+  if [ "$CN1SS_INITIALIZED" -eq 1 ] && [ -n "$CN1SS_JAVA_CLASSPATH" ] && [ -d "$CN1SS_JAVA_CLASSPATH" ]; then
+    return 0
+  fi
+
+  local need_compile=1
+  if [ -d "$CN1SS_CLASS_DIR" ] && [ -f "$CN1SS_STAMP_FILE" ]; then
+    if ! find "$CN1SS_SOURCE_PATH" -type f -name '*.java' -newer "$CN1SS_STAMP_FILE" -print -quit | grep -q .; then
+      need_compile=0
+    fi
+  fi
+
+  if [ "$need_compile" -eq 1 ]; then
+    mkdir -p "$CN1SS_CACHE_ROOT"
+    rm -rf "$CN1SS_CLASS_DIR"
+    mkdir -p "$CN1SS_CLASS_DIR"
+    local -a sources=()
+    while IFS= read -r -d '' src; do
+      if grep -q '@PACKAGE@' "$src" 2>/dev/null; then
+        cn1ss_log "Skipping template source $src"
+        continue
+      fi
+      sources+=("$src")
+    done < <(find "$CN1SS_SOURCE_PATH" -type f -name '*.java' -print0 | sort -z)
+    if [ "${#sources[@]}" -eq 0 ]; then
+      cn1ss_log "CN1SS setup failed: no Java sources found under $CN1SS_SOURCE_PATH"
+      return 1
+    fi
+    cn1ss_log "Compiling CN1SS helpers -> $CN1SS_CLASS_DIR"
+    local src display
+    for src in "${sources[@]}"; do
+      display="${src#$CN1SS_SOURCE_PATH/}"
+      display="${display:-$(basename "$src")}"
+      cn1ss_log "  javac $display"
+      if ! "$CN1SS_JAVAC_BIN" -d "$CN1SS_CLASS_DIR" -cp "$CN1SS_CLASS_DIR" "$src"; then
+        cn1ss_log "CN1SS setup failed: javac returned non-zero status ($display)"
+        return 1
+      fi
+    done
+    touch "$CN1SS_STAMP_FILE" 2>/dev/null || true
+  else
+    cn1ss_log "Reusing CN1SS helpers in $CN1SS_CLASS_DIR"
+  fi
+
+  CN1SS_JAVA_CLASSPATH="$CN1SS_CLASS_DIR"
+  CN1SS_INITIALIZED=1
+}
+
+cn1ss_log() {
+  echo "[cn1ss] $*"
+}
+
+cn1ss_java_run() {
+  local class_name="$1"; shift
+  if [ -z "${CN1SS_JAVA_BIN:-}" ] || [ ! -x "$CN1SS_JAVA_BIN" ]; then
+    cn1ss_log "CN1SS_JAVA_BIN is not configured"
+    return 1
+  fi
+  if [ -z "${CN1SS_JAVA_CLASSPATH:-}" ] || [ ! -d "$CN1SS_JAVA_CLASSPATH" ]; then
+    cn1ss_log "CN1SS Java helpers not initialized; call cn1ss_setup first"
+    return 1
+  fi
+  "$CN1SS_JAVA_BIN" "${CN1SS_JAVA_OPTS[@]}" -cp "$CN1SS_JAVA_CLASSPATH" "$class_name" "$@"
+}
+
+cn1ss_count_chunks() {
+  local file="$1"
+  local test="${2:-}"
+  local channel="${3:-}"
+  if [ -z "$file" ] || [ ! -r "$file" ]; then
+    echo 0
+    return
+  fi
+  local args=("count" "$file")
+  if [ -n "$test" ]; then
+    args+=("--test" "$test")
+  fi
+  if [ -n "$channel" ]; then
+    args+=("--channel" "$channel")
+  fi
+  cn1ss_java_run "$CN1SS_MAIN_CLASS" "${args[@]}" 2>/dev/null || echo 0
+}
+
+cn1ss_extract_base64() {
+  local file="$1"
+  local test="${2:-}"
+  local channel="${3:-}"
+  if [ -z "$file" ] || [ ! -r "$file" ]; then
+    return 1
+  fi
+  local args=("extract" "$file")
+  if [ -n "$test" ]; then
+    args+=("--test" "$test")
+  fi
+  if [ -n "$channel" ]; then
+    args+=("--channel" "$channel")
+  fi
+  cn1ss_java_run "$CN1SS_MAIN_CLASS" "${args[@]}"
+}
+
+cn1ss_decode_binary() {
+  local file="$1"
+  local test="${2:-}"
+  local channel="${3:-}"
+  if [ -z "$file" ] || [ ! -r "$file" ]; then
+    return 1
+  fi
+  local args=("extract" "$file" "--decode")
+  if [ -n "$test" ]; then
+    args+=("--test" "$test")
+  fi
+  if [ -n "$channel" ]; then
+    args+=("--channel" "$channel")
+  fi
+  cn1ss_java_run "$CN1SS_MAIN_CLASS" "${args[@]}"
+}
+
+cn1ss_list_tests() {
+  local file="$1"
+  if [ -z "$file" ] || [ ! -r "$file" ]; then
+    return 1
+  fi
+  cn1ss_java_run "$CN1SS_MAIN_CLASS" tests "$file"
+}
+
+cn1ss_verify_png() {
+  local file="$1"
+  [ -s "$file" ] || return 1
+  head -c 8 "$file" | od -An -t x1 | tr -d ' \n' | grep -qi '^89504e470d0a1a0a$'
+}
+
+cn1ss_verify_jpeg() {
+  local file="$1"
+  [ -s "$file" ] || return 1
+  local header trailer
+  header="$(head -c 2 "$file" | od -An -t x1 | tr -d ' \n' | tr '[:lower:]' '[:upper:]')"
+  trailer="$(tail -c 2 "$file" | od -An -t x1 | tr -d ' \n' | tr '[:lower:]' '[:upper:]')"
+  [ "$header" = "FFD8" ] && [ "$trailer" = "FFD9" ]
+}
+
+cn1ss_decode_test_asset() {
+  local test="$1"; shift
+  local dest="$1"; shift
+  local channel="$1"; shift
+  local verifier="$1"; shift
+  local entry source_type source_path count
+
+  rm -f "$dest" 2>/dev/null || true
+  for entry in "$@"; do
+    source_type="${entry%%:*}"
+    source_path="${entry#*:}"
+    [ -s "$source_path" ] || continue
+    count="$(cn1ss_count_chunks "$source_path" "$test" "$channel")"
+    count="${count//[^0-9]/}"; : "${count:=0}"
+    [ "$count" -gt 0 ] || continue
+    cn1ss_log "Reassembling test '$test' from ${source_type} source: $source_path (chunks=$count)"
+    if cn1ss_decode_binary "$source_path" "$test" "$channel" > "$dest" 2>/dev/null; then
+      if [ -z "$verifier" ] || "$verifier" "$dest"; then
+        echo "${source_type}:$(basename "$source_path")"
+        return 0
+      fi
+    fi
+  done
+  rm -f "$dest" 2>/dev/null || true
+  return 1
+}
+
+cn1ss_decode_test_png() {
+  local test="$1"; shift
+  local dest="$1"; shift
+  cn1ss_decode_test_asset "$test" "$dest" "" cn1ss_verify_png "$@"
+}
+
+cn1ss_decode_test_preview() {
+  local test="$1"; shift
+  local dest="$1"; shift
+  cn1ss_decode_test_asset "$test" "$dest" "PREVIEW" cn1ss_verify_jpeg "$@"
+}
+
+cn1ss_file_size() {
+  local file="$1"
+  if [ ! -f "$file" ]; then
+    echo 0
+    return
+  fi
+  if stat --version >/dev/null 2>&1; then
+    stat --printf='%s' "$file"
+  elif stat -f '%z' "$file" >/dev/null 2>&1; then
+    stat -f '%z' "$file"
+  else
+    wc -c < "$file" 2>/dev/null | tr -d ' \n'
+  fi
+}
+
+cn1ss_post_pr_comment() {
+  local body_file="$1"
+  local preview_dir="$2"
+  if [ -z "$body_file" ] || [ ! -s "$body_file" ]; then
+    cn1ss_log "Skipping PR comment post (no content)."
+    return 0
+  fi
+  local comment_token="${GITHUB_TOKEN:-}"; local body_size
+  if [ -z "$comment_token" ] && [ -n "${GH_TOKEN:-}" ]; then
+    comment_token="${GH_TOKEN}"
+    cn1ss_log "PR comment auth using GH_TOKEN fallback"
+  fi
+  if [ -z "$comment_token" ]; then
+    cn1ss_log "PR comment skipped (no GitHub token available)"
+    return 0
+  fi
+  if [ -z "${GITHUB_EVENT_PATH:-}" ] || [ ! -f "$GITHUB_EVENT_PATH" ]; then
+    cn1ss_log "PR comment skipped (GITHUB_EVENT_PATH unavailable)"
+    return 0
+  fi
+  body_size=$(wc -c < "$body_file" 2>/dev/null || echo 0)
+  cn1ss_log "Attempting to post PR comment (payload bytes=${body_size})"
+  GITHUB_TOKEN="$comment_token" cn1ss_java_run "$CN1SS_POST_COMMENT_CLASS" \
+    --body "$body_file" \
+    --preview-dir "$preview_dir"
+  local rc=$?
+  if [ $rc -eq 0 ]; then
+    cn1ss_log "Posted screenshot comparison comment to PR"
+  else
+    cn1ss_log "STAGE:COMMENT_POST_FAILED (see stderr for details)"
+    if [ -n "${ARTIFACTS_DIR:-}" ]; then
+      local failure_flag="$ARTIFACTS_DIR/pr-comment-failed.txt"
+      printf 'Comment POST failed at %s\n' "$(date -u +'%Y-%m-%dT%H:%M:%SZ')" > "$failure_flag" 2>/dev/null || true
+    fi
+  fi
+  return $rc
+}