Convert lightTheme and darkTheme to methods (#1234)

This PR converts the variables `lightTheme` and `darkTheme` to the methods `getLightTheme()` and `getDarkTheme()`. The reason for this is that in golden tests outside of `/app`, the `golden_toolkit` package is unable to load our "Rubik" font (see eBay/flutter_glove_box#158). With this method, the golden tests can override the font family with a font like "Roboto".
SharezoneApp · Jan 6, 2024 · e22d4b6 · e22d4b6
1 parent 75cb922
commit e22d4b6
Show file tree

Hide file tree

Showing 23 changed files with 253 additions and 248 deletions.
diff --git a/app/lib/main/sharezone_material_app.dart b/app/lib/main/sharezone_material_app.dart
@@ -42,9 +42,9 @@ class SharezoneMaterialApp extends StatelessWidget {
       debugShowCheckedModeBanner: false,
       title: PlatformCheck.isWeb ? "Sharezone Web-App" : "Sharezone",
       color: primaryColor,
-      darkTheme: darkTheme.copyWith(
+      darkTheme: getDarkTheme().copyWith(
           visualDensity: themeSettings.visualDensitySetting.visualDensity),
-      theme: lightTheme.copyWith(
+      theme: getLightTheme().copyWith(
           visualDensity: themeSettings.visualDensitySetting.visualDensity),
       themeMode: _getThemeMode(themeSettings.themeBrightness),
       localizationsDelegates: const [

diff --git a/app/lib/navigation/drawer/sign_out_dialogs/src/sign_out_and_delete_anonymous_user.dart b/app/lib/navigation/drawer/sign_out_dialogs/src/sign_out_and_delete_anonymous_user.dart
@@ -246,7 +246,7 @@ class DeleteConfirmationCheckbox extends StatelessWidget {
           Material(
             color: Colors.transparent,
             child: Theme(
-              data: darkTheme,
+              data: getDarkTheme(),
               child: Checkbox(
                 value: confirm,
                 onChanged: onChanged,

diff --git a/app/test_goldens/blackboard/details/blackboard_item_read_by_users_list_page_test.dart b/app/test_goldens/blackboard/details/blackboard_item_read_by_users_list_page_test.dart
@@ -80,7 +80,7 @@ void main() {
       });
 
       testGoldens('(light mode)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -89,7 +89,7 @@ void main() {
       });
 
       testGoldens('(dark mode)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,
@@ -106,7 +106,7 @@ void main() {
       });
 
       testGoldens('(light mode)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -115,7 +115,7 @@ void main() {
       });
 
       testGoldens('(dark mode)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,

diff --git a/app/test_goldens/calendrical_events/page/past_calendrical_events_page_test.dart b/app/test_goldens/calendrical_events/page/past_calendrical_events_page_test.dart
@@ -84,7 +84,7 @@ void main() {
       });
 
       testGoldens('renders correctly (light theme)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -93,7 +93,7 @@ void main() {
       });
 
       testGoldens('renders correctly (dark theme)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,
@@ -112,7 +112,7 @@ void main() {
       });
 
       testGoldens('renders correctly (light theme)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -121,7 +121,7 @@ void main() {
       });
 
       testGoldens('renders correctly (dark theme)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,

diff --git a/app/test_goldens/dashboard/dashboard_page_test.dart b/app/test_goldens/dashboard/dashboard_page_test.dart
@@ -69,7 +69,7 @@ void main() {
         BlocProvider<HolidayBloc>(
           bloc: holidayBloc,
           child: MaterialApp(
-            theme: lightTheme,
+            theme: getLightTheme(),
             home: const Scaffold(
               body: Center(
                 child: HolidayCountdownSection(),

diff --git a/...dens/groups/src/pages/course/course_edit/design/src/dialog/select_design_dialog_test.dart b/...dens/groups/src/pages/course/course_edit/design/src/dialog/select_design_dialog_test.dart
@@ -67,22 +67,22 @@ void main() {
 
       testGoldens('displays select base color dialog as expected (light mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: lightTheme);
+        await pumpSelectDesignDialog(tester, theme: getLightTheme());
 
         await multiScreenGolden(tester, 'select_base_color_dialog_light');
       });
 
       testGoldens('displays select base color dialog as expected (dark mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: darkTheme);
+        await pumpSelectDesignDialog(tester, theme: getDarkTheme());
 
         await multiScreenGolden(tester, 'select_base_color_dialog_dark');
       });
 
       testGoldens(
           'displays select a color shade dialog as expected (light mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: lightTheme);
+        await pumpSelectDesignDialog(tester, theme: getLightTheme());
 
         await tester
             .tap(find.byKey(Key('color-circle-${Colors.blue.value}')).last);
@@ -94,7 +94,7 @@ void main() {
       testGoldens(
           'displays select a color shade dialog as expected (dark mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: darkTheme);
+        await pumpSelectDesignDialog(tester, theme: getDarkTheme());
 
         await tester
             .tap(find.byKey(Key('color-circle-${Colors.blue.value}')).last);
@@ -113,14 +113,14 @@ void main() {
 
       testGoldens('displays select design dialog as expected (light mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: lightTheme);
+        await pumpSelectDesignDialog(tester, theme: getLightTheme());
 
         await multiScreenGolden(tester, 'select_free_design_dialog_light');
       });
 
       testGoldens('displays select design dialog as expected (dark mode)',
           (tester) async {
-        await pumpSelectDesignDialog(tester, theme: darkTheme);
+        await pumpSelectDesignDialog(tester, theme: getDarkTheme());
 
         await multiScreenGolden(tester, 'select_free_design_dialog_dark');
       });

diff --git a/app/test_goldens/homework/homework_dialog/homework_dialog_test.dart b/app/test_goldens/homework/homework_dialog/homework_dialog_test.dart
@@ -65,15 +65,15 @@ void main() {
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       await multiScreenGolden(
         tester,
         'homework_dialog_add_empty_light',
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: darkTheme);
+          isEditing: false, theme: getDarkTheme());
 
       await multiScreenGolden(
         tester,
@@ -131,15 +131,15 @@ void main() {
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       await multiScreenGolden(
         tester,
         'homework_dialog_add_filled_1_light',
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: darkTheme);
+          isEditing: false, theme: getDarkTheme());
 
       await multiScreenGolden(
         tester,
@@ -200,7 +200,7 @@ void main() {
       whenListenPresentation(homeworkDialogBloc,
           initialEvents: [const StartedUploadingAttachments()]);
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       // Wait for the SnackBar to appear.
       await tester.pump(const Duration(milliseconds: 500));
@@ -223,7 +223,7 @@ void main() {
       await pumpAndSettleHomeworkDialog(
         tester,
         isEditing: false,
-        theme: darkTheme,
+        theme: getDarkTheme(),
       );
       // Otherwise the theme is not completly applied (some text is still black
       // instead of white).
@@ -293,7 +293,7 @@ void main() {
         SavingFailed(Exception('Test Exception Message'), null)
       ]);
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       // Wait for the SnackBar to appear.
       await tester.pump(const Duration(milliseconds: 500));
@@ -318,7 +318,7 @@ void main() {
       await pumpAndSettleHomeworkDialog(
         tester,
         isEditing: false,
-        theme: darkTheme,
+        theme: getDarkTheme(),
       );
       // Otherwise the theme is not completly applied (some text is still black
       // instead of white).
@@ -357,15 +357,15 @@ void main() {
           initialEvents: [const RequiredFieldsNotFilledOut()]);
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       await multiScreenGolden(
         tester,
         'homework_dialog_with_error_light',
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: darkTheme);
+          isEditing: false, theme: getDarkTheme());
 
       await multiScreenGolden(
         tester,
@@ -415,15 +415,15 @@ void main() {
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: lightTheme);
+          isEditing: false, theme: getLightTheme());
 
       await multiScreenGolden(
         tester,
         'homework_dialog_edit_filled_1_light',
       );
 
       await pumpAndSettleHomeworkDialog(tester,
-          isEditing: false, theme: darkTheme);
+          isEditing: false, theme: getDarkTheme());
 
       await multiScreenGolden(
         tester,

diff --git a/...homework/teacher/homework_done_by_users_list/homework_completion_user_list_page_test.dart b/...homework/teacher/homework_done_by_users_list/homework_completion_user_list_page_test.dart
@@ -84,7 +84,7 @@ void main() {
       });
 
       testGoldens('(light mode)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -93,7 +93,7 @@ void main() {
       });
 
       testGoldens('(dark mode)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,
@@ -110,7 +110,7 @@ void main() {
       });
 
       testGoldens('(light mode)', (tester) async {
-        await pumpPage(tester, theme: lightTheme);
+        await pumpPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(
           tester,
@@ -119,7 +119,7 @@ void main() {
       });
 
       testGoldens('(dark mode)', (tester) async {
-        await pumpPage(tester, theme: darkTheme);
+        await pumpPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(
           tester,

diff --git a/app/test_goldens/onboarding/mobile_welcome_page_test.dart b/app/test_goldens/onboarding/mobile_welcome_page_test.dart
@@ -22,7 +22,7 @@ void main() {
     }
 
     testGoldens('renders as expected (light theme)', (tester) async {
-      await pumpPage(tester, theme: lightTheme);
+      await pumpPage(tester, theme: getLightTheme());
 
       await multiScreenGolden(tester, 'mobile_welcome_page_light');
     });
@@ -32,7 +32,7 @@ void main() {
     //
     // Ticket: https://github.com/SharezoneApp/sharezone-app/issues/916
     testGoldens('renders as expected (dark theme)', (tester) async {
-      await pumpPage(tester, theme: darkTheme);
+      await pumpPage(tester, theme: getDarkTheme());
 
       await multiScreenGolden(tester, 'mobile_welcome_page_dark');
     });

diff --git a/app/test_goldens/privacy_policy/privacy_policy_display_settings_test.dart b/app/test_goldens/privacy_policy/privacy_policy_display_settings_test.dart
@@ -25,7 +25,7 @@ void main() {
     testGoldens('displays as expected', (tester) async {
       await tester.pumpWidget(
         MaterialApp(
-          theme: lightTheme,
+          theme: getLightTheme(),
           home: Scaffold(
             body: ChangeNotifierProvider<PrivacyPolicyThemeSettings>(
               create: (context) {

diff --git a/app/test_goldens/settings/notification_page_test.dart b/app/test_goldens/settings/notification_page_test.dart
@@ -66,13 +66,13 @@ void main() {
     }
 
     testGoldens('renders as expected (light mode)', (tester) async {
-      await pumpNotificationPage(tester, themeData: lightTheme);
+      await pumpNotificationPage(tester, themeData: getLightTheme());
 
       await multiScreenGolden(tester, 'notification_page_light');
     });
 
     testGoldens('renders as expected (dark mode)', (tester) async {
-      await pumpNotificationPage(tester, themeData: darkTheme);
+      await pumpNotificationPage(tester, themeData: getDarkTheme());
 
       await multiScreenGolden(tester, 'notification_page_dark');
     });
@@ -82,7 +82,7 @@ void main() {
               SharezonePlusFeature.changeHomeworkReminderTime))
           .thenReturn(false);
 
-      await pumpNotificationPage(tester, themeData: lightTheme);
+      await pumpNotificationPage(tester, themeData: getLightTheme());
 
       await tester
           .tap(find.byKey(const Key('homework-notifications-time-tile')));

diff --git a/app/test_goldens/settings/support/support_page_test.dart b/app/test_goldens/settings/support/support_page_test.dart
@@ -60,13 +60,13 @@ void main() {
       });
 
       testGoldens('renders as expected (light mode)', (tester) async {
-        await pumpSupportPage(tester, theme: lightTheme);
+        await pumpSupportPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(tester, 'support_page_with_plus_light');
       });
 
       testGoldens('renders as expected (dark mode)', (tester) async {
-        await pumpSupportPage(tester, theme: darkTheme);
+        await pumpSupportPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(tester, 'support_page_with_plus_dark');
       });
@@ -78,13 +78,13 @@ void main() {
       });
 
       testGoldens('renders as expected (light mode)', (tester) async {
-        await pumpSupportPage(tester, theme: lightTheme);
+        await pumpSupportPage(tester, theme: getLightTheme());
 
         await multiScreenGolden(tester, 'support_page_without_plus_light');
       });
 
       testGoldens('renders as expected (dark mode)', (tester) async {
-        await pumpSupportPage(tester, theme: darkTheme);
+        await pumpSupportPage(tester, theme: getDarkTheme());
 
         await multiScreenGolden(tester, 'support_page_without_plus_dark');
       });