測試 UI 層

#

判斷你的架構是否健全的一個方法,就是考慮應用程式是否容易測試。 由於 view model(檢視模型)和 view(檢視)有明確定義的輸入, 它們的相依性可以輕鬆地被 mock 或 fake, 因此很容易撰寫單元測試。

ViewModel 單元測試

#

要測試 view model 的 UI 邏輯,應該撰寫不依賴 Flutter 函式庫或測試框架的單元測試。

Repository(資料儲存庫)是 view model 唯一的相依性 (除非你實作了 use-cases), 而對 repository 進行 mocksfakes 就是你所需的唯一測試前置作業。 在這個範例測試中,使用了一個名為 FakeBookingRepository 的 fake。

home_screen_test.dart
dart
void main() {
  group('HomeViewModel tests', () {
    test('Load bookings', () {
      // HomeViewModel._load is called in the constructor of HomeViewModel.
      final viewModel = HomeViewModel(
        bookingRepository: FakeBookingRepository()
          ..createBooking(kBooking),
        userRepository: FakeUserRepository(),
      );

      expect(viewModel.bookings.isNotEmpty, true);
    });
  });
}

FakeBookingRepository 類別實作了 BookingRepository。 在本案例研究的 data layer section 中, 對 BookingRepository 類別有詳細的說明。

fake_booking_repository.dart
dart
class FakeBookingRepository implements BookingRepository {
  List<Booking> bookings = List.empty(growable: true);

  @override
  Future<Result<void>> createBooking(Booking booking) async {
    bookings.add(booking);
    return Result.ok(null);
  }
  // ...
}

View 元件(Widget)測試

#

當你已經為 view model 撰寫了測試後,你也已經建立了撰寫元件(Widget)測試所需的 fake。 以下範例展示了如何使用 HomeViewModel 以及所需的 repository 來設定 HomeScreen 元件(Widget)測試:

home_screen_test.dart
dart
void main() {
  group('HomeScreen tests', () {
    late HomeViewModel viewModel;
    late MockGoRouter goRouter;
    late FakeBookingRepository bookingRepository;

    setUp(() {
      bookingRepository = FakeBookingRepository()
        ..createBooking(kBooking);
      viewModel = HomeViewModel(
        bookingRepository: bookingRepository,
        userRepository: FakeUserRepository(),
      );
      goRouter = MockGoRouter();
      when(() => goRouter.push(any())).thenAnswer((_) => Future.value(null));
    });

    // ...
  });
}

這個設定會建立所需的兩個假資料庫(fake repositories), 並將它們傳遞給HomeViewModel物件。 這個類別本身不需要被偽造(faked)。

在定義好 view model 及其相依項目之後, 就需要建立要進行測試的 Widget 樹狀結構。 在HomeScreen的測試中,會定義一個loadWidget方法。

home_screen_test.dart
dart
void main() {
  group('HomeScreen tests', () {
    late HomeViewModel viewModel;
    late MockGoRouter goRouter;
    late FakeBookingRepository bookingRepository;

    setUp(
      // ...
    );

    void loadWidget(WidgetTester tester) async {
      await testApp(
        tester,
        ChangeNotifierProvider.value(
          value: FakeAuthRepository() as AuthRepository,
          child: Provider.value(
            value: FakeItineraryConfigRepository() as ItineraryConfigRepository,
            child: HomeScreen(viewModel: viewModel),
          ),
        ),
        goRouter: goRouter,
      );
    }

    // ...
  });
}

這個方法會再去呼叫 testApp,這是一個在 compass app 中用於所有元件測試(widget tests)的通用方法。其內容如下:

testing/app.dart
dart
void testApp(
  WidgetTester tester,
  Widget body, {
  GoRouter? goRouter,
}) async {
  tester.view.devicePixelRatio = 1.0;
  await tester.binding.setSurfaceSize(const Size(1200, 800));
  await mockNetworkImages(() async {
    await tester.pumpWidget(
      MaterialApp(
        localizationsDelegates: [
          GlobalWidgetsLocalizations.delegate,
          GlobalMaterialLocalizations.delegate,
          AppLocalizationDelegate(),
        ],
        theme: AppTheme.lightTheme,
        home: InheritedGoRouter(
          goRouter: goRouter ?? MockGoRouter(),
          child: Scaffold(
            body: body,
          ),
        ),
      ),
    );
  });
}

這個函式的唯一工作,就是建立一個可以進行測試的元件樹(widget tree)。

loadWidget 方法會傳入元件樹中用於測試的獨特部分。 在這個例子中,包含了 HomeScreen 及其 view model, 以及一些位於元件樹較高層級的額外假造(faked)repository。

最重要的重點是,只要你的架構設計良好, view 和 view model 的測試只需要對 repository 進行 mock。

測試資料層

#

和 UI 層類似,資料層的元件也有明確定義的輸入與輸出, 因此兩端都可以被 fake。 若要為任一 repository 撰寫單元測試, 只需 mock 它所依賴的 service。 以下範例展示了 BookingRepository 的單元測試。

booking_repository_remote_test.dart
dart
void main() {
  group('BookingRepositoryRemote tests', () {
    late BookingRepository bookingRepository;
    late FakeApiClient fakeApiClient;

    setUp(() {
      fakeApiClient = FakeApiClient();
      bookingRepository = BookingRepositoryRemote(
        apiClient: fakeApiClient,
      );
    });

    test('should get booking', () async {
      final result = await bookingRepository.getBooking(0);
      final booking = result.asOk.value;
      expect(booking, kBooking);
    });
  });
}

想進一步了解如何撰寫 mocks(模擬物件)與 fakes(假物件), 可以參考 Compass App testing 目錄 中的範例, 或閱讀 Flutter 的測試文件

意見回饋

#

由於本網站的這一部分仍在持續演進中, 我們歡迎您的意見回饋