Revamp the scenario_app/../README.md to encourage self-sustenance
#51196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonahwilliams
approved these changes
Mar 5, 2024
gmackall
approved these changes
Mar 5, 2024
| Or for a specific, build, such as `android_debug_unopt_arm64`: | ||
| By default when run locally, the test runner: | ||
|
|
||
| - Uses the engine-wide efault graphics backend for Android. |
There was a problem hiding this comment.
Suggested change
| - Uses the engine-wide efault graphics backend for Android. | |
| - Uses the engine-wide default graphics backend for Android. |
| dart ./testing/scenario_app/bin/run_android_tests.dart --help | ||
| ``` | ||
|
|
||
| Frequency used options include: |
There was a problem hiding this comment.
Suggested change
| Frequency used options include: | |
| Frequently used options include: |
There was a problem hiding this comment.
fyi: there is a vscode plugin that will do spell checking, super handy.
gaaclarke
approved these changes
Mar 5, 2024
Comment on lines
19
to
38
| This test suite was [originally written in 2019](https://github.com/flutter/engine/pull/10007) | ||
| with a goal of: | ||
|
|
||
| > \[being\] suitable for embedders to do integration testing with - it has no | ||
| > dependencies on the flutter_tools or framework, and so will not fail/flake | ||
| > based on variances in those downstream. | ||
|
|
||
| Unfortunately, the Android side of the test suite was never fully operational, | ||
| and the tests, even if failing, were accidentally be reported as passing on CI. | ||
| In 2024, as the team got closer to shipping our new graphics backend, | ||
| [Impeller](https://docs.flutter.dev/perf/impeller) on Android, it was clear that | ||
| we needed a reliable test suite for the engine on Android, particularly for | ||
| visual tests around external textures and platform views. | ||
|
|
||
| So, this package was revived and updated to be a (more) reliable test suite for | ||
| the engine on Android. It's by no means complete | ||
| ([contributions welcome](#contributing)), but it did successfully catch at least | ||
| one bug that would not have been detected automatically otherwise. | ||
|
|
||
| _Go forth and test the engine on Android!_ |
There was a problem hiding this comment.
I don't think this history-in-prose should get top billing. I think a Timeline section lower down would make more sense. We can keep the guiding principles.
Something like:
## Timeline
- 2019 Originally implemented: lorem ipsom
- 2024 Revamped to work for impeller.
| ### Scope of Testing | ||
|
|
||
| The tests in this package are end-to-end tests that _specifically_ exercise the | ||
| engine and Android-specific embedding code. They are not unit tests for the |
There was a problem hiding this comment.
It would be nice to add a link after "unit tests" to the link provided below. Maybe using something like [1]
| width="300" | ||
| /> | ||
|
|
||
| _The top picture is the Flutter app, and the bottom picture is just Android._ |
There was a problem hiding this comment.
It would be nice to have a link to https://github.com/flutter/engine/tree/main/tools/compare_goldens here, maybe a "see also" note.
| dart ./testing/scenario_app/bin/run_android_tests.dart --help | ||
| ``` | ||
|
|
||
| Frequency used options include: |
There was a problem hiding this comment.
fyi: there is a vscode plugin that will do spell checking, super handy.
|
|
||
| See also: | ||
|
|
||
| - [`DrawSolidBlueScreenTest.java`](./app/src/androidTest/java/dev/flutter/scenariosui/DrawSolidBlueScreenTest.java), an example of a JUnit test. |
There was a problem hiding this comment.
I'd put these links above to make them more contextual.
matanlurey
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Mar 6, 2024
auto-submit bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Mar 6, 2024
…144659) flutter/engine@effcf97...d374c78 2024-03-06 matanlurey@users.noreply.github.com Revamp the `scenario_app/../README.md` to encourage self-sustenance (flutter/engine#51196) 2024-03-06 jonahwilliams@google.com [Impeller] disable blending in gaussian intermediate steps. (flutter/engine#51118) 2024-03-06 bdero@google.com [Impeller] Enable depth buffer clipping & Stencil-then-Cover path rendering. (flutter/engine#51219) 2024-03-06 skia-flutter-autoroll@skia.org Roll Skia from 37947aec8c5c to 1d1fd7fe1a89 (1 revision) (flutter/engine#51216) 2024-03-06 bdero@google.com [Impeller] Fix path winding when bridging from contours with an odd number of points. (flutter/engine#51218) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Please CC rmistry@google.com,zra@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feedback welcome, though if it is non-blocking and ambiguous consider a follow-up PR instead 😸