Flutter状态管理测试插件bloc_test的使用

简介

bloc_test 是一个用于简化 Bloc 和 Cubit 测试的 Dart 包。它与 bloc 和 mocktail 协同工作，使得编写和维护测试更加容易。

更多信息请访问 bloclibrary.dev！

创建 Mock 对象

为了方便测试，我们需要创建 Mock 对象来模拟真实的 Bloc 或 Cubit 行为。

import 'package:bloc_test/bloc_test.dart';

class MockCounterBloc extends MockBloc<CounterEvent, int> implements CounterBloc {}
class MockCounterCubit extends MockCubit<int> implements CounterCubit {}

模拟状态流

whenListen 方法可以用来模拟 Bloc 或 Cubit 的状态流。这对于返回预定义的状态序列非常有用。

// 创建一个 mock 实例
final counterBloc = MockCounterBloc();

// 模拟状态流
whenListen(
  counterBloc,
  Stream.fromIterable([0, 1, 2, 3]),
  initialState: 0,
);

// 断言初始状态是否正确
expect(counterBloc.state, equals(0));

// 断言模拟的状态流是否按预期发出
await expectLater(counterBloc.stream, emitsInOrder(<int>[0, 1, 2, 3]));

// 断言当前状态与模拟的状态流同步
expect(counterBloc.state, equals(3));

使用 blocTest 进行单元测试

blocTest 提供了一种简洁的方式来编写 Bloc 或 Cubit 的测试用例。它会自动处理断言 Bloc 发出的预期状态，并确保没有额外的状态被发出。

示例代码

定义 Cubit 和 Bloc

class CounterCubit extends Cubit<int> {
  CounterCubit() : super(0);

  void increment() => emit(state + 1);
}

abstract class CounterEvent {}

class CounterIncrementPressed extends CounterEvent {}

class CounterBloc extends Bloc<CounterEvent, int> {
  CounterBloc() : super(0) {
    on<CounterIncrementPressed>((event, emit) => emit(state + 1));
  }
}

编写测试用例

void main() {
  group('CounterCubit', () {
    blocTest<CounterCubit, int>(
      'emits [] when nothing is called',
      build: () => CounterCubit(),
      expect: () => const <int>[],
    );

    blocTest<CounterCubit, int>(
      'emits [1] when increment is called',
      build: () => CounterCubit(),
      act: (cubit) => cubit.increment(),
      expect: () => const <int>[1],
    );
  });

  group('CounterBloc', () {
    blocTest<CounterBloc, int>(
      'emits [] when nothing is added',
      build: () => CounterBloc(),
      expect: () => const <int>[],
    );

    blocTest<CounterBloc, int>(
      'emits [1] when CounterIncrementPressed is added',
      build: () => CounterBloc(),
      act: (bloc) => bloc.add(CounterIncrementPressed()),
      expect: () => const <int>[1],
    );
  });
}

使用 seed 设置初始状态

有时我们可能需要在测试开始前设置初始状态：

blocTest<CounterBloc, int>(
  'emits [10] when seeded with 9',
  build: () => CounterBloc(),
  seed: () => 9,
  act: (bloc) => bloc.add(CounterIncrementPressed()),
  expect: () => const <int>[10],
);

使用 skip 忽略部分状态

如果某些状态不需要断言，可以使用 skip 参数跳过它们：

blocTest<CounterBloc, int>(
  'emits [2] when CounterIncrementPressed is added twice',
  build: () => CounterBloc(),
  act: (bloc) => bloc..add(CounterIncrementPressed())..add(CounterIncrementPressed()),
  skip: 1,
  expect: () => const <int>[2],
);

处理异步操作

对于包含异步操作的 Bloc，可以使用 wait 参数等待一段时间再进行断言：

blocTest<MyBloc, MyState>(
  'emits [MyState] when MyEvent is added',
  build: () => MyBloc(),
  act: (bloc) => bloc.add(MyEvent()),
  wait: const Duration(milliseconds: 300),
  expect: () => [isA<MyState>()],
);

验证内部逻辑

可以使用 verify 参数来验证 Bloc 内部的方法调用：

blocTest<MyBloc, MyState>(
  'emits [MyState] when MyEvent is added',
  build: () => MyBloc(),
  act: (bloc) => bloc.add(MyEvent()),
  expect: () => [isA<MyState>()],
  verify: (_) {
    verify(() => repository.someMethod(any())).called(1);
  },
);

捕获异常

如果期望 Bloc 抛出异常，可以使用 errors 参数：

blocTest<MyBloc, MyState>(
  'throws Exception when null is added',
  build: () => MyBloc(),
  act: (bloc) => bloc.add(null),
  errors: () => [isA<Exception>()],
);

通过这些方法，我们可以更轻松地编写和维护 Bloc 和 Cubit 的测试用例，确保应用程序的状态管理逻辑是可靠的。