Flutter模拟数据插件nano_mock的使用

Flutter模拟数据插件nano_mock的使用

NanoMock 简介

NanoMock 是一个轻量级的模拟库，无需任何依赖或代码生成即可使用。它适用于需要模拟回调函数的场景，特别适合在 Flutter 和 Dart 项目中进行单元测试。

使用教程

示例功能

假设我们有一个函数 exampleImplementation，它接受两个整数参数 x 和 y，以及一个回调函数 callback。如果 x + y > 10，则调用回调函数并返回其结果；否则返回 null。

T? exampleImplementation<T>(int x, int y, T Function(int x, int y) callback) {
  if (x + y > 10) {
    return callback(x, y);
  } else {
    return null;
  }
}

步骤 1：创建 NanoMock 实例

首先，我们需要创建一个 NanoMock 实例。泛型类型对应于你想要模拟的回调函数的返回类型。

final mock = NanoMock<bool>();

步骤 2：设置模拟行为

接下来，我们告诉 mock 在给定参数的情况下返回特定的值。这里我们设置当传入 [5, 7] 时，mock 返回 true。

final verify = mock.when(true, [5, 7]);

你需要保留 verify 的引用，以便稍后验证函数是否被调用。

步骤 3：调用目标函数

现在我们可以调用 exampleImplementation 函数，并将 mock 作为回调函数传递。注意，mock 不能直接传递给函数，而是需要将其包装在一个函数中，将参数放入列表后再传递给 mock。

_exampleImplementation(5, 7, (x, y) => mock([x, y]));

步骤 4：验证调用

最后，我们验证 mock 是否被正确调用。这里我们期望 mock 被调用一次。

verify.called(1);

如果你期望回调函数没有被调用，可以使用 neverCalled：

verify.neverCalled();

其他功能

模拟返回 void 的函数

对于返回 void 的函数，可以使用 whenVoid 方法进行模拟：

final verify = mock.whenVoid([1, 3]);

在这种情况下，不需要指定返回值。

获取调用次数

你可以通过读取 calls 属性来获取 mock 的调用次数，而无需执行断言：

print(verify.calls); // 输出 1

完整示例 Demo

以下是一个完整的示例，展示了如何使用 NanoMock 进行单元测试：

import 'package:test/test.dart';
import 'package:nano_mock/nano_mock.dart';

/// 一个示例函数，接受一个回调函数，根据条件决定是否调用该回调。
T? _exampleImplementation<T>(int x, int y, T Function(int x, int y) callback) {
  if (x + y > 10) {
    return callback(x, y);
  } else {
    return null;
  }
}

void main() {
  group("_exampleImplementation", () {
    test("当和大于10时，函数调用回调", () {
      // 创建 NanoMock 实例
      final mock = NanoMock<bool>();

      // 设置 mock 在传入 [5, 7] 时返回 true
      final verify = mock.when(true, [5, 7]);

      // 调用函数并验证返回值为 true
      expect(
        _exampleImplementation(5, 7, (x, y) => mock([x, y])),
        true,
      );

      // 验证回调函数被调用了一次
      verify.called(1);
    });

    test("当和小于等于10时，函数不调用回调", () {
      // 创建 NanoMock 实例
      final mock = NanoMock<bool>();

      // 设置 mock 在传入 [3, 5] 时返回 false
      final verify = mock.when(false, [3, 5]);

      // 调用函数并验证返回值为 null
      expect(
        _exampleImplementation(3, 5, (x, y) => mock([x, y])),
        null,
      );

      // 验证回调函数从未被调用
      verify.neverCalled();
    });
  });
}