tab_scaffold_test.dart 38.8 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
import 'dart:typed_data';

7 8 9
import 'package:flutter/cupertino.dart';
import 'package:flutter_test/flutter_test.dart';

10
import '../image_data.dart';
11
import '../rendering/rendering_tester.dart' show TestCallbackPainter;
12

13
late List<int> selectedTabs;
14

15
class MockCupertinoTabController extends CupertinoTabController {
16
  MockCupertinoTabController({ required super.initialIndex });
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

  bool isDisposed = false;
  int numOfListeners = 0;

  @override
  void addListener(VoidCallback listener) {
    numOfListeners++;
    super.addListener(listener);
  }

  @override
  void removeListener(VoidCallback listener) {
    numOfListeners--;
    super.removeListener(listener);
  }

  @override
  void dispose() {
    isDisposed = true;
    super.dispose();
  }
}

40 41 42 43 44
void main() {
  setUp(() {
    selectedTabs = <int>[];
  });

45 46
  BottomNavigationBarItem tabGenerator(int index) {
    return BottomNavigationBarItem(
47
      icon: ImageIcon(MemoryImage(Uint8List.fromList(kTransparentImage))),
48
      label: 'Tab ${index + 1}',
49 50 51
    );
  }

52 53 54 55
  testWidgets('Tab switching', (WidgetTester tester) async {
    final List<int> tabsPainted = <int>[];

    await tester.pumpWidget(
56 57
      CupertinoApp(
        home: CupertinoTabScaffold(
xster's avatar
xster committed
58 59
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
60 61
            return CustomPaint(
              painter: TestCallbackPainter(
62
                onPaint: () { tabsPainted.add(index); },
63
              ),
64
              child: Text('Page ${index + 1}'),
xster's avatar
xster committed
65 66 67
            );
          },
        ),
68 69 70
      ),
    );

71
    expect(tabsPainted, const <int>[0]);
72 73 74 75
    RichText tab1 = tester.widget(find.descendant(
      of: find.text('Tab 1'),
      matching: find.byType(RichText),
    ));
76
    expect(tab1.text.style!.color, CupertinoColors.activeBlue);
77 78 79 80
    RichText tab2 = tester.widget(find.descendant(
      of: find.text('Tab 2'),
      matching: find.byType(RichText),
    ));
81
    expect(tab2.text.style!.color!.value, 0xFF999999);
82 83 84 85

    await tester.tap(find.text('Tab 2'));
    await tester.pump();

86
    expect(tabsPainted, const <int>[0, 1]);
87 88 89 90
    tab1 = tester.widget(find.descendant(
      of: find.text('Tab 1'),
      matching: find.byType(RichText),
    ));
91
    expect(tab1.text.style!.color!.value, 0xFF999999);
92 93 94 95
    tab2 = tester.widget(find.descendant(
      of: find.text('Tab 2'),
      matching: find.byType(RichText),
    ));
96
    expect(tab2.text.style!.color, CupertinoColors.activeBlue);
97 98 99 100

    await tester.tap(find.text('Tab 1'));
    await tester.pump();

101
    expect(tabsPainted, const <int>[0, 1, 0]);
102
    // CupertinoTabBar's onTap callbacks are passed on.
103
    expect(selectedTabs, const <int>[1, 0]);
104 105 106 107 108 109
  });

  testWidgets('Tabs are lazy built and moved offstage when inactive', (WidgetTester tester) async {
    final List<int> tabsBuilt = <int>[];

    await tester.pumpWidget(
110 111
      CupertinoApp(
        home: CupertinoTabScaffold(
xster's avatar
xster committed
112 113 114
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            tabsBuilt.add(index);
115
            return Text('Page ${index + 1}');
xster's avatar
xster committed
116 117
          },
        ),
118 119 120
      ),
    );

121
    expect(tabsBuilt, const <int>[0]);
122 123 124 125 126 127 128
    expect(find.text('Page 1'), findsOneWidget);
    expect(find.text('Page 2'), findsNothing);

    await tester.tap(find.text('Tab 2'));
    await tester.pump();

    // Both tabs are built but only one is onstage.
129
    expect(tabsBuilt, const <int>[0, 0, 1]);
130 131 132 133 134 135
    expect(find.text('Page 1', skipOffstage: false), isOffstage);
    expect(find.text('Page 2'), findsOneWidget);

    await tester.tap(find.text('Tab 1'));
    await tester.pump();

136
    expect(tabsBuilt, const <int>[0, 0, 1, 0, 1]);
137 138 139
    expect(find.text('Page 1'), findsOneWidget);
    expect(find.text('Page 2', skipOffstage: false), isOffstage);
  });
