Update _goldens_io.dart to generate failure images during a size mism… #142177

bramp · 2024-01-24T22:02:06Z

Update the matchesGoldenFile() / LocalComparisonOutput code to generate failure images for golden tests that fail when the image sizes do not match. This can make it far quicker to identify what is wrong with the test image.

Fixes #141488

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.
[ x 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.
N/A I updated/added relevant documentation (doc comments with ///).
N/A I added new tests to check the change I am making, or this 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.

flutter-dashboard · 2024-01-24T22:02:09Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Piinks

Hi @bramp welcome! Thanks for contributing. :)

This change will require a test that validates it works as expected.

packages/flutter_test/lib/src/_goldens_io.dart

bramp · 2024-01-26T18:59:47Z

Ok tests added. Thanks for the review.

Piinks · 2024-01-30T00:43:50Z

packages/flutter_test/test/goldens_test.dart

Nice test! 👍

thanks, mostly copy and paste :)

bramp · 2024-02-01T19:54:12Z

Friendly ping, I think I addressed all comments.

Piinks

Thanks for contributing! This will need a second review, I've recruited someone for a second stamp!

justinmc

LGTM 👍 easy enough fix.

…atch failure

…ase of a image size mismatch.

* master: (32 commits) [reland] Add `AnimationStyle` to `showSnackBar` (flutter#143052) Run Mac x64 build tests in postsubmit only (flutter#142334) Copy the flutter version JSON file into the simulated Flutter SDK used by update_packages (flutter#143035) Mark `Windows_android hot_mode_dev_cycle_win__benchmark` as no longer flaky (flutter#143016) Dispose precached image info (flutter#143017) Instrument CurvedAnimation. (flutter#143007) Update _goldens_io.dart to generate failure images during a size mism… (flutter#142177) Reverts "Activate InkSparkle on CanvasKit" (flutter#143036) Activate InkSparkle on CanvasKit (flutter#138545) [Windows] Fix signed/unsigned int comparison (flutter#142341) Reverts "Move native assets to `isolated/` directory" (flutter#143027) Reverts "Roll Flutter Engine from 808886312e2b to 07cdaab7f531 (18 revisions)" (flutter#143025) Make destructiveRed a CupertinoDynamicColor (flutter#141364) Move native assets to `isolated/` directory (flutter#142709) Roll Flutter Engine from 808886312e2b to 07cdaab7f531 (18 revisions) (flutter#143005) Fix CupertinoPageScaffold resizeToAvoidBottomInset (flutter#142776) Reverts "Add `AnimationStyle` to `showSnackBar`" (flutter#143001) Material 3 - Tab indicator stretch animation (flutter#141954) Add `AnimationStyle` to `showSnackBar` (flutter#142825) Roll Packages from ae3494d to 1a5a7ce (2 revisions) (flutter#142985) ...

…ize mism… (flutter/flutter#142177)

flutter/flutter@e6ba809...8431cae 2024-02-07 [email protected] Roll Flutter Engine from 1ac6beb8a3c2 to 6807342305e4 (6 revisions) (flutter/flutter#143082) 2024-02-07 [email protected] Manual roll Flutter Engine from 808886312e2b to 1ac6beb8a3c2 (22 revisions) (flutter/flutter#143039) 2024-02-07 [email protected] Roll Packages from 1a5a7ce to e4ea6bf (4 revisions) (flutter/flutter#143076) 2024-02-07 [email protected] Fix M3 text field height + initial step for input decorator M3 test migration (flutter/flutter#142981) 2024-02-07 [email protected] [reland] Add `AnimationStyle` to `showSnackBar` (flutter/flutter#143052) 2024-02-07 [email protected] Run Mac x64 build tests in postsubmit only (flutter/flutter#142334) 2024-02-07 [email protected] Copy the flutter version JSON file into the simulated Flutter SDK used by update_packages (flutter/flutter#143035) 2024-02-07 [email protected] Mark `Windows_android hot_mode_dev_cycle_win__benchmark` as no longer flaky (flutter/flutter#143016) 2024-02-07 [email protected] Dispose precached image info (flutter/flutter#143017) 2024-02-07 [email protected] Instrument CurvedAnimation. (flutter/flutter#143007) 2024-02-07 [email protected] Update _goldens_io.dart to generate failure images during a size mismâ�¦ (flutter/flutter#142177) 2024-02-07 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Activate InkSparkle on CanvasKit" (flutter/flutter#143036) 2024-02-07 [email protected] Activate InkSparkle on CanvasKit (flutter/flutter#138545) 2024-02-07 [email protected] [Windows] Fix signed/unsigned int comparison (flutter/flutter#142341) 2024-02-07 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Move native assets to `isolated/` directory" (flutter/flutter#143027) 2024-02-06 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 808886312e2b to 07cdaab7f531 (18 revisions)" (flutter/flutter#143025) 2024-02-06 [email protected] Make destructiveRed a CupertinoDynamicColor (flutter/flutter#141364) 2024-02-06 [email protected] Move native assets to `isolated/` directory (flutter/flutter#142709) 2024-02-06 [email protected] Roll Flutter Engine from 808886312e2b to 07cdaab7f531 (18 revisions) (flutter/flutter#143005) 2024-02-06 [email protected] Fix CupertinoPageScaffold resizeToAvoidBottomInset (flutter/flutter#142776) 2024-02-06 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `AnimationStyle` to `showSnackBar`" (flutter/flutter#143001) 2024-02-06 [email protected] Material 3 - Tab indicator stretch animation (flutter/flutter#141954) 2024-02-06 [email protected] Add `AnimationStyle` to `showSnackBar` (flutter/flutter#142825) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…ize mism… (flutter/flutter#142177)

github-actions bot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. labels Jan 24, 2024

bramp mentioned this pull request Jan 24, 2024

Golden tests do not write out failure images on a size mismatch #141488

Closed

Piinks reviewed Jan 26, 2024

View reviewed changes

packages/flutter_test/lib/src/_goldens_io.dart Outdated Show resolved Hide resolved

Piinks reviewed Jan 30, 2024

View reviewed changes

Piinks approved these changes Feb 7, 2024

View reviewed changes

justinmc approved these changes Feb 7, 2024

View reviewed changes

bramp added 2 commits February 6, 2024 18:12

Update _goldens_io.dart to generate failure images during a size mism…

2ebef5a

…atch failure

Added tests for ensuring master/test images only are written in the c…

3ce0841

…ase of a image size mismatch.

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 7, 2024

auto-submit bot merged commit 10f1e63 into flutter:master Feb 7, 2024

engine-flutter-autoroll mentioned this pull request Feb 7, 2024

Roll Flutter from e6ba809b8a23 to 6a7baf573ec0 (20 revisions) flutter/packages#6072

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2024

10f1e63 Update _goldens_io.dart to generate failure images during a s…

e7685aa

…ize mism… (flutter/flutter#142177)

engine-flutter-autoroll mentioned this pull request Feb 7, 2024

Roll Flutter from e6ba809b8a23 to 39d8df4f4fbd (21 revisions) flutter/packages#6073

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2024

10f1e63 Update _goldens_io.dart to generate failure images during a s…

7c6b185

…ize mism… (flutter/flutter#142177)

engine-flutter-autoroll mentioned this pull request Feb 7, 2024

Roll Flutter from e6ba809b8a23 to 900e060a1c0f (22 revisions) flutter/packages#6074

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2024

10f1e63 Update _goldens_io.dart to generate failure images during a s…

c0f0992

…ize mism… (flutter/flutter#142177)

engine-flutter-autoroll mentioned this pull request Feb 7, 2024

Roll Flutter from e6ba809b8a23 to 8431cae8843c (23 revisions) flutter/packages#6075

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2024

10f1e63 Update _goldens_io.dart to generate failure images during a s…

4ef8503

…ize mism… (flutter/flutter#142177)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 14, 2024

10f1e63 Update _goldens_io.dart to generate failure images during a s…

77dd498

…ize mism… (flutter/flutter#142177)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update _goldens_io.dart to generate failure images during a size mism… #142177

Update _goldens_io.dart to generate failure images during a size mism… #142177

Uh oh!

bramp commented Jan 24, 2024 •

edited by Piinks

Loading

Uh oh!

flutter-dashboard bot commented Jan 24, 2024

Uh oh!

Piinks left a comment

Uh oh!

Uh oh!

bramp commented Jan 26, 2024

Uh oh!

Piinks Jan 30, 2024

Uh oh!

bramp Jan 30, 2024

Uh oh!

bramp commented Feb 1, 2024

Uh oh!

Piinks left a comment

Uh oh!

justinmc left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Update _goldens_io.dart to generate failure images during a size mism… #142177

Update _goldens_io.dart to generate failure images during a size mism… #142177

Uh oh!

Conversation

bramp commented Jan 24, 2024 • edited by Piinks Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Jan 24, 2024

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bramp commented Jan 26, 2024

Uh oh!

Piinks Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

bramp Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

bramp commented Feb 1, 2024

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bramp commented Jan 24, 2024 •

edited by Piinks

Loading