Flutter参数化测试插件parameterized_test的使用

目录

• 特性
• 安装
• 用法
• 示例
  • 简单的单值列表测试
  • 多值列表测试
  • 复杂对象列表测试
  • 枚举列表测试
  • 从函数获取值列表的测试
  • 带有setup和teardown的简单测试
  • 异步测试
  • CSV数据测试
• 附加信息

特性 ✨

• ✅ 根据提供的参数列表多次运行测试。
• ✅ 基于 dart test package 构建。
• ✅ 测试中使用的参数类型转换。
• ✅ 为parameterizedTest添加测试选项。
• ✅ 每个参数可以包含自己的测试选项。

安装 🛠

在pubspec.yaml文件中添加以下内容：

dev_dependencies:
  parameterized_test: ^latest_version

用法 ⚡️

通过提供参数列表，可以用相同的测试函数运行多次。例如：

parameterizedTest(
  'Fruit name matches length',
  [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6],
    ['pineapple', 9],
  ],
  (String fruit, int length) {
    expect(fruit.length, length);
  },
);

此代码将创建一个包含四个测试的组，每个测试都使用提供的参数运行测试函数。

添加测试选项到参数 🔩

可以通过使用options扩展为特定参数添加测试选项，如skip或testOn。

parameterizedTest(
  'Fruit name matches length',
  [
    ['kiwi', 4],
    ['apple', 5].options(skip: 'Apple is not ripe yet'),
    ['banana', 6],
    ['pineapple', 9],
  ],
  (String fruit, int length) {
    expect(fruit.length, length);
  },
);

更改测试描述输出 📝

可以通过定义customDescriptionBuilder来自定义测试描述输出。

parameterizedTest(
  'Example of custom description',
  [
    ['first', 'second', true],
    ['third', 'fourth', false],
  ],
  (String value1, String value2, bool expected) {
    expect(value1 != value2, expected);
  },
  customDescriptionBuilder: (groupDescription, index, values) => '🚀[$index] $groupDescription: <<${values.join('|')}>>',
);

示例 📦

简单的单值列表测试

parameterizedTest(
  'Example of list of single values',
  [
    1,
    2,
    3,
  ],
  (int value) {
    final result = value < 4;
    expect(result, true);
  },
);

多值列表测试

parameterizedTest('Example of list of multiple values', [
  [0, 1, 1],
  [1, 1, 2],
  [1, 2, 3],
  [2, 2, 4],
], (int value1, int value2, int sum) {
  expect(value1 + value2, sum);
});

复杂对象列表测试

parameterizedTest('Example of a list with complex object', [
  [DateTime(2024, 4, 12), 5],
  [DateTime(1969, 7, 20), 7],
], (DateTime dateTime, int expectedWeekday) {
  expect(dateTime.weekday, expectedWeekday);
});

枚举列表测试

enum FruitEnum {
  kiwi(4),
  apple(5),
  banana(6),
  pineapple(9);

  const FruitEnum(this.wordLength);

  final int wordLength;
}

parameterizedTest(
  'Example using enum as value',
  FruitEnum.values,
  (FruitEnum testEnum) {
    expect(testEnum.name.length, testEnum.wordLength);
  },
);

从函数获取值列表的测试

List<dynamic> provideData() {
  return [
    [0, 1, 1],
    [1, 1, 2],
    [1, 2, 3],
    [2, 2, 4],
  ];
}

parameterizedTest(
  'Example of list of values from function',
  provideData(),
  (int value1, int value2, int sum) {
    expect(value1 + value2, sum);
  },
);

带有setup和teardown的简单测试

parameterizedTest(
  'Example with setup and teardown ',
  [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6],
  ],
  (String word, int length) {
    expect(word.length, length);
  },
  setUp: () {
    print('Setup everything I need for testing');
  },
  tearDown: () {
    print('tear it down again');
  },
);

异步测试

parameterizedTest(
  'Example using a async test',
  [
    100,
    200,
    300,
  ],
  (int value) async {
    final millis = DateTime.now().millisecondsSinceEpoch;
    await Future<void>.delayed(Duration(milliseconds: value));
    final passed = DateTime.now().millisecondsSinceEpoch - millis;

    expect(passed >= value, true);
  },
);

CSV数据测试

parameterizedTest('Example of CSV data',
  const CsvToListConverter().convert('kiwi,4\r\napple,5\r\nbanana,6'),
  (String fruit, int length) {
    expect(fruit.length, length);
});

附加信息 💡

parameterized_test是一个简单的包装器，用于轻松地多次执行不同值的测试。欢迎提出反馈或提交拉取请求。