Flutter插件功能介绍插件pact_dart的使用

Flutter插件功能介绍插件pact_dart的使用

pact_dart 是一个用于生成 Pact 合同的 Dart 框架。它实现了 Pact 规范 v3，并使用了 Pact FFI Library。

文档

本说明文档提供了库的基本介绍。更多关于 Pact 的文档可以在 https://docs.pact.io/ 查看。

• 安装
• 基本用法

需要帮助？

• 加入我们的社区 slack workspace
• Stack Overflow: https://stackoverflow.com/questions/tagged/pact
• 在 Twitter 上打招呼: @pact_up

安装

首先，在你的项目中添加 pact_dart 作为开发依赖：

# 安装 pact_dart 作为开发依赖
dart pub add --dev pact_dart

# 下载并安装所需的库
dart run pact_dart:install

# 🚀 现在编写一些测试！

对于 Flutter 项目：

# 安装 pact_dart 作为开发依赖
flutter pub add --dev pact_dart

# 下载并安装所需的库
flutter pub run pact_dart:install

# 🚀 现在编写一些测试！

手动安装指南

默认情况下，Pact FFI Library 会被安装到 macOS 和 Linux 的 /usr/local/lib 目录下。但你可以通过设置 PACT_DART_LIB_DOWNLOAD_PATH 环境变量来修改安装路径。

PACT_DART_LIB_DOWNLOAD_PATH=/app/my-other-location dart run pact_dart:install

手动安装：

下载最新的 Pact FFI Library 并安装到标准库搜索路径（例如，在 macOS/Linux 上建议的路径为 /usr/local/lib）：

确保你有正确的扩展名：

• 对于 Mac OSX: .dylib
• 对于 Linux: .so
• 对于 Windows: .dll

wget https://github.com/pact-foundation/pact-reference/releases/download/libpact_ffi-v0.0.2/libpact_ffi-osx-x86_64.dylib.gz
gunzip libpact_ffi-osx-x86_64.dylib.gz
mv libpact_ffi-osx-x86_64.dylib /usr/local/lib/libpact_ffi.dylib

使用

编写消费者测试

Pact 是一个消费者驱动的合同测试工具，这意味着 API 消费者会编写测试以设定其对 API 提供者的假设和需求。通过单元测试我们的 API 客户端，它可以生成一个可以共享给提供者的合同，以确认这些假设并防止破坏性更改。

在这个例子中，我们正在测试与 HTTP 服务的 /users 资源通信的用户存储库。该存储库有一个单一方法 fetchAll()，它将返回一个用户列表。

import 'package:pact_dart/pact_dart.dart';

// 创建一个新的模拟服务实例
final pact = PactMockService('FlutterConsumer', 'APIService');

// 添加交互
pact
    .newInteraction() // 新的交互
    .given('a user exists', params: {'first_name': 'Betsy', 'last_name': 'Tester'}) // 设置状态
    .andGiven('') // 可选的额外状态
    .uponReceiving('a request for all users') // 接收请求
    .withRequest('GET', '/users') // 请求类型和路径
    .willRespondWith(200, body: { // 响应
        // 使用匹配器，因为我们关心响应的类型和结构，而不是确切的值
        'page': PactMatchers.SomethingLike(1),
        'per_page': PactMatchers.SomethingLike(20),
        'total': PactMatchers.IntegerLike(20),
        'total_pages': PactMatchers.SomethingLike(3),
        'data': PactMatchers.EachLike([ // 数组匹配器
            {
                'id': PactMatchers.uuid('f3a9cf4a-92d7-4aae-a945-63a6440b528b'), // UUID 匹配器
                'first_name': PactMatchers.SomethingLike('Betsy'), // 某些值匹配器
                'last_name': PactMatchers.SomethingLike('Tester'),
                'salary': PactMatchers.DecimalLike(125000.00) // 数值匹配器
            }
        ])
    });

// 运行模拟服务
pact.run(secure: false);

// 模拟调用实际的 API 方法
final loginRepository = UsersRepository();
final users = await loginRepository.fetchAll();

// 断言
expect(users.length, equals(20)); // 用户数量
expect(users[0].firstName, equals('Betsy')); // 第一个用户的姓名
expect(users[0].lastName, equals('Tester')); // 第一个用户的姓氏

// 写入 Pact 文件并重置模拟服务
pact.writePactFile();
pact.reset();