搜索插件、代码仓与 APP 分类

插件详情v0.1.9

riverpod_test

一个测试库,可轻松测试提供者。专为与 riverpod 包一起使用而设计。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
4570
喜欢数
28
Pub 分数
150

安装插件

flutter pub add riverpod_test

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

riverpod_test 是一个旨在简化 Flutter 应用程序中 Riverpod 提供者测试的测试库。它提供了实用工具,可轻松覆盖、模拟和隔离测试提供者值,确保测试的可靠性和可维护性。专为 Riverpod 包设计,它与 Flutter 的测试生态系统无缝集成,使开发者能够在不依赖真实依赖项的情况下验证状态逻辑。该库支持所有主要平台,非常适合跨平台测试工作流程。

适合场景

  • 测试提供程序状态更改
  • 在测试中模拟依赖项
  • 验证提供程序中的业务逻辑
  • 将单元测试与真实数据源隔离
  • 验证提供程序中的异步操作

主要特点

  • 轻松提供者覆盖
  • 内置模拟支持
  • 与 Flutter 测试框架的集成
  • 对异步和同步提供程序的支持
  • 简洁、可读的测试语法

适合对象

  • 使用 Riverpod 的 Flutter 开发人员
  • 注重测试可靠性的团队
  • 需要大量 provider 测试的项目
  • 编写单元测试和集成测试的开发者
  • 跨平台 Flutter 应用程序

使用建议

  • 需要 Riverpod 包
  • 仅限 Riverpod 特定测试
  • 复杂场景可能需要额外的设置
  • 仅适用于 widget 级别测试
  • 依赖外部测试环境配置

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Pub Star on Github Flutter Website License: MIT Bloc Library


Package

Package is a port of felangel's bloc_test, modified to work with Riverpod Providers.
Increase code coverage by testing all riverpod providers.

Installation

For a Flutter project:

flutter pub add --dev riverpod_test

For a Dart project:

dart pub add --dev riverpod_test

Usage

testProvider

import 'package:riverpod_test.dart';

testProvider(
  'expect [0]',
  provider: counterProvider,
  expect: () => [0],
);

final counterProvider = Provider<int>((ref) => 0);

testNotifier

testNotifier(
  'expect [2] when increment is called twice and skip: 1',
  provider: counterNotifierProvider,
  act: (notifier) => notifier
      ..increment()
      ..increment(),
  skip: 1,
  expect: () => [2],
);

final counterNotifierProvider =
    NotifierProvider<CounterNotifier, int>(CounterNotifier.new);

class CounterNotifier extends Notifier<int> {
  @override
  int build() => 0;

  void increment() => state++;
}

testAsyncNotifier (also handles StreamNotifier)

testAsyncNotifier<CounterAsyncNotifier, int>(
  'expect [AsyncData(1)] when call increment',
  provider: counterAsyncNotifierProvider(0),
  act: (notifier) => notifier.increment(),
  expect: () => <AsyncValue<int>>[const AsyncData(1)],
);

testAsyncNotifier(
  'verify if mockRepository sideEffect is called',
  provider: sideEffectAsyncNotifierProvider(1),
  overrides: [repositoryProvider.overrideWithValue(mockRepository)],
  act: (notifier) => notifier.increment(),
  verify: (_) => verify(mockRepository.sideEffect).called(1),
);

final counterAsyncNotifierProvider =
    AsyncNotifierProviderFamily<CounterAsyncNotifier, int, int>(
  CounterAsyncNotifier.new,
);

class CounterAsyncNotifier extends FamilyAsyncNotifier<int, int> {
  @override
  FutureOr<int> build(int initialValue) => initialValue;

  void increment() => state = AsyncData(value + 1);
}

class MockRepository extends Mock implements Repository {}

final sideEffectAsyncNotifierProvider =
    AsyncNotifierProviderFamily<SideEffectAsyncNotifier, int, int>(
  SideEffectAsyncNotifier.new,
);

class SideEffectAsyncNotifier extends FamilyAsyncNotifier<int, int> {
  @override
  FutureOr<int> build(int initialValue) => initialValue;

  Repository get repository => ref.watch(repositoryProvider);

  void increment() {
    repository.sideEffect();
    state = AsyncData(value + 1);
  }
}

testResultProvider

testResultProvider<Repository>(
  'expect [1] when incrementCounter is called',
  provider: repositoryProvider,
  act: (result) => result.incrementCounter(),
  expect: () => [1],
);

final repositoryProvider = Provider<Repository>((ref) => Repository());

class Repository {
  int incrementCounter() => 1;
}

testStateNotifier

testStateNotifier<CounterStateNotifier, int>(
  'expect [0] when decrement is called and seed: 1',
  provider: counterStateNotifierProvider,
  act: (notifier) => notifier.decrement(),
  seed: 1,
  wait: const Duration(milliseconds: 100),
  expect: () => <int>[0],
);

final counterStateNotifierProvider =
    StateNotifierProvider<CounterStateNotifier, int>(
  (ref) => CounterStateNotifier(),
);

class CounterStateNotifier extends StateNotifier<int> {
  CounterStateNotifier() : super(0);

  void increment() => state++;

  Future<void> decrement() async {
    await Future<void>.delayed(const Duration(milliseconds: 100));
    state--;
  }
}

所属分类

依赖

依赖清单 4 项

源码仓库

使用此插件的项目

暂无相关数据。