util.dart 3.65 KB
Newer Older
1 2 3 4 5
// 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/widgets.dart';
6
import 'package:flutter_test/flutter_test.dart';
7
import 'package:integration_test/integration_test.dart';
8
import 'package:macrobenchmarks/common.dart';
9 10 11 12
import 'package:macrobenchmarks/main.dart' as app;

typedef ControlCallback = Future<void> Function(WidgetController controller);

13 14 15 16 17 18 19
class ScrollableButtonRoute {
  ScrollableButtonRoute(this.listViewKey, this.buttonKey);

  final String listViewKey;
  final String buttonKey;
}

20 21 22
void macroPerfTestE2E(
  String testName,
  String routeName, {
23
  Duration? pageDelay,
24
  Duration duration = const Duration(seconds: 3),
25 26
  ControlCallback? body,
  ControlCallback? setup,
27
}) {
28 29 30 31 32 33 34 35 36 37
  macroPerfTestMultiPageE2E(
    testName,
    <ScrollableButtonRoute>[
      ScrollableButtonRoute(kScrollableName, routeName),
    ],
    pageDelay: pageDelay,
    duration: duration,
    body: body,
    setup: setup,
  );
38 39 40 41 42 43 44 45 46 47
}

void macroPerfTestMultiPageE2E(
    String testName,
    List<ScrollableButtonRoute> routes, {
      Duration? pageDelay,
      Duration duration = const Duration(seconds: 3),
      ControlCallback? body,
      ControlCallback? setup,
    }) {
48 49 50
  final WidgetsBinding widgetsBinding = IntegrationTestWidgetsFlutterBinding.ensureInitialized();
  assert(widgetsBinding is IntegrationTestWidgetsFlutterBinding);
  final IntegrationTestWidgetsFlutterBinding binding = widgetsBinding as IntegrationTestWidgetsFlutterBinding;
51 52 53
  binding.framePolicy = LiveTestWidgetsFlutterBindingFramePolicy.benchmarkLive;

  testWidgets(testName, (WidgetTester tester) async {
Ming Lyu (CareF)'s avatar
Ming Lyu (CareF) committed
54
    assert(tester.binding == binding);
55 56 57 58 59 60 61 62 63
    app.main();
    await tester.pumpAndSettle();

    // The slight initial delay avoids starting the timing during a
    // period of increased load on the device. Without this delay, the
    // benchmark has greater noise.
    // See: https://github.com/flutter/flutter/issues/19434
    await tester.binding.delayed(const Duration(microseconds: 250));

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
    for (final ScrollableButtonRoute route in routes) {
      expect(route.listViewKey, startsWith('/'));
      expect(route.buttonKey, startsWith('/'));

      // Make sure each list view page is settled
      await tester.pumpAndSettle();

      final Finder listView = find.byKey(ValueKey<String>(route.listViewKey));
      // ListView is not a Scrollable, but it contains one
      final Finder scrollable = find.descendant(of: listView, matching: find.byType(Scrollable));
      // scrollable should find one widget as soon as the page is loaded
      expect(scrollable, findsOneWidget);

      final Finder button = find.byKey(ValueKey<String>(route.buttonKey), skipOffstage: false);
      // button may or may not find a widget right away until we scroll to it
      await tester.scrollUntilVisible(button, 50, scrollable: scrollable);
      // After scrolling, button should find one Widget
81
      expect(button, findsOneWidget);
82 83

      // Allow scrolling to settle
84 85 86 87 88
      await tester.pumpAndSettle();
      await tester.tap(button);
      // Cannot be pumpAndSettle because some tests have infinite animation.
      await tester.pump(const Duration(milliseconds: 20));
    }
89 90 91 92 93 94 95 96 97 98

    if (pageDelay != null) {
      // Wait for the page to load
      await tester.binding.delayed(pageDelay);
    }

    if (setup != null) {
      await setup(tester);
    }

99
    await binding.watchPerformance(() async {
100 101 102 103 104 105
      final Future<void> durationFuture = tester.binding.delayed(duration);
      if (body != null) {
        await body(tester);
      }
      await durationFuture;
    });
106
  }, semanticsEnabled: false, timeout: Timeout.none);
107
}