140 141 142

  testWidgets('Last tab gets focus', (WidgetTester tester) async {
    // 2 nodes for 2 tabs
143 144 145 146
    final List<FocusNode> focusNodes = <FocusNode>[
      FocusNode(debugLabel: 'Node 1'),
      FocusNode(debugLabel: 'Node 2'),
    ];
147 148

    await tester.pumpWidget(
149
      CupertinoApp(
150 151 152 153 154 155 156 157
        home: CupertinoTabScaffold(
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            return CupertinoTextField(
              focusNode: focusNodes[index],
              autofocus: true,
            );
          },
xster's avatar
xster committed
158
        ),
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
      ),
    );

    expect(focusNodes[0].hasFocus, isTrue);

    await tester.tap(find.text('Tab 2'));
    await tester.pump();

    expect(focusNodes[0].hasFocus, isFalse);
    expect(focusNodes[1].hasFocus, isTrue);

    await tester.tap(find.text('Tab 1'));
    await tester.pump();

    expect(focusNodes[0].hasFocus, isTrue);
    expect(focusNodes[1].hasFocus, isFalse);
  });

  testWidgets('Do not affect focus order in the route', (WidgetTester tester) async {
    final List<FocusNode> focusNodes = <FocusNode>[
179 180 181 182
      FocusNode(debugLabel: 'Node 1'),
      FocusNode(debugLabel: 'Node 2'),
      FocusNode(debugLabel: 'Node 3'),
      FocusNode(debugLabel: 'Node 4'),
183 184 185
    ];

    await tester.pumpWidget(
186
      CupertinoApp(
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
        home: CupertinoTabScaffold(
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            return Column(
              children: <Widget>[
                CupertinoTextField(
                  focusNode: focusNodes[index * 2],
                  placeholder: 'TextField 1',
                ),
                CupertinoTextField(
                  focusNode: focusNodes[index * 2 + 1],
                  placeholder: 'TextField 2',
                ),
              ],
            );
          },
xster's avatar
xster committed
203
        ),
204 205 206 207 208 209 210 211
      ),
    );

    expect(
      focusNodes.any((FocusNode node) => node.hasFocus),
      isFalse,
    );

212
    await tester.tap(find.widgetWithText(CupertinoTextField, 'TextField 2'));
213 214 215 216 217 218 219 220 221

    expect(
      focusNodes.indexOf(focusNodes.singleWhere((FocusNode node) => node.hasFocus)),
      1,
    );

    await tester.tap(find.text('Tab 2'));
    await tester.pump();

222
    await tester.tap(find.widgetWithText(CupertinoTextField, 'TextField 1'));
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

    expect(
      focusNodes.indexOf(focusNodes.singleWhere((FocusNode node) => node.hasFocus)),
      2,
    );

    await tester.tap(find.text('Tab 1'));
    await tester.pump();

    // Upon going back to tab 1, the item it tab 1 that previously had the focus
    // (TextField 2) gets it back.
    expect(
      focusNodes.indexOf(focusNodes.singleWhere((FocusNode node) => node.hasFocus)),
      1,
    );
  });
239

240 241 242 243 244 245 246 247 248 249 250 251
  testWidgets('Programmatic tab switching by changing the index of an existing controller', (WidgetTester tester) async {
    final CupertinoTabController controller = CupertinoTabController(initialIndex: 1);
    final List<int> tabsPainted = <int>[];

    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: _buildTabBar(),
          controller: controller,
          tabBuilder: (BuildContext context, int index) {
            return CustomPaint(
              painter: TestCallbackPainter(
252
                onPaint: () { tabsPainted.add(index); },
253
              ),
254
              child: Text('Page ${index + 1}'),
255 256 257 258 259 260
            );
          },
        ),
      ),
    );

261
    expect(tabsPainted, const <int>[1]);
262 263 264 265

    controller.index = 0;
    await tester.pump();

266
    expect(tabsPainted, const <int>[1, 0]);
267 268 269 270 271 272 273
    // onTap is not called when changing tabs programmatically.
    expect(selectedTabs, isEmpty);

    // Can still tap out of the programmatically selected tab.
    await tester.tap(find.text('Tab 2'));
    await tester.pump();

274 275
    expect(tabsPainted, const <int>[1, 0, 1]);
    expect(selectedTabs, const <int>[1]);
