パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細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 開発者
  • テストの信頼性を最優先とするチーム
  • 広範なプロバイダーテストを必要とするプロジェクト
  • ユニットテストおよび統合テストを書く開発者
  • クロスプラットフォームのFlutterアプリケーション

注意事項

  • Riverpod パッケージが必要です
  • Riverpod固有のテストに限定
  • 複雑なシナリオでは追加の設定が必要になる場合があります
  • ウィジェットレベルのテストのみには適していない
  • 外部テスト環境の構成に依存しています

元の 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 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。