java - 当数据返回有或没有子项的项目时如何验证 PACT(填充或不存在现有数组)
问题描述
我正在使用 PACT 和 Java 进行合同测试,我的问题是我有一个 api,其中的项目可能会像这样出现:
[
{
"programCode": "ELA_NGL_G7_TX",
"contentResources": [
{
"tocPosition": 1827,
"contentIdentifier": "l_6bf0783e-8499-4f6c-9f9b-c8fbdc8dcf6b_e5f25016-e2fa-4223-8969-2004c644917d"
},
{
"tocPosition": 1828,
"contentIdentifier": "l_192af774-54b9-4280-87e9-71f2b86a7d4d_e5f25016-e2fa-4223-8969-2004c644917d",
"skills": [
{
"skillId": "ae836bd9-4758-4665-b3f8-8339313363e3",
"spineId": "63c2b7d0-cd69-4e8a-9761-c90623104b8c"
}
]
}
]
如您所见,有时内在技能数组会出现其他人不会出现的情况,并且不确定如何将这种情况纳入我的消费者测试中。我的意思是,如果响应有或没有取决于特定参数的技能数组,我可以有两个不同的测试,这可能没问题,但在这里它们来自同一个调用。所以我想我需要的是一个 if else 之类的东西,如果存在技能数组,那么我会断言它的内在孩子,否则就忽略它。
这是我的消费者:
@ExtendWith(PactConsumerTestExt.class)
public class PublishContractWithTocGetSummaryTest {
Map<String, String> headers = new HashMap<>();
String getRecommendations = "/toc/getsummary/ELA_NGL_G7_TX";
@Pact(provider = "CRS-METADATA-FILTERING-SERVICE", consumer = "CRS-TOC-RECOMMENDER")
public RequestResponsePact createPact(PactDslWithProvider builder) throws IOException {
headers.put("Content-Type", "application/json");
DslPart body = new PactDslJsonBody()
.stringValue("programCode", "ELA_NGL_G7_TX")
.eachLike("contentResources")
.integerType("tocPosition", 0)
.stringType("contentIdentifier", "l_9d23cb4f-69dc-4032-bb53-73501234dc14_e5f25016-e2fa-4223-8969-2004c644917d")
.closeArray();
return builder
.given("get TOC Summary")
.uponReceiving("get TOC Summary")
.path(getRecommendations)
.method("GET")
.headers(headers)
.willRespondWith()
.status(200)
.body(body)
.toPact();
}
非常感谢。
解决方案
对您的问题的简短回答是,没有办法完全按照您的意愿行事。
关于为什么不可用的更长答案在常见问题解答中:
为什么不支持指定可选属性?
首先,假设您在进行验证测试时可以控制提供者的数据(和消费者的数据)。如果您不这样做,那么 Pact 可能不是适合您情况的最佳工具。
其次,如果 Pact 支持断言元素$.body.name
可能存在于响应中,那么您编写的消费者代码可以处理$.body.name
可选$.body.firstname
的不正确的假设。请记住,提供者可能会返回额外的数据而不会违反合同,但它必须至少提供您期望的数据。
指定“SOME_VALUE 或 null”也是如此。如果您的所有提供者验证测试数据都针对此键返回空值,您可能会认为您已经验证了“SOME_VALUE”,但实际上,您从未验证过。在生产环境中,您可能会得到一个完全不同的“SOME_VALUE”,这可能会导致问题。
指定长度为 0 或更大的数组也是如此。如果您的所有提供者验证数据都返回 0 长度数组,那么您的所有验证测试都将通过,而您无需验证数组的内容。这就是为什么您只能指定最小长度为 1 的数组或长度为零的数组的原因。
请记住,与描述文档所有可能状态的模式不同,Pact 是“示例契约”。如果您需要断言多个变体是可能的,那么您需要为每个变体提供一个示例。但是,在为每个变体添加 Pact 测试之前,请考虑它是否对您真的很重要。请记住,每次交互都会带来维护和执行时间的“成本”,您需要考虑在您的特定情况下是否值得付出代价。您最好处理协议中的常见场景,然后将您的消费者编写代码以优雅地处理意外变化(例如,通过忽略该数据并发出警报)。
https://docs.pact.io/faq#why-is-there-no-support-for-specifying-optional-attributes
推荐阅读
- python-2.7 - 错误"AttributeError: 'product.pricelist' 对象没有属性 'get_product_pricelist'
- three.js - Oculus GO 浏览器全屏
- ruby-on-rails - 限制用户在模型中执行某些操作
- mysql - Rails 4:两个 has_many 模型的模型关系和索引
- python - 为什么 python 显示 datetime(2018,01,01,10,08,00) 的无效令牌?
- c - 就 CPU 时间而言,等待互斥体与等待信号量
- codeigniter - 错误“警告:mysqli_fetch_assoc() 期望参数 1 为 mysqli_result,布尔值在 C:\xampp\htdocs\biservis\profil.php 第 199 行给出”
- python - 仅当查询中的列表计数大于 0 时才应用过滤器
- amazon-web-services - 使用 SQS、SNS 和 APIGW 进行无服务器或 SAM 和本地开发
- sql - 错误:select * from table where column like '%tom's'