packages/flutter_test/test/test_widgets_app_test.dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/services.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';

void main() {
  group('TestWidgetsApp', () {
    testWidgets('home widget is displayed', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Text('Home Widget')));

      expect(find.text('Home Widget'), findsOneWidget);
    });

    testWidgets('uses default color (white) when not specified', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.color, const Color(0xFFFFFFFF));
    });

    testWidgets('uses custom color when specified', (WidgetTester tester) async {
      const customColor = Color(0xFF123456);

      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder(), color: customColor));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.color, customColor);
    });

    testWidgets('provides working Overlay', (WidgetTester tester) async {
      late OverlayState overlayState;

      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  overlayState = Overlay.of(context);
                },
                child: const Text('Tap me'),
              );
            },
          ),
        ),
      );

      await tester.tap(find.text('Tap me'));
      await tester.pump();

      expect(overlayState, isNotNull);
    });

    testWidgets('overlay entries can be inserted and displayed', (WidgetTester tester) async {
      late OverlayState overlayState;
      OverlayEntry? overlayEntry;

      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  overlayState = Overlay.of(context);
                  overlayEntry = OverlayEntry(
                    builder: (BuildContext context) {
                      return const Positioned(top: 100, left: 100, child: Text('Overlay Content'));
                    },
                  );
                  overlayState.insert(overlayEntry!);
                },
                child: const Text('Show Overlay'),
              );
            },
          ),
        ),
      );

      expect(find.text('Overlay Content'), findsNothing);

      await tester.tap(find.text('Show Overlay'));
      await tester.pump();

      expect(find.text('Overlay Content'), findsOneWidget);

      overlayEntry?.remove();
      overlayEntry?.dispose();
      await tester.pump();

      expect(find.text('Overlay Content'), findsNothing);
    });

    testWidgets('provides working Navigator', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).push(
                    PageRouteBuilder<void>(
                      pageBuilder:
                          (
                            BuildContext context,
                            Animation<double> animation,
                            Animation<double> secondaryAnimation,
                          ) {
                            return const Text('Second Page');
                          },
                    ),
                  );
                },
                child: const Text('Navigate'),
              );
            },
          ),
        ),
      );

      expect(find.text('Navigate'), findsOneWidget);
      expect(find.text('Second Page'), findsNothing);

      await tester.tap(find.text('Navigate'));
      await tester.pumpAndSettle();

      expect(find.text('Second Page'), findsOneWidget);
    });

    testWidgets('Navigator can pop routes', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).push(
                    PageRouteBuilder<void>(
                      pageBuilder:
                          (
                            BuildContext context,
                            Animation<double> animation,
                            Animation<double> secondaryAnimation,
                          ) {
                            return GestureDetector(
                              onTap: () {
                                Navigator.of(context).pop();
                              },
                              child: const Text('Second Page - Tap to go back'),
                            );
                          },
                    ),
                  );
                },
                child: const Text('First Page'),
              );
            },
          ),
        ),
      );

      expect(find.text('First Page'), findsOneWidget);

      await tester.tap(find.text('First Page'));
      await tester.pumpAndSettle();

      expect(find.text('Second Page - Tap to go back'), findsOneWidget);
      expect(find.text('First Page'), findsNothing);

      await tester.tap(find.text('Second Page - Tap to go back'));
      await tester.pumpAndSettle();

      expect(find.text('First Page'), findsOneWidget);
      expect(find.text('Second Page - Tap to go back'), findsNothing);
    });

    testWidgets('provides MediaQuery', (WidgetTester tester) async {
      late MediaQueryData mediaQueryData;

      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              mediaQueryData = MediaQuery.of(context);
              return const Placeholder();
            },
          ),
        ),
      );

      expect(mediaQueryData, isNotNull);
      expect(mediaQueryData.size, isNotNull);
    });

    testWidgets('provides Directionality', (WidgetTester tester) async {
      late TextDirection textDirection;

      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              textDirection = Directionality.of(context);
              return const Placeholder();
            },
          ),
        ),
      );

      expect(textDirection, isNotNull);
    });

    testWidgets('routes can be navigated with pushNamed', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).pushNamed('/details');
                },
                child: const Text('Home Page'),
              );
            },
          ),
          routes: <String, WidgetBuilder>{
            '/details': (BuildContext context) => const Text('Details Page'),
          },
        ),
      );

      expect(find.text('Home Page'), findsOneWidget);
      expect(find.text('Details Page'), findsNothing);

      await tester.tap(find.text('Home Page'));
      await tester.pumpAndSettle();

      expect(find.text('Details Page'), findsOneWidget);
    });

    testWidgets('routes support pop navigation', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).pushNamed('/details');
                },
                child: const Text('Home Page'),
              );
            },
          ),
          routes: <String, WidgetBuilder>{
            '/details': (BuildContext context) => GestureDetector(
              onTap: () {
                Navigator.of(context).pop();
              },
              child: const Text('Details Page - Tap to go back'),
            ),
          },
        ),
      );

      expect(find.text('Home Page'), findsOneWidget);

      await tester.tap(find.text('Home Page'));
      await tester.pumpAndSettle();

      expect(find.text('Details Page - Tap to go back'), findsOneWidget);
      expect(find.text('Home Page'), findsNothing);

      await tester.tap(find.text('Details Page - Tap to go back'));
      await tester.pumpAndSettle();

      expect(find.text('Home Page'), findsOneWidget);
      expect(find.text('Details Page - Tap to go back'), findsNothing);
    });

    testWidgets('uses no transition by default for simpler testing', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).pushNamed('/details');
                },
                child: const Text('Home Page'),
              );
            },
          ),
          routes: <String, WidgetBuilder>{
            '/details': (BuildContext context) => const Text('Details Page'),
          },
        ),
      );

      await tester.tap(find.text('Home Page'));
      // Single pump is sufficient with zero-duration transitions.
      await tester.pump();

      // Route should be immediately visible without needing pumpAndSettle.
      expect(find.text('Details Page'), findsOneWidget);
    });

    testWidgets('custom pageRouteBuilder is used', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return GestureDetector(
                onTap: () {
                  Navigator.of(context).pushNamed('/details');
                },
                child: const Text('Home Page'),
              );
            },
          ),
          routes: <String, WidgetBuilder>{
            '/details': (BuildContext context) => const Text('Details Page'),
          },
          pageRouteBuilder: <T>(RouteSettings settings, WidgetBuilder builder) {
            return PageRouteBuilder<T>(
              settings: settings,
              pageBuilder:
                  (
                    BuildContext context,
                    Animation<double> animation,
                    Animation<double> secondaryAnimation,
                  ) => builder(context),
              transitionsBuilder:
                  (
                    BuildContext context,
                    Animation<double> animation,
                    Animation<double> secondaryAnimation,
                    Widget child,
                  ) {
                    return ScaleTransition(scale: animation, child: child);
                  },
            );
          },
        ),
      );

      await tester.tap(find.text('Home Page'));
      await tester.pump();

      // Custom pageRouteBuilder wraps the route with ScaleTransition.
      expect(find.byType(ScaleTransition), findsWidgets);
      expect(find.text('Details Page'), findsOneWidget);
    });

    testWidgets('multiple routes can be defined', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          home: Builder(
            builder: (BuildContext context) {
              return Column(
                children: <Widget>[
                  GestureDetector(
                    onTap: () {
                      Navigator.of(context).pushNamed('/page1');
                    },
                    child: const Text('Go to Page 1'),
                  ),
                  GestureDetector(
                    onTap: () {
                      Navigator.of(context).pushNamed('/page2');
                    },
                    child: const Text('Go to Page 2'),
                  ),
                ],
              );
            },
          ),
          routes: <String, WidgetBuilder>{
            '/page1': (BuildContext context) => const Text('Page 1 Content'),
            '/page2': (BuildContext context) => const Text('Page 2 Content'),
          },
        ),
      );

      // Navigate to page 1.
      await tester.tap(find.text('Go to Page 1'));
      await tester.pumpAndSettle();
      expect(find.text('Page 1 Content'), findsOneWidget);

      // Go back.
      tester.state<NavigatorState>(find.byType(Navigator)).pop();
      await tester.pumpAndSettle();

      // Navigate to page 2.
      await tester.tap(find.text('Go to Page 2'));
      await tester.pumpAndSettle();
      expect(find.text('Page 2 Content'), findsOneWidget);
    });

    testWidgets('initialRoute navigates to the specified route on launch', (
      WidgetTester tester,
    ) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          initialRoute: '/details',
          routes: <String, WidgetBuilder>{
            '/': (BuildContext context) => const Text('Home Page'),
            '/details': (BuildContext context) => const Text('Details Page'),
          },
        ),
      );

      await tester.pumpAndSettle();

      expect(find.text('Details Page'), findsOneWidget);
    });

    testWidgets('initialRoute defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.initialRoute, isNull);
    });

    testWidgets('builder wraps the navigator content', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          builder: (BuildContext context, Widget? child) {
            return Column(
              children: <Widget>[
                const Text('Header from builder'),
                Expanded(child: child ?? const SizedBox.shrink()),
              ],
            );
          },
          home: const Text('Content'),
        ),
      );

      expect(find.text('Header from builder'), findsOneWidget);
      expect(find.text('Content'), findsOneWidget);
    });

    testWidgets('builder defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.builder, isNull);
    });

    testWidgets('builder receives the navigator as child', (WidgetTester tester) async {
      Widget? receivedChild;

      await tester.pumpWidget(
        TestWidgetsApp(
          builder: (BuildContext context, Widget? child) {
            receivedChild = child;
            return child ?? const SizedBox.shrink();
          },
          home: const Text('Home'),
        ),
      );

      expect(receivedChild, isNotNull);
    });

    testWidgets('shortcuts defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.shortcuts, isNull);
    });

    testWidgets('custom shortcuts are passed to WidgetsApp', (WidgetTester tester) async {
      final customShortcuts = <ShortcutActivator, Intent>{
        const SingleActivator(LogicalKeyboardKey.keyX, control: true): VoidCallbackIntent(() {}),
      };

      await tester.pumpWidget(
        TestWidgetsApp(home: const Placeholder(), shortcuts: customShortcuts),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.shortcuts, customShortcuts);
    });

    testWidgets('custom shortcuts respond to key events', (WidgetTester tester) async {
      var shortcutTriggered = false;

      await tester.pumpWidget(
        TestWidgetsApp(
          shortcuts: <ShortcutActivator, Intent>{
            const SingleActivator(LogicalKeyboardKey.keyK, control: true): VoidCallbackIntent(() {
              shortcutTriggered = true;
            }),
          },
          actions: <Type, Action<Intent>>{VoidCallbackIntent: VoidCallbackAction()},
          home: const Focus(autofocus: true, child: Placeholder()),
        ),
      );

      await tester.pump();
      await tester.sendKeyDownEvent(LogicalKeyboardKey.control);
      await tester.sendKeyDownEvent(LogicalKeyboardKey.keyK);
      await tester.sendKeyUpEvent(LogicalKeyboardKey.keyK);
      await tester.sendKeyUpEvent(LogicalKeyboardKey.control);

      expect(shortcutTriggered, isTrue);
    });

    testWidgets('textStyle defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.textStyle, isNull);
    });

    testWidgets('custom textStyle is passed to WidgetsApp', (WidgetTester tester) async {
      const customStyle = TextStyle(fontSize: 24.0, color: Color(0xFFFF0000));

      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder(), textStyle: customStyle));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.textStyle, customStyle);
    });

    testWidgets('textStyle wraps tree in DefaultTextStyle', (WidgetTester tester) async {
      const customStyle = TextStyle(fontSize: 32.0, color: Color(0xFF00FF00));
      late TextStyle resolvedStyle;

      await tester.pumpWidget(
        TestWidgetsApp(
          textStyle: customStyle,
          home: Builder(
            builder: (BuildContext context) {
              resolvedStyle = DefaultTextStyle.of(context).style;
              return const Placeholder();
            },
          ),
        ),
      );

      expect(resolvedStyle.fontSize, 32.0);
      expect(resolvedStyle.color, const Color(0xFF00FF00));
    });

    testWidgets('actions defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.actions, isNull);
    });

    testWidgets('custom actions are passed to WidgetsApp', (WidgetTester tester) async {
      final customActions = <Type, Action<Intent>>{VoidCallbackIntent: VoidCallbackAction()};

      await tester.pumpWidget(TestWidgetsApp(home: const Placeholder(), actions: customActions));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.actions, customActions);
    });

    testWidgets('restorationScopeId is passed to WidgetsApp', (WidgetTester tester) async {
      await tester.pumpWidget(
        const TestWidgetsApp(home: Placeholder(), restorationScopeId: 'test-app'),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.restorationScopeId, 'test-app');
    });

    testWidgets('restorationScopeId defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.restorationScopeId, isNull);
    });

    testWidgets('restorationScopeId inserts RootRestorationScope', (WidgetTester tester) async {
      await tester.pumpWidget(
        const TestWidgetsApp(home: Placeholder(), restorationScopeId: 'test-scope'),
      );

      expect(find.byType(RootRestorationScope), findsOneWidget);
    });

    testWidgets('navigatorKey provides access to NavigatorState', (WidgetTester tester) async {
      final navigatorKey = GlobalKey<NavigatorState>();

      await tester.pumpWidget(
        TestWidgetsApp(
          navigatorKey: navigatorKey,
          home: const Text('Home Page'),
          routes: <String, WidgetBuilder>{
            '/details': (BuildContext context) => const Text('Details Page'),
          },
        ),
      );

      expect(find.text('Home Page'), findsOneWidget);
      expect(find.text('Details Page'), findsNothing);

      // Use navigatorKey to navigate directly.
      navigatorKey.currentState!.pushNamed('/details');
      await tester.pumpAndSettle();

      expect(find.text('Details Page'), findsOneWidget);

      // Use navigatorKey to pop.
      navigatorKey.currentState!.pop();
      await tester.pumpAndSettle();

      expect(find.text('Home Page'), findsOneWidget);
      expect(find.text('Details Page'), findsNothing);
    });

    testWidgets('onGenerateRoute builds routes from callback', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          initialRoute: '/',
          onGenerateRoute: (RouteSettings settings) {
            if (settings.name == '/') {
              return PageRouteBuilder<void>(
                settings: settings,
                pageBuilder: (_, _, _) => const Text('Generated Home'),
              );
            }
            return null;
          },
        ),
      );

      expect(find.text('Generated Home'), findsOneWidget);
    });

    testWidgets('onGenerateRoute supports push navigation', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          initialRoute: '/',
          onGenerateRoute: (RouteSettings settings) => switch (settings.name) {
            '/' => PageRouteBuilder<void>(
              settings: settings,
              pageBuilder: (_, _, _) => Builder(
                builder: (BuildContext context) {
                  return GestureDetector(
                    onTap: () => Navigator.of(context).pushNamed('/second'),
                    child: const Text('First'),
                  );
                },
              ),
            ),
            '/second' => PageRouteBuilder<void>(
              settings: settings,
              pageBuilder: (_, _, _) => const Text('Second'),
            ),
            _ => null,
          },
        ),
      );

      expect(find.text('First'), findsOneWidget);
      expect(find.text('Second'), findsNothing);

      await tester.tap(find.text('First'));
      await tester.pumpAndSettle();

      expect(find.text('Second'), findsOneWidget);
    });

    testWidgets('onGenerateRoute works with builder', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          initialRoute: '/',
          builder: (BuildContext context, Widget? child) {
            return Column(
              children: <Widget>[
                const Text('Header'),
                Expanded(child: child ?? const SizedBox.shrink()),
              ],
            );
          },
          onGenerateRoute: (RouteSettings settings) {
            return PageRouteBuilder<void>(
              settings: settings,
              pageBuilder: (_, _, _) => const Text('Route Content'),
            );
          },
        ),
      );

      expect(find.text('Header'), findsOneWidget);
      expect(find.text('Route Content'), findsOneWidget);
    });

    testWidgets('onGenerateRoute defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.onGenerateRoute, isNull);
    });

    testWidgets('onUnknownRoute defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.onUnknownRoute, isNull);
    });

    testWidgets('onUnknownRoute is passed to WidgetsApp', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(home: const Placeholder(), onUnknownRoute: (settings) => null),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.onUnknownRoute, isNotNull);
    });

    testWidgets('localizationsDelegates defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.localizationsDelegates, isNull);
    });

    testWidgets('localizationsDelegates is passed to WidgetsApp', (WidgetTester tester) async {
      final delegates = <LocalizationsDelegate<Object?>>[];

      await tester.pumpWidget(
        TestWidgetsApp(home: const Placeholder(), localizationsDelegates: delegates),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(identical(widgetsApp.localizationsDelegates, delegates), isTrue);
    });

    testWidgets('localeListResolutionCallback defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.localeListResolutionCallback, isNull);
    });

    testWidgets('localeListResolutionCallback is passed to WidgetsApp', (
      WidgetTester tester,
    ) async {
      await tester.pumpWidget(
        const TestWidgetsApp(
          home: Placeholder(),
          localeListResolutionCallback: testLocalResolutionCallback,
        ),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(
        identical(widgetsApp.localeListResolutionCallback, testLocalResolutionCallback),
        isTrue,
      );
    });

    testWidgets('onGenerateInitialRoutes defaults to null', (WidgetTester tester) async {
      await tester.pumpWidget(const TestWidgetsApp(home: Placeholder()));

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(widgetsApp.onGenerateInitialRoutes, isNull);
    });

    testWidgets('onGenerateInitialRoutes is passed to WidgetsApp', (WidgetTester tester) async {
      await tester.pumpWidget(
        TestWidgetsApp(
          onGenerateInitialRoutes: testOnGenerateInitialRoutes,
          onGenerateRoute: (_) => null,
        ),
      );

      final WidgetsApp widgetsApp = tester.widget(find.byType(WidgetsApp));
      expect(identical(widgetsApp.onGenerateInitialRoutes, testOnGenerateInitialRoutes), isTrue);
    });
  });
}

Locale? testLocalResolutionCallback(List<Locale>? locales, Iterable<Locale> supportedLocales) {
  return null;
}

List<Route<Object?>> testOnGenerateInitialRoutes(String initialRouteName) {
  return <Route<Object?>>[
    PageRouteBuilder<int>(
      settings: const RouteSettings(name: '/'),
      pageBuilder: (_, _, _) {
        return const Placeholder();
      },
    ),
  ];
}