Merge pull request #2426 from leancodepl/small-fixes-in-patrol-log

Small fixes in patrol log

packages/patrol_log/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0
+
+- Fix report path when path contain spaces.
+- Fix path to the test file on the failed test list in summary.
+- Add `ConfigEntry`.
+
 ## 0.1.0
 
 - Add option to not clear test steps.

packages/patrol_log/lib/src/ansi_codes.dart

@@ -8,17 +8,15 @@ class AnsiCodes {
   /// `[1m` - Set text to bold.
   static const String bold = '$escape[1m';
 
-  /// `[30m` - Set text color to gray.
-  static const String gray = '$escape[30m';
+  static String color(String color) => '$escape[${color}m';
 
-  /// `[38;5;87m` - Set text color to light blue. Used for native actions.
-  static const String lightBlue = '$escape[38;5;87m';
-
-  static String custom(String color) => '$escape[${color}m';
-
-  static String get green => custom('32');
-  static String get yellow => custom('33');
-  static String get blue => custom('34');
-  static String get magenta => custom('35');
-  static String get cyan => custom('36');
+  static String gray = color('30');
+  static String red = color('31');
+  static String green = color('32');
+  static String yellow = color('33');
+  static String blue = color('34');
+  static String lightBlue = color('38;5;87');
+  static String magenta = color('35');
+  static String cyan = color('36');
+  static String orange = color('38;5;208');
 }

packages/patrol_log/lib/src/entries/config_entry.dart

@@ -0,0 +1,30 @@
+part of 'entry.dart';
+
+@JsonSerializable()
+class ConfigEntry extends Entry {
+  ConfigEntry({
+    required this.config,
+    DateTime? timestamp,
+  }) : super(
+          timestamp: timestamp ?? DateTime.now(),
+          type: EntryType.config,
+        );
+
+  @override
+  factory ConfigEntry.fromJson(Map<String, dynamic> json) =>
+      _$ConfigEntryFromJson(json);
+
+  final Map<String, dynamic> config;
+
+  @override
+  Map<String, dynamic> toJson() => _$ConfigEntryToJson(this);
+
+  @override
+  String pretty() => config.toString();
+
+  @override
+  String toString() => 'ConfigEntry(${toJson()})';
+
+  @override
+  List<Object?> get props => [config, timestamp, type];
+}

packages/patrol_log/lib/src/entries/entry.dart

@@ -7,6 +7,8 @@ part 'error_entry.dart';
 part 'log_entry.dart';
 part 'step_entry.dart';
 part 'test_entry.dart';
+part 'warning_entry.dart';
+part 'config_entry.dart';
 
 part 'entry.g.dart';
 
