Java环境下能否将Pact交互存为JSON文件引入消费者测试

问题解答 #

基于Java的Pact JVM框架完全支持该实现，你可以通过预先定义符合Pact规范的交互JSON文件，在消费者测试中直接加载这些文件生成对应Pact契约，无需硬编码交互逻辑。

具体实现步骤 #

1. 引入依赖 #

以Maven为例，在pom.xml中添加JUnit5版本的Pact消费者依赖：

<dependency>
    <groupId>au.com.dius.pact.consumer</groupId>
    <artifactId>pact-jvm-consumer-junit5</artifactId>
    <version>4.6.11</version>
    <scope>test</scope>
</dependency>

2. 准备交互JSON文件 #

按Pact规范编写请求/响应交互的JSON文件，统一放置到项目src/test/resources/pact-interactions目录下，示例文件get-user-interaction.json内容如下：

{
  "description": "get user by id",
  "providerState": "user with id 1 exists",
  "request": {
    "method": "GET",
    "path": "/users/1",
    "headers": {
      "Accept": "application/json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "id": 1,
      "name": "Zhang San",
      "email": "zhangsan@example.com"
    }
  }
}

3. 编写消费者测试加载JSON生成Pact文件 #

测试代码中直接读取指定目录下的JSON交互文件，加载到Pact测试上下文，执行测试后会自动生成标准Pact契约文件到指定目录：

import au.com.dius.pact.consumer.MockServer;
import au.com.dius.pact.consumer.junit5.PactConsumerTest;
import au.com.dius.pact.consumer.junit5.PactTestFor;
import au.com.dius.pact.core.model.Pact;
import au.com.dius.pact.core.model.PactReader;
import au.com.dius.pact.core.model.RequestResponsePact;
import org.apache.http.client.fluent.Request;
import org.junit.jupiter.api.Test;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

@PactConsumerTest
public class PactFromJsonTest {

    // 加载指定目录下所有交互JSON生成Pact对象
    @au.com.dius.pact.consumer.junit5.Pact(provider = "UserProvider", consumer = "UserConsumer")
    public RequestResponsePact createPact() {
        List<RequestResponsePact> pacts = new ArrayList<>();
        File interactionDir = new File("src/test/resources/pact-interactions");
        
        // 遍历目录下所有JSON文件加载
        for (File file : interactionDir.listFiles((dir, name) -> name.endsWith(".json"))) {
            Pact pact = PactReader.loadPact(file.getAbsolutePath());
            if (pact instanceof RequestResponsePact) {
                pacts.add((RequestResponsePact) pact);
            }
        }
        
        // 合并所有交互到同一个Pact契约
        return pacts.stream()
                .reduce((p1, p2) -> {
                    p1.getInteractions().addAll(p2.getInteractions());
                    return p1;
                })
                .orElseThrow(() -> new RuntimeException("No valid interaction JSON found"));
    }

    @Test
    @PactTestFor(pactMethod = "createPact")
    public void testLoadInteractionsFromJson(MockServer mockServer) throws IOException {
        // 执行测试请求，验证交互逻辑
        String response = Request.Get(mockServer.getUrl() + "/users/1")
                .addHeader("Accept", "application/json")
                .execute()
                .returnContent()
                .asString();
        
        // 自定义业务断言逻辑
        assert response.contains("Zhang San");
    }
}

4. 配置Pact文件输出路径 #

你可以在src/test/resources下添加pact.conf文件，指定生成的Pact文件输出目录：

pact {
  consumer {
    pactDir = "./target/pacts"
  }
}

执行测试后，符合规范的Pact契约文件会自动生成到./target/pacts目录，你可以直接将这些文件同步到你搭建的独立Pact服务器中使用。

内容的提问来源于stack exchange，提问作者Srividya Kundeti