
本文详细介绍了在Pact Java契约测试中,如何有效地向请求体注入动态生成的ID。通过利用Pact的Provider State机制和`valueFromProviderState`方法,结合正确的占位符语法`${}`,可以在Provider端动态生成数据并在Consumer端引用,从而解决因数据清理导致ID变化的问题,确保契约测试的健壮性和准确性。
在微服务架构中,契约测试是确保服务间兼容性的关键环节。然而,当服务的请求或响应体中包含动态生成的数据(如ID)时,传统的硬编码契约可能会失效。本文将深入探讨如何利用Pact Java在Provider端动态生成ID,并在Consumer端的契约请求体中正确引用这些动态ID,以应对数据清理后ID变化的问题。
在Pact契约测试中,Provider(服务提供方)和Consumer(服务消费方)都定义了预期的交互。当某个PUT或POST API需要根据一个ID来更新资源,而这个ID在每次测试运行前可能会动态生成或因数据清理而改变时,Consumer契约中硬编码的ID将不再有效。为了解决这个问题,我们需要一种机制,让Provider在测试执行时生成实际的ID,并将其传递给Consumer契约进行匹配。
Pact通过Provider State(Provider状态)机制来处理动态数据。Provider可以在测试执行前设置一个特定的状态,并在这个状态下生成或获取动态数据。
立即学习“Java免费学习笔记(深入)”;
Provider类示例:
@Slf4j
@Provider("Assignments API")
@Consumer("LTI-AGS-Tool")
@VerificationReports(value = {"console", "markdown"}, reportDir = "target/pacts")
class PactProviderLTIAGSIT {
private HashMap<String, String> headers = new HashMap<>();
private String updateAssignmentId; // 用于存储动态生成的ID
private final String SERVICE_TOKEN = "myToken";
@BeforeEach
void createTeacherAssignment() {
// 模拟创建资源并获取其ID
String assignmentBody = createBodyStringForStudentAssignmentSetup();
assignmentBody = assignmentBody.replace("CPWAG", "OTHER_TEXT_RESOURCE");
headers.put("Content-Type", "application/json");
headers.put("Authorization", "myToken");
RequestSpecification rq = Util.getRequestSpecification().baseUri(baseAssignmentUrl).headers(headers);
Response response = rq.body(assignmentBody).post();
assertEquals(201, response.getStatusCode());
// 从响应中提取动态生成的ID
updateAssignmentId = response.jsonPath().get("assignments[0].refId");
log.info("assignment id is " + updateAssignmentId);
}
@TestTemplate
@ExtendWith(PactVerificationInvocationContextProvider.class)
void pactTestTemplate(PactVerificationContext context, HttpRequest request) {
request.addHeader("Authorization", SERVICE_TOKEN);
logCurlFromPact(context, request);
context.verifyInteraction();
}
@BeforeEach
void before(PactVerificationContext context) {
context.setTarget(new HttpsTestTarget(BASE_PACT_TEACHER_ASSIGNMENTS_URL, 443, ""));
}
/**
* 定义Provider状态,并暴露动态ID
* 当Consumer契约声明需要"Scoring info is passed between ags-tool and assignmentapi"状态时,
* 此方法将被调用,并返回一个包含动态ID的Map。
*/
@State("Scoring info is passed between ags-tool and assignmentapi")
Map<String, Object> getScoringInfo() {
Map<String, Object> map = new HashMap<>();
map.put("assignmentId", updateAssignmentId); // 将动态ID放入Map中
return map;
}
}在上述Provider代码中:
Consumer端需要声明它依赖于Provider的某个状态,并使用Pact DSL提供的特定方法来引用Provider状态中暴露的动态数据。
Consumer契约示例(修正后):
@ExtendWith(PactConsumerTestExt.class)
class PactConsumerSendScoreIT {
private final Map<String, String> headers = new HashMap<>();
private final String path = "/v5/assignmentStatus/update";
@Pact(provider = PACT_PROVIDER, consumer = PACT_CONSUMER)
public RequestResponsePact scoreConsumerPact(PactDslWithProvider builder) {
headers.put("Content-Type", "application/json");
// 构建请求体
DslPart body = new PactDslJsonBody()
// 关键:使用 valueFromProviderState 引用Provider状态中的动态ID
// 第一个参数是JSON体中的键名
// 第二个参数是Provider状态Map中的键名,需要用 ${} 包裹以进行字符串插值
// 第三个参数是Consumer测试时的示例值(用于Consumer端Mock Server匹配)
.valueFromProviderState("assignmentId", "${assignmentId}", "c1ef3bbf-55a2-4638-8f93-22b2916fe085")
.stringType("timestamp", DateTime.now().plusHours(3).toString())
.decimalType("scoreGiven", 75.00)
.decimalType("scoreMaximum", 100.00)
.stringType("comment", "Good work!")
.stringType("status", "IN_PROGRESS")
.stringType("userId", "c2ef3bbf-55a2-4638-8f93-22b2916fe085")
.close();
return builder
.given("Scoring info is passed between ags-tool and assignmentapi") // 声明依赖的Provider状态
.uponReceiving("Scoring info is passed between ags-tool and assignmentapi")
.path(path)
.method("POST")
.body(body)
.headers(headers)
.willRespondWith()
.status(201)
.body(body) // 响应体也可能包含动态ID,此处为简化示例
.toPact();
}
@Test
@PactTestFor(pactMethod = "scoreConsumerPact", providerName = PACT_PROVIDER, port = "8080", pactVersion = PactSpecVersion.V3)
void runTest(MockServer mockServer) {
// Consumer测试时,可以继续使用示例值,因为MockServer会根据契约匹配
// 或者在实际请求中构造动态数据(如果Consumer自身也需要动态数据)
String updateAssignmentId = "c2ef3bbf-55a2-4638-8f93-22b2916fe085";
HashMap<String, Object> map = new HashMap<>();
map.put("timestamp", DateTime.now().plusHours(3).toString());
map.put("scoreGiven", 75.00);
map.put("scoreMaximum", 100.00);
map.put("comment", "Good work!");
map.put("status", "IN_PROGRESS");
map.put("userId", "c2ef3bbf-55a2-4638-8f93-22b2916fe085");
map.put("assignmentId", updateAssignmentId); // Consumer测试时使用的示例ID
RequestSpecification rq = Util.getRequestSpecification().baseUri(mockServer.getUrl()).headers(headers);
Response response = rq.body(map).post(path);
assertEquals(201, response.getStatusCode());
}
}在上述Consumer代码中:
通过Pact的Provider State机制和 valueFromProviderState 方法,我们可以优雅地解决在契约测试中动态ID的注入问题。关键在于Provider端正确地通过 @State 方法暴露动态数据,并在Consumer契约中使用 valueFromProviderState 结合 ${} 占位符语法来引用这些数据。这种方法不仅保证了契约测试的准确性,也极大地提升了测试的灵活性和健壮性,尤其适用于那些依赖于动态生成数据的API。
以上就是如何使用Pact Java在契约体中注入动态ID的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号