Write golden image tests (#213)

Author: daohoangson

.github/workflows/flutter.yml

@@ -10,7 +10,7 @@ env:
   GIT_CRYPT_KEY: ${{ secrets.GIT_CRYPT_KEY }}
 
 jobs:
-  build_apk:
+  test:
     if: ${{ startsWith(github.ref, 'refs/heads/') }}
     runs-on: ubuntu-latest
     steps:
@@ -19,6 +19,38 @@ jobs:
         run: |
           set -e
 
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          bash ./.github/workflows/prepare.sh
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          flutter-version: ${{ env.FLUTTER_VERSION }}
+
+      - name: Prepare packages/api
+        run: |
+          set -e
+
+          cd ./packages/api
+          ./tool/build.sh
+          flutter test --coverage
+      - run: flutter test --coverage
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: failures
+          path: "**/failures/*.png"
+      - uses: codecov/codecov-action@v3
+
+  build_apk:
+    if: ${{ github.ref == 'refs/heads/master' || contains(github.ref, 'android') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Prepare repo
+        run: |
+          set -e
+
           eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
           bash ./.github/workflows/prepare.sh
 

.gitignore

@@ -1,3 +1,6 @@
+/coverage/
+**/failures/*.png
+
 /android/fastlane/README.md
 /android/fastlane/report.xml
 /ios/Flutter/.last_build_id

dart_test.yaml

@@ -0,0 +1,2 @@
+tags:
+  golden:

lib/main.dart

@@ -4,6 +4,7 @@ import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:provider/provider.dart';
 import 'package:the_app/src/abstracts/error_reporting.dart' as error_reporting;
 import 'package:the_app/src/abstracts/firebase.dart' as firebase;
+import 'package:the_app/src/abstracts/http.dart' as http;
 import 'package:the_app/src/intl.dart';
 import 'package:the_app/src/link.dart';
 import 'package:the_app/src/screens/home.dart';
@@ -74,6 +75,7 @@ class MyApp extends StatelessWidget {
           ChangeNotifierProvider<DarkTheme>.value(value: darkTheme),
           ChangeNotifierProvider<DevTools>.value(value: devTools),
           ChangeNotifierProvider<FontScale>.value(value: fontScale),
+          Provider(create: (_) => http.configureHttpClient()),
         ],
         child: Builder(builder: (context) => _buildApp(context)),
       );

lib/src/abstracts/cached_network_image.dart

@@ -0,0 +1,32 @@
+import 'package:cached_network_image/cached_network_image.dart' as lib;
+import 'package:flutter/material.dart';
+import 'package:flutter_cache_manager/flutter_cache_manager.dart' as lib;
+
+@visibleForTesting
+lib.BaseCacheManager? debugCacheManager;
+
+lib.BaseCacheManager get manager =>
+    debugCacheManager ?? lib.DefaultCacheManager();
+
+ImageProvider image(String url) =>
+    lib.CachedNetworkImageProvider(url, cacheManager: manager);
+
+class ImageWidget extends StatelessWidget {
+  final String imageUrl;
+
+  const ImageWidget(this.imageUrl, {super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return lib.CachedNetworkImage(
+      cacheManager: manager,
+      errorWidget: (_, __, ___) => const DecoratedBox(
+        decoration: BoxDecoration(
+          color: Colors.grey,
+        ),
+      ),
+      fit: BoxFit.cover,
+      imageUrl: imageUrl,
+    );
+  }
+}

lib/src/abstracts/http.dart

@@ -0,0 +1,3 @@
+import 'package:http/http.dart' as lib;
+
+lib.Client configureHttpClient() => lib.Client();

lib/src/abstracts/progress_indicator.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/material.dart';
+
+@visibleForTesting
+var debugDeterministic = false;
+
+class AdaptiveProgressIndicator extends StatelessWidget {
+  final double? value;
+
+  const AdaptiveProgressIndicator({super.key, this.value});
+
+  @override
+  Widget build(BuildContext context) {
+    return Center(
+      child: debugDeterministic
+          ? const Text('Loading...')
+          : CircularProgressIndicator.adaptive(value: value),
+    );
+  }
+}

lib/src/api.dart

@@ -4,6 +4,7 @@ import 'dart:io';
 import 'package:flutter/material.dart';
 import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:flutter_widget_from_html/flutter_widget_from_html.dart';
+import 'package:http/http.dart' as http;
 import 'package:provider/provider.dart';
 import 'package:the_api/api.dart';
 import 'package:the_api/oauth_token.dart';
@@ -172,22 +173,21 @@ typedef ApiOnJsonMap = void Function(Map jsonMap);
 typedef ApiOnError = void Function(dynamic error);
 
 class ApiApp extends StatefulWidget {
-  final Api api;
   final Widget child;
+  final bool enableBatch;
 
-  ApiApp({
+  const ApiApp({
     required this.child,
+    this.enableBatch = true,
     Key? key,
-  })  : api = Api(config.apiRoot, config.clientId, config.clientSecret)
-          ..httpHeaders['Api-Bb-Code-Chr'] = '1'
-          ..httpHeaders['Api-Post-Tree'] = '1',
-        super(key: key);
+  }) : super(key: key);
 
   @override
   State<ApiApp> createState() => _ApiAppState();
 }
 
 class _ApiAppState extends State<ApiApp> {
+  late final Api api;
   final secureStorage = const FlutterSecureStorage();
   final visitor = User.zero();
 
@@ -196,15 +196,25 @@ class _ApiAppState extends State<ApiApp> {
   OauthToken? _token;
   var _tokenHasBeenSet = false;
 
-  Api get api => widget.api;
-
   String get _secureStorageKeyToken =>
       kSecureStorageKeyPrefixToken + api.clientId;
 
   @override
   void initState() {
     super.initState();
 
+    api = Api(
+      context.read<http.Client>(),
+      apiRoot: config.apiRoot,
+      clientId: config.clientId,
+      clientSecret: config.clientSecret,
+      enableBatch: widget.enableBatch,
+      httpHeaders: const {
+        'Api-Bb-Code-Chr': '1',
+        'Api-Post-Tree': '1',
+      },
+    );
+
     secureStorage.read(key: _secureStorageKeyToken).then<OauthToken?>(
       (value) {
         try {

lib/src/intl.dart

@@ -3,8 +3,13 @@ import 'package:intl/intl.dart';
 import 'package:the_app/l10n/messages_all.dart';
 import 'package:timeago/timeago.dart' as timeago;
 
+@visibleForTesting
+DateTime? debugClock;
+
 final _numberFormatCompact = NumberFormat.compact();
 
+DateTime get _clock => debugClock ?? DateTime.now();
+
 L10n l(BuildContext context) => Localizations.of<L10n>(context, L10n)!;
 
 MaterialLocalizations lm(BuildContext context) =>
@@ -388,8 +393,9 @@ class L10n {
       Intl.message('Unignore', locale: localeName, name: 'userUnignore');
 
   static Future<L10n> load(Locale locale) {
+    final countryCode = locale.countryCode ?? '';
     final localeName = Intl.canonicalizedLocale(
-        locale.countryCode!.isEmpty ? locale.languageCode : locale.toString());
+        countryCode.isEmpty ? locale.languageCode : locale.toString());
     return initializeMessages(localeName).then((_) => L10n(localeName));
   }
 }
@@ -419,9 +425,10 @@ String formatTimestamp(BuildContext context, int? timestamp) {
   if (timestamp == null) return '';
 
   final d = secondsToDateTime(timestamp);
-  if (DateTime.now().subtract(const Duration(days: 30)).isBefore(d)) {
+  final clock = _clock;
+  if (clock.subtract(const Duration(days: 30)).isBefore(d)) {
     final locale = Localizations.localeOf(context).languageCode;
-    return timeago.format(d, locale: locale);
+    return timeago.format(d, clock: clock, locale: locale);
   }
 
   // TODO: use date format from device locale

lib/src/screens/initial_path.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:the_app/src/abstracts/progress_indicator.dart';
 import 'package:the_app/src/api.dart';
 import 'package:the_app/src/link.dart';
 import 'package:the_app/src/screens/home.dart';
@@ -68,7 +69,7 @@ class _InitialPathState extends State<InitialPathScreen>
       : FutureBuilder<Widget>(
           builder: (__, snapshot) =>
               snapshot.data ??
-              const Scaffold(body: Center(child: CircularProgressIndicator())),
+              const Scaffold(body: AdaptiveProgressIndicator()),
           future: _future,
         );
 }