Flutter未知功能插件dartz_test的探索使用

描述

dartz_test 提供了匹配器来帮助你在使用 dartz 包定义的功能编程类型时进行单元测试。这使得开发者能够更方便地验证代码逻辑，特别是在处理复杂的函数式编程概念时。

特性

• Codecov - 用于测量测试覆盖率。
• BSD 3-Clause License - 开源许可协议。
• Pub Package - 可通过Dart Pub安装。

入门指南

安装

为了在你的项目中使用 dartz_test，你需要将其添加为开发依赖项：

dart pub add --dev dartz_test

或者在 pubspec.yaml 文件中添加如下内容：

dev_dependencies:
  dartz_test: ^最新版本号

然后运行 dart pub get 来安装依赖。

使用方法

Either 类型

Either 是一种容器类型，它可以包含两种不同类型的值之一（通常是成功或失败的状态）。dartz_test 提供了一些辅助工具来测试 Either 的实例。

示例代码

下面是一个简单的例子，展示了如何使用 isRight, isRightOf, 和 isRightThat 等匹配器来检查 Either 是否为右值（即成功的状态）。

import 'package:dartz_test/dartz_test.dart';
import 'package:dartz/dartz.dart';
import 'package:test/test.dart';

void main() {
  test('either is right', () {
    Either<String, String> either = Right('foo');

    expect(either, isRight);
    expect(either, isRightOf('foo'));
    expect(either, isRightThat(equals('foo')));

    var value = either.getRightOrFailTest();
    expect(value, equals('foo'));
  });

  test('either is left', () {
    Either<String, String> either = Left('foo');

    expect(either, isLeft);
    expect(either, isLeftOf('foo'));
    expect(either, isLeftThat(equals('foo')));
    
    // Note: getRightOrFailTest() will throw if called on a Left value.
    // If you need to access the left value, consider using fold or match.
  });
}

对于 Left 值也有类似的匹配器：isLeft, isLeftOf, 和 isLeftThat。

Option 类型

Option 是另一种容器类型，它表示一个可能存在的值（类似于其他语言中的可空类型）。dartz_test 同样提供了相应的匹配器来简化对 Option 的测试。

示例代码

这里我们来看一个简单的例子，说明如何测试 Option 是否为空或包含特定值。

test('option is none', () {
  Option<String> option = None();
  expect(option, isNone);
});

test('option is Some', () {
  Option<String> option = Some('foo');

  expect(option, isSome);
  expect(option, isSomeOf('foo'));
  expect(option, isSomeThat(equals('foo')));

  var value = option.getOrFailTest();
  expect(value, equals('foo'));
});

此外，需要注意的是 isSomeOf 和 isRightOf 这样的匹配器是基于 == 操作符工作的，而不是 equals 匹配器。因此，在比较复杂对象（如列表）时应该使用 isSomeThat 或 isRightThat 配合 equals 匹配器以确保正确的比较结果。

注意事项

当涉及到复杂的对象比较时（例如列表或其他集合），直接使用 isRightOf 或 isSomeOf 可能会导致意外的结果，因为它们依赖于 == 操作符。在这种情况下，请改用 isRightThat 或 isSomeThat 并结合 equals 匹配器来进行逐元素的比较。

完整示例 Demo

以下是一个完整的 Dart 测试文件示例，综合运用了上述所有特性：

import 'package:dartz_test/dartz_test.dart';
import 'package:dartz/dartz.dart';
import 'package:test/test.dart';

void main() {
  group('Testing functional programming types with dartz_test:', () {

    // Testing Either type
    group('Either:', () {
      test('either is right', () {
        Either<String, String> either = Right('foo');

        expect(either, isRight);
        expect(either, isRightOf('foo'));
        expect(either, isRightThat(equals('foo')));

        var value = either.getRightOrFailTest();
        expect(value, equals('foo'));
      });

      test('either is left', () {
        Either<String, String> either = Left('foo');

        expect(either, isLeft);
        expect(either, isLeftOf('foo'));
        expect(either, isLeftThat(equals('foo')));
        
        // Note: getRightOrFailTest() will throw if called on a Left value.
        // If you need to access the left value, consider using fold or match.
      });

      test("isLeftOf and isRightOf work with == and not the 'equals' matcher ", () {
        var list1 = ['foo'];
        var list2 = ['foo'];

        // Unless list1 and list2 are declared with const in this example, list1 != list2
        // This line passes the test
        expect(list1 == list2, isFalse);

        // But the `equals` matcher compares the two lists item by item.
        // This line passes the test
        expect(list1, equals(list2));

        Either<List<String>, List<String>> either = Right(list1);

        //! Because list1 != list2, this line doesn't pass the test
        expect(() => expect(either, isRightOf(list2)), throwsA(anything));

        // Use `isRightThat` instead
        expect(either, isRightThat(equals(list2)));

        // `isLeftOf` and `isLeftThat` behave exactly the same
      });
    });

    // Testing Option type
    group('Option:', () {
      test('option is none', () {
        Option<String> option = None();
        expect(option, isNone);
      });

      test('option is Some', () {
        Option<String> option = Some('foo');

        expect(option, isSome);
        expect(option, isSomeOf('foo'));
        expect(option, isSomeThat(equals('foo')));

        var value = option.getOrFailTest();
        expect(value, equals('foo'));
      });

      test("`isSomeOf` works with == and not the `equals` matcher", () {
        var list1 = ['foo'];
        var list2 = ['foo'];

        Either<List<String>, List<String>> either = Right(list1);

        //! Because list1 != list2, this line doesn't pass the test
        expect(() => expect(either, isSomeOf(list2)), throwsA(anything));

        // Use `isSomeThat` instead
        expect(either, isSomeThat(equals(list2)));
      });
    });
  });
}

这个例子涵盖了如何使用 dartz_test 包提供的各种匹配器来测试 Either 和 Option 类型的不同情况，并且演示了在比较复杂对象时应选择合适的匹配器以避免潜在的问题。