-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
599 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| import 'dart:core'; | ||
| import 'dart:core' as core; | ||
| import 'dart:io'; | ||
| import 'dart:typed_data'; | ||
| import 'dart:ui' as ui; | ||
|
|
||
| import 'package:dartx/dartx_io.dart'; | ||
| import 'package:flutter/rendering.dart'; | ||
| import 'package:flutter/widgets.dart'; | ||
| import 'package:flutter_test/flutter_test.dart'; | ||
| import 'package:nanoid2/nanoid2.dart'; | ||
| import 'package:spot/spot.dart'; | ||
| import 'package:spot/src/screenshot/screenshot.dart' as self | ||
| show takeScreenshot; | ||
| import 'package:stack_trace/stack_trace.dart'; | ||
|
|
||
| export 'package:stack_trace/stack_trace.dart' show Frame; | ||
|
|
||
| /// A screenshot taken from a widget test. | ||
| /// | ||
| /// May also be just a single widget, not the entire screen | ||
| class Screenshot { | ||
| Screenshot({ | ||
| required this.file, | ||
| this.initiator, | ||
| }); | ||
|
|
||
| /// The file where the screenshot was saved to | ||
| final File file; | ||
|
|
||
| /// Call stack of the code that initiated the screenshot | ||
| final Frame? initiator; | ||
| } | ||
|
|
||
| /// Takes a screenshot of the entire screen or a single widget. | ||
| /// | ||
| /// Provide a [selector], [snapshot] or [element] to take a screenshot of. | ||
| /// When the screenshot is taken from a larger than just your widget, wrap your | ||
| /// widget with a [RepaintBoundary] to indicate where the screenshot should be | ||
| /// taken. | ||
| /// | ||
| /// Use [name] to make it easier to identify the screenshot in the file system. | ||
| /// By default, a random name is generated prefixed with the test file name and | ||
| /// line number. | ||
| Future<Screenshot> takeScreenshot({ | ||
| Element? element, | ||
| SingleWidgetSnapshot? snapshot, | ||
| SingleWidgetSelector? selector, | ||
| String? name, | ||
| }) async { | ||
| final TestWidgetsFlutterBinding binding = TestWidgetsFlutterBinding.instance; | ||
| final Frame? frame = _caller(); | ||
|
|
||
| // Element that is currently active in the widget tree, to take a screenshot of | ||
| final Element liveElement = () { | ||
| if (selector != null) { | ||
| // taking a fresh snapshot guarantees an element that is currently in the | ||
| // tree and can be screenshotted | ||
| final snapshot = selector.snapshot().existsOnce(); | ||
| return snapshot.element; | ||
| } | ||
|
|
||
| if (snapshot != null) { | ||
| if (!snapshot.element.mounted) { | ||
| throw StateError( | ||
| 'Can not take a screenshot of snapshot $snapshot, because it is not mounted anymore. ' | ||
| 'Only Elements that are currently mounted can be screenshotted.', | ||
| ); | ||
| } | ||
| if (snapshot.widget != snapshot.element.widget) { | ||
| throw StateError( | ||
| 'Can not take a screenshot of snapshot $snapshot, because the Element has been updated since the snapshot was taken. ' | ||
| 'This happens when the widget tree is rebuilt.', | ||
| ); | ||
| } | ||
| return snapshot.element; | ||
| } | ||
|
|
||
| if (element != null) { | ||
| if (!element.mounted) { | ||
| throw StateError( | ||
| 'Can not take a screenshot of Element $element, because it is not mounted anymore. ' | ||
| 'Only Elements that are currently mounted can be screenshotted.', | ||
| ); | ||
| } | ||
| return element; | ||
| } | ||
|
|
||
| // fallback to screenshotting the entire app | ||
| // Deprecated, but as of today there is no multi window support for widget tests | ||
| // ignore: deprecated_member_use | ||
| return binding.renderViewElement!; | ||
| }(); | ||
|
|
||
| late final Uint8List bytes; | ||
| await binding.runAsync(() async { | ||
| final image = await _captureImage(liveElement); | ||
| final byteData = await image.toByteData(format: ui.ImageByteFormat.png); | ||
| if (byteData == null) { | ||
| return 'Could not take screenshot'; | ||
| } | ||
| bytes = byteData.buffer.asUint8List(); | ||
| image.dispose(); | ||
| }); | ||
|
|
||
| final spotTempDir = Directory.systemTemp.directory('spot'); | ||
| if (!spotTempDir.existsSync()) { | ||
| spotTempDir.createSync(); | ||
| } | ||
| String callerFileName() { | ||
| final file = frame?.uri.pathSegments.last.replaceFirst('.dart', ''); | ||
| final line = frame?.line; | ||
| if (file != null && line != null) { | ||
| return '$file:$line'; | ||
| } | ||
| if (file != null) { | ||
| return file; | ||
| } | ||
| return 'unknown'; | ||
| } | ||
|
|
||
| final String screenshotFileName = () { | ||
| final String n; | ||
| if (name != null) { | ||
| // escape / | ||
| n = Uri.encodeQueryComponent(name); | ||
| } else { | ||
| n = callerFileName(); | ||
| } | ||
|
|
||
| // always append a unique id to avoid name collisions | ||
| final uniqueId = nanoid(length: 5); | ||
| return '$n-$uniqueId.png'; | ||
| }(); | ||
| final file = spotTempDir.file(screenshotFileName); | ||
| file.writeAsBytesSync(bytes); | ||
| // ignore: avoid_print | ||
| core.print( | ||
| 'Screenshot file://${file.path}\n' | ||
| ' taken at ${frame?.member} ${frame?.uri}:${frame?.line}:${frame?.column}', | ||
| ); | ||
| return Screenshot(file: file, initiator: frame); | ||
| } | ||
|
|
||
| extension SelectorScreenshotExtension<W extends Widget> | ||
| on SingleWidgetSelector<W> { | ||
| /// Takes as screenshot of the widget that can be found by this selector. | ||
| Future<Screenshot> takeScreenshot({String? name}) { | ||
| return self.takeScreenshot(selector: this, name: name); | ||
| } | ||
| } | ||
|
|
||
| extension SnapshotScreenshotExtension<W extends Widget> | ||
| on SingleWidgetSnapshot<W> { | ||
| /// Takes as screenshot of the widget that was captured in this snapshot. | ||
| /// | ||
| /// The snapshot must have been taken at the same frame | ||
| Future<Screenshot> takeScreenshot({String? name}) { | ||
| return self.takeScreenshot(snapshot: this, name: name); | ||
| } | ||
| } | ||
|
|
||
| extension ElementScreenshotExtension on Element { | ||
| /// Takes as screenshot of this element | ||
| /// | ||
| /// The element must be mounted | ||
| Future<Screenshot> takeScreenshot({String? name}) { | ||
| return self.takeScreenshot(element: this, name: name); | ||
| } | ||
| } | ||
|
|
||
| /// Render the closest [RepaintBoundary] of the [element] into an image. | ||
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [OffsetLayer.toImage] which is the actual method being called. | ||
| Future<ui.Image> _captureImage(Element element) async { | ||
| assert(element.renderObject != null); | ||
| RenderObject renderObject = element.renderObject!; | ||
| while (!renderObject.isRepaintBoundary) { | ||
| renderObject = renderObject.parent! as RenderObject; | ||
| } | ||
| assert(!renderObject.debugNeedsPaint); | ||
|
|
||
| final OffsetLayer layer = renderObject.debugLayer! as OffsetLayer; | ||
| final ui.Image image = await layer.toImage(renderObject.paintBounds); | ||
|
|
||
| if (element.renderObject is RenderBox) { | ||
| final expectedSize = (element.renderObject as RenderBox?)!.size; | ||
| if (expectedSize.width != image.width || | ||
| expectedSize.height != image.height) { | ||
| // ignore: avoid_print | ||
| print( | ||
| 'Warning: The screenshot captured of ${element.toStringShort()} is ' | ||
| 'larger (${image.width}, ${image.height}) than ' | ||
| '${element.toStringShort()} (${expectedSize.width}, ${expectedSize.height}) itself.\n' | ||
| 'Wrap the ${element.toStringShort()} in a RepaintBoundary to be able to capture only that layer. ', | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| return image; | ||
| } | ||
|
|
||
| /// Returns the frame in the call stack that is most useful for identifying for | ||
| /// humans | ||
| Frame? _caller({StackTrace? stack}) { | ||
| final trace = stack != null ? Trace.parse(stack.toString()) : Trace.current(); | ||
| final relevantLines = trace.frames.where((line) { | ||
| if (line.isCore) return false; | ||
| final url = line.uri.toString(); | ||
| if (url.contains('package:spot')) return false; | ||
| return true; | ||
| }).toList(); | ||
| final Frame? bestGuess = relevantLines.firstOrNull; | ||
| return bestGuess; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.