_goldens_io.dart 12.3 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:io';
7
import 'dart:math' as math;
8
import 'dart:typed_data';
9
import 'dart:ui';
10

11
import 'package:flutter/foundation.dart';
12
import 'package:path/path.dart' as path;
13
// ignore: deprecated_member_use
14 15 16
import 'package:test_api/test_api.dart' as test_package show TestFailure;

import 'goldens.dart';
17
import 'test_async_utils.dart';
18 19 20

/// The default [GoldenFileComparator] implementation for `flutter test`.
///
21 22
/// The term __golden file__ refers to a master image that is considered the
/// true rendering of a given widget, state, application, or other visual
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
/// representation you have chosen to capture. This comparator loads golden
/// files from the local file system, treating the golden key as a relative
/// path from the test file's directory.
///
/// This comparator performs a pixel-for-pixel comparison of the decoded PNGs,
/// returning true only if there's an exact match. In cases where the captured
/// test image does not match the golden file, this comparator will provide
/// output to illustrate the difference, described in further detail below.
///
/// When using `flutter test --update-goldens`, [LocalFileComparator]
/// updates the golden files on disk to match the rendering.
///
/// ## Local Output from Golden File Testing
///
/// The [LocalFileComparator] will output test feedback when a golden file test
/// fails. This output takes the form of differential images contained within a
/// `failures` directory that will be generated in the same location specified
/// by the golden key. The differential images include the master and test
/// images that were compared, as well as an isolated diff of detected pixels,
/// and a masked diff that overlays these detected pixels over the master image.
///
/// The following images are examples of a test failure output:
///
/// |  File Name                 |  Image Output |
/// |----------------------------|---------------|
/// |  testName_masterImage.png  | ![A golden master image](https://flutter.github.io/assets-for-api-docs/assets/flutter-test/goldens/widget_masterImage.png)  |
/// |  testName_testImage.png    | ![Test image](https://flutter.github.io/assets-for-api-docs/assets/flutter-test/goldens/widget_testImage.png)  |
/// |  testName_isolatedDiff.png | ![An isolated pixel difference.](https://flutter.github.io/assets-for-api-docs/assets/flutter-test/goldens/widget_isolatedDiff.png) |
/// |  testName_maskedDiff.png   | ![A masked pixel difference](https://flutter.github.io/assets-for-api-docs/assets/flutter-test/goldens/widget_maskedDiff.png) |
///
/// See also:
///
///   * [GoldenFileComparator], the abstract class that [LocalFileComparator]
///   implements.
///   * [matchesGoldenFile], the function from [flutter_test] that invokes the
///    comparator.
59
class LocalFileComparator extends GoldenFileComparator with LocalComparisonOutput {
60 61 62 63 64 65
  /// Creates a new [LocalFileComparator] for the specified [testFile].
  ///
  /// Golden file keys will be interpreted as file paths relative to the
  /// directory in which [testFile] resides.
  ///
  /// The [testFile] URL must represent a file.
66
  LocalFileComparator(Uri testFile, {path.Style? pathStyle})
67 68 69
    : basedir = _getBasedir(testFile, pathStyle),
      _path = _getPath(pathStyle);

70
  static path.Context _getPath(path.Style? style) {
71 72 73
    return path.Context(style: style ?? path.Style.platform);
  }

74
  static Uri _getBasedir(Uri testFile, path.Style? pathStyle) {
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
    final path.Context context = _getPath(pathStyle);
    final String testFilePath = context.fromUri(testFile);
    final String testDirectoryPath = context.dirname(testFilePath);
    return context.toUri(testDirectoryPath + context.separator);
  }

  /// The directory in which the test was loaded.
  ///
  /// Golden file keys will be interpreted as file paths relative to this
  /// directory.
  final Uri basedir;

  /// Path context exists as an instance variable rather than just using the
  /// system path context in order to support testing, where we can spoof the
  /// platform to test behaviors with arbitrary path styles.
  final path.Context _path;

  @override
  Future<bool> compare(Uint8List imageBytes, Uri golden) async {
    final File goldenFile = _getGoldenFile(golden);
    if (!goldenFile.existsSync()) {
96 97 98
      throw test_package.TestFailure(
        'Could not be compared against non-existent file: "$golden"'
      );
99 100
    }
    final List<int> goldenBytes = await goldenFile.readAsBytes();
101
    final ComparisonResult result = await GoldenFileComparator.compareLists(
102 103 104
      imageBytes,
      goldenBytes,
    );
105 106

    if (!result.passed) {
107 108
      final String error = await generateFailureOutput(result, golden, basedir);
      throw FlutterError(error);
109 110 111 112 113 114 115 116 117 118 119 120 121 122
    }
    return result.passed;
  }

