test: golden tests (#5)

* test: add goldens * fix: add storageAdapter to fix golden tests --------- Co-authored-by: Joshua Wellbrock <[email protected]>
emdgroup · Nov 19, 2024 · aa19b69 · aa19b69
1 parent 219530d
commit aa19b69
Show file tree

Hide file tree

Showing 45 changed files with 437 additions and 15 deletions.
diff --git a/.flutter-plugins b/.flutter-plugins
diff --git a/.flutter-plugins-dependencies b/.flutter-plugins-dependencies
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,6 @@ migrate_working_dir/
 **/doc/api/
 .dart_tool/
 build/
+.flutter-plugins
+.flutter-plugins-dependencies
+test/failures
diff --git a/lib/src/ui/imp_widget.dart b/lib/src/ui/imp_widget.dart
@@ -18,11 +18,16 @@ class ImpWidget extends StatelessWidget {
     required this.onIdentificationDone,
     required this.onIdentificationFailed,
     required this.chipIdFormat,
+    this.storageAdapter,
     super.key,
   });
 
   final ChipIdFormat? chipIdFormat;
 
+  /// The StorageAdapter to use for persisting the last connected and paired
+  /// devices.
+  final StorageAdapter? storageAdapter;
+
   /// The strategy to use for the connection.
   final ConnectionStrategy connectionStrategy;
 
