Flutter内联快照生成插件inline_snapshot的使用

Flutter内联快照生成插件inline_snapshot的使用

Inline Snapshot

这是一个支持Dart内联快照测试的库，灵感来源于 expect-test、rspec-inline-snapshot 和 Jest 等项目！

特性

• 执行内联快照测试
• 允许基于实际结果更新预期结果

什么是方便？

预期结果不是写入外部文件，而是存储在输入的同一位置。这使得验证输入和预期结果变得容易。由于测试可以自动更新，修改测试的唯一成本就是审查检测到的差异。

以下是一些可能使用内联快照测试的情况：

• 测试编程语言中的解析器结果（例如，AST）
• 测试代码格式化的输出
• 测试代码压缩器的输出
• 测试模板引擎的输出
• 测试序列化/反序列化过程的输出
• 测试数据转换或映射函数的输出

在这些情况下，预期结果可能是小的并且容易改变，内联快照测试允许你轻松更新预期结果，并在同一位置验证输入和输出。

开始使用

在你的 pubspec.yaml 文件中添加以下开发依赖项：

dev_dependencies:
  inline_snapshot: ^1.0.2

使用方法

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

void main() {
  tearDownAll(() async {
    await Expect.apply();
  });

  group('A group of tests', () {
    test('First Test', () {
      var e = Expect();
      //             ^替换 "actual string" 当运行 `UPDATE_EXPECT=1 dart test`
      e.eq("actual string");
    });
  });
}

在这个例子中，Expect 对象是空的。你可以通过运行以下命令来更新源代码中的预期结果：UPDATE_EXPECT=true dart test。

这将更新源代码中的预期结果，如下所示：

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

void main() {
  tearDownAll(() async {
    await Expect.apply();
  });

  group('A group of tests', () {
    test('First Test', () {
      var e = Expect("actual string");
      //             ^已替换 "actual string"!!
      e.eq("actual string");
    });
  });
}

你可以将 UPDATE_EXPECT 设置为 1 或 true。如果不指定它，Expect 对象的行为类似于 expect(actual, expected)，并且在比较之前会移除预期结果中的前导换行符。

它是如何工作的

当你调用 Expect("expect string") 时，预期结果和调用者的所在位置会被存储。当调用 Expect#eq(actual: String) 时，实际值与预期结果进行比较。如果它们匹配，测试被认为是成功的，不再执行其他操作。如果不匹配，预期结果将被标记为替换。当执行 Expect.apply() 时，标记为替换的实际值将被替换为预期结果。

贡献者

• ktanaka101 - 创建者，维护者

许可证

MIT

示例代码

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

void main() {
  tearDownAll(() async {
    await Expect.apply();
  });

  group('A group of tests', () {
    test('First Test', () {
      var e = Expect();
      //             ^替换 "actual string" 当运行 `UPDATE_EXPECT dart test`
      e.eq("actual string");
    });
  });
}