  @override
  Future<void> update(Uri golden, Uint8List imageBytes) async {
    final File goldenFile = _getGoldenFile(golden);
    await goldenFile.parent.create(recursive: true);
    await goldenFile.writeAsBytes(imageBytes, flush: true);
  }

  File _getGoldenFile(Uri golden) {
    return File(_path.join(_path.fromUri(basedir), _path.fromUri(golden.path)));
  }
123 124 125 126 127 128 129 130
}

/// A class for use in golden file comparators that run locally and provide
/// output.
class LocalComparisonOutput {
  /// Writes out diffs from the [ComparisonResult] of a golden file test.
  ///
  /// Will throw an error if a null result is provided.
131
  Future<String> generateFailureOutput(
132 133 134 135
    ComparisonResult result,
    Uri golden,
    Uri basedir, {
    String key = '',
136
  }) async => TestAsyncUtils.guard<String>(() async {
137 138
    String additionalFeedback = '';
    if (result.diffs != null) {
139
      additionalFeedback = '\nFailure feedback can be found at ${path.join(basedir.path, 'failures')}';
140
      final Map<String, Image> diffs = result.diffs!.cast<String, Image>();
141
      for (final MapEntry<String, Image> entry in diffs.entries) {
142
        final File output = getFailureFile(
143
          key.isEmpty ? entry.key : entry.key + '_' + key,
144 145 146 147
          golden,
          basedir,
        );
        output.parent.createSync(recursive: true);
148
        final ByteData? pngBytes = await entry.value.toByteData(format: ImageByteFormat.png);
149
        output.writeAsBytesSync(pngBytes!.buffer.asUint8List());
150
      }
151
    }
152 153
    return 'Golden "$golden": ${result.error}$additionalFeedback';
  });
154

155 156
  /// Returns the appropriate file for a given diff from a [ComparisonResult].
  File getFailureFile(String failure, Uri golden, Uri basedir) {
157
    final String fileName = golden.pathSegments.last;
158 159 160 161
    final String testName = fileName.split(path.extension(fileName))[0]
      + '_'
      + failure
      + '.png';
162 163 164
    return File(path.join(
      path.fromUri(basedir),
      path.fromUri(Uri.parse('failures/$testName')),
165
    ));
166 167
  }
}
168 169 170

/// Returns a [ComparisonResult] to describe the pixel differential of the
/// [test] and [master] image bytes provided.
171
Future<ComparisonResult> compareLists(List<int>? test, List<int>? master) async {
172 173 174 175 176 177 178 179 180 181
  if (identical(test, master))
    return ComparisonResult(passed: true);

  if (test == null || master == null || test.isEmpty || master.isEmpty) {
    return ComparisonResult(
      passed: false,
      error: 'Pixel test failed, null image provided.',
    );
  }

182 183 184
  final Codec testImageCodec =
      await instantiateImageCodec(Uint8List.fromList(test));
  final Image testImage = (await testImageCodec.getNextFrame()).image;
185
  final ByteData? testImageRgba = await testImage.toByteData();
186 187 188 189

  final Codec masterImageCodec =
      await instantiateImageCodec(Uint8List.fromList(master));
  final Image masterImage = (await masterImageCodec.getNextFrame()).image;
190
  final ByteData? masterImageRgba = await masterImage.toByteData();
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

  final int width = testImage.width;
  final int height = testImage.height;

  if (width != masterImage.width || height != masterImage.height) {
    return ComparisonResult(
      passed: false,
      error: 'Pixel test failed, image sizes do not match.\n'
        'Master Image: ${masterImage.width} X ${masterImage.height}\n'
        'Test Image: ${testImage.width} X ${testImage.height}',
    );
  }

  int pixelDiffCount = 0;
  final int totalPixels = width * height;
206 207
  final ByteData invertedMasterRgba = _invert(masterImageRgba!);
  final ByteData invertedTestRgba = _invert(testImageRgba!);
208

209
  final Uint8List testImageBytes = (await testImage.toByteData())!.buffer.asUint8List();
210 211
  final ByteData maskedDiffRgba = ByteData(testImageBytes.length);
  maskedDiffRgba.buffer.asUint8List().setRange(0, testImageBytes.length, testImageBytes);
212
  final ByteData isolatedDiffRgba = ByteData(width * height * 4);
213 214 215

  for (int x = 0; x < width; x++) {
    for (int y =0; y < height; y++) {
216 217 218
      final int byteOffset = (width * y + x) * 4;
      final int testPixel = testImageRgba.getUint32(byteOffset);
      final int masterPixel = masterImageRgba.getUint32(byteOffset);
219

220 221 222 223
      final int diffPixel = (_readRed(testPixel) - _readRed(masterPixel)).abs()
        + (_readGreen(testPixel) - _readGreen(masterPixel)).abs()
        + (_readBlue(testPixel) - _readBlue(masterPixel)).abs()
        + (_readAlpha(testPixel) - _readAlpha(masterPixel)).abs();
224 225

      if (diffPixel != 0 ) {
226 227 228 229 230 231 232 233 234 235 236
        final int invertedMasterPixel = invertedMasterRgba.getUint32(byteOffset);
        final int invertedTestPixel = invertedTestRgba.getUint32(byteOffset);
        // We grab the max of the 0xAABBGGRR encoded bytes, and then convert
        // back to 0xRRGGBBAA for the actual pixel value, since this is how it
        // was historically done.
        final int maskPixel = _toRGBA(math.max(
          _toABGR(invertedMasterPixel),
          _toABGR(invertedTestPixel),
        ));
        maskedDiffRgba.setUint32(byteOffset, maskPixel);
        isolatedDiffRgba.setUint32(byteOffset, maskPixel);
237 238 239 240 241 242 243 244 245 246 247
        pixelDiffCount++;
      }
    }
  }

  if (pixelDiffCount > 0) {
    return ComparisonResult(
      passed: false,
      error: 'Pixel test failed, '
        '${((pixelDiffCount/totalPixels) * 100).toStringAsFixed(2)}% '
        'diff detected.',
248 249 250 251 252 253
      diffs:  <String, Image>{
        'masterImage' : masterImage,
        'testImage' : testImage,
        'maskedDiff' : await _createImage(maskedDiffRgba, width, height),
        'isolatedDiff' : await _createImage(isolatedDiffRgba, width, height),
      },
254 255 256 257 258
    );
  }
  return ComparisonResult(passed: true);
}