276 277 278
  });

  testWidgets('Programmatic tab switching by passing in a new controller', (WidgetTester tester) async {
279 280 281
    final List<int> tabsPainted = <int>[];

    await tester.pumpWidget(
282 283
      CupertinoApp(
        home: CupertinoTabScaffold(
xster's avatar
xster committed
284 285
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
286 287
            return CustomPaint(
              painter: TestCallbackPainter(
288
                onPaint: () { tabsPainted.add(index); },
289
              ),
290
              child: Text('Page ${index + 1}'),
xster's avatar
xster committed
291 292 293
            );
          },
        ),
294 295 296
      ),
    );

297
    expect(tabsPainted, const <int>[0]);
298 299

    await tester.pumpWidget(
300 301
      CupertinoApp(
        home: CupertinoTabScaffold(
302 303
          tabBar: _buildTabBar(),
          controller: CupertinoTabController(initialIndex: 1), // Programmatically change the tab now.
xster's avatar
xster committed
304
          tabBuilder: (BuildContext context, int index) {
305 306
            return CustomPaint(
              painter: TestCallbackPainter(
307
                onPaint: () { tabsPainted.add(index); },
308
              ),
309
              child: Text('Page ${index + 1}'),
xster's avatar
xster committed
310 311 312
            );
          },
        ),
313 314 315
      ),
    );

316
    expect(tabsPainted, const <int>[0, 1]);
317 318 319 320 321 322 323
    // onTap is not called when changing tabs programmatically.
    expect(selectedTabs, isEmpty);

    // Can still tap out of the programmatically selected tab.
    await tester.tap(find.text('Tab 1'));
    await tester.pump();

324 325
    expect(tabsPainted, const <int>[0, 1, 0]);
    expect(selectedTabs, const <int>[0]);
326
  });
xster's avatar
xster committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

  testWidgets('Tab bar respects themes', (WidgetTester tester) async {
    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            return const Placeholder();
          },
        ),
      ),
    );

    BoxDecoration tabDecoration = tester.widget<DecoratedBox>(find.descendant(
      of: find.byType(CupertinoTabBar),
      matching: find.byType(DecoratedBox),
343
    )).decoration as BoxDecoration;
xster's avatar
xster committed
344

345
    expect(tabDecoration.color, isSameColorAs(const Color(0xF0F9F9F9))); // Inherited from theme.
xster's avatar
xster committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

    await tester.tap(find.text('Tab 2'));
    await tester.pump();

    // Pump again but with dark theme.
    await tester.pumpWidget(
      CupertinoApp(
        theme: const CupertinoThemeData(
          brightness: Brightness.dark,
          primaryColor: CupertinoColors.destructiveRed,
        ),
        home: CupertinoTabScaffold(
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            return const Placeholder();
          },
        ),
      ),
    );

    tabDecoration = tester.widget<DecoratedBox>(find.descendant(
      of: find.byType(CupertinoTabBar),
      matching: find.byType(DecoratedBox),
369
    )).decoration as BoxDecoration;
xster's avatar
xster committed
370

371
    expect(tabDecoration.color, isSameColorAs(const Color(0xF01D1D1D)));
xster's avatar
xster committed
372 373 374 375 376 377

    final RichText tab1 = tester.widget(find.descendant(
      of: find.text('Tab 1'),
      matching: find.byType(RichText),
    ));
    // Tab 2 should still be selected after changing theme.
378
    expect(tab1.text.style!.color!.value, 0xFF757575);
xster's avatar
xster committed
379 380 381 382
    final RichText tab2 = tester.widget(find.descendant(
      of: find.text('Tab 2'),
      matching: find.byType(RichText),
    ));
383
    expect(tab2.text.style!.color, isSameColorAs(CupertinoColors.systemRed.darkColor));
xster's avatar
xster committed
384
  });
385 386

  testWidgets('Tab contents are padded when there are view insets', (WidgetTester tester) async {
387
    late BuildContext innerContext;
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

    await tester.pumpWidget(
      CupertinoApp(
        home: MediaQuery(
          data: const MediaQueryData(
            viewInsets: EdgeInsets.only(bottom: 200),
          ),
          child: CupertinoTabScaffold(
            tabBar: _buildTabBar(),
            tabBuilder: (BuildContext context, int index) {
              innerContext = context;
              return const Placeholder();
            },
          ),
        ),
      ),
    );

Dan Field's avatar
Dan Field committed
406
    expect(tester.getRect(find.byType(Placeholder)), const Rect.fromLTWH(0, 0, 800, 400));
407 408
    // Don't generate more media query padding from the translucent bottom
    // tab since the tab is behind the keyboard now.
409
    expect(MediaQuery.of(innerContext).padding.bottom, 0);
410 411
  });

412
  testWidgets('Tab contents are not inset when resizeToAvoidBottomInset overridden', (WidgetTester tester) async {
413
    late BuildContext innerContext;
414 415 416 417 418 419 420 421 422 423 424 425 426

    await tester.pumpWidget(
      CupertinoApp(
        home: MediaQuery(
          data: const MediaQueryData(
            viewInsets: EdgeInsets.only(bottom: 200),
          ),
          child: CupertinoTabScaffold(
            resizeToAvoidBottomInset: false,
            tabBar: _buildTabBar(),
            tabBuilder: (BuildContext context, int index) {
              innerContext = context;
              return const Placeholder();
427
            },
428 429 430 431 432
          ),
        ),
      ),
    );

Dan Field's avatar
Dan Field committed
433
    expect(tester.getRect(find.byType(Placeholder)), const Rect.fromLTWH(0, 0, 800, 600));
434 435
    // Media query padding shows up in the inner content because it wasn't masked
    // by the view inset.
436
    expect(MediaQuery.of(innerContext).padding.bottom, 50);
437 438
  });

