WIP - Gold testing

.ci.yaml

@@ -136,6 +136,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       add_recipes_cq: "true"
       target_file: dart_unit_tests.yaml
       channel: master
@@ -146,6 +150,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: dart_unit_tests.yaml
       channel: master
       version_file: flutter_master.version
@@ -155,6 +163,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: dart_unit_tests.yaml
       channel: stable
       version_file: flutter_stable.version
@@ -164,6 +176,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: dart_unit_tests.yaml
       channel: stable
       version_file: flutter_stable.version
@@ -173,6 +189,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       add_recipes_cq: "true"
       target_file: web_dart_unit_tests.yaml
       channel: master
@@ -183,6 +203,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: web_dart_unit_tests.yaml
       channel: master
       version_file: flutter_master.version
@@ -192,6 +216,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: web_dart_unit_tests.yaml
       channel: stable
       version_file: flutter_stable.version
@@ -201,6 +229,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: web_dart_unit_tests.yaml
       channel: stable
       version_file: flutter_stable.version
@@ -211,6 +243,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       add_recipes_cq: "true"
       target_file: web_dart_unit_tests_wasm.yaml
       channel: master
@@ -221,6 +257,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: web_dart_unit_tests_wasm.yaml
       channel: master
       version_file: flutter_master.version
@@ -951,6 +991,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: windows_dart_unit_tests.yaml
       channel: master
       version_file: flutter_master.version
@@ -960,6 +1004,10 @@ targets:
     recipe: packages/packages
     timeout: 60
     properties:
+      dependencies: >-
+        [
+          {"dependency": "goldctl", "version": "git_revision:031e93819017b95c3f2dfe463189c7b8d02f2f83"}
+        ]
       target_file: windows_dart_unit_tests.yaml
       channel: master
       version_file: flutter_master.version

.ci/scripts/analyze_flutter_goldens.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+# Copyright 2013 The Flutter Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+set -e
+
+cd script/flutter_goldens
+flutter analyze --fatal-infos

.ci/scripts/flutter_goldens_format.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+# Copyright 2013 The Flutter Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+set -e
+
+cd script/flutter_goldens
+dart format --set-exit-if-changed .

.ci/scripts/flutter_goldens_tests.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+# Copyright 2013 The Flutter Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+set -e
+
+cd script/flutter_goldens
+flutter test

.ci/scripts/prepare_tool.sh

@@ -10,3 +10,6 @@ git branch main origin/main
 
 cd script/tool
 dart pub get
+
+cd ../flutter_goldens
+flutter pub get

.ci/targets/analyze.yaml

@@ -4,6 +4,8 @@ tasks:
     infra_step: true # Note infra steps failing prevents "always" from running.
   - name: analyze repo tools
     script: .ci/scripts/analyze_repo_tools.sh
+  - name: analyze flutter_goldens
+    script: .ci/scripts/analyze_flutter_goldens.sh
   - name: download Dart deps
     script: .ci/scripts/tool_runner.sh
     args: ["fetch-deps"]

.ci/targets/repo_checks.yaml

@@ -13,6 +13,10 @@ tasks:
     script: .ci/scripts/plugin_tools_tests.sh
   - name: tool format
     script: .ci/scripts/plugin_tools_format.sh
+  - name: flutter_goldens unit tests
+    script: .ci/scripts/flutter_goldens_tests.sh
+  - name: flutter_goldens format
+    script: .ci/scripts/flutter_goldens_format.sh
   - name: format
     script: .ci/scripts/tool_runner.sh
     # Skip Swift formatting on Linux builders.

.ci/targets/repo_tools_tests.yaml

@@ -4,3 +4,5 @@ tasks:
     infra_step: true # Note infra steps failing prevents "always" from running.
   - name: tool unit tests
     script: .ci/scripts/plugin_tools_tests.sh
+  - name: flutter_goldens unit tests
+    script: .ci/scripts/flutter_goldens_tests.sh

packages/cupertino_ui/pubspec.yaml

@@ -1,6 +1,7 @@
 name: cupertino_ui
 description: The official Flutter Cupertino Design Library, implementing the iOS design system.
-version: 0.0.1
+version: 0.0.2
+publish_to: none
 repository: https://github.com/flutter/packages/tree/main/packages/cupertino_ui
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A%20cupertino%22
 
@@ -13,6 +14,8 @@ dependencies:
     sdk: flutter
 
 dev_dependencies:
+  flutter_goldens:
+    path: ../../script/flutter_goldens
   flutter_test:
     sdk: flutter
 

