firka/flutter
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docimports for flutter_goldens, flutter_localizations, flutter_web_plugins, fuchsia_remote_debug_protocol, integration_test (#151271)

Browse Source 
Part of https://github.com/flutter/flutter/issues/150800
This commit is contained in:
Michael Goderbauer
2024-07-11 13:15:05 -07:00
committed by GitHub
parent 17584ab790
commit fb290b3121
12 changed files with 46 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/flutter_goldens/lib/flutter_goldens.dart
View File

@@ -190,7 +190,7 @@ abstract class FlutterGoldenFileComparator extends GoldenFileComparator {
///
/// The optional [suffix] argument is used by the
/// [FlutterPostSubmitFileComparator] and the [FlutterPreSubmitFileComparator].
/// These [FlutterGoldenFileComparators] randomize their base directories to
/// These [FlutterGoldenFileComparator]s randomize their base directories to
/// maintain thread safety while using the `goldctl` tool.
@protected
@visibleForTesting
@@ -535,7 +535,7 @@ class FlutterSkippingFileComparator extends FlutterGoldenFileComparator {
///
/// This comparator utilizes the [SkiaGoldClient] to request baseline images for
/// the given device under test for comparison. This comparator is initialized
/// when conditions for all other [FlutterGoldenFileComparators] have not been
/// when conditions for all other [FlutterGoldenFileComparator]s have not been
/// met, see the `isForEnvironment` method for each one listed below.
///
/// The [FlutterLocalFileComparator] is intended to run on local machines and

11
packages/flutter_goldens/lib/skia_client.dart
View File

@@ -2,6 +2,9 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/// @docImport 'flutter_goldens.dart';
library;
import 'dart:convert';
import 'dart:io' as io;
@@ -24,7 +27,7 @@ const String _kImpellerKey = 'FLUTTER_TEST_IMPELLER';
/// Signature of callbacks used to inject [print] replacements.
typedef LogCallback = void Function(String);
/// Exception thrown when an error is returned from the [SkiaClient].
/// Exception thrown when an error is returned from the [SkiaGoldClient].
class SkiaException implements Exception {
/// Creates a new `SkiaException` with a required error [message].
const SkiaException(this.message);
@@ -75,12 +78,12 @@ class SkiaGoldClient {
/// A client for making Http requests to the Flutter Gold dashboard.
final io.HttpClient httpClient;
/// The local [Directory] within the [comparisonRoot] for the current test
/// The local [Directory] within the comparison root for the current test
/// context. In this directory, the client will create image and JSON files
/// for the goldctl tool to use.
///
/// This is informed by the [FlutterGoldenFileComparator] [basedir]. It cannot
/// be null.
/// This is informed by [FlutterGoldenFileComparator.basedir]. It cannot be
/// null.
final Directory workDirectory;
/// The logging function to use when reporting messages to the console.

2
packages/flutter_goldens/test/json_templates.dart
View File

@@ -17,7 +17,7 @@ String authTemplate({
}
/// Json response template for Skia Gold image request:
/// https://flutter-gold.skia.org/img/images/[imageHash].png
/// https://flutter-gold.skia.org/img/images/{imageHash}.png
List<List<int>> imageResponseTemplate() {
return <List<int>>[
<int>[