439
  testWidgets('Tab contents bottom padding are not consumed by viewInsets when resizeToAvoidBottomInset overridden', (WidgetTester tester) async {
440 441
    final Widget child = Localizations(
      locale: const Locale('en', 'US'),
442
      delegates: const <LocalizationsDelegate<dynamic>>[
443 444 445 446 447 448 449 450 451 452 453 454
        DefaultWidgetsLocalizations.delegate,
        DefaultCupertinoLocalizations.delegate,
      ],
      child: Directionality(
        textDirection: TextDirection.ltr,
        child: CupertinoTabScaffold(
          resizeToAvoidBottomInset: false,
          tabBar: _buildTabBar(),
          tabBuilder: (BuildContext context, int index) {
            return const Placeholder();
          },
        ),
455
      ),
456 457 458 459 460 461 462 463
    );

    await tester.pumpWidget(
      CupertinoApp(
        home: MediaQuery(
          data: const MediaQueryData(
            viewInsets: EdgeInsets.only(bottom: 20.0),
          ),
464
          child: child,
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        ),
      ),
    );

    final Offset initialPoint = tester.getCenter(find.byType(Placeholder));

    // Consume bottom padding - as if by the keyboard opening
    await tester.pumpWidget(
      MediaQuery(
        data: const MediaQueryData(
          viewPadding: EdgeInsets.only(bottom: 20),
          viewInsets: EdgeInsets.only(bottom: 300),
        ),
        child: child,
      ),
    );

    final Offset finalPoint = tester.getCenter(find.byType(Placeholder));

    expect(initialPoint, finalPoint);
  });

487 488 489 490 491
  testWidgets(
    'Opaque tab bar consumes bottom padding while non opaque tab bar does not',
    (WidgetTester tester) async {
      // Regression test for https://github.com/flutter/flutter/issues/43581.
      Future<EdgeInsets> getContentPaddingWithTabBarColor(Color color) async {
492
        late EdgeInsets contentPadding;
493 494 495 496 497 498 499 500 501 502 503

        await tester.pumpWidget(
          CupertinoApp(
            home: MediaQuery(
              data: const MediaQueryData(padding: EdgeInsets.only(bottom: 50)),
              child: CupertinoTabScaffold(
                tabBar: CupertinoTabBar(
                  backgroundColor: color,
                  items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
                ),
                tabBuilder: (BuildContext context, int index) {
504
                  contentPadding = MediaQuery.of(context).padding;
505
                  return const Placeholder();
506
                },
507 508 509 510 511 512 513 514 515
              ),
            ),
          ),
        );
        return contentPadding;
      }

      expect(await getContentPaddingWithTabBarColor(const Color(0xAAFFFFFF)), isNot(EdgeInsets.zero));
      expect(await getContentPaddingWithTabBarColor(const Color(0xFFFFFFFF)), EdgeInsets.zero);
516 517
    },
  );
518

519
  testWidgets('Tab and page scaffolds do not double stack view insets', (WidgetTester tester) async {
520
    late BuildContext innerContext;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

    await tester.pumpWidget(
      CupertinoApp(
        home: MediaQuery(
          data: const MediaQueryData(
            viewInsets: EdgeInsets.only(bottom: 200),
          ),
          child: CupertinoTabScaffold(
            tabBar: _buildTabBar(),
            tabBuilder: (BuildContext context, int index) {
              return CupertinoPageScaffold(
                child: Builder(
                  builder: (BuildContext context) {
                    innerContext = context;
                    return const Placeholder();
                  },
                ),
              );
            },
          ),
        ),
      ),
    );

Dan Field's avatar
Dan Field committed
545
    expect(tester.getRect(find.byType(Placeholder)), const Rect.fromLTWH(0, 0, 800, 400));
546
    expect(MediaQuery.of(innerContext).padding.bottom, 0);
547
  });
548

549
  testWidgets('Deleting tabs after selecting them should switch to the last available tab', (WidgetTester tester) async {
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
    final List<int> tabsBuilt = <int>[];

    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(4, tabGenerator),
            onTap: (int newTab) => selectedTabs.add(newTab),
          ),
          tabBuilder: (BuildContext context, int index) {
            tabsBuilt.add(index);
            return Text('Page ${index + 1}');
          },
        ),
      ),
    );

567
    expect(tabsBuilt, const <int>[0]);
568 569
    // selectedTabs list is appended to on onTap callbacks. We didn't tap
    // any tabs yet.
570
    expect(selectedTabs, const <int>[]);
571 572 573 574 575 576
    tabsBuilt.clear();

    await tester.tap(find.text('Tab 4'));
    await tester.pump();

    // Tabs 1 and 4 are built but only one is onstage.
