Test WidgetTester handling test pointers #83337

dkwingsmt · 2021-05-25T11:12:47Z

This PR adds tests to the following behaviors, which have existed without tests:

When tapping during live testing, a message is printed with widgets that contain the tap location.
When tapping during live testing, a mark is displayed on screen on the tap location.

API change to `TestWidgetsFlutterBinding`

TestWidgetsFlutterBinding.handlePointerEvent no longer shadows GestureBinding.handlePointerEvent with a different signature. Its source-specified version is renamed to handlePointerEventForSource. This allows subclasses to redefine only how pointer events are handled (for each source) without having to change the source storing process.

New feature of `AnimationSheetBuilder`

AnimationSheetBuilder now supports a new option at construction: allLayers. The current behavior is allLayers: false. If allLayers is true, the recorder records the resulting image composited by the entire tree, clipped by the region of this recorder. This is useful when it is impossible for the recorder to include the target image in its subtree, which is needed for the test of this PR.

New way to use `AnimationSheetBuilder` and deprecation

AnimationSheetBuilder's output step used to require two calls: display and surfaceSize. This PR introduced a new way: collate.

The collate function directly puts the images together and asynchronously returns an image. It requires less boilerplate, and outputs smaller images (1/3 the width & height) without any compromise to quality.

The current APIs (display and surfaceSize) are thus deprecated. A migration guide is provided (although these APIs are probably not used by customer tests or g3): flutter/website#5862.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…r-debug

skia-gold · 2021-05-27T13:00:11Z

Gold has detected about 1 untriaged digest(s) on patchset 9.
View them at https://flutter-gold.skia.org/cl/github/83337

skia-gold · 2021-05-28T00:37:32Z

Gold has detected about 3 new digest(s) on patchset 11.
View them at https://flutter-gold.skia.org/cl/github/83337

skia-gold · 2021-05-28T01:37:32Z

Gold has detected about 3 new digest(s) on patchset 12.
View them at https://flutter-gold.skia.org/cl/github/83337

…r-debug

skia-gold · 2021-06-01T09:12:32Z

Gold has detected about 3 new digest(s) on patchset 14.
View them at https://flutter-gold.skia.org/cl/github/83337

skia-gold · 2021-06-01T19:52:32Z

Gold has detected about 3 new digest(s) on patchset 15.
View them at https://flutter-gold.skia.org/cl/github/83337

skia-gold · 2021-06-01T20:07:32Z

Gold has detected about 3 new digest(s) on patchset 16.
View them at https://flutter-gold.skia.org/cl/github/83337

goderbauer

LGTM

goderbauer · 2021-06-01T22:14:49Z

packages/flutter/test/animation/animation_sheet_test.dart


-    final Widget display = await builder.display();
-    await tester.binding.setSurfaceSize(builder.sheetSize());
+    final Widget display = await builder.display(); // ignore: deprecated_member_use


Can these just be migrated to the new API? If not, maybe leave a comment explaining the ignore?

This is to test the deprecated APIs are still working. I'll add a comment.

goderbauer · 2021-06-01T22:16:49Z

packages/flutter/test/material/progress_indicator_test.dart

-    await tester.pumpWidget(display);
-
+    final ui.Image image = await animationSheet.collate(20);
+    // The deprecated `sheetSize` is used only for the migration from


What does this comment mean? Should these be migrated to the new API?

