| commit | ac6b69118404c9baa6bae223121d2c7318ae2779 | [log] [tgz] |
|---|---|---|
| author | Matan Lurey <matanlurey@users.noreply.github.com> | Sat Dec 28 11:48:20 2024 -0800 |
| committer | dart-internal-monorepo <dart-internal-monorepo@dart-ci-internal.iam.gserviceaccount.com> | Sat Dec 28 12:48:09 2024 -0800 |
| tree | 043c20c2c531b0676406bd8d6ffd36cdcb23e5ab | |
| parent | b401e7c5154bcd170b525bcbbc94a9cc9af37693 [diff] |
Implement golden-file matching for `integration_test` on Android and iOS devices (#160484) Work towards https://github.com/flutter/flutter/issues/143299. Work towards https://github.com/flutter/flutter/issues/160043. --- This PR implements, end-to-end, support for `matchesGoldenFile` when (a) running with `package:integration_test` (b) on a device, such as an Android emulator, Android device, iOS simulator, or iOS device, where the _runner_ of a test file does not have process and local-file system access. There are multiple parts to this PR; I could make it smaller than 1K lines, but the bulk of that is tests, and it would mean landing PRs that are incomplete and unused, which does not seem useful - so instead here is a quick overview of the PR's contents - questions/feedback welcome, and I am willing to break code out or land incremental refactors if requested. 1. Augmented `flutter_platform.dart` (used for iOS and Android), similar to [`flutter_web_platform.dart`](https://github.com/flutter/flutter/blob/1398dc7eecb696d302e4edb19ad79901e615ed56/packages/flutter_tools/lib/src/test/flutter_web_platform.dart#L117-L128), now creates and uses [`test_golden_comparator.dart`](https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/test/test_golden_comparator.dart) to proxy calls (coming from the VM service protocol) for golden-file updates and comparisons to a `flutter_tester` process. A full explanation of how (or why) it works this way is too hard to include here, but see https://github.com/flutter/flutter/pull/160215 for more details. 1. Added `VmServiceProxyGoldenFileComparator`, which is a currently unused (outside of a single e2e test) comparator that forwards calls to `compare` and `update` to the VM service protocol (of which, the other side of this is implemented above, in `flutter_platform.dart`. The idea is that this comparator would be used automatically when running in an integration test on a device that requires it (similar to how web works today), but that is **not** wired up yet and requires additional work in `flutter_tools`. 1. Added two unit tests (of both the client and server), and a full e2e-test using it to run `matchesGoldenFile`. https://dart.googlesource.com/external/github.com/flutter/flutter/+/4cd0e330133fda5fab38eeecfb5644959807fb94
Monorepo is:
With depot_tools installed and on your path, create a directory for your monorepo checkout and run these commands to create a gclient solution in that directory:
mkdir monorepo cd monorepo gclient config --unmanaged https://dart.googlesource.com/monorepo gclient sync -D
This gives you a checkout in the monorepo directory that contains:
monorepo/ DEPS - the DEPS used for this gclient checkout commits.json - the pinned commits for Dart, flutter/engine, and flutter/flutter tools/ - scripts used to create monorepo DEPS engine/src/ - the flutter/buildroot repo flutter/ - the flutter/engine repo out/ - the build directory, where Flutter engine builds are created third_party/ - Flutter dependencies checked out by DEPS dart/ - the Dart SDK checkout. third_party - Dart dependencies, also used by Flutter flutter/ - the flutter/flutter repo
Flutter's instructions for building the engine are at Compiling the engine
They can be followed closely, with a few changes:
goma_ctl ensure_start is sufficient.Example build commands that work on linux:
MONOREPO_PATH=$PWD if [[ ! $PATH =~ (^|:)$MONOREPO_PATH/flutter/bin(:|$) ]]; then PATH=$MONOREPO_PATH/flutter/bin:$PATH fi export GOMA_DIR=$(dirname $(command -v gclient))/.cipd_bin goma_ctl ensure_start pushd engine/src flutter/tools/gn --goma --no-prebuilt-dart-sdk --unoptimized --full-dart-sdk autoninja -C out/host_debug_unopt popd
The Flutter commands used to build and run apps will use the locally built Flutter engine and Dart SDK, instead of the one downloaded by the Flutter tool, if the --local-engine option is provided.
For example, to build and run the Flutter spinning square sample on the web platform,
MONOREPO_PATH=$PWD cd flutter/examples/layers flutter --local-engine=host_debug_unopt \ -d chrome run widgets/spinning_square.dart cd $MONOREPO_PATH
To build for desktop, specify the desktop platform device in flutter run as -d macos or -d linux or -d windows. You may also need to run the command
flutter create --platforms=windows,macos,linux
on existing apps, such as sample apps. New apps created with flutter create already include these support files. Details of desktop support are at Desktop Support for Flutter
Tests in the Flutter source tree can be run with the flutter test command, run in the directory of a package containing tests. For example:
MONOREPO_PATH=$PWD cd flutter/packages/flutter flutter test --local-engine=host_debug_unopt cd $MONOREPO_PATH
Please file an issue or email the dart-engprod team with any problems with or questions about using monorepo.
We will update this documentation to address them.
flutter commands may download the engine and Dart SDK files for the configured channel, even though they will be using the local engine and its SDK.gclient sync needs to be run in an administrator session, because some installed dependencies create symlinks.