v1: Controls integration tests - part I

.appveyor.yml

@@ -26,13 +26,13 @@ environment:
       job_group: build_flet_package
       APPVEYOR_BUILD_WORKER_IMAGE: ubuntu2204
 
-    - job_name: Integration tests on macOS
-      job_group: integration_tests
-      python_stack: python 3.10
-      APPVEYOR_BUILD_WORKER_IMAGE: macos-sonoma
-      FLET_TEST_SCREENSHOTS_PIXEL_RATIO: 2.0
-      FLET_TEST_SCREENSHOTS_SIMILARITY_THRESHOLD: 99.0
-      FLET_TEST_DISABLE_FVM: 1
+    # - job_name: Integration tests on macOS
+    #   job_group: integration_tests
+    #   python_stack: python 3.10
+    #   APPVEYOR_BUILD_WORKER_IMAGE: macos-sonoma
+    #   FLET_TEST_SCREENSHOTS_PIXEL_RATIO: 2.0
+    #   FLET_TEST_SCREENSHOTS_SIMILARITY_THRESHOLD: 99.0
+    #   FLET_TEST_DISABLE_FVM: 1
 
     - job_name: Build Flet for Windows
       job_group: build_flet

.github/workflows/macos-integration-tests.yml

@@ -0,0 +1,53 @@
+name: macOS Integration Tests
+
+on:
+  push:
+  pull_request:
+
+env:
+  FLUTTER_VERSION: "3.32.8"
+  FLET_TEST_SCREENSHOTS_PIXEL_RATIO: "2.0"
+  FLET_TEST_SCREENSHOTS_SIMILARITY_THRESHOLD: "99.0"
+  FLET_TEST_DISABLE_FVM: "1"
+
+jobs:
+  test-macos:
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install CocoaPods
+        run: brew install cocoapods
+
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.FLUTTER_VERSION }}
+          channel: stable
+          cache: true
+
+      - name: Install uv
+        shell: bash
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> "$GITHUB_PATH"
+
+      - name: Show tool versions
+        run: |
+          python3 --version
+          uv --version
+          pod --version
+          flutter --version
+
+      - name: Run integration tests
+        working-directory: sdk/python
+        run: |
+          uv run pytest -s -o log_cli=true -o log_cli_level=INFO packages/flet/integration_tests
+
+      - name: Upload failure screenshots
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-failures-macos
+          path: sdk/python/packages/flet/integration_tests/**/*_actual.png
+          if-no-files-found: ignore

client/integration_test/flutter_tester.dart

@@ -74,6 +74,10 @@ class FlutterWidgetTester implements Tester {
   Future<void> tap(TestFinder finder) =>
       _tester.tap((finder as FlutterTestFinder).raw);
 
+  @override
+  Future<void> longPress(TestFinder finder) =>
+      _tester.longPress((finder as FlutterTestFinder).raw);
+
   @override
   Future<void> enterText(TestFinder finder, String text) =>
       _tester.enterText((finder as FlutterTestFinder).raw, text);

packages/flet/lib/src/controls/page.dart

@@ -1,9 +1,11 @@
+import 'dart:ui' as ui;
 import 'dart:ui';
 
 import 'package:collection/collection.dart';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
+import 'package:flutter/rendering.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:provider/provider.dart';
@@ -25,6 +27,7 @@ import '../utils/platform_utils_web.dart'
 import '../utils/session_store_web.dart'
     if (dart.library.io) "../utils/session_store_non_web.dart";
 import '../utils/theme.dart';
+import '../utils/time.dart';
 import '../utils/user_fonts.dart';
 import '../widgets/animated_transition_page.dart';
 import '../widgets/loading_page.dart';
@@ -44,6 +47,7 @@ class PageControl extends StatefulWidget {
 
 class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
   final _navigatorKey = GlobalKey<NavigatorState>();
+  final _rootKey = GlobalKey();
   late final RouteState _routeState;
   late final SimpleRouterDelegate _routerDelegate;
   late final RouteParser _routeParser;
@@ -52,7 +56,7 @@ class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
   ServiceRegistry? _userServices;
   bool? _prevOnKeyboardEvent;
   bool _keyboardHandlerSubscribed = false;
-
+  double _dpr = 1.0;
   String? _prevViewRoutes;
 
   final Map<int, MultiView> _multiViews = <int, MultiView>{};
@@ -87,13 +91,14 @@ class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
         onRestart: () => _handleAppLifecycleTransition('restart'));
 
     _attachKeyboardListenerIfNeeded();
+    widget.control.addInvokeMethodListener(_invokeMethod);
   }
 
   @override
   void didChangeDependencies() {
     debugPrint("Page.didChangeDependencies: ${widget.control.id}");
     super.didChangeDependencies();
-
+    _dpr = MediaQuery.devicePixelRatioOf(context);
     _loadFontsIfNeeded(FletBackend.of(context));
   }
 