@@ -39,14 +41,18 @@ enum EntryType {
   error,
   step,
   test,
-  log;
+  log,
+  warning,
+  config;
 
   static EntryType byName(String name) {
     return switch (name) {
       'error' => EntryType.error,
       'step' => EntryType.step,
       'test' => EntryType.test,
       'log' => EntryType.log,
+      'warning' => EntryType.warning,
+      'config' => EntryType.config,
       _ => throw ArgumentError('Unknown EntryType: $name')
     };
   }

packages/patrol_log/lib/src/entries/error_entry.dart

@@ -21,7 +21,7 @@ class ErrorEntry extends Entry {
 
   @override
   String pretty() {
-    return message;
+    return '${AnsiCodes.red}$message${AnsiCodes.reset}';
   }
 
   @override

packages/patrol_log/lib/src/entries/warning_entry.dart

@@ -0,0 +1,32 @@
+part of 'entry.dart';
+
+@JsonSerializable()
+class WarningEntry extends Entry {
+  WarningEntry({
+    required this.message,
+    DateTime? timestamp,
+  }) : super(
+          timestamp: timestamp ?? DateTime.now(),
+          type: EntryType.warning,
+        );
+
+  @override
+  factory WarningEntry.fromJson(Map<String, dynamic> json) =>
+      _$WarningEntryFromJson(json);
+
+  final String message;
+
+  @override
+  Map<String, dynamic> toJson() => _$WarningEntryToJson(this);
+
+  @override
+  String pretty() {
+    return '${AnsiCodes.yellow}$message${AnsiCodes.reset}';
+  }
+
+  @override
+  String toString() => 'WarningEntry(${toJson()})';
+
+  @override
+  List<Object?> get props => [message, timestamp, type];
+}

packages/patrol_log/lib/src/patrol_log_reader.dart

@@ -43,6 +43,8 @@ class PatrolLogReader {
       StreamController<Entry>.broadcast();
   late final StreamSubscription<Entry> _streamSubscription;
 
+  final Map<String, dynamic> _config = {};
+
   void listen() {
     // Listen to the entry stream and pretty print the patrol logs.
     readEntries();
@@ -93,11 +95,10 @@ class PatrolLogReader {
 
   /// Take line containg PATROL_LOG tag, parse it to [Entry] and add to stream.
   void _parsePatrolLog(String line) {
-    final regExp = RegExp(r'PATROL_LOG \{(.*?)\}');
+    final regExp = RegExp('PATROL_LOG (.*)');
     final match = regExp.firstMatch(line);
     if (match != null) {
-      final matchedText = match.group(1)!;
-      final json = '{$matchedText}';
+      final json = match.group(1)!;
       final entry = parseEntry(json);
 
       if (entry case TestEntry _) {
@@ -146,6 +147,8 @@ class PatrolLogReader {
       EntryType.test => TestEntry.fromJson(json),
       EntryType.log => LogEntry.fromJson(json),
       EntryType.error => ErrorEntry.fromJson(json),
+      EntryType.warning => WarningEntry.fromJson(json),
+      EntryType.config => ConfigEntry.fromJson(json),
     };
   }
 
@@ -205,12 +208,33 @@ class PatrolLogReader {
             log(entry.pretty());
 
           case ErrorEntry():
+          case WarningEntry():
             log(entry.pretty());
+          case ConfigEntry():
+            _readConfig(entry);
         }
       },
     );
   }
 
+  /// Read the config passed by [PatrolLogWriter].
+  void _readConfig(ConfigEntry entry) {
+    if (_config.isNotEmpty) {
+      return;
+    }
+
+    _config.addAll(entry.config);
+
+    if (_config['printLogs'] == false) {
+      final warningEntry = WarningEntry(
+        message: 'Printing flutter steps is disabled in the config. '
+            'To enable it, set `PatrolTesterConfig(printLogs: true)`.',
+      );
+
+      log(warningEntry.pretty());
+    }
+  }
+
   /// Returns a summary of the test results. That contains:
   ///
   /// - Total number of tests
@@ -226,7 +250,7 @@ class PatrolLogReader {
       '${Emojis.failure} Failed: $failedTestsCount\n'
       '${failedTestsCount > 0 ? '$failedTestsList\n' : ''}'
       '${Emojis.skip} Skipped: $skippedTests\n'
-      '${Emojis.report} Report: $reportPath\n'
+      '${Emojis.report} Report: ${reportPath.replaceAll(' ', '%20')}\n'
       '${Emojis.duration} Duration: ${_stopwatch.elapsed.inSeconds}s\n';
 
   /// Closes the stream subscription and the stream controller.

packages/patrol_log/lib/src/patrol_log_writer.dart

@@ -4,8 +4,12 @@ import 'dart:convert';
 import 'package:patrol_log/patrol_log.dart';
 
 class PatrolLogWriter {
-  PatrolLogWriter() : _controller = StreamController<Entry>.broadcast() {
+  PatrolLogWriter({Map<String, dynamic> config = const {}})
+      : _controller = StreamController<Entry>.broadcast() {
     write();
+
+    /// Pass config to the PatrolLogReader
+    log(ConfigEntry(config: config));
   }
 
   final StreamController<Entry> _controller;

packages/patrol_log/lib/src/patrol_single_test_entry.dart

@@ -34,7 +34,9 @@ class PatrolSingleTestEntry {
       closingTestEntry?.status ?? openingTestEntry.status;
 
   /// The name of the test with the path.
-  String get nameWithPath => openingTestEntry.nameWithPath;
+  ///
+  /// If test is not closed yet, the path is unknown, so return only test name.
+  String get nameWithPath => closingTestEntry?.nameWithPath ?? name;
 
   /// The execution time of the test.
   Duration get executionTime {

packages/patrol_log/pubspec.yaml

@@ -1,7 +1,7 @@
 name: patrol_log
 description: >
   Log package for Patrol, a powerful Flutter-native UI testing framework.
-version: 0.1.0
+version: 0.2.0
 homepage: https://patrol.leancode.co
 repository: https://github.com/leancodepl/patrol/tree/master/packages/patrol_log
 issue_tracker: https://github.com/leancodepl/patrol/issues