Refactor Android build scripts into modular helpers (#3962)

Author: shai-almog

scripts/android/lib/patch_gradle_files.py

@@ -0,0 +1,222 @@
+#!/usr/bin/env python3
+"""Utilities to normalize generated Gradle build files for Android tests."""
+from __future__ import annotations
+
+import argparse
+import pathlib
+import re
+from typing import Tuple
+
+REPOSITORIES_BLOCK = """\
+repositories {
+    google()
+    mavenCentral()
+}
+"""
+
+
+def _ensure_repositories(content: str) -> Tuple[str, bool]:
+    """Ensure a repositories block exists with google() and mavenCentral()."""
+    pattern = re.compile(r"(?ms)^\s*repositories\s*\{.*?\}")
+    match = pattern.search(content)
+    block_added = False
+
+    if not match:
+        # Append a canonical repositories block to the end of the file.
+        if not content.endswith("\n"):
+            content += "\n"
+        content += REPOSITORIES_BLOCK
+        return content, True
+
+    block = match.group(0)
+    if "google()" not in block or "mavenCentral()" not in block:
+        lines = block.splitlines()
+        header = lines[0]
+        body = [line for line in lines[1:-1] if line.strip()]
+        if "google()" not in block:
+            body.append("    google()")
+        if "mavenCentral()" not in block:
+            body.append("    mavenCentral()")
+        new_block = "\n".join([header, *sorted(set(body)), lines[-1]])
+        content = content[: match.start()] + new_block + content[match.end() :]
+        block_added = True
+    return content, block_added
+
+
+def _ensure_android_sdk(content: str, compile_sdk: int, target_sdk: int) -> Tuple[str, bool]:
+    changed = False
+
+    def insert_or_replace(pattern: str, repl: str, search_scope: str) -> Tuple[str, bool]:
+        nonlocal content
+        match = re.search(pattern, content, re.MULTILINE)
+        if match:
+            new_content = re.sub(pattern, repl, content, count=1, flags=re.MULTILINE)
+            if new_content != content:
+                content = new_content
+                return content, True
+            return content, False
+        anchor = re.search(search_scope, content, re.MULTILINE)
+        if not anchor:
+            return content, False
+        start = anchor.end()
+        content = content[:start] + f"\n{repl}" + content[start:]
+        return content, True
+
+    # Ensure android block exists
+    if re.search(r"(?m)^\s*android\s*\{", content) is None:
+        if not content.endswith("\n"):
+            content += "\n"
+        content += (
+            "\nandroid {\n"
+            f"    compileSdkVersion {compile_sdk}\n"
+            "    defaultConfig {\n"
+            f"        targetSdkVersion {target_sdk}\n"
+            "    }\n}"
+        )
+        return content, True
+
+    new_content, changed_once = insert_or_replace(
+        pattern=rf"(?m)^\s*compileSdkVersion\s+\d+",
+        repl=f"    compileSdkVersion {compile_sdk}",
+        search_scope=r"(?m)^\s*android\s*\{",
+    )
+    changed = changed or changed_once
+
+    default_config = re.search(r"(?ms)^\s*defaultConfig\s*\{.*?^\s*\}", content)
+    if default_config:
+        block = default_config.group(0)
+        if re.search(r"(?m)^\s*targetSdkVersion\s+\d+", block):
+            updated = re.sub(
+                r"(?m)^\s*targetSdkVersion\s+\d+",
+                f"        targetSdkVersion {target_sdk}",
+                block,
+            )
+        else:
+            updated = re.sub(r"{", "{\n        targetSdkVersion %d" % target_sdk, block, count=1)
+        if updated != block:
+            content = content[: default_config.start()] + updated + content[default_config.end() :]
+            changed = True
+    else:
+        content, changed_once = insert_or_replace(
+            pattern=r"(?ms)(^\s*android\s*\{)",
+            repl="    defaultConfig {\n        targetSdkVersion %d\n    }" % target_sdk,
+            search_scope=r"(?m)^\s*android\s*\{",
+        )
+        changed = changed or changed_once
+
+    return content, changed
+
+
+def _ensure_instrumentation_runner(content: str) -> Tuple[str, bool]:
+    runner = "androidx.test.runner.AndroidJUnitRunner"
+    if runner in content:
+        return content, False
+    changed = False
+    pattern = re.compile(r"(?m)^\s*testInstrumentationRunner\s*\".*?\"\s*$")
+    if pattern.search(content):
+        new_content = pattern.sub(f"        testInstrumentationRunner \"{runner}\"", content)
+        return new_content, True
+    default_config = re.search(r"(?ms)^\s*defaultConfig\s*\{", content)
+    if default_config:
+        insert_point = default_config.end()
+        content = (
+            content[:insert_point]
+            + f"\n        testInstrumentationRunner \"{runner}\""
+            + content[insert_point:]
+        )
+        changed = True
+    else:
+        android_block = re.search(r"(?ms)^\s*android\s*\{", content)
+        if android_block:
+            insert_point = android_block.end()
+            snippet = (
+                "\n    defaultConfig {\n"
+                f"        testInstrumentationRunner \"{runner}\"\n"
+                "    }"
+            )
+            content = content[:insert_point] + snippet + content[insert_point:]
+            changed = True
+    return content, changed
+
+
+def _remove_legacy_use_library(content: str) -> Tuple[str, bool]:
+    new_content, count = re.subn(
+        r"(?m)^\s*useLibrary\s+'android\.test\.(?:base|mock|runner)'\s*$",
+        "",
+        content,
+    )
+    return new_content, bool(count)
+
+
+def _ensure_test_dependencies(content: str) -> Tuple[str, bool]:
+    module_view = re.sub(r"(?ms)^\s*(buildscript|pluginManagement)\s*\{.*?^\s*\}", "", content)
+    uses_modern = re.search(
+        r"(?m)^\s*(implementation|api|testImplementation|androidTestImplementation)\b",
+        module_view,
+    )
+    configuration = "androidTestImplementation" if uses_modern else "androidTestCompile"
+    dependencies = [
+        "androidx.test.ext:junit:1.1.5",
+        "androidx.test:runner:1.5.2",
+        "androidx.test:core:1.5.0",
+        "androidx.test.services:storage:1.4.2",
+    ]
+    missing = [dep for dep in dependencies if dep not in module_view]
+    if not missing:
+        return content, False
+    block = "\n\ndependencies {\n" + "".join(
+        f"    {configuration} \"{dep}\"\n" for dep in missing
+    ) + "}\n"
+    if not content.endswith("\n"):
+        content += "\n"
+    return content + block, True
+
+
+def patch_app_build_gradle(path: pathlib.Path, compile_sdk: int, target_sdk: int) -> bool:
+    text = path.read_text(encoding="utf-8")
+    changed = False
+
+    for transform in (
+        lambda c: _ensure_android_sdk(c, compile_sdk, target_sdk),
+        _ensure_instrumentation_runner,
+        _remove_legacy_use_library,
+        _ensure_test_dependencies,
+    ):
+        text, modified = transform(text)
+        changed = changed or modified
+
+    if changed:
+        path.write_text(text if text.endswith("\n") else text + "\n", encoding="utf-8")
+    return changed
+
+
+def patch_root_build_gradle(path: pathlib.Path) -> bool:
+    text = path.read_text(encoding="utf-8")
+    text, changed = _ensure_repositories(text)
+    if changed:
+        path.write_text(text if text.endswith("\n") else text + "\n", encoding="utf-8")
+    return changed
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Normalize Gradle build files")
+    parser.add_argument("--root", required=True, type=pathlib.Path, help="Path to root build.gradle")
+    parser.add_argument("--app", required=True, type=pathlib.Path, help="Path to app/build.gradle")
+    parser.add_argument("--compile-sdk", type=int, default=33)
+    parser.add_argument("--target-sdk", type=int, default=33)
+    args = parser.parse_args()
+
+    modified_root = patch_root_build_gradle(args.root)
+    modified_app = patch_app_build_gradle(args.app, args.compile_sdk, args.target_sdk)
+
+    if modified_root:
+        print(f"Patched {args.root}")
+    if modified_app:
+        print(f"Patched {args.app}")
+    if not (modified_root or modified_app):
+        print("Gradle files already normalized")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

scripts/android/tests/HelloCodenameOneInstrumentedTest.java

@@ -0,0 +1,112 @@
+package @PACKAGE@;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.Intent;
+import android.graphics.Bitmap;
+import android.graphics.Canvas;
+import android.util.Base64;
+import android.util.DisplayMetrics;
+import android.view.View;
+
+import androidx.test.core.app.ActivityScenario;
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.io.ByteArrayOutputStream;
+
+@RunWith(AndroidJUnit4.class)
+public class HelloCodenameOneInstrumentedTest {
+
+    private static void println(String s) {
+        System.out.println(s);
+    }
+
+    @Test
+    public void testUseAppContext_andEmitScreenshot() throws Exception {
+        Context ctx = ApplicationProvider.getApplicationContext();
+        String pkg = "@PACKAGE@";
+        Assert.assertEquals("Package mismatch", pkg, ctx.getPackageName());
+
+        Intent launch = ctx.getPackageManager().getLaunchIntentForPackage(pkg);
+        if (launch == null) {
+            Intent q = new Intent(Intent.ACTION_MAIN);
+            q.addCategory(Intent.CATEGORY_LAUNCHER);
+            q.setPackage(pkg);
+            launch = q;
+        }
+        launch.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+
+        println("CN1SS:INFO: about to launch Activity");
+        byte[] pngBytes = null;
+
+        try (ActivityScenario<Activity> scenario = ActivityScenario.launch(launch)) {
+            Thread.sleep(750);
+
+            println("CN1SS:INFO: activity launched");
+
+            final byte[][] holder = new byte[1][];
+            scenario.onActivity(activity -> {
+                try {
+                    View root = activity.getWindow().getDecorView().getRootView();
+                    int w = root.getWidth();
+                    int h = root.getHeight();
+                    if (w <= 0 || h <= 0) {
+                        DisplayMetrics dm = activity.getResources().getDisplayMetrics();
+                        w = Math.max(1, dm.widthPixels);
+                        h = Math.max(1, dm.heightPixels);
+                        int sw = View.MeasureSpec.makeMeasureSpec(w, View.MeasureSpec.EXACTLY);
+                        int sh = View.MeasureSpec.makeMeasureSpec(h, View.MeasureSpec.EXACTLY);
+                        root.measure(sw, sh);
+                        root.layout(0, 0, w, h);
+                        println("CN1SS:INFO: forced layout to " + w + "x" + h);
+                    } else {
+                        println("CN1SS:INFO: natural layout " + w + "x" + h);
+                    }
+
+                    Bitmap bmp = Bitmap.createBitmap(w, h, Bitmap.Config.ARGB_8888);
+                    Canvas c = new Canvas(bmp);
+                    root.draw(c);
+
+                    ByteArrayOutputStream baos = new ByteArrayOutputStream(Math.max(1024, w * h / 2));
+                    boolean ok = bmp.compress(Bitmap.CompressFormat.PNG, 100, baos);
+                    if (!ok) {
+                        throw new RuntimeException("Bitmap.compress returned false");
+                    }
+                    holder[0] = baos.toByteArray();
+                    println("CN1SS:INFO: png_bytes=" + holder[0].length);
+                } catch (Throwable t) {
+                    println("CN1SS:ERR: onActivity " + t);
+                    t.printStackTrace(System.out);
+                }
+            });
+
+            pngBytes = holder[0];
+        } catch (Throwable t) {
+            println("CN1SS:ERR: launch " + t);
+            t.printStackTrace(System.out);
+        }
+
+        if (pngBytes == null || pngBytes.length == 0) {
+            println("CN1SS:END");
+            Assert.fail("Screenshot capture produced 0 bytes");
+            return;
+        }
+
+        String b64 = Base64.encodeToString(pngBytes, Base64.NO_WRAP);
+        final int chunkSize = 2000;
+        int count = 0;
+        for (int pos = 0; pos < b64.length(); pos += chunkSize) {
+            int end = Math.min(pos + chunkSize, b64.length());
+            System.out.println("CN1SS:" + String.format("%06d", pos) + ":" + b64.substring(pos, end));
+            count++;
+        }
+        println("CN1SS:INFO: chunks=" + count + " total_b64_len=" + b64.length());
+        System.out.println("CN1SS:END");
+        System.out.flush();
+    }
+}