setting up integration tests on CI

Author: denis-zhdanov

integration_test/category/category_manager_integration_test.dart

@@ -1,7 +1,7 @@
 import 'dart:convert';
 
 import 'package:chrono_sheet/category/model/icon_info.dart';
-import 'package:chrono_sheet/category/service/category_manager.dart';
+import 'package:chrono_sheet/category/service/shared_category_data_manager.dart';
 import 'package:chrono_sheet/google/drive/service/google_drive_service.dart';
 import 'package:chrono_sheet/main.dart' as app;
 import 'package:chrono_sheet/sheet/model/sheet_model.dart';
@@ -36,8 +36,7 @@ void main() {
     await gService.getOrCreateFile(remoteDirId, testContext.testId, sheetMimeType, true);
   }
 
-  // TODO name accordingly
-  testWidgets("integration-test", (WidgetTester tester) async {
+  testWidgets("saving category icons in remote storage", (WidgetTester tester) async {
     final main = MainScreenDriver(tester);
     final chooseSheet = ChooseSheetScreenDriver(tester);
     final manageCategory = ManageCategoryScreenDriver(tester);
@@ -48,7 +47,7 @@ void main() {
     app.main();
     await tester.pumpAndSettle();
 
-    await main.clickSelectFile();
+    await main.clickSelectGoogleFile();
     await chooseSheet.selectTestSheet();
 
     await main.clickAddCategory();

integration_test/framework/driver/category/manage/category_manage_screen_driver.dart

@@ -1,19 +1,23 @@
 import 'dart:io';
 
 import 'package:chrono_sheet/category/service/category_icon_selector.dart';
+import 'package:chrono_sheet/log/util/log_util.dart';
 import 'package:chrono_sheet/ui/widget_key.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 import '../../../../../test_common/context/test_context.dart';
 
+final _logger = getNamedLogger();
+
 class ManageCategoryScreenDriver {
 
   final WidgetTester tester;
 
   ManageCategoryScreenDriver(this.tester);
 
   Future<void> setCategoryName(String name) async {
+    _logger.info("setting active category name as '$name'");
     final nameField = find.byKey(AppWidgetKey.manageCategoryName);
     expect(nameField, findsOneWidget);
 
@@ -22,7 +26,9 @@ class ManageCategoryScreenDriver {
   }
 
   Future<void> selectIcon(String icon) async {
-    final iconFile = File("${TestContext.current.rootLocalDirPath}/$icon");
+    final iconPath = "${TestContext.current.rootLocalDirPath}/$icon";
+    _logger.info("selecting category icon from path $iconPath");
+    final iconFile = File(iconPath);
     if (!iconFile.existsSync()) {
       throw AssertionError("icon file with name '$icon' does not exist at path: ${iconFile.path}");
     }
@@ -38,6 +44,7 @@ class ManageCategoryScreenDriver {
   }
 
   Future<void> saveChanges() async {
+    _logger.info("saving category changes");
     final saveButton = find.byKey(AppWidgetKey.saveCategoryState);
     expect(saveButton, findsOneWidget);
 

integration_test/framework/driver/choose_sheet/choose_sheet_driver.dart

@@ -1,21 +1,27 @@
+import 'package:chrono_sheet/log/util/log_util.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 import '../../../../test_common/context/test_context.dart';
 import '../../../category/integration_test_common.dart';
 
+final _logger = getNamedLogger();
+
 class ChooseSheetScreenDriver {
   final WidgetTester tester;
 
   const ChooseSheetScreenDriver(this.tester);
 
   Future<void> selectTestSheet() async {
-    final fileFinder = find.widgetWithText(ListTile, TestContext.current.testId);
+    final sheetName = TestContext.current.testId;
+    final fileFinder = find.widgetWithText(ListTile, sheetName);
     await UiVerificationUtil.waitForWidget(
       description: "a google sheet created for the current test",
       tester: tester,
       finder: fileFinder,
     );
+    _logger.info("selected google sheet file '$sheetName'");
+
     await tester.tap(fileFinder);
     await tester.pumpAndSettle();
   }

integration_test/framework/driver/main/main_screen_driver.dart

@@ -1,13 +1,17 @@
+import 'package:chrono_sheet/log/util/log_util.dart';
 import 'package:chrono_sheet/ui/widget_key.dart';
 import 'package:flutter_test/flutter_test.dart';
 
+final _logger = getNamedLogger();
+
 class MainScreenDriver {
 
   final WidgetTester tester;
 
   MainScreenDriver(this.tester);
 
-  Future<void> clickSelectFile() async {
+  Future<void> clickSelectGoogleFile() async {
+    _logger.info("clicking 'select google file' widget");
     final selectFileWidget = find.byKey(AppWidgetKey.selectFile);
     expect(selectFileWidget, findsOneWidget);
 
@@ -16,6 +20,7 @@ class MainScreenDriver {
   }
 
   Future<void> clickAddCategory() async {
+    _logger.info("clicking 'add category' widget");
     final createCategoryButton = find.byKey(AppWidgetKey.createCategory);
     expect(createCategoryButton, findsOneWidget);
 

lib/category/model/category.dart

@@ -1,7 +1,10 @@
 import 'package:chrono_sheet/category/model/category_representation.dart';
+import 'package:chrono_sheet/log/util/log_util.dart';
 import 'package:flutter/foundation.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
+final _logger = getNamedLogger();
+
 class _Key {
   static String getName(String keyPrefix) {
     return "$keyPrefix.name";
@@ -44,6 +47,7 @@ final class Category implements Comparable<Category> {
     await prefs.setString(_Key.getName(keyPrefix), name);
     await prefs.setBool(_Key.getPersistedInGoogle(keyPrefix), persistedInGoogle);
     await representation.serialize(prefs, keyPrefix);
+    _logger.fine("stored category $this into a local storage under key prefix '$keyPrefix'");
   }
 
   static Future<Category?> deserialiseIfPossible(SharedPreferencesAsync prefs, String keyPrefix) async {

lib/category/service/category_manager.g.dart

@@ -22,8 +22,8 @@ final _logger = getNamedLogger();
 typedef _CategoriesToInfo = Map<String, IconInfo>;
 
 @Riverpod(keepAlive: true)
-CategoryManager categoryManager(Ref ref) {
-  return CategoryManager();
+SharedCategoryDataManager categoryManager(Ref ref) {
+  return SharedCategoryDataManager();
 }
 
 class _Key {
@@ -59,7 +59,7 @@ class CategoryGooglePaths {
   static String get picturesDirPath => "$rootDirPathToUse/pictures";
 }
 
-class CategoryManager {
+class SharedCategoryDataManager {
   final _prefs = SharedPreferencesAsync();
   final driveService = GoogleDriveService();
   DateTime? _startTime;
@@ -75,7 +75,7 @@ class CategoryManager {
       final diff = now.difference(start);
       if (diff.inMinutes < 10) {
         _logger.info(
-          "skipped picture manager tick because only ${diff.inMinutes} minutes elapsed since the last check",
+          "skipped category manager tick because only ${diff.inMinutes} minutes elapsed since the last check",
         );
         return;
       }
@@ -84,8 +84,10 @@ class CategoryManager {
     var online = await isOnline();
     if (!online) {
       _logger.info("skipped picture manager tick because the application is offline");
+      return;
     }
 
+    _logger.info("checking if we need to sync local and remote categories info");
     _startTime = now;
     try {
       await _handlePendingCategoryRenames();
@@ -106,7 +108,7 @@ class CategoryManager {
   }
 
   Future<_CategoriesToInfo> _getRemoteInfo() async {
-    _logger.info("start downloading remote pictures infos");
+    _logger.info("start fetching remote categories infos");
     final directoryId = await _getGoogleDirectoryId(CategoryGooglePaths.mappingDirPath);
     final driveFiles = await driveService.listFiles(directoryId);
     final result = <String, IconInfo>{};
@@ -149,7 +151,7 @@ class CategoryManager {
 
     final files = rootDir.listSync();
     final Map<String, IconInfo> result = {};
-    _logger.fine("found ${files.length} category mapping files in directory ${rootDir.path}");
+    _logger.fine("found ${files.length} category mapping file(s) in directory ${rootDir.path}");
     for (final file in files) {
       if (file is File) {
         final categoryName = p.basename(file.path);
@@ -257,24 +259,28 @@ class CategoryManager {
   }
 
   Future<void> onNewCategory(Category category) async {
+    _logger.fine("got information about new category '$category'");
     await category.serialize(_prefs, _Key.getCategory(category.name));
     final representation = category.representation;
     if (representation is! ImageCategoryRepresentation) {
-      _logger.fine("skip category change as it doesn't have image representations: $category");
+      _logger.fine("skip new category processing as it doesn't have image representations: $category");
       return;
     }
     final iconFile = representation.file;
     final mappingFile = File("${_getLocalDataDir().path}/${category.name}");
     final parentDir = mappingFile.parent;
     if (mappingFile.existsSync()) {
       mappingFile.deleteSync();
+      _logger.fine("deleted previous local category mapping file for category '${category.name}': ${mappingFile.path}");
     } else if (!parentDir.existsSync()) {
       await parentDir.create(recursive: true);
-      _logger.info("created a directory for storing categories meta info: ${parentDir.path}");
+      _logger.info("created a local directory for storing categories meta info: ${parentDir.path}");
     }
     final content = "${iconFile.path},${clockProvider.now().toIso8601String()}";
     mappingFile.writeAsStringSync(content);
-    _logger.info("written '$content' into category meta info file ${mappingFile.path} for category ${category.name}");
+    _logger.info(
+      "wrote category meta info for category '${category.name}' into local file ${mappingFile.path}: $content",
+    );
     await tick(true);
   }
 

…b/category/service/category_manager.dart …ervice/shared_category_data_manager.dartlib/category/service/category_manager.dart renamed to lib/category/service/shared_category_data_manager.dart lib/category/service/category_manager.dart renamed to lib/category/service/shared_category_data_manager.dart

@@ -5,7 +5,7 @@ import 'package:chrono_sheet/category/model/category_representation.dart';
 import 'package:chrono_sheet/file/state/file_state.dart';
 import 'package:chrono_sheet/generated/app_localizations.dart';
 import 'package:chrono_sheet/log/util/log_util.dart';
-import 'package:chrono_sheet/category/service/category_manager.dart';
+import 'package:chrono_sheet/category/service/shared_category_data_manager.dart';
 import 'package:chrono_sheet/sheet/model/sheet_model.dart';
 import 'package:chrono_sheet/sheet/parser/sheet_parser.dart';
 import 'package:chrono_sheet/util/regexp_util.dart';
@@ -91,18 +91,18 @@ class CategoriesStateManager extends _$CategoryStateManager {
     if (selectedFile == null) {
       return CategoriesState.empty;
     }
-    final cached = await _readCachedCategoryState(selectedFile);
-    if (cached == null) {
+    final local = await _readLocalCategoryState(selectedFile);
+    if (local == null) {
       final result = await _parseAndApplyCategoriesFromSheet(selectedFile);
       return result.match((error) => CategoriesState(), (newState) => newState);
     } else {
-      _logger.info("found cached category state: $cached");
+      _logger.info("found local category state: $local");
       _parseAndApplyCategoriesFromSheet(selectedFile).then((result) {
         result.map((newState) {
           state = AsyncValue.data(newState);
         });
       });
-      return cached;
+      return local;
     }
   }
 
@@ -117,11 +117,11 @@ class CategoriesStateManager extends _$CategoryStateManager {
       (categoryNamesFromFile) async {
         _logger.info("fetched remote categories: $categoryNamesFromFile");
         final currentState = state;
-        CategoriesState? cached;
+        CategoriesState? local;
         if (currentState is AsyncData) {
-          cached = currentState.value;
+          local = currentState.value;
         }
-        final newCategoryState = await _merge(cached, categoryNamesFromFile);
+        final newCategoryState = await _merge(local, categoryNamesFromFile);
         await _cacheCategoryState(newCategoryState, file);
         return Either.right(newCategoryState);
       },
@@ -140,7 +140,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
     );
   }
 
-  Future<CategoriesState?> _readCachedCategoryState(GoogleFile file) async {
+  Future<CategoriesState?> _readLocalCategoryState(GoogleFile file) async {
     List<Category> categories = [];
     Set<String> usedCategories = {};
     for (int i = 0; ; i++) {
@@ -156,7 +156,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
       categories.add(category);
     }
     _logger.info(
-      "found ${categories.length} cached categories for file ${file.id} (${file.name}): \n${categories.join("\n")}",
+      "found ${categories.length} local category(ies) for file ${file.id} (${file.name}): \n${categories.join("\n")}",
     );
     if (categories.isEmpty) {
       return null;
@@ -264,12 +264,12 @@ class CategoriesStateManager extends _$CategoryStateManager {
     return {s1: _getDefaultRepresentationText(s1), s2: _getDefaultRepresentationText(s2)};
   }
 
-  Future<CategoriesState> _merge(CategoriesState? cached, List<String> currentCategoryNames) async {
-    _logger.info("merging cached categories state (\n$cached\n) and current categories ($currentCategoryNames)");
-    if (currentCategoryNames.isEmpty && (cached?.categories.all((c) => c.persistedInGoogle) ?? true)) {
+  Future<CategoriesState> _merge(CategoriesState? local, List<String> currentCategoryNames) async {
+    _logger.info("merging local categories state (\n$local\n) and current categories (\n$currentCategoryNames\n)");
+    if (currentCategoryNames.isEmpty && (local?.categories.all((c) => c.persistedInGoogle) ?? true)) {
       return CategoriesState.empty;
     }
-    if (cached == null) {
+    if (local == null) {
       List<Category> categories = await Future.wait(
         currentCategoryNames.map((name) async {
           return await _getCategoryByName(name);
@@ -279,12 +279,12 @@ class CategoriesStateManager extends _$CategoryStateManager {
       final selected = categories.first;
       return CategoriesState(selected: selected, categories: categories);
     }
-    List<Category> sortedCategories = List.of(cached.categories);
+    List<Category> sortedCategories = List.of(local.categories);
     sortedCategories.removeWhere(
       (category) => !currentCategoryNames.contains(category.name) && category.persistedInGoogle,
     );
-    final Set<String> cachedCategoryNames = Set.of(cached.categories.map((c) => c.name));
-    final categoryNamesToAdd = currentCategoryNames.where((name) => !cachedCategoryNames.contains(name));
+    final Set<String> localCategoryNames = Set.of(local.categories.map((c) => c.name));
+    final categoryNamesToAdd = currentCategoryNames.where((name) => !localCategoryNames.contains(name));
     final categoriesToAdd = await Future.wait(
       categoryNamesToAdd.map((name) async {
         return await _getCategoryByName(name);
@@ -294,7 +294,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
 
     sortedCategories = ensureNoDuplicateTextRepresentations(sortedCategories);
 
-    Category? selected = cached.selected;
+    Category? selected = local.selected;
     if (selected == null || !currentCategoryNames.contains(selected.name)) {
       selected = sortedCategories.first;
     }
@@ -334,7 +334,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
     for (int i = 0; i < categories.length; i++) {
       await _prefs.setString(_Key.getFileCategoryPrefix(fileToUse, i), categories[i].name);
     }
-    _logger.info("cached categories state for file ${fileToUse.id} (${fileToUse.name}): $state");
+    _logger.info("local categories state for file ${fileToUse.id} (${fileToUse.name}): $state");
     return ManageCategoryResult.success;
   }
 
@@ -360,6 +360,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
   }
 
   Future<ManageCategoryResult> addNewCategory(Category category) async {
+    _logger.info("got a request to add category $category");
     final currentState = await future;
     final withConflictingName = _findCategoryWithName(currentState, category.name);
     if (withConflictingName != null) {
@@ -374,7 +375,7 @@ class CategoriesStateManager extends _$CategoryStateManager {
     state = AsyncValue.data(newState);
     final result = await _cacheCategoryState(newState);
     if (result == ManageCategoryResult.success) {
-      _logger.info("categories state after adding new category '$category': $newState");
+      _logger.info("successfully added category $category");
     }
 
     ref.read(categoryManagerProvider).onNewCategory(category);