577 578
    expect(tabsBuilt, const <int>[0, 3]);
    expect(selectedTabs, const <int>[3]);
579 580 581 582
    expect(find.text('Page 1', skipOffstage: false), isOffstage);
    expect(find.text('Page 4'), findsOneWidget);
    tabsBuilt.clear();

583
    // Delete 2 tabs while Page 4 is still selected.
584 585 586 587 588 589 590 591 592 593 594 595 596
    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
            onTap: (int newTab) => selectedTabs.add(newTab),
          ),
          tabBuilder: (BuildContext context, int index) {
            tabsBuilt.add(index);
            // Change the builder too.
            return Text('Different page ${index + 1}');
          },
        ),
597
      ),
598 599
    );

600
    expect(tabsBuilt, const <int>[0, 1]);
601 602
    // We didn't tap on any additional tabs to invoke the onTap callback. We
    // just deleted a tab.
603
    expect(selectedTabs, const <int>[3]);
604 605 606 607 608 609 610 611 612 613 614 615 616
    // Tab 1 was previously built so it's rebuilt again, albeit offstage.
    expect(find.text('Different page 1', skipOffstage: false), isOffstage);
    // Since all the tabs after tab 2 are deleted, tab 2 is now the last tab and
    // the actively shown tab.
    expect(find.text('Different page 2'), findsOneWidget);
    // No more tab 4 since it's deleted.
    expect(find.text('Different page 4', skipOffstage: false), findsNothing);
    // We also changed the builder so no tabs should be built with the old
    // builder.
    expect(find.text('Page 1', skipOffstage: false), findsNothing);
    expect(find.text('Page 2', skipOffstage: false), findsNothing);
    expect(find.text('Page 4', skipOffstage: false), findsNothing);
  });
617

618 619 620
  // Regression test for https://github.com/flutter/flutter/issues/33455
  testWidgets('Adding new tabs does not crash the app', (WidgetTester tester) async {
    final List<int> tabsPainted = <int>[];
621
    final CupertinoTabController controller = CupertinoTabController();
622 623 624 625 626 627 628 629 630 631 632

    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(10, tabGenerator),
          ),
          controller: controller,
          tabBuilder: (BuildContext context, int index) {
            return CustomPaint(
              painter: TestCallbackPainter(
633
                onPaint: () { tabsPainted.add(index); },
634
              ),
635
              child: Text('Page ${index + 1}'),
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
            );
          },
        ),
      ),
    );

    expect(tabsPainted, const <int> [0]);

    // Increase the num of tabs to 20.
    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(20, tabGenerator),
          ),
          controller: controller,
          tabBuilder: (BuildContext context, int index) {
            return CustomPaint(
              painter: TestCallbackPainter(
655
                onPaint: () { tabsPainted.add(index); },
656
              ),
657
              child: Text('Page ${index + 1}'),
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
            );
          },
        ),
      ),
    );

    expect(tabsPainted, const <int> [0, 0]);

    await tester.tap(find.text('Tab 19'));
    await tester.pump();

    // Tapping the tabs should still work.
    expect(tabsPainted, const <int>[0, 0, 18]);
  });

673 674 675 676
  testWidgets(
    'If a controller is initially provided then the parent stops doing so for rebuilds, '
    'a new instance of CupertinoTabController should be created and used by the widget, '
    "while preserving the previous controller's tab index",
677 678
    (WidgetTester tester) async {
      final List<int> tabsPainted = <int>[];
679
      final CupertinoTabController oldController = CupertinoTabController();
680 681 682 683 684 685 686 687 688 689 690

      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(10, tabGenerator),
            ),
            controller: oldController,
            tabBuilder: (BuildContext context, int index) {
              return CustomPaint(
                painter: TestCallbackPainter(
691
                  onPaint: () { tabsPainted.add(index); },
692
                ),
693
                child: Text('Page ${index + 1}'),
694
              );
695
            },
696
          ),
697
        ),
698 699
      );

700
      expect(tabsPainted, const <int> [0]);
701 702 703 704 705 706 707 708 709 710 711

      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(10, tabGenerator),
            ),
            tabBuilder:
            (BuildContext context, int index) {
              return CustomPaint(
                painter: TestCallbackPainter(
712
                  onPaint: () { tabsPainted.add(index); },
713
                ),
714
                child: Text('Page ${index + 1}'),
715
              );
716
            },
717
          ),
718
        ),
719 720
      );

721
      expect(tabsPainted, const <int> [0, 0]);
722 723 724 725 726

      await tester.tap(find.text('Tab 2'));
      await tester.pump();

      // Tapping the tabs should still work.
727
      expect(tabsPainted, const <int>[0, 0, 1]);
728 729 730 731 732

      oldController.index = 10;
      await tester.pump();

      // Changing [index] of the oldController should not work.
733
      expect(tabsPainted, const <int> [0, 0, 1]);
734 735
    },
  );
736

