WebGoldenComparator class abstract

Compares image pixels against a golden image file.

Instances of this comparator will be used as the backend for matchesGoldenFile when tests are running on Flutter Web, and will usually implemented by deferring the screenshot taking and image comparison to a test server.

Instances of this comparator will be invoked by the test framework in the TestWidgetsFlutterBinding.runAsync zone and are thus not subject to the fake async constraints that are normally imposed on widget tests (i.e. the need or the ability to call WidgetTester.pump to advance the microtask queue). Prior to the invocation, the test framework will render only the Element to be compared on the screen.

See also:

Implementers

Constructors

WebGoldenComparator()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

compare(double width, double height, Uri golden) → Future<bool>
Compares the rendered pixels of size widthxheight that is being rendered on the top left of the screen against the golden file identified by golden.
compareBytes(Uint8List bytes, Uri golden) → Future<bool>
Compares the pixels of decoded png bytes against the golden file identified by golden.
getTestUri(Uri key, int? version) → Uri
Returns a new golden file Uri to incorporate any version number with the key.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
update(double width, double height, Uri golden) → Future<void>
Updates the golden file identified by golden with rendered pixels of widthxheight.
updateBytes(Uint8List bytes, Uri golden) → Future<void>
Compares the pixels of decoded png bytes against the golden file identified by golden.

Operators

operator ==(Object other) → bool
The equality operator.
inherited