Merge pull request #2 from sncf-connect-tech/1-improve_exception_reporting

resolves #1 improve exception reporting

Author: Tiska

lib/reporters/widget_stdout_reporter.dart

@@ -17,7 +17,8 @@ class WidgetStdoutReporter extends Reporter {
   @override
   Future<void> onScenarioStarted(StartedMessage message) async {
     logger.i(COOL_COLOR("\n${"-" * 100}\n"));
-    logger.i(COOL_COLOR('${DateTime.now()} - Running scenario: ${message.name + _getContext(message.context)}'));
+    logger.i(COOL_COLOR(
+        '${DateTime.now()} - Running scenario: ${message.name + _getContext(message.context)}'));
   }
 
   @override
@@ -29,15 +30,24 @@ class WidgetStdoutReporter extends Reporter {
 
   @override
   Future<void> onStepFinished(StepFinishedMessage message) async {
-    var stepColor = message.result.result == StepExecutionResult.pass ? PASS_COLOR : FAIL_COLOR;
-    var printMessage = [
-      stepColor('  '),
-      stepColor(_getStatePrefixIcon(message.result.result)),
-      stepColor(message.name),
-      NEUTRAL_COLOR(_getExecutionDuration(message.result)),
-      stepColor(_getReasonMessage(message.result)),
-      stepColor(_getErrorMessage(message.result))
-    ].join((' ')).trimRight();
+    var stepColor = message.result.result == StepExecutionResult.pass
+        ? PASS_COLOR
+        : FAIL_COLOR;
+    String printMessage;
+    if (message.result is ErroredStepResult) {
+      var errorMessage = (message.result as ErroredStepResult);
+      printMessage =
+          FAIL_COLOR('${errorMessage.exception}\n${errorMessage.stackTrace}');
+    } else {
+      printMessage = [
+        stepColor('  '),
+        stepColor(_getStatePrefixIcon(message.result.result)),
+        stepColor(message.name),
+        NEUTRAL_COLOR(_getExecutionDuration(message.result)),
+        stepColor(_getReasonMessage(message.result)),
+        stepColor(_getErrorMessage(message.result))
+      ].join((' ')).trimRight();
+    }
     logger.i(printMessage);
 
     // TODO adapter à cette classe
@@ -59,7 +69,8 @@ class WidgetStdoutReporter extends Reporter {
   }
 
   String _getReasonMessage(StepResult stepResult) {
-    if (stepResult.resultReason != null && stepResult.resultReason!.isNotEmpty) {
+    if (stepResult.resultReason != null &&
+        stepResult.resultReason!.isNotEmpty) {
       return '\n      ${stepResult.resultReason}';
     } else {
       return '';
@@ -75,7 +86,8 @@ class WidgetStdoutReporter extends Reporter {
   }
 
   String _getContext(RunnableDebugInformation context) {
-    return NEUTRAL_COLOR("\t# ${_getFeatureFilePath(context)}:${context.lineNumber}");
+    return NEUTRAL_COLOR(
+        "\t# ${_getFeatureFilePath(context)}:${context.lineNumber}");
   }
 
   String _getFeatureFilePath(RunnableDebugInformation context) {

lib/utils/widget_renderer.dart

@@ -6,23 +6,43 @@ import 'dart:typed_data';
 import 'dart:ui' as ui;
 import 'package:flutter/rendering.dart';
 
-Future<void> takeScreenshot() async {
+Future<void> takeScreenshot({withWidgetTreeRender = false}) async {
   await currentWorld.tester.pumpAndSettle();
-  RenderRepaintBoundary boundary = _getMainWidget().renderObject! as RenderRepaintBoundary;
-  ui.Image image = await boundary.toImage();
-  ByteData? byteData = await image.toByteData(format: ui.ImageByteFormat.png);
-  Uint8List pngBytes = byteData!.buffer.asUint8List();
-  await currentWorld.screenshot?.writeAsBytes(pngBytes);
+  RenderObject? renderObject = _getMainWidget()?.renderObject;
+  if (renderObject != null) {
+    RenderRepaintBoundary boundary = renderObject as RenderRepaintBoundary;
+    ui.Image image = await boundary.toImage();
+    ByteData? byteData = await image.toByteData(format: ui.ImageByteFormat.png);
+    Uint8List pngBytes = byteData!.buffer.asUint8List();
+    await currentWorld.screenshot?.writeAsBytes(pngBytes);
+
+    if (withWidgetTreeRender) {
+      await dumpWidgetRender();
+    }
+  } else {
+    logger.e('Screenshot failed.');
+  }
 }
 
 Future<void> dumpWidgetRender() async {
-  final widgetRendering = _printWidgetTree(_getMainWidget(), 0);
-  logger.i("Impression widget :\n $widgetRendering");
-  await currentWorld.dumpFile?.writeAsString(widgetRendering.toString());
+  Element? widget = _getMainWidget();
+  if (widget != null) {
+    final widgetRendering = _printWidgetTree(_getMainWidget(), 0);
+    logger.i("Impression widget :\n $widgetRendering");
+    await currentWorld.dumpFile?.writeAsString(widgetRendering.toString());
+  } else {
+    logger.e('Widget render dump failed.');
+  }
 }
 
-Element _getMainWidget() {
-  return currentWorld.tester.allElements.firstWhere((element) => element.widget.runtimeType == RepaintBoundary);
+Element? _getMainWidget() {
+  try {
+    return currentWorld.tester.allElements
+        .firstWhere((element) => element.widget.runtimeType == RepaintBoundary);
+  } catch (e) {
+    logger.e('Cannot get a RepaintBoundary widget.');
+    return null;
+  }
 }
 
 int? firstLevel;

lib/world/widget_hooks.dart

@@ -41,8 +41,7 @@ class WidgetHooks implements Hook {
       var dumpFileName = _getDumpFilePath();
       currentWorld.dumpFile = File("$dumpFileName.txt");
       currentWorld.screenshot = File("$dumpFileName.png");
-      await takeScreenshot();
-      await dumpWidgetRender();
+      await takeScreenshot(withWidgetTreeRender: true);
     }
   }