Initial commit

integration_test/utils/tatu_chat_tester.dart

@@ -0,0 +1,128 @@
+// SPDX-FileCopyrightText: 2019-Present Christian Kußowski
+// SPDX-FileCopyrightText: 2019-Present Contributors to FluffyChat
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import 'package:tatchat/main.dart' as app;
+import 'package:flutter/widgets.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+extension type TatuChatTester(WidgetTester tester) {
+  static int _printCounter = 1;
+
+  void _print(String message) {
+    debugPrint(
+      '[INTEGRATION TEST] ${DateTime.now().toIso8601String()} | Step ${_printCounter++} -  $message',
+    );
+  }
+
+  Future<bool> isVisible(
+    Object object, {
+    Duration timeout = const Duration(seconds: 3),
+  }) async {
+    final end = DateTime.now().add(timeout);
+    while (object.toFinder().evaluate().isEmpty) {
+      if (DateTime.now().isAfter(end)) {
+        return false;
+      }
+      await tester.pump(const Duration(milliseconds: 500));
+    }
+    return true;
+  }
+
+  Future<void> waitFor(
+    Object object, {
+    Duration timeout = const Duration(seconds: 30),
+  }) async {
+    _print('👀 Waiting for "$object" (${timeout.inSeconds}s)');
+    final end = DateTime.now().add(timeout);
+    while (object.toFinder().evaluate().isEmpty) {
+      if (DateTime.now().isAfter(end)) {
+        throw Exception('⏱️ Timed out waiting for "$object"!');
+      }
+      await tester.pump(const Duration(milliseconds: 500));
+    }
+  }
+
+  Future<Finder> _ensureVisible(Object object, {int? index}) async {
+    var finder = object.toFinder();
+    if (finder.evaluate().isEmpty) await waitFor(object);
+
+    if (finder.evaluate().length > 1) {
+      if (index == null) {
+        throw Exception(
+          '⚠️ Found ${finder.evaluate().length} "$object" objects. Please specify an index!',
+        );
+      }
+      if (finder.evaluate().length <= index) {
+        throw Exception(
+          '⚠️ Found ${finder.evaluate().length} "$object" objects. So index $index does not exist!',
+        );
+      }
+      finder = finder.at(index);
+    }
+    return finder;
+  }
+
+  Future<void> tapOn(
+    Object object, {
+    int? index,
+    bool pumpAndSettle = true,
+  }) async {
+    final finder = await _ensureVisible(object, index: index);
+
+    _print('👆 Tapping on "$object"');
+    await tester.tap(finder);
+    if (pumpAndSettle) await tester.pumpAndSettle();
+  }
+
+  Future<void> goBack() => tapOn(find.byTooltip('Back'));
+
+  Future<void> enterText(
+    Object object,
+    String text, {
+    int? index,
+    bool pumpAndSettle = true,
+  }) async {
+    final finder = await _ensureVisible(object, index: index);
+
+    _print('⌨️ Enter "$text" into "$object"');
+    await tester.enterText(finder, text);
+    FocusManager.instance.primaryFocus?.unfocus();
+    if (pumpAndSettle) await tester.pumpAndSettle();
+  }
+
+  Future<void> scrollUntilVisible(
+    Object object, {
+    int? index,
+    Object? scrollable,
+  }) async {
+    _print('📜 Scrolling to "$object"');
+    await tester.scrollUntilVisible(
+      object.toFinder(),
+      500.0,
+      scrollable: scrollable?.toFinder() ?? find.byType(Scrollable).last,
+    );
+    await tester.pumpAndSettle();
+  }
+}
+
+extension on Object {
+  Finder toFinder() => switch (this) {
+    final Finder finder => finder,
+    final String string => find.text(string),
+    final Key key => find.byKey(key),
+    final IconData icon => find.byIcon(icon),
+    final Type type => find.byType(type),
+    final Widget widget => find.byWidget(widget),
+    _ => throw Exception('Unsupported finder type: $runtimeType'),
+  };
+}
+
+extension StartTest on WidgetTester {
+  Future<TatuChatTester> startTatuChatTest() async {
+    app.main(['integration_test']);
+
+    return TatuChatTester(this);
+  }
+}