737 738 739
  testWidgets(
    'Do not call dispose on a controller that we do not own '
    'but do remove from its listeners when done listening to it',
740 741 742 743 744 745 746 747 748 749 750 751
    (WidgetTester tester) async {
      final MockCupertinoTabController mockController = MockCupertinoTabController(initialIndex: 0);

      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
            ),
            controller: mockController,
            tabBuilder: (BuildContext context, int index) => const Placeholder(),
          ),
752
        ),
753 754 755 756 757 758 759 760 761 762 763 764 765
      );

      expect(mockController.numOfListeners, 1);
      expect(mockController.isDisposed, isFalse);

      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
            ),
            tabBuilder: (BuildContext context, int index) => const Placeholder(),
          ),
766
        ),
767 768 769 770
      );

      expect(mockController.numOfListeners, 0);
      expect(mockController.isDisposed, isFalse);
771 772
    },
  );
773 774 775 776 777 778 779 780 781 782 783

  testWidgets('The owner can dispose the old controller', (WidgetTester tester) async {
    CupertinoTabController controller = CupertinoTabController(initialIndex: 2);

    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
          ),
          controller: controller,
784
          tabBuilder: (BuildContext context, int index) => const Placeholder(),
785
        ),
786
      ),
787 788 789 790 791 792
    );
    expect(find.text('Tab 1'), findsOneWidget);
    expect(find.text('Tab 2'), findsOneWidget);
    expect(find.text('Tab 3'), findsOneWidget);

    controller.dispose();
793
    controller = CupertinoTabController();
794 795 796 797 798 799 800
    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
          ),
          controller: controller,
801
          tabBuilder: (BuildContext context, int index) => const Placeholder(),
802
        ),
803
      ),
804 805 806 807 808 809 810 811
    );

    // Should not crash here.
    expect(find.text('Tab 1'), findsOneWidget);
    expect(find.text('Tab 2'), findsOneWidget);
    expect(find.text('Tab 3'), findsNothing);
  });

812
  testWidgets('A controller can control more than one CupertinoTabScaffold, '
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    'removal of listeners does not break the controller',
    (WidgetTester tester) async {
      final List<int> tabsPainted0 = <int>[];
      final List<int> tabsPainted1 = <int>[];
      MockCupertinoTabController controller = MockCupertinoTabController(initialIndex: 2);

      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoPageScaffold(
            child: Stack(
              children: <Widget>[
                CupertinoTabScaffold(
                  tabBar: CupertinoTabBar(
                    items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
                  ),
                  controller: controller,
                  tabBuilder: (BuildContext context, int index) {
                    return CustomPaint(
                      painter: TestCallbackPainter(
832
                        onPaint: () => tabsPainted0.add(index),
833
                      ),
834
                    );
835
                  },
836 837 838 839 840 841 842 843 844
                ),
                CupertinoTabScaffold(
                  tabBar: CupertinoTabBar(
                    items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
                  ),
                  controller: controller,
                  tabBuilder: (BuildContext context, int index) {
                    return CustomPaint(
                      painter: TestCallbackPainter(
845
                        onPaint: () => tabsPainted1.add(index),
846
                      ),
847
                    );
848
                  },
849
                ),
850 851 852 853
              ],
            ),
          ),
        ),
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
      );
      expect(tabsPainted0, const <int>[2]);
      expect(tabsPainted1, const <int>[2]);
      expect(controller.numOfListeners, 2);

      controller.index = 0;
      await tester.pump();
      expect(tabsPainted0, const <int>[2, 0]);
      expect(tabsPainted1, const <int>[2, 0]);

      controller.index = 1;
      // Removing one of the tabs works.
      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoPageScaffold(
            child: Stack(
              children: <Widget>[
                CupertinoTabScaffold(
                  tabBar: CupertinoTabBar(
                    items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
                  ),
                  controller: controller,
                  tabBuilder: (BuildContext context, int index) {
                    return CustomPaint(
                      painter: TestCallbackPainter(
879
                        onPaint: () => tabsPainted0.add(index),
880
                      ),
881
                    );
882
                  },
883
                ),
884 885 886 887
              ],
            ),
          ),
        ),
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
      );

      expect(tabsPainted0, const <int>[2, 0, 1]);
      expect(tabsPainted1, const <int>[2, 0]);
      expect(controller.numOfListeners, 1);

      // Replacing controller works.
      controller = MockCupertinoTabController(initialIndex: 2);
      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoPageScaffold(
            child: Stack(
              children: <Widget>[
                CupertinoTabScaffold(
                  tabBar: CupertinoTabBar(
                    items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
                  ),
                  controller: controller,
                  tabBuilder: (BuildContext context, int index) {
                    return CustomPaint(
                      painter: TestCallbackPainter(
909 910
                        onPaint: () => tabsPainted0.add(index),
                      ),
911
                    );
912
                  },
913
                ),
914 915 916 917
              ],
            ),
          ),
        ),
