fix(cat-voices): flutter integration tests (#3257)

* test(cat-voices): fix integration tests - part 1 (#3061)

* test(cat-voices): fix integration tests

* building flutter driver and simplest test

* fix previous commit

* update docs

* export test utils

* prepare for test accounts

* test account

* optional unlocked flag

* app test

* remove warnings

* allow awaiting video and asset cache initialisation

* allow calling bootstrap in SetUp method

* allow awaiting ImagePrecacheService

* app tests

* account cubit safe checks emits

* account tests

* chore: remove debug prints

* rollback timeline change

* simplify tests and fix analyzer

* update UserService tests names

* RegistrationService createAccount masterKey.use

* improve ImagePrecacheService and VideoManager isInitialized completer logic

* chore: missing TODO comment

* chore: TODO about test accounts

* feat: awaiting db operations completion

* cleanup

* rollback timeline change

* remove SemanticsBinding

* chore: formatting

---------

Co-authored-by: Servercic <[email protected]>
Co-authored-by: Damian Moliński <[email protected]>
Co-authored-by: Damian Molinski <[email protected]>

* chore: code formatting (#3230)

* fix(cat-voices): flutter integration tests - part3 (#3240)

* fund name text

* chore: bring back discovery tests

* Change DateTime with DateTimeExt

* feat: allow mocking CurrentCampaign and mocking DateTime so specific phase

* allow updating dummy

* chore: proposals tests

* onboarding tests

* recovery flow tests

* chore: more discovery tests

* fix: import

* chore: remove splash TODO comment

* chore: skip e2e integration tests

* fix: analysis

---------

Co-authored-by: Emir Hodzic <[email protected]>
Co-authored-by: Servercic <[email protected]>

Author: 3 people

catalyst_voices/apps/voices/integration_test/Earthfile

@@ -28,6 +28,7 @@ integration-test-web:
         sleep 5 && \
         flutter drive --driver=test_driver/integration_tests.dart \
             --target=integration_test/all_test.dart \
+            --dart-define=ENV_NAME=dev \
             -d $browser --driver-port=$driver_port \
             --web-header Cross-Origin-Opener-Policy=same-origin \
             --web-header Cross-Origin-Embedder-Policy=require-corp \

catalyst_voices/apps/voices/integration_test/README.md

@@ -74,13 +74,16 @@ To run the integration tests via the command line, use the following command:
 
 ```bash
 flutter drive \
+  --dart-define=ENV_NAME=dev \
   --web-header Cross-Origin-Opener-Policy=same-origin \
   --web-header Cross-Origin-Embedder-Policy=require-corp \
   --driver=test_driver/integration_tests.dart \
   --target=integration_test/all_test.dart \
   -d chrome
 ```
 
+Where `ENV_NAME` can be `dev`|`preprod`|`prod`|`relative`.
+
 ### Via Visual Studio Code
 
 To run the tests in Visual Studio Code,

catalyst_voices/apps/voices/integration_test/all_test.dart

@@ -1,25 +1,63 @@
 import 'package:catalyst_voices/configs/bootstrap.dart';
+import 'package:catalyst_voices/dependency/dependencies.dart';
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+import 'package:catalyst_voices_repositories/catalyst_voices_repositories.dart';
+import 'package:catalyst_voices_services/catalyst_voices_services.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
 
-import 'suites/account_test.dart' as account_test;
-import 'suites/app_test.dart' as app_test;
-import 'suites/discovery_test.dart' as discovery_test;
-import 'suites/onboarding_restore_test.dart' as onboarding_restore_test;
-import 'suites/onboarding_test.dart' as onboarding_test;
-import 'suites/proposals_test.dart' as proposals_test;
+import 'suites/suites.dart';
 
-void main() async {
+void main() {
   final binding = IntegrationTestWidgetsFlutterBinding.ensureInitialized();
-  binding.testTextInput.register();
 
   setUpAll(() async {
-    await bootstrap(router: buildAppRouter());
+    binding.testTextInput.register();
+
+    // F14
+    final f14Campaign = Campaign.f14();
+    mockedActiveCampaign = f14Campaign;
+
+    final proposalSubmissionTimeline = f14Campaign.timeline.phases
+        .firstWhere((element) => element.type == CampaignPhaseType.proposalSubmission)
+        .timeline;
+
+    final middle = proposalSubmissionTimeline.middle();
+
+    DateTimeExt.mockedDateTime = middle;
+  });
+
+  setUp(() async {
+    await bootstrap();
+
+    await loggingService.updateSettings(printToConsole: const Optional(false));
+
+    await Dependencies.instance.get<SyncManager>().waitForSync;
   });
-  app_test.main();
-  onboarding_restore_test.main();
-  onboarding_test.main();
-  account_test.main();
-  discovery_test.main();
-  proposals_test.main();
+
+  tearDown(() async {
+    await Dependencies.instance.get<CatalystDatabase>().pendingOperations;
+    // TODO(damian-molinski): sometimes tests are flaky because of pending db queries
+    // do not have time to finish. pendingOperations is not implemented correctly
+    await Future<void>.delayed(const Duration(milliseconds: 500));
+
+    await cleanUpStorages();
+    await cleanUpUserDataFromDatabase();
+    await Dependencies.instance.reset;
+  });
+
+  tearDownAll(() {
+    binding.testTextInput.unregister();
+  });
+
+  group('App -', appTests, skip: _skipE2EReason);
+  group('Account -', accountTests, skip: _skipE2EReason);
+  group('Discovery space -', discoverySpaceTests, skip: _skipE2EReason);
+  group('Onboarding -', onboardingTests, skip: _skipE2EReason);
+  // TODO(emiride): rethink how to setup tests accounts in different environments for gateway.
+  group('Onboarding Restore Flow -', onboardingRestoreTests, skip: _skipE2EReason);
+  group('Proposals space -', proposalsTests, skip: _skipE2EReason);
 }
+
+const _skipE2EReason = 'No maintained. Playwright implementation in progress';

catalyst_voices/apps/voices/integration_test/pageobject/account_dropdown_page.dart

@@ -5,7 +5,7 @@ import 'package:patrol_finders/patrol_finders.dart';
 import '../utils/translations_utils.dart';
 
 class AccountDropdownPage {
-  PatrolTester $;
+  final PatrolTester $;
   final profileAndKeychainText = const Key('ProfileAndKeychain');
 
   final popUpMenuAccountHeader = const Key('PopUpMenuAccountHeader');
@@ -18,6 +18,7 @@ class AccountDropdownPage {
   final redirectToDocsMenuItem = const Key('CatalystKnowledgeBase');
   final segmentedButtonContainer = const Key('segmentedButtonContainer');
   final lockAccountButton = const Key('LockAccountButton');
+
   AccountDropdownPage(this.$);
 
   Future<void> accountDropdownContainsSpecificData() async {
@@ -45,7 +46,6 @@ class AccountDropdownPage {
   Future<void> accountDropdownLooksAsExpected() async {
     expect($(profileAndKeychainText), findsOneWidget);
     expect($(segmentedButton), findsWidgets);
-    expect($(setupRolesMenuItem), findsOneWidget);
     expect($(lockAccountButton), findsOneWidget);
   }
 

catalyst_voices/apps/voices/integration_test/pageobject/app_bar_page.dart

@@ -6,20 +6,32 @@ import '../utils/constants.dart';
 import '../utils/translations_utils.dart';
 
 class AppBarPage {
-  late PatrolTester $;
+  final PatrolTester $;
+
   final spacesDrawerButton = const Key('DrawerButton');
   final getStartedBtn = const Key('GetStartedButton');
   final finishRegistrationBtn = const Key('FinishRegistrationButton');
   final accountPopupBtn = const Key('AccountPopupButton');
   final lockBtn = const Key('LockButton');
   final unlockBtn = const Key('UnlockButton');
+  final visitorBtn = const Key('VisitorBtn');
   final sessionAccountPopupMenuAvatar = const Key('SessionAccountPopupMenuAvatar');
+  final createProposalBtn = const Key('CreateProposalButton');
+
   AppBarPage(this.$);
 
   Future<void> accountPopupBtnClick() async {
     await $(sessionAccountPopupMenuAvatar).tap();
   }
 
+  Future<void> createProposalBtnIsNotVisible() async {
+    expect($(createProposalBtn), findsNothing);
+  }
+
+  Future<void> createProposalBtnIsVisible() async {
+    expect($(createProposalBtn), findsOneWidget);
+  }
+
   Future<void> finishAccountCreationBtnIsVisible() async {
     expect($(finishRegistrationBtn), findsOneWidget);
     expect(
@@ -32,6 +44,10 @@ class AppBarPage {
     await $(getStartedBtn).tap(settleTimeout: Time.short.duration);
   }
 
+  Future<bool> getStartedBtnExists() async {
+    return $(getStartedBtn).exists;
+  }
+
   Future<void> getStartedBtnIsVisible() async {
     expect($(getStartedBtn), findsOneWidget);
     expect($(getStartedBtn).$(Text).text, (await t()).getStarted);
@@ -43,10 +59,12 @@ class AppBarPage {
 
   Future<void> looksAsExpectedForVisitor() async {
     await getStartedBtnIsVisible();
+    await visitorBtnIsVisible();
   }
 
   Future<void> looksAsExpectedForVisitorOnboardingInProgress() async {
     await finishAccountCreationBtnIsVisible();
+    await visitorBtnIsVisible();
   }
 
   Future<void> sessionAccountPopupMenuAvatarIsVisible() async {
@@ -57,8 +75,8 @@ class AppBarPage {
     await $(spacesDrawerButton).waitUntilVisible().tap();
   }
 
-  Future<void> spacesDrawerButtonExists({bool? reverse = false}) async {
-    expect($(spacesDrawerButton).exists, !reverse!);
+  Future<void> spacesDrawerButtonExists({bool reverse = false}) async {
+    expect($(spacesDrawerButton).exists, !reverse);
   }
 
   Future<void> unlockBtnClick() async {
@@ -68,4 +86,8 @@ class AppBarPage {
   Future<void> unlockBtnIsVisible() async {
     expect($(unlockBtn), findsOneWidget);
   }
+
+  Future<void> visitorBtnIsVisible() async {
+    expect($(visitorBtn), findsOneWidget);
+  }
 }

catalyst_voices/apps/voices/integration_test/pageobject/common_page.dart

@@ -2,7 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:patrol_finders/patrol_finders.dart';
 
 class CommonPage {
-  late PatrolTester $;
+  final PatrolTester $;
 
   final decorData = const Key('DecoratorData');
   final decorIconBefore = const Key('DecoratorIconBefore');
@@ -16,5 +16,6 @@ class CommonPage {
   final errorRetryBtn = const Key('ErrorRetryBtn');
   final buttonFilledType = const Key('ButtonFilled');
   final buttonTextType = const Key('ButtonText');
+
   CommonPage(this.$);
 }

catalyst_voices/apps/voices/integration_test/pageobject/discovery/campaign_categories_section.dart

@@ -6,7 +6,7 @@ import '../../utils/translations_utils.dart';
 import '../discovery_page.dart';
 
 class CampaignCategoriesSection {
-  late PatrolTester $;
+  final PatrolTester $;
 
   final categoriesRoot = const Key('CampaignCategoriesStateSelector');
   final categoriesTitle = const Key('CampaignCategoriesTitle');
@@ -22,10 +22,11 @@ class CampaignCategoriesSection {
   final categoryDetailsButton = const Key('CategoryDetailsBtn');
   final viewProposalsButton = const Key('ViewProposalsBtn');
   final categoriesLoadingError = const Key('CampaignCategoriesError');
+
   CampaignCategoriesSection(this.$);
 
   Future<void> categoriesAreRenderedCorrectly() async {
-    for (var i = 0; i < 6; i++) {
+    for (var i = 0; i < 4; i++) {
       try {
         $(categoriesRoot).$(campaignCategories).at(i).$(description).visible;
       } catch (e) {

catalyst_voices/apps/voices/integration_test/pageobject/discovery/campaign_hero_section_page.dart

@@ -5,14 +5,16 @@ import 'package:patrol_finders/patrol_finders.dart';
 import '../../utils/translations_utils.dart';
 
 class CampaignHeroSection {
-  late PatrolTester $;
+  final PatrolTester $;
+
   final heroBackgroundVideo = const Key('HeroBackgroundVideo');
   final campaignBriefTitle = const Key('CampaignBriefTitle');
   final campaignBriefDescription = const Key('CampaignBriefDescription');
   final viewProposalsButton = const Key('ViewProposalsBtn');
   final unlockBtn = const Key('UnlockButton');
   final loadingError = const Key('ErrorIndicator');
   final campaignHeroSectionRoot = const Key('CampaignHeroSection');
+
   CampaignHeroSection(this.$);
 
   Future<void> campaignBriefDescriptionIsRenderedCorrectly() async {

catalyst_voices/apps/voices/integration_test/pageobject/discovery/current_campaign_selector_page.dart

@@ -8,9 +8,8 @@ import '../../utils/translations_utils.dart';
 import '../discovery_page.dart';
 
 class CurrentCampaignSection {
-  late PatrolTester $;
+  final PatrolTester $;
 
-  final currentCampaignRoot = const Key('CurrentCampaignRoot');
   final title = const Key('CurrentCampaignTitle');
   final subtitle = const Key('Subtitle');
   final description = const Key('Description');
@@ -24,12 +23,13 @@ class CurrentCampaignSection {
   final timelineCard = const Key('TimelineCard');
   final campaignTimelineComponent = const Key('CampaignTimeline');
   final timelineCardTitle = const Key('TimelineCardTitle');
-  final timelineCardDate = const Key('TimelineCardDate');
   final currentCampaignLoadingError = const Key('CurrentCampaignError');
+
   CurrentCampaignSection(this.$);
 
   Future<void> campaignDetailsAreRenderedCorrectly() async {
-    await $(fundsDetailCard).$(fundsDetailAskRangeMax).$(#Title).scrollTo();
+    await $(fundsDetailCard).scrollTo();
+
     expect(
       $(fundsDetailCard).$(fundsDetailBudget).$(#Title).text,
       (await t()).campaignTreasury,
@@ -54,34 +54,16 @@ class CurrentCampaignSection {
       $(fundsDetailCard).$(fundsDetailRequested).$(#Funds).text!.isNotEmpty,
       isTrue,
     );
-    expect(
-      $(fundsDetailCard).$(fundsDetailAskRangeMax).$(#Title).text,
-      (await t()).maximumAsk,
-    );
-    expect(
-      $(fundsDetailCard).$(fundsDetailAskRangeMax).$(#Value).text!.isNotEmpty,
-      isTrue,
-    );
-    expect(
-      $(fundsDetailCard).$(fundsDetailAskRangeMax).$(#Value).text!.isNotEmpty,
-      isTrue,
-    );
-    await $(currentCampaignRoot).$(ideaSubTitle).scrollTo(step: 150);
-    expect(
-      $(currentCampaignRoot).$(ideaSubTitle).text,
-      (await t()).ideaJourney,
-    );
-    final descriptionText = $.tester
-        .widget<MarkdownBody>(
-          $(currentCampaignRoot).$(ideaDescription).$(MarkdownBody),
-        )
-        .data;
+
+    await $(ideaSubTitle).scrollTo(step: 150);
+    expect($(ideaSubTitle).text, (await t()).ideaJourney);
+    final descriptionText = $.tester.widget<MarkdownBody>($(ideaDescription).$(MarkdownBody)).data;
     final textToMatch = (await t())
         .ideaJourneyDescription(VoicesConstants.campaignTimeline)
         .split('#### ')[1]
         .split('[fund timeline]')[0];
     expect(descriptionText.indexOf(textToMatch), greaterThanOrEqualTo(1));
-    expect($(currentCampaignRoot).$(timelineCard), findsExactly(5));
+    expect($(timelineCard), findsExactly(6));
   }
 
   Future<void> descriptionIsRenderedCorrectly() async {
@@ -98,35 +80,23 @@ class CurrentCampaignSection {
   }
 
   Future<void> subtitleIsRenderedCorrectly() async {
-    expect($(subtitle).text?.startsWith('Catalyst Fund '), true);
+    expect($(subtitle).text?.startsWith('Catalyst Fund'), true);
   }
 
   Future<void> timelineCardsDataIsRendered() async {
     await descriptionIsRenderedCorrectly();
     await DiscoveryPage($).loadRetryOnError(currentCampaignLoadingError);
-    await $(currentCampaignRoot).$(timelineCard).at(0).$(timelineCardDate).scrollTo(step: 150);
-    for (var i = 0; i < 5; i++) {
+
+    for (var i = 0; i < 6; i++) {
       final cardTitle = $(campaignTimelineComponent).$(timelineCard).at(i).$(timelineCardTitle);
       await $.tester.dragUntilVisible(
         cardTitle,
         $(campaignTimelineComponent).$(SingleChildScrollView),
         const Offset(10, 0),
       );
+      await $(timelineCard).at(i).tap();
       expect(
-        $(currentCampaignRoot).$(timelineCard).at(i).$(AnimatedSwitcher).$(Text),
-        findsNothing,
-      );
-      await $(currentCampaignRoot).$(timelineCard).at(i).tap();
-      expect(
-        $(currentCampaignRoot).$(timelineCard).at(i).$(timelineCardTitle).text,
-        isNotEmpty,
-      );
-      expect(
-        $(currentCampaignRoot).$(timelineCard).at(i).$(timelineCardDate).text,
-        isNotEmpty,
-      );
-      expect(
-        $(currentCampaignRoot).$(timelineCard).at(i).$(AnimatedSwitcher).$(Text).text,
+        $(timelineCard).at(i).$(timelineCardTitle).text,
         isNotEmpty,
       );
     }

catalyst_voices/apps/voices/integration_test/pageobject/discovery/how_it_works_section_page.dart

@@ -5,7 +5,7 @@ import 'package:patrol_finders/patrol_finders.dart';
 import '../../utils/translations_utils.dart';
 
 class HowItWorksSection {
-  late PatrolTester $;
+  final PatrolTester $;
 
   final title = const Key('HowItWorksTitle');
   final collaborateAvatar = const Key('collaborateAvatar');
@@ -19,6 +19,7 @@ class HowItWorksSection {
   final followDescription = const Key('followDescription');
   final loadingError = const Key('ErrorIndicator');
   final howItWorksRoot = const Key('HowItWorks');
+
   HowItWorksSection(this.$);
 
   Future<void> collaborateAvatarIsRenderedCorrectly() async {