I plan to submit a new PR for the migration because the migration will break golden tests (because they'll be 1/3 in size), and in this way we're more sure what exactly caused the golden tests. It does look a bit redundant. Should I do them in the same PR?

packages/flutter_test/lib/src/animation_sheet.dart

goderbauer · 2021-06-01T22:21:46Z

packages/flutter/test/animation/live_binding_test.dart

+   */
+
+  LiveTestWidgetsFlutterBinding();
+  testWidgets('Should show event indicator for pointer events', (WidgetTester tester) async {


nit: add a blank line before this one to help readability.

goderbauer · 2021-06-01T22:22:34Z

packages/flutter_test/test/widget_tester_live_device_test.dart

+import 'package:flutter/material.dart';
+import 'package:flutter/rendering.dart';
+import 'package:flutter_test/flutter_test.dart';
+


nit: remove extra blank line?

goderbauer · 2021-06-01T22:25:33Z

packages/flutter_test/test/widget_tester_live_device_test.dart

+    return _storeDebugPrints == null ?
+      super.debugPrintOverride :
+      ((String? message, { int? wrapWidth }) => _storeDebugPrints!.add(message));


Suggested change

return _storeDebugPrints == null ?

super.debugPrintOverride :

((String? message, { int? wrapWidth }) => _storeDebugPrints!.add(message));

return _storeDebugPrints == null

? super.debugPrintOverride

: ((String? message, { int? wrapWidth }) => _storeDebugPrints!.add(message));

goderbauer · 2021-06-01T22:27:53Z

packages/flutter_test/test/widget_tester_live_device_test.dart

+    await tester.pump();
+    expect(invocations, 0);
+
+    expect(printedMessages, equals('''


Maybe to verify that it doesn't just list all possibilities also check what it prints when the tap misses the Text widget?

skia-gold · 2021-06-02T10:22:32Z

Gold has detected about 5 new digest(s) on patchset 18.
View them at https://flutter-gold.skia.org/cl/github/83337

skia-gold · 2021-06-02T10:57:32Z

Gold has detected about 6 new digest(s) on patchset 19.
View them at https://flutter-gold.skia.org/cl/github/83337

dkwingsmt added 2 commits May 25, 2021 03:29

Add test 1

62dc709

Add golden test

6440e4e

flutter-dashboard bot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. c: contributor-productivity Team-specific productivity, code health, technical debt. labels May 25, 2021

google-cla bot added the cla: yes label May 25, 2021

dkwingsmt added 7 commits May 25, 2021 14:58

Fix last test inTest

698685e

Working

ce3f8f4

Fix collate and improve test

dbcfc36

AllLayers

4a28fe6

Doc

e1745cf

Merge remote-tracking branch 'upstream/master' into test-widget-teste…

f74f279

…r-debug

Deprecate

b375b03

Fix style

ec008b8

dkwingsmt mentioned this pull request May 28, 2021

Replace AnimationSheetBuilder.display with collate flutter/website#5862

Merged

flutter-dashboard bot added the f: material design flutter/packages/flutter/material repository. label May 28, 2021

Move tests to animation

351b383

Better doc and fix binding

2695788

dkwingsmt added 2 commits June 1, 2021 01:26

Merge remote-tracking branch 'upstream/master' into test-widget-teste…

18f237b

…r-debug

Add tests

f8527cc

Fix deprecation

d8999af

Skip web test

ad81989

dkwingsmt requested a review from goderbauer June 1, 2021 20:46

goderbauer approved these changes Jun 1, 2021

View reviewed changes

dkwingsmt added 2 commits June 2, 2021 03:09

Review

39d20f5

More fixes

7baee8d

Fix analyze

2a0445b

dkwingsmt removed f: material design flutter/packages/flutter/material repository. c: contributor-productivity Team-specific productivity, code health, technical debt. labels Jun 2, 2021

dkwingsmt merged commit e3da1bd into flutter:master Jun 2, 2021

dkwingsmt deleted the test-widget-tester-debug branch June 2, 2021 18:50

goderbauer mentioned this pull request Jun 2, 2021

[flutter_test/integration_test] added setSurfaceSize test coverage #82712

Merged

8 tasks

dkwingsmt mentioned this pull request Jul 16, 2021

Make LiveTestWidgetsFlutterBinding work with setSurfaceSize and live tests #86449

Merged

8 tasks

Test WidgetTester handling test pointers #83337

Test WidgetTester handling test pointers #83337

Uh oh!

Conversation

dkwingsmt commented May 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API change to TestWidgetsFlutterBinding

New feature of AnimationSheetBuilder

New way to use AnimationSheetBuilder and deprecation

Pre-launch Checklist

Uh oh!

skia-gold commented May 27, 2021

Uh oh!

skia-gold commented May 28, 2021

Uh oh!

skia-gold commented May 28, 2021

Uh oh!

skia-gold commented Jun 1, 2021

Uh oh!

skia-gold commented Jun 1, 2021

Uh oh!

skia-gold commented Jun 1, 2021

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

dkwingsmt Jun 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

dkwingsmt Jun 2, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

goderbauer Jun 1, 2021

Choose a reason for hiding this comment

Uh oh!

skia-gold commented Jun 2, 2021

Uh oh!

skia-gold commented Jun 2, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dkwingsmt commented May 25, 2021 •

edited

Loading

API change to `TestWidgetsFlutterBinding`

New feature of `AnimationSheetBuilder`

New way to use `AnimationSheetBuilder` and deprecation

dkwingsmt Jun 2, 2021 •

edited

Loading