packages/cupertino_ui/test/flutter_test_config.dart

@@ -0,0 +1,14 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:async';
+
+import 'goldens_io.dart'
+    if (dart.library.js_interop) 'goldens_web.dart'
+    as flutter_goldens;
+
+Future<void> testExecutable(FutureOr<void> Function() testMain) {
+  // Enable golden file testing using Skia Gold.
+  return flutter_goldens.testExecutable(testMain, namePrefix: 'cupertino_ui');
+}

packages/cupertino_ui/test/goldens/goldens_test.dart

@@ -0,0 +1,23 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/cupertino.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+void main() {
+  testWidgets('Inconsequential golden test', (WidgetTester tester) async {
+    // The test validates the Flutter Gold integration. Any changes to the
+    // golden file can be approved at any time.
+    await tester.pumpWidget(
+      const CupertinoApp(home: Center(child: Text('Cupertino Goldens'))),
+    );
+
+    await tester.pumpAndSettle();
+    await expectLater(
+      find.byType(CupertinoApp),
+      matchesGoldenFile('inconsequential_golden_file.png'),
+    );
+  }, skip: kIsWeb);
+}

packages/cupertino_ui/test/goldens_io.dart

@@ -0,0 +1,5 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+export 'package:flutter_goldens/flutter_goldens.dart' show testExecutable;

packages/cupertino_ui/test/goldens_web.dart

@@ -0,0 +1,11 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:async';
+
+// package:flutter_goldens is not used as part of the test process for web.
+Future<void> testExecutable(
+  FutureOr<void> Function() testMain, {
+  String? namePrefix,
+}) async => testMain();

packages/material_ui/pubspec.yaml

@@ -1,6 +1,7 @@
 name: material_ui
 description: The official Flutter Material UI Library, implementing Google's Material Design design system.
-version: 0.0.1
+version: 0.0.2
+publish_to: none
 repository: https://github.com/flutter/packages/tree/main/packages/material_ui
 issue_tracker:  https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A%20material%20design%22
 
@@ -13,6 +14,8 @@ dependencies:
     sdk: flutter
 
 dev_dependencies:
+  flutter_goldens:
+    path: ../../script/flutter_goldens
   flutter_test:
     sdk: flutter
 

packages/material_ui/test/flutter_test_config.dart

@@ -0,0 +1,14 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:async';
+
+import 'goldens_io.dart'
+    if (dart.library.js_interop) 'goldens_web.dart'
+    as flutter_goldens;
+
+Future<void> testExecutable(FutureOr<void> Function() testMain) {
+  // Enable golden file testing using Skia Gold.
+  return flutter_goldens.testExecutable(testMain, namePrefix: 'material_ui');
+}

packages/material_ui/test/goldens/goldens_test.dart

@@ -0,0 +1,24 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/cupertino.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:material_ui/material_ui.dart';
+
+void main() {
+  testWidgets('Inconsequential golden test', (WidgetTester tester) async {
+    // The test validates the Flutter Gold integration. Any changes to the
+    // golden file can be approved at any time.
+    await tester.pumpWidget(
+      RepaintBoundary(child: Container(color: const Color(0xAFF61145))),
+    );
+
+    await tester.pumpAndSettle();
+    await expectLater(
+      find.byType(RepaintBoundary),
+      matchesGoldenFile('inconsequential_golden_file.png'),
+    );
+  }, skip: kIsWeb);
+}

packages/material_ui/test/goldens_io.dart

@@ -0,0 +1,5 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+export 'package:flutter_goldens/flutter_goldens.dart' show testExecutable;

packages/material_ui/test/goldens_web.dart

@@ -0,0 +1,11 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:async';
+
+// package:flutter_goldens is not used as part of the test process for web.
+Future<void> testExecutable(
+  FutureOr<void> Function() testMain, {
+  String? namePrefix,
+}) async => testMain();

script/flutter_goldens/README.md

@@ -0,0 +1,11 @@
+This package is an internal implementation detail for our testing
+infrastructure. It enables packages to use the Skia Gold
+infrastructure for tracking golden image tests.
+
+See also:
+
+ * https://skia.org/docs/dev/testing/skiagold/
+ * https://flutter-packages-gold.skia.org/
+ * [Writing a golden file test for package flutter]
+
+[Writing a golden file test for package flutter]: https://github.com/flutter/flutter/blob/master/docs/contributing/testing/Writing-a-golden-file-test-for-package-flutter.md