918 919 920 921
      );
      expect(tabsPainted0, const <int>[2, 0, 1, 2]);
      expect(tabsPainted1, const <int>[2, 0]);
      expect(controller.numOfListeners, 1);
922 923
    },
  );
924 925 926 927 928 929 930 931 932 933 934 935 936 937

  testWidgets('Assert when current tab index >= number of tabs', (WidgetTester tester) async {
    final CupertinoTabController controller = CupertinoTabController(initialIndex: 2);

    try {
      await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(2, tabGenerator),
            ),
            controller: controller,
            tabBuilder: (BuildContext context, int index) => Text('Different page ${index + 1}'),
          ),
938
        ),
939 940 941 942 943 944 945 946 947 948 949 950 951 952
      );
    } on AssertionError catch (e) {
      expect(e.toString(), contains('controller.index < tabBar.items.length'));
    }

    await tester.pumpWidget(
      CupertinoApp(
        home: CupertinoTabScaffold(
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
          ),
          controller: controller,
          tabBuilder: (BuildContext context, int index) => Text('Different page ${index + 1}'),
        ),
953
      ),
954 955 956 957 958 959 960 961 962 963 964 965
    );

    expect(tester.takeException(), null);

    controller.index = 10;
    await tester.pump();

    final String message = tester.takeException().toString();
    expect(message, contains('current index ${controller.index}'));
    expect(message, contains('with 3 tabs'));
  });

966 967 968
  testWidgets("Don't replace focus nodes for existing tabs when changing tab count", (WidgetTester tester) async {
    final CupertinoTabController controller = CupertinoTabController(initialIndex: 2);

969
    final List<FocusScopeNode> scopes = List<FocusScopeNode>.filled(5, FocusScopeNode());
970 971 972 973 974 975 976 977 978 979 980 981
    await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(3, tabGenerator),
            ),
            controller: controller,
            tabBuilder: (BuildContext context, int index) {
              scopes[index] = FocusScope.of(context);
              return Container();
            },
          ),
982
        ),
983 984 985 986 987 988 989 990
    );

    for (int i = 0; i < 3; i++) {
      controller.index = i;
      await tester.pump();
    }
    await tester.pump();

991
    final List<FocusScopeNode> newScopes = <FocusScopeNode>[];
992 993 994 995 996 997 998 999
    await tester.pumpWidget(
        CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: CupertinoTabBar(
              items: List<BottomNavigationBarItem>.generate(5, tabGenerator),
            ),
            controller: controller,
            tabBuilder: (BuildContext context, int index) {
1000
              newScopes.add(FocusScope.of(context));
1001 1002 1003
              return Container();
            },
          ),
1004
        ),
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
    );
    for (int i = 0; i < 5; i++) {
      controller.index = i;
      await tester.pump();
    }
    await tester.pump();

    expect(scopes.sublist(0, 3), equals(newScopes.sublist(0, 3)));
  });

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  testWidgets('Current tab index cannot go below zero or be null', (WidgetTester tester) async {
    void expectAssertionError(VoidCallback callback, String errorMessage) {
      try {
        callback();
      } on AssertionError catch (e) {
        expect(e.toString(), contains(errorMessage));
      }
    }

    expectAssertionError(() => CupertinoTabController(initialIndex: -1), '>= 0');

    final CupertinoTabController controller = CupertinoTabController();

    expectAssertionError(() => controller.index = -1, '>= 0');
  });

1031 1032 1033 1034 1035
  testWidgets('Does not lose state when focusing on text input', (WidgetTester tester) async {
    // Regression testing for https://github.com/flutter/flutter/issues/28457.

    await tester.pumpWidget(
      MediaQuery(
1036
        data: const MediaQueryData(),
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
        child: CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: _buildTabBar(),
            tabBuilder: (BuildContext context, int index) {
              return const CupertinoTextField();
            },
          ),
        ),
      ),
    );

    final EditableTextState editableState = tester.state<EditableTextState>(find.byType(EditableText));

    await tester.enterText(find.byType(CupertinoTextField), "don't lose me");

    await tester.pumpWidget(
      MediaQuery(
        data: const MediaQueryData(
          viewInsets:  EdgeInsets.only(bottom: 100),
        ),
        child: CupertinoApp(
          home: CupertinoTabScaffold(
            tabBar: _buildTabBar(),
            tabBuilder: (BuildContext context, int index) {
              return const CupertinoTextField();
            },
          ),
        ),
      ),
    );

    // The exact same state instance is still there.
    expect(tester.state<EditableTextState>(find.byType(EditableText)), editableState);
    expect(find.text("don't lose me"), findsOneWidget);
  });