@@ -148,9 +153,30 @@ class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
     if (_keyboardHandlerSubscribed) {
       HardwareKeyboard.instance.removeHandler(_handleKeyDown);
     }
+    widget.control.removeInvokeMethodListener(_invokeMethod);
     super.dispose();
   }
 
+  Future<dynamic> _invokeMethod(String name, dynamic args) async {
+    debugPrint("Page.$name($args)");
+    switch (name) {
+      case "take_screenshot":
+        if (_rootKey.currentContext == null) {
+          return null;
+        }
+        await Future.delayed(
+            parseDuration(args["delay"], const Duration(milliseconds: 20))!);
+        final boundary = _rootKey.currentContext!.findRenderObject()
+            as RenderRepaintBoundary;
+        final image = await boundary.toImage(
+            pixelRatio: parseDouble(args["pixel_ratio"], _dpr)!);
+        final data = await image.toByteData(format: ui.ImageByteFormat.png);
+        return data!.buffer.asUint8List();
+      default:
+        throw Exception("Unknown Page method: $name");
+    }
+  }
+
   void _updateMultiViews() {
     if (!widget.control.backend.multiView) {
       return;
@@ -383,7 +409,7 @@ class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
     var showSemanticsDebugger =
         control.getBool("show_semantics_debugger", false)!;
 
-    var app = widgetsDesign == PageDesign.cupertino
+    Widget? app = widgetsDesign == PageDesign.cupertino
         ? home != null
             ? CupertinoApp(
                 debugShowCheckedModeBanner: false,
@@ -432,6 +458,14 @@ class _PageControlState extends State<PageControl> with WidgetsBindingObserver {
                 supportedLocales: localeConfiguration.supportedLocales,
                 locale: localeConfiguration.locale,
               );
+
+    if (control.getBool("enable_screenshots") == true) {
+      app = RepaintBoundary(
+        key: _rootKey,
+        child: app,
+      );
+    }
+
     return PageContext(
       themeMode: themeMode,
       brightness: brightness,

packages/flet/lib/src/controls/submenu_button.dart

@@ -82,7 +82,7 @@ class _SubmenuButtonControlState extends State<SubmenuButtonControl> {
       leadingIcon: widget.control.buildWidget("leading"),
       trailingIcon: widget.control.buildWidget("trailing"),
       menuChildren: widget.control.buildWidgets("controls"),
-      child: widget.control.buildWidget("content"),
+      child: widget.control.buildTextOrWidget("content"),
     );
 
     var focusValue = widget.control.getString("focus");

packages/flet/lib/src/services/tester.dart

@@ -79,6 +79,12 @@ class TesterService extends FletService {
           await control.backend.tester!.tap(finder);
         }
 
+      case "long_press":
+        var finder = _finders[args["id"]];
+        if (finder != null) {
+          await control.backend.tester!.longPress(finder);
+        }
+
       case "enter_text":
         var finder = _finders[args["id"]];
         if (finder != null) {

packages/flet/lib/src/testing/tester.dart

@@ -14,6 +14,7 @@ abstract class Tester {
   TestFinder findByIcon(IconData icon);
   Future<Uint8List> takeScreenshot(String name);
   Future<void> tap(TestFinder finder);
+  Future<void> longPress(TestFinder finder);
   Future<void> enterText(TestFinder finder, String text);
   Future<void> mouseHover(TestFinder finder);
   void teardown();

sdk/python/examples/apps/counter/counter.py

@@ -18,7 +18,7 @@ def plus_click(e):
     page.add(
         ft.Row(
             [
-                ft.IconButton(ft.Icons.REMOVE, on_click=minus_click),
+                ft.IconButton(ft.Icons.REMOVE, on_click=minus_click, key="decrement"),
                 txt_number,
                 ft.IconButton(ft.Icons.ADD, on_click=plus_click),
             ],
@@ -27,4 +27,5 @@ def plus_click(e):
     )
 
 
-ft.run(main)
+if __name__ == "__main__":
+    ft.run(main)

sdk/python/examples/apps/counter/test_counter_app.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+
+import counter as app
+import flet as ft
+import flet.testing as ftt
+import pytest
+import pytest_asyncio
+
+
+@pytest_asyncio.fixture(scope="module")
+async def flet_app(request):
+    flet_app = ftt.FletTestApp(
+        flutter_app_dir=(Path(__file__).parent / "../../../../../client").resolve(),
+        flet_app_main=app.main,
+        test_path=request.fspath,
+    )
+    await flet_app.start()
+    yield flet_app
+    await flet_app.teardown()
+
+
+@pytest.mark.asyncio(loop_scope="module")
+async def test_app(flet_app: ftt.FletTestApp):
+    tester = flet_app.tester
+    await tester.pump_and_settle()
+    zero_text = await tester.find_by_text("0")
+    assert zero_text.count == 1
+
+    # tap increment button
+    increment_btn = await tester.find_by_icon(ft.Icons.ADD)
+    assert increment_btn.count == 1
+    await tester.tap(increment_btn)
+    await tester.pump_and_settle()
+    assert (await tester.find_by_text("1")).count == 1
+
+    # tap decrement button
+    decrement_button = await tester.find_by_key("decrement")
+    assert decrement_button.count == 1
+    await tester.tap(decrement_button)
+    await tester.tap(decrement_button)
+    await tester.pump_and_settle()
+    assert (await tester.find_by_text("-1")).count == 1

sdk/python/examples/controls/app_bar/actions_and_popup_menu.py

@@ -33,4 +33,5 @@ def handle_checked_item_click(e: ft.Event[ft.PopupMenuItem]):
     page.add(ft.Text("Body!"))
 
 
-ft.run(main)
+if __name__ == "__main__":
+    ft.run(main)

sdk/python/examples/controls/checkbox/basic.py

@@ -22,4 +22,5 @@ def handle_button_click(e: ft.Event[ft.ElevatedButton]):
     )
 
 
-ft.run(main)
+if __name__ == "__main__":
+    ft.run(main)

sdk/python/examples/controls/dropdown/color_selection_with_filtering.py

@@ -2,6 +2,8 @@
 
 
 def main(page: ft.Page):
+    page.theme_mode = ft.ThemeMode.LIGHT
+
     def get_options():
         colors = [
             ft.Colors.RED,

sdk/python/examples/controls/image/src_base64.py

@@ -4,7 +4,9 @@
 def main(page: ft.Page):
     page.add(
         ft.Image(
-            src_base64="iVBORw0KGgoAAAANSUhEUgAAABkAAAAgCAYAAADnnNMGAAAACXBIWXMAAAORAAADkQFnq8zdAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAA6dJREFUSImllltoHFUYx3/fzOzm0lt23ZrQ1AQbtBehNpvQohgkBYVo410RwQctNE3Sh0IfiiBoIAjqi6TYrKnFy4O3oiiRavDJFi3mXomIBmOxNZe63ay52GR3Zj4f2sTEzmx3m//TYf7/c35zvgPnO6KqrESXqpq3muocAikv6m+/zytj3ejik1VN21G31YA9CgJ6xC+bMyQZPVCuarciPAMYC99V6Vw5pLbFSibHmlVoRVj9P3cmPBM8tSJI/M6mzabpfoAQ9fIF7WK4bd5vvuFnLGgy2vi0abg94A0AcJGvMq3hDxGRyar9r4F+iLAm0yIiRk8m37tctS1WsrIhhrI30+Srmg+J87OXUf3lWGS1q89dC6ltsSanxk4Aj2QBABii96300g87P/rtlrWr8l+vyDMfdlXSyyEikqxsiOUAQJCBhfHdXRfCq1LSsSlcWG+KBAGStvvrMkgiuv8lUc2mREukPwLUfHG+uTQv8Eown7VL3XlbBxYhf1c17hbVF3MDwA9bts280TnaU1YYqPby07aeFlUlHt27wSQ4CLo+F8AvoTCvHmyKF+ZbEb/M77P2LgvAwmrTHAHflN3KZxVbMC2jMFNOpgPnrMSOhvvFkMezXdwV4ePbtvHtxnJAMQ0j4JtVnO+eLb5oiSlt5HDbv7t1O90lpYCCCKbhfzW5kAIwUAazR0BlfII8Ow0I6uoVmI9MyAMwbMs8CExmDbk4zgu931MyO4OI4KrYflkRjOoTI+uM9d1vjotwKPu9QMk/sxzuO8POiVFcdZ1M2YBVsMEAKOqLvaPIe7mACuw0z/80SMH58SMplxlfiDhVi7dw2pltRhjKBQTQdrSja2KKTfE551NHuaZ0QVPvWYQUn31/Vm2nDvgjF4grVJx6suSvrvrSJ/6cSW2Oz9mf264uNrB806xZ1k/CZ49dUKgDEtlCROX2hfHpx8pGuuo3PpqYulw8fjndOp1yhgtNKRevJ1FyR2Ola+jXAjdnwTkZ6o896GdWdxDw7IxFg+0DpmXchTKSBWQnIuJn9u4j7dt+13UfHXEkXQOcuQ4kMhVtqsgUyPiQiPQfHw1NB2sRjmXKuTg1NwwBYLhtPtQX26eqTwGXPDOqvmcC4Hnwfrrad94GrVsOYTqUTkQY+iTlNe/6O1miSP/x0VB/+wMIDwHn/vtV1iQC4Xv95uUEWVCoL9Y5Z+gdovoyMHUFJHv88jmVy0vTuw7cZNv2YaA61Bfb7ZX5F8SaUv2xwZevAAAAAElFTkSuQmCC"
+            src_base64="iVBORw0KGgoAAAANSUhEUgAAABkAAAAgCAYAAADnnNMGAAAACXBIWXMAAAORAAADkQFnq8zdAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAA6dJREFUSImllltoHFUYx3/fzOzm0lt23ZrQ1AQbtBehNpvQohgkBYVo410RwQctNE3Sh0IfiiBoIAjqi6TYrKnFy4O3oiiRavDJFi3mXomIBmOxNZe63ay52GR3Zj4f2sTEzmx3m//TYf7/c35zvgPnO6KqrESXqpq3muocAikv6m+/zytj3ejik1VN21G31YA9CgJ6xC+bMyQZPVCuarciPAMYC99V6Vw5pLbFSibHmlVoRVj9P3cmPBM8tSJI/M6mzabpfoAQ9fIF7WK4bd5vvuFnLGgy2vi0abg94A0AcJGvMq3hDxGRyar9r4F+iLAm0yIiRk8m37tctS1WsrIhhrI30+Srmg+J87OXUf3lWGS1q89dC6ltsSanxk4Aj2QBABii96300g87P/rtlrWr8l+vyDMfdlXSyyEikqxsiOUAQJCBhfHdXRfCq1LSsSlcWG+KBAGStvvrMkgiuv8lUc2mREukPwLUfHG+uTQv8Eown7VL3XlbBxYhf1c17hbVF3MDwA9bts280TnaU1YYqPby07aeFlUlHt27wSQ4CLo+F8AvoTCvHmyKF+ZbEb/M77P2LgvAwmrTHAHflN3KZxVbMC2jMFNOpgPnrMSOhvvFkMezXdwV4ePbtvHtxnJAMQ0j4JtVnO+eLb5oiSlt5HDbv7t1O90lpYCCCKbhfzW5kAIwUAazR0BlfII8Ow0I6uoVmI9MyAMwbMs8CExmDbk4zgu931MyO4OI4KrYflkRjOoTI+uM9d1vjotwKPu9QMk/sxzuO8POiVFcdZ1M2YBVsMEAKOqLvaPIe7mACuw0z/80SMH58SMplxlfiDhVi7dw2pltRhjKBQTQdrSja2KKTfE551NHuaZ0QVPvWYQUn31/Vm2nDvgjF4grVJx6suSvrvrSJ/6cSW2Oz9mf264uNrB806xZ1k/CZ49dUKgDEtlCROX2hfHpx8pGuuo3PpqYulw8fjndOp1yhgtNKRevJ1FyR2Ola+jXAjdnwTkZ6o896GdWdxDw7IxFg+0DpmXchTKSBWQnIuJn9u4j7dt+13UfHXEkXQOcuQ4kMhVtqsgUyPiQiPQfHw1NB2sRjmXKuTg1NwwBYLhtPtQX26eqTwGXPDOqvmcC4Hnwfrrad94GrVsOYTqUTkQY+iTlNe/6O1miSP/x0VB/+wMIDwHn/vtV1iQC4Xv95uUEWVCoL9Y5Z+gdovoyMHUFJHv88jmVy0vTuw7cZNv2YaA61Bfb7ZX5F8SaUv2xwZevAAAAAElFTkSuQmCC",
+            width=100,
+            height=100,
         ),
     )
 

sdk/python/packages/flet/integration_tests/README.md

@@ -33,7 +33,7 @@ FLET_TEST_DEVICE=<simulator-name> FLET_TEST_PLATFORM=android uv run pytest -s -o
 Running test to create golden images:
 
 ```
-FLET_TEST_GOLDEN=1 uv run pytest -s -o log_cli=true -o log_cli_level=INFO packages/flet/integration_tests/test_controls.py
+FLET_TEST_GOLDEN=1 uv run pytest -s -o log_cli=true -o log_cli_level=INFO packages/flet/integration_tests/controls/test_buttons.py
 ```
 
 Environment variables:

sdk/python/packages/flet/integration_tests/controls/test_alert_dialog.py

@@ -0,0 +1,29 @@
+import flet as ft
+import flet.testing as ftt
+import pytest
+
+
+@pytest.mark.asyncio(loop_scope="module")
+async def test_alert_dialog_basic(flet_app: ftt.FletTestApp, request):
+    flet_app.page.theme_mode = ft.ThemeMode.LIGHT
+    ad = ft.AlertDialog(
+        key="ad",
+        title=ft.Text("Hello"),
+        content=ft.Text("You are notified!"),
+        alignment=ft.Alignment.CENTER,
+        on_dismiss=lambda e: print("Dialog dismissed!"),
+        title_padding=ft.Padding.all(25),
+    )
+    flet_app.page.enable_screenshots = True
+    flet_app.page.window.width = 400
+    flet_app.page.window.height = 600
+    flet_app.page.show_dialog(ad)
+    flet_app.page.update()
+    await flet_app.tester.pump_and_settle()
+
+    flet_app.assert_screenshot(
+        "alert_dialog_basic",
+        await flet_app.page.take_screenshot(
+            pixel_ratio=flet_app.screenshots_pixel_ratio
+        ),
+    )

sdk/python/packages/flet/integration_tests/controls/test_app_bar.py

@@ -0,0 +1,25 @@
+from pathlib import Path
+
+import flet as ft
+import flet.testing as ftt
+import pytest
+import pytest_asyncio
+
+
+@pytest.mark.asyncio(loop_scope="module")
+async def test_app_bar(flet_app: ftt.FletTestApp, request):
+    flet_app.page.theme_mode = ft.ThemeMode.LIGHT
+    await flet_app.assert_control_screenshot(
+        request.node.name,
+        ft.AppBar(
+            bgcolor=ft.Colors.PRIMARY_CONTAINER,
+            leading=ft.Icon(ft.Icons.PALETTE),
+            leading_width=40,
+            title=ft.Text("AppBar Test"),
+            center_title=False,
+            actions=[
+                ft.IconButton(icon=ft.Icons.TAB),
+                ft.IconButton(icon=ft.Icons.WALLET),
+            ],
+        ),
+    )