v1: Controls integration tests - part I (#5546)

* Checkbox basic test and PopupMenuTheme docstrings

* add cupertino action sheet test

* Checkbox tests

* removed screenshot from example test

* Add tests

* Fix tests

* add simple app-bar test

* try counter app test from examples folder

* Tests cleanup

* move test_app_bar.py and reference image

* add dropdown test

* Add macOS integration tests GitHub Actions workflow

Introduces a new workflow to run integration tests on macOS 14 using CocoaPods, uv, and Flutter. The workflow installs dependencies, runs Python integration tests, and uploads failure screenshots as artifacts.

* Update macOS CI to use flutter-action and set version

Replaces manual Flutter installation with subosito/flutter-action, sets FLUTTER_VERSION to 3.32.8, and simplifies the workflow. This improves maintainability and ensures consistent Flutter setup in CI.

* Disable integration tests on appveyor

* Update macos-integration-tests.yml

* Button, ElevatedButton, FilledButton tests

* FloatingActionButton test

* IconButton

* Add page screenshot capability and update dropdown test

Implemented the ability to take full-page screenshots in the Flutter page control and exposed it via the Python BasePage API. Updated the dropdown integration test to use the new screenshot feature and replaced golden images accordingly. Also clarified the integration test README for golden image generation.

* banner test

* PopupMenuButton basic test

* OutlinedButton basic test

* MenuItemButton basic test

* SegmentedButton basic test

* SubmenuButton basic test

Also fixed content type

* CupertinoButton basic test

* CupertinoActionSheetAction basic test

* CupertinoContextMenuAction basic test

* CupertinoDialogAction basic test

* CupertinoFilledButton basic test

* CupertinoSegmentedButton basic test

* CupertinoSlidingSegmentedButton basic test

* CupertinoTintedButton basic test

* TextButton basic test

* Add canvas drawing tests and golden images for macOS

Introduces integration tests for canvas drawing features including color fill, points (as points, lines, polygon), and shadow rendering. Adds corresponding golden images for macOS to validate visual output.

* Simplify canvas shadow test

* CircleAvatar test

* Skip test_draw_shadow in canvas integration tests

Temporarily disables the test_draw_shadow test in test_canvas.py using pytest.mark.skip, likely due to instability or pending fixes.

* AlertDialog basic test

* BottomSheet basic test

* CupertinoAlertDialog basic test

* CupertinoBottomSheet basic test

* Add long press support to Tester API

Introduces a longPress method to the Tester interface and its implementations in Dart and Python, enabling long press interactions in automated tests. Updates the service layer to handle the new 'long_press' command.

* CupertinoContextMenu

not done, menu doesn't open

* Image test

---------

Co-authored-by: InesaFitsner <[email protected]>
Co-authored-by: Owen McDonnell <[email protected]>

Author: 3 people

.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)