@@ -36,6 +41,7 @@ class ImpWidget extends StatelessWidget {
   Widget build(BuildContext context) {
     return DeviceConnector(
       connectionStrategy: connectionStrategy,
+      storageAdapter: storageAdapter,
       connectedBuilder: (BuildContext context) {
         return LdSubmit<bool>(
           config: LdSubmitConfig<bool>(

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -21,8 +21,11 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   flutter_lints: ^2.0.0
+  golden_toolkit: ^0.15.0
   mockito: ^5.4.4
+  mtrust_urp_virtual_strategy: ^8.0.1
 flutter:
+  uses-material-design: true
   generate: true
   assets:
     - assets/
diff --git a/test/golden_utils.dart b/test/golden_utils.dart
@@ -0,0 +1,109 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_localizations/flutter_localizations.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:golden_toolkit/golden_toolkit.dart';
+import 'package:liquid_flutter/liquid_flutter.dart';
+import 'package:mtrust_imp_kit/mtrust_imp_kit.dart';
+
+typedef WidgetBuilder = Future<Future<void> Function()?> Function(
+  WidgetTester tester,
+  Future<void> Function(Widget widget) placeWidget,
+);
+Widget liquidFrame({
+  required Key key,
+  required Widget child,
+  required bool isDark,
+  required LdThemeSize size,
+}) {
+  final theme = LdTheme()..setThemeSize(size);
+  return Localizations(
+    delegates: const [
+      GlobalWidgetsLocalizations.delegate,
+      LiquidLocalizations.delegate,
+      UrpUiLocalizations.delegate,
+      ImpLocalizations.delegate,
+    ],
+    locale: const Locale('en'),
+    child: Directionality(
+      textDirection: TextDirection.ltr,
+      child: LdThemeProvider(
+        theme: theme,
+        autoSize: false,
+        brightnessMode:
+            isDark ? LdThemeBrightnessMode.dark : LdThemeBrightnessMode.light,
+        child: Builder(
+          builder: (context) {
+            return Container(
+              padding: const EdgeInsets.all(16),
+              margin: const EdgeInsets.all(16),
+              decoration: BoxDecoration(
+                color: theme.background,
+                borderRadius: ldRadiusM,
+              ),
+              child: Directionality(
+                textDirection: TextDirection.ltr,
+                child: Builder(
+                  builder: (context) {
+                    return SingleChildScrollView(
+                      child: Center(key: key, child: child),
+                    );
+                  },
+                ),
+              ),
+            );
+          },
+        ),
+      ),
+    ),
+  );
+}
+
+Future<void> multiGolden(
+  WidgetTester tester,
+  String name,
+  Map<String, WidgetBuilder> widgets, {
+  int width = 900,
+}) async {
+  ldDisableAnimations = true;
+  urpUiDisableAnimations = true;
+  await loadAppFonts();
+  for (final entry in widgets.entries) {
+    for (final themeSize in LdThemeSize.values) {
+      for (final brightness in Brightness.values) {
+        final slug = '${entry.key}/'
+            "${themeSize.toString().split(".").last}"
+            "-${brightness.toString().split(".").last}";
+        await tester.binding.setSurfaceSize(
+          Size(width.toDouble(), 1000),
+        );
+        final cleanup = await entry.value(tester, (widget) async {
+          await tester.pumpWidget(
+            liquidFrame(
+              key: ValueKey(slug),
+              child: widget,
+              isDark: brightness == Brightness.dark,
+              size: themeSize,
+            ),
+          );
+        });
+        final size =
+            find.byKey(ValueKey(slug)).evaluate().single.size ?? Size.zero;
+        await tester.binding.setSurfaceSize(
+          Size(width.toDouble(), size.height + 64),
+        );
+        await tester.pump();
+        await screenMatchesGolden(
+          tester,
+          '$name/$slug',
+          customPump: (tester) async {
+            await tester.pumpAndSettle();
+          },
+        );
+        if (cleanup != null) {
+          await cleanup();
+        }
+        await tester.pumpAndSettle();
+      }
+    }
+  }
+}
diff --git a/test/goldens/ImpWidget/Idle/l-dark.png b/test/goldens/ImpWidget/Idle/l-dark.png
diff --git a/test/goldens/ImpWidget/Idle/l-light.png b/test/goldens/ImpWidget/Idle/l-light.png
diff --git a/test/goldens/ImpWidget/Idle/m-dark.png b/test/goldens/ImpWidget/Idle/m-dark.png
diff --git a/test/goldens/ImpWidget/Idle/m-light.png b/test/goldens/ImpWidget/Idle/m-light.png
diff --git a/test/goldens/ImpWidget/Idle/s-dark.png b/test/goldens/ImpWidget/Idle/s-dark.png
diff --git a/test/goldens/ImpWidget/Idle/s-light.png b/test/goldens/ImpWidget/Idle/s-light.png
diff --git a/test/goldens/ImpWidget/Measure Complete/l-dark.png b/test/goldens/ImpWidget/Measure Complete/l-dark.png
diff --git a/test/goldens/ImpWidget/Measure Complete/l-light.png b/test/goldens/ImpWidget/Measure Complete/l-light.png
diff --git a/test/goldens/ImpWidget/Measure Complete/m-dark.png b/test/goldens/ImpWidget/Measure Complete/m-dark.png
diff --git a/test/goldens/ImpWidget/Measure Complete/m-light.png b/test/goldens/ImpWidget/Measure Complete/m-light.png
diff --git a/test/goldens/ImpWidget/Measure Complete/s-dark.png b/test/goldens/ImpWidget/Measure Complete/s-dark.png
diff --git a/test/goldens/ImpWidget/Measure Complete/s-light.png b/test/goldens/ImpWidget/Measure Complete/s-light.png
diff --git a/test/goldens/ImpWidget/Measure Fail/l-dark.png b/test/goldens/ImpWidget/Measure Fail/l-dark.png
diff --git a/test/goldens/ImpWidget/Measure Fail/l-light.png b/test/goldens/ImpWidget/Measure Fail/l-light.png
diff --git a/test/goldens/ImpWidget/Measure Fail/m-dark.png b/test/goldens/ImpWidget/Measure Fail/m-dark.png
diff --git a/test/goldens/ImpWidget/Measure Fail/m-light.png b/test/goldens/ImpWidget/Measure Fail/m-light.png
diff --git a/test/goldens/ImpWidget/Measure Fail/s-dark.png b/test/goldens/ImpWidget/Measure Fail/s-dark.png
diff --git a/test/goldens/ImpWidget/Measure Fail/s-light.png b/test/goldens/ImpWidget/Measure Fail/s-light.png
diff --git a/test/goldens/ImpWidget/Measuring/l-dark.png b/test/goldens/ImpWidget/Measuring/l-dark.png
diff --git a/test/goldens/ImpWidget/Measuring/l-light.png b/test/goldens/ImpWidget/Measuring/l-light.png
diff --git a/test/goldens/ImpWidget/Measuring/m-dark.png b/test/goldens/ImpWidget/Measuring/m-dark.png
diff --git a/test/goldens/ImpWidget/Measuring/m-light.png b/test/goldens/ImpWidget/Measuring/m-light.png
diff --git a/test/goldens/ImpWidget/Measuring/s-dark.png b/test/goldens/ImpWidget/Measuring/s-dark.png
diff --git a/test/goldens/ImpWidget/Measuring/s-light.png b/test/goldens/ImpWidget/Measuring/s-light.png
diff --git a/test/goldens/ImpWidget/Priming/l-dark.png b/test/goldens/ImpWidget/Priming/l-dark.png
diff --git a/test/goldens/ImpWidget/Priming/l-light.png b/test/goldens/ImpWidget/Priming/l-light.png
diff --git a/test/goldens/ImpWidget/Priming/m-dark.png b/test/goldens/ImpWidget/Priming/m-dark.png
diff --git a/test/goldens/ImpWidget/Priming/m-light.png b/test/goldens/ImpWidget/Priming/m-light.png
diff --git a/test/goldens/ImpWidget/Priming/s-dark.png b/test/goldens/ImpWidget/Priming/s-dark.png
diff --git a/test/goldens/ImpWidget/Priming/s-light.png b/test/goldens/ImpWidget/Priming/s-light.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/l-dark.png b/test/goldens/ImpWidget/Waiting for measurement/l-dark.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/l-light.png b/test/goldens/ImpWidget/Waiting for measurement/l-light.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/m-dark.png b/test/goldens/ImpWidget/Waiting for measurement/m-dark.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/m-light.png b/test/goldens/ImpWidget/Waiting for measurement/m-light.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/s-dark.png b/test/goldens/ImpWidget/Waiting for measurement/s-dark.png
diff --git a/test/goldens/ImpWidget/Waiting for measurement/s-light.png b/test/goldens/ImpWidget/Waiting for measurement/s-light.png
diff --git a/...fault_identification_ui_builder_test.dart → test/imp_kit_test.dart b/...fault_identification_ui_builder_test.dart → test/imp_kit_test.dart
@@ -1,9 +1,9 @@
 import 'package:flutter_test/flutter_test.dart';
 
 void main() {
-  group('pChipKit', () {
+  group('ImpKit', () {
     test(' test suite example', () {
       expect(1, 1);
     });
   });
-}
+}
diff --git a/test/imp_widget_test.dart b/test/imp_widget_test.dart
@@ -0,0 +1,210 @@
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:golden_toolkit/golden_toolkit.dart';
+import 'package:mtrust_imp_kit/mtrust_imp_kit.dart';
+import 'package:mtrust_imp_kit/src/format_utils.dart';
+
+import 'golden_utils.dart';
+import 'test_utils.dart';
+
+void main() {
+  testGoldens('ImpWidget', (WidgetTester test) async {
+    urpUiDisableAnimations = true;
+
+    await multiGolden(
+      test,
+      'ImpWidget',
+      {
+        'Idle': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+          return null;
+        },
+        'Priming': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.byKey(const Key('connect_button')));
+
+          return () async {
+            strategy.primeCompleter.complete();
+          };
+        },
+        'Waiting for measurement': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.byKey(const Key('connect_button')));
+
+          await tester.pumpAndSettle();
+
+          strategy.primeCompleter.complete();
+
+          await tester.pumpAndSettle();
+
+          return () async {
+            strategy.startMeasurementCompleter.complete();
+          };
+        },
+        'Measuring': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.byKey(const Key('connect_button')));
+
+          await tester.pumpAndSettle();
+
+          strategy.primeCompleter.complete();
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.text('Start reading'));
+
+          await tester.pumpAndSettle();
+
+          return () async {
+            strategy.startMeasurementCompleter.complete();
+          };
+        },
+        'Measure Fail': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.byKey(const Key('connect_button')));
+
+          await tester.pumpAndSettle();
+
+          strategy.primeCompleter.complete();
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.text('Start reading'));
+
+          strategy.startMeasurementCompleter.completeError('');
+
+          await tester.pumpAndSettle();
+
+          return () async {};
+        },
+        'Measure Complete': (tester, place) async {
+          final strategy = CompleterStrategy(withReaders: true);
+
+          final storageAdapter = MockStorageAdapter();
+
+          await place(
+            AspectRatio(
+              aspectRatio: 1,
+              child: ImpWidget(
+                connectionStrategy: strategy.strategy,
+                storageAdapter: storageAdapter,
+                chipIdFormat: ChipIdFormat.hex,
+                onIdentificationDone: (_) async {},
+                onIdentificationFailed: () async {},
+              ),
+            ),
+          );
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.byKey(const Key('connect_button')));
+
+          await tester.pumpAndSettle();
+
+          strategy.primeCompleter.complete();
+
+          await tester.pumpAndSettle();
+
+          await tester.tap(find.text('Start reading'));
+
+          strategy.startMeasurementCompleter.complete();
+
+          await tester.pumpAndSettle();
+
+          return () async {};
+        },
+      },
+      width: 500,
+    );
+  });
+}