259 260 261 262 263 264 265 266 267 268 269 270 271
/// Inverts [imageBytes], returning a new [ByteData] object.
ByteData _invert(ByteData imageBytes) {
  final ByteData bytes = ByteData(imageBytes.lengthInBytes);
  // Invert the RGB data (but not A).
  for (int i = 0; i < imageBytes.lengthInBytes; i += 4) {
    bytes.setUint8(i, 255 - imageBytes.getUint8(i));
    bytes.setUint8(i + 1, 255 - imageBytes.getUint8(i + 1));
    bytes.setUint8(i + 2, 255 - imageBytes.getUint8(i + 2));
    bytes.setUint8(i + 3, imageBytes.getUint8(i + 3));
  }
  return bytes;
}

272 273 274
/// An unsupported [WebGoldenComparator] that exists for API compatibility.
class DefaultWebGoldenComparator extends WebGoldenComparator {
  @override
275
  Future<bool> compare(double width, double height, Uri golden) {
276 277 278 279
    throw UnsupportedError('DefaultWebGoldenComparator is only supported on the web.');
  }

  @override
280
  Future<void> update(double width, double height, Uri golden) {
281 282 283
    throw UnsupportedError('DefaultWebGoldenComparator is only supported on the web.');
  }
}
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320

/// Reads the red value out of a 32 bit rgba pixel.
int _readRed(int pixel) => (pixel >> 24) & 0xff;

/// Reads the green value out of a 32 bit rgba pixel.
int _readGreen(int pixel) => (pixel >> 16) & 0xff;

/// Reads the blue value out of a 32 bit rgba pixel.
int _readBlue(int pixel) => (pixel >> 8) & 0xff;

/// Reads the alpha value out of a 32 bit rgba pixel.
int _readAlpha(int pixel) => pixel & 0xff;

/// Convenience wrapper around [decodeImageFromPixels].
Future<Image> _createImage(ByteData bytes, int width, int height) {
  final Completer<Image> completer = Completer<Image>();
  decodeImageFromPixels(
    bytes.buffer.asUint8List(),
    width,
    height,
    PixelFormat.rgba8888,
    completer.complete,
  );
  return completer.future;
}

// Converts a 32 bit rgba pixel to a 32 bit abgr pixel
int _toABGR(int rgba) =>
    (_readAlpha(rgba) << 24) |
    (_readBlue(rgba) << 16) |
    (_readGreen(rgba) << 8) |
    _readRed(rgba);

// Converts a 32 bit abgr pixel to a 32 bit rgba pixel
int _toRGBA(int abgr) =>
  // This is just a mirror of the other conversion.
  _toABGR(abgr);