测试

契约测试详解

在契约测试中，消费端（Consumer）的测试阶段确实不需要真实的提供者（Provider）服务启动，其核心目的是通过模拟提供者的行为生成契约文件。以下是详细的解释和流程说明：

1. 消费端测试的核心目标

消费端测试的关键目的是明确定义对提供者接口的期望，而不是验证真实的提供者实现。具体过程如下：

  • 模拟提供者：使用 Pact 框架启动一个模拟的提供者服务（Mock Provider），监听在指定端口（如 8080）。
  • 记录交互：消费端代码向模拟服务发送请求，Pact 会记录请求和预期的响应，生成契约文件（pacts/*.json）。
  • 验证消费端逻辑：确保消费端代码能正确处理模拟服务返回的响应（如解析字段、处理状态码）。

关键点：
✅ 提供者未启动：真实提供者服务此时不需要运行，所有交互由 Pact 的模拟服务替代。
✅ 契约生成：测试结束后，生成的契约文件是消费端对提供者接口的“约定”。

2. 消费端测试的具体流程

以用户服务（Consumer）调用订单服务（Provider）的 /orders/{userId} 接口为例：

步骤 1：消费端测试代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// 消费者测试代码（Mocha + Node.js assert）
const { Pact } = require("@pact-foundation/pact");
const assert = require("assert");
const { fetchUserOrders } = require("./orderClient");

describe("Order Service Contract Test", () => {
  const provider = new Pact({ consumer: "User Service", provider: "Order Service", port: 8080 });

  before(async () => await provider.setup()); // 启动模拟提供者
  after(() => provider.finalize()); // 生成契约文件

  it("获取用户订单", async () => {
    // 定义契约交互
    await provider.addInteraction({
      withRequest: { method: "GET", path: "/orders/123" },
      willRespondWith: { status: 200, body: [{ id: "1", amount: 100 }] },
    });

    // 消费者代码调用模拟服务（http://localhost:8080）
    const orders = await fetchUserOrders("123");
    assert.deepStrictEqual(orders, [{ id: "1", amount: 100 }]);
  });
});

步骤 2：生成契约文件

运行测试后，Pact 会生成以下文件：

1
2
3
4
5
6
7
8
9
10
11
12
// pacts/user_service-order_service.json
{
  "consumer": { "name": "User Service" },
  "provider": { "name": "Order Service" },
  "interactions": [
    {
      "description": "获取用户订单",
      "request": { "method": "GET", "path": "/orders/123" },
      "response": { "status": 200, "body": [{ "id": "1", "amount": 100 }] }
    }
  ]
}

3. 提供者测试的独立性

提供者的验证是独立的后续阶段，无需消费端参与：

  1. 启动真实提供者服务：例如启动一个订单服务的 Express 实例。
  2. 加载契约文件：Pact 根据契约中的定义，向真实服务发送请求（如 GET /orders/123）。
  3. 验证响应匹配契约：检查真实服务的响应状态码、字段、格式是否与契约一致。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 提供者测试代码（验证契约）
const { Verifier } = require("@pact-foundation/pact");
const { startServer, stopServer } = require("./server");

describe("Order Service Provider Test", () => {
  before(async () => await startServer(3000)); // 启动真实服务
  after(() => stopServer());

  it("验证契约", async () => {
    const result = await new Verifier({
      providerBaseUrl: "http://localhost:3000", // 真实服务地址
      pactUrls: ["./pacts/user_service-order_service.json"],
    }).verifyProvider();
    assert.ok(result.includes("所有契约验证通过"));
  });
});

4. 为什么消费端不需要真实提供者？

  1. 解耦开发：消费端团队无需等待提供者实现完成，即可定义接口期望。
  2. 快速反馈：消费端测试仅验证自身逻辑，而非依赖外部服务稳定性。
  3. 契约驱动：契约文件是双方协作的唯一真实来源，而非隐式假设。

5. 常见误解澄清

误解 实际情况
“消费端测试需要真实提供者运行。” ❌ 错误。消费端测试使用 Pact 的模拟服务，真实提供者无需启动。
“契约文件是提供者生成的。” ❌ 错误。契约文件由消费端生成，提供者仅验证是否符合契约。
“消费端测试覆盖提供者逻辑。” ❌ 错误。消费端测试仅验证自身逻辑，提供者需独立测试其实现。

总结

  • 消费端测试：生成契约文件，验证消费端代码逻辑，不依赖真实提供者。
  • 提供者测试：根据契约验证真实服务，需启动提供者实例。
  • 核心价值：通过契约文件解耦团队协作，避免集成阶段的意外故障。