mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
4cd0e33013
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`](1398dc7eec/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`.
44 lines
1.2 KiB
Dart
44 lines
1.2 KiB
Dart
// 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.
|
|
|
|
@Tags(<String>['reduced-test-set'])
|
|
library;
|
|
|
|
import 'package:flutter/material.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
import 'package:integration_test/integration_test.dart';
|
|
|
|
import 'package:integration_test_example/main.dart' as app;
|
|
|
|
/// To run:
|
|
///
|
|
/// ```sh
|
|
/// # Be in this directory
|
|
/// cd dev/packages/integration_test/example
|
|
///
|
|
/// flutter test integration_test/matches_golden_test.dart
|
|
/// ```
|
|
///
|
|
/// To run on a particular device, see `flutter -d`.
|
|
void main() {
|
|
IntegrationTestWidgetsFlutterBinding.ensureInitialized();
|
|
|
|
// TODO(matanlurey): Make this automatic as part of the bootstrap.
|
|
VmServiceProxyGoldenFileComparator.useIfRunningOnDevice();
|
|
|
|
testWidgets('can use matchesGoldenFile with integration_test', (WidgetTester tester) async {
|
|
// Build our app and trigger a frame.
|
|
app.main();
|
|
|
|
// TODO(matanlurey): Is this necessary?
|
|
await tester.pumpAndSettle();
|
|
|
|
// Take a screenshot.
|
|
await expectLater(
|
|
find.byType(MaterialApp),
|
|
matchesGoldenFile('integration_test_matches_golden_file.png'),
|
|
);
|
|
});
|
|
}
|