1072 1073 1074 1075 1076 1077

  testWidgets('textScaleFactor is set to 1.0', (WidgetTester tester) async {
    await tester.pumpWidget(
      CupertinoApp(
        home: Builder(builder: (BuildContext context) {
          return MediaQuery(
1078
            data: MediaQuery.of(context).copyWith(textScaleFactor: 99),
1079 1080 1081 1082
            child: CupertinoTabScaffold(
              tabBar: CupertinoTabBar(
                items: List<BottomNavigationBarItem>.generate(
                  10,
1083
                  (int i) => BottomNavigationBarItem(icon: ImageIcon(MemoryImage(Uint8List.fromList(kTransparentImage))), label: '$i'),
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
                ),
              ),
              tabBuilder: (BuildContext context, int index) => const Text('content'),
            ),
          );
        }),
      ),
    );

    final Iterable<RichText> barItems = tester.widgetList<RichText>(
      find.descendant(
        of: find.byType(CupertinoTabBar),
        matching: find.byType(RichText),
      ),
    );

    final Iterable<RichText> contents = tester.widgetList<RichText>(
      find.descendant(
        of: find.text('content'),
        matching: find.byType(RichText),
        skipOffstage: false,
      ),
    );

    expect(barItems.length, greaterThan(0));
    expect(barItems.any((RichText t) => t.textScaleFactor != 1), isFalse);

    expect(contents.length, greaterThan(0));
    expect(contents.any((RichText t) => t.textScaleFactor != 99), isFalse);
  });
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217

  testWidgets('state restoration', (WidgetTester tester) async {
    await tester.pumpWidget(
      CupertinoApp(
        restorationScopeId: 'app',
        home: CupertinoTabScaffold(
          restorationId: 'scaffold',
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(
              4,
              (int i) => BottomNavigationBarItem(icon: const Icon(CupertinoIcons.map), label: 'Tab $i'),
            ),
          ),
          tabBuilder: (BuildContext context, int i) => Text('Content $i'),
        ),
      ),
    );

    expect(find.text('Content 0'), findsOneWidget);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsNothing);
    expect(find.text('Content 3'), findsNothing);

    await tester.tap(find.text('Tab 2'));
    await tester.pumpAndSettle();

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsOneWidget);
    expect(find.text('Content 3'), findsNothing);

    await tester.restartAndRestore();

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsOneWidget);
    expect(find.text('Content 3'), findsNothing);

    final TestRestorationData data = await tester.getRestorationData();

    await tester.tap(find.text('Tab 1'));
    await tester.pumpAndSettle();

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsOneWidget);
    expect(find.text('Content 2'), findsNothing);
    expect(find.text('Content 3'), findsNothing);

    await tester.restoreFrom(data);

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsOneWidget);
    expect(find.text('Content 3'), findsNothing);
  });

  testWidgets('switch from internal to external controller with state restoration', (WidgetTester tester) async {
    Widget buildWidget({CupertinoTabController? controller}) {
      return CupertinoApp(
        restorationScopeId: 'app',
        home: CupertinoTabScaffold(
          controller: controller,
          restorationId: 'scaffold',
          tabBar: CupertinoTabBar(
            items: List<BottomNavigationBarItem>.generate(
              4,
              (int i) => BottomNavigationBarItem(icon: const Icon(CupertinoIcons.map), label: 'Tab $i'),
            ),
          ),
          tabBuilder: (BuildContext context, int i) => Text('Content $i'),
        ),
      );
    }

    await tester.pumpWidget(buildWidget());

    expect(find.text('Content 0'), findsOneWidget);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsNothing);
    expect(find.text('Content 3'), findsNothing);

    await tester.tap(find.text('Tab 2'));
    await tester.pumpAndSettle();

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsOneWidget);
    expect(find.text('Content 3'), findsNothing);

    final CupertinoTabController controller = CupertinoTabController(initialIndex: 3);
    await tester.pumpWidget(buildWidget(controller: controller));

    expect(find.text('Content 0'), findsNothing);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsNothing);
    expect(find.text('Content 3'), findsOneWidget);

    await tester.pumpWidget(buildWidget());

    expect(find.text('Content 0'), findsOneWidget);
    expect(find.text('Content 1'), findsNothing);
    expect(find.text('Content 2'), findsNothing);
    expect(find.text('Content 3'), findsNothing);
  });
1218 1219
}

1220
CupertinoTabBar _buildTabBar({ int selectedTab = 0 }) {
1221
  return CupertinoTabBar(
1222
    items: <BottomNavigationBarItem>[
1223
      BottomNavigationBarItem(
1224
        icon: ImageIcon(MemoryImage(Uint8List.fromList(kTransparentImage))),
1225
        label: 'Tab 1',
1226
      ),
1227
      BottomNavigationBarItem(
1228
        icon: ImageIcon(MemoryImage(Uint8List.fromList(kTransparentImage))),
1229
        label: 'Tab 2',
1230 1231
      ),
    ],
1232
    currentIndex: selectedTab,
1233 1234
    onTap: (int newTab) => selectedTabs.add(newTab),
  );
1235
}