Flutter功能生成测试插件generator_test的使用

Flutter功能生成测试插件generator_test的使用

介绍

generator_test 是一个用于帮助测试生成器和 build_runner 包的库，它允许使用 Dart 文件而不是字符串来编写测试。这使得测试生成器和 build_runner 包变得更加简单和直观。

目的

测试生成器和 build_runner 包可能比较困难，generator_test 的目的是让这个过程变得更简单。

使用方法

1. 添加依赖

首先，在你的 pubspec.yaml 文件中添加 generator_test 作为开发依赖：

dev_dependencies:
  generator_test: ^最新版本

2. 创建fixture文件

fixture 是一个已知的状态，测试将基于此状态运行。你可以创建一个“输出”文件来与生成的代码进行比较，基于特定的输入。

例如，假设你有一个输入文件 input.dart：

@ClassName()
class Example {}

对应的 fixture 文件 input.g.dart 可能如下所示：

// **************************************************************************
// ClassNameGenerator
// **************************************************************************

// The class name is `Example`

generator_test 会自动处理 part 文件的包含与否，并根据被测试的生成器选择合适的扩展名。你可以在 fixture 文件的顶部使用 * 包裹生成器名称，或者让 generator_test 自动处理：

// @generator=ClassNameGenerator

3. 创建测试

测试生成器

以下是一个测试生成器的示例：

import 'package:generator_test/generator_test.dart';
import './fake_generator.dart';

void main() async {
  final generator = SuccessGenerator(
    ['input.dart'],          // 输入文件路径
    ['input.g.dart'],        // 生成的文件路径
    fakeGenerator,           // 生成器实例
    compareWithFixture: true, // 是否与 fixture 文件比较
  );

  await generator.test();    // 运行测试
}

测试构建器

如果你使用的是 build_runner，可以这样测试：

import 'package:generator_test/generator_test.dart';
import './fake_builder.dart';

void main() async {
  final generator = SuccessGenerator.fromBuilder(
    ['input.dart'],          // 输入文件路径
    ['input.g.dart'],        // 生成的文件路径
    classNameBuilder,        // 构建器入口点
    compareWithFixture: true, // 是否与 fixture 文件比较
    options: {'add_comment': true}, // 构建器配置
  );

  await generator.test();    // 运行测试
}

4. 调试技巧

调试 build_runner 可能比较复杂，尤其是当你需要从大量的数据中筛选出你需要的值时。generator_test 提供了一个简单的调试方式：你可以在测试中添加 async/await 并在调试模式下运行测试。

例如：

void main() {
  test('generates successfully', () async {
    final generator = SuccessGenerator.fromBuilder(
      ['input.dart'],
      classNameBuilder,
      compareWithFixture: false, // 仅验证输入
    );

    // 在这里设置断点并调试
    await generator.test();
  });
}

通过这种方式，你可以更轻松地找到你需要的值，并确保生成器按预期工作。

完整示例 Demo

下面是一个完整的示例项目，展示了如何使用 generator_test 来测试一个简单的生成器。

项目结构：

.
├── lib
│   └── fake_generator.dart
├── test
│   ├── input.dart
│   ├── input.g.dart
│   └── generator_test.dart
└── pubspec.yaml

lib/fake_generator.dart (简单的生成器实现)

import 'package:build/src/builder/build_step.dart';
import 'package:source_gen/source_gen.dart';

class ClassNameGenerator extends Generator {
  @override
  FutureOr<String> generate(LibraryReader library, BuildStep buildStep) {
    final classes = library.classes.where((c) => c.hasAnnotation(const TypeChecker.fromRuntime(ClassName)));
    return classes.map((c) => '// The class name is ${c.name}').join('\n');
  }
}

class ClassName {
  const ClassName();
}

test/input.dart (输入文件)

@ClassName()
class Example {}

test/input.g.dart (预期生成的文件)

// **************************************************************************
// ClassNameGenerator
// **************************************************************************

// The class name is Example

test/generator_test.dart (测试文件)

import 'package:generator_test/generator_test.dart';
import '../lib/fake_generator.dart';

void main() async {
  final generator = SuccessGenerator(
    ['input.dart'],          // 输入文件路径
    ['input.g.dart'],        // 生成的文件路径
    ClassNameGenerator(),    // 生成器实例
    compareWithFixture: true, // 是否与 fixture 文件比较
  );

  await generator.test();    // 运行测试
}