automated-tests - 使用 TV4 的 Postman 架构验证

Question

我在测试选项卡内使用 tv4 验证 Postman 中的模式时遇到问题 - 无论我提供什么，它总是返回一个真实的测试。我完全不知所措，真的可以用手 - 这是我的示例 JSON 响应和我的测试:

我已经尝试了我能找到的每个 Stack Overflow/教程的大量变体，但没有任何效果 - 它总是返回 true。

//Test Example 

var jsonData = JSON.parse(responseBody);
const schema = {
"required" : ["categories"],
"properties": {
"categories": {
    "required" : ["aStringOne", "aStringTwo", "aStringThree" ],
    "type": "array",
    "properties" : {
        "aStringOne": {"type": "string" },
        "aStringTwo": {"type": "null" },
        "aStringThree": {"type": "boolean" }
    }
}
}
};

pm.test('Schema is present and accurate', () => {
var result=tv4.validateMultiple(jsonData, schema);
console.log(result);
pm.expect(result.valid).to.be.true;
});

//Response Example

{
"categories": [
{
    "aStringOne": "31000",
    "aStringTwo": "Yarp",
    "aStringThree": "More Yarp Indeed"
}
]
}

这应该返回 false，因为所有三个属性都是字符串，但它的传递。我愿意使用不同的验证器或其他技术，只要我可以将其导出为 postman 集合以在我的 CI/CD 过程中与 newman 一起使用。我期待着您能提供的任何帮助。

Answer 1

我建议不要使用 tv4在 Postman 中，该项目没有得到积极支持，Postman 现在包含一个更好的(在我看来)、更积极维护的选项，称为 Ajv .

语法略有不同，但希望这能让您了解它如何为您工作。

我已经模拟了您的数据并将所有内容添加到 Tests 中选项卡 - 如果您更改 jsonData变量为 pm.response.json()它将针对实际的响应主体运行。

var jsonData = {
    "categories": [
        {
            "aStringOne": "31000",
            "aStringTwo": "Yarp",
            "aStringThree": "More Yarp Indeed"
        }
    ]
}



var Ajv = require('ajv'),
    ajv = new Ajv({logger: console, allErrors: true}),
    schema =  {
    "type": "object",
    "required": [ "categories"],
    "properties": {
      "categories": {
          "type": "array",
          "items": {
              "type": "object",
              "required": [ "aStringOne", "aStringTwo", "aStringThree" ],
              "properties": {
                  "aStringOne": { "type": "string" },
                  "aStringTwo": { "type": "integer"},
                  "aStringThree": { "type": "boolean"},
         }
       }
     }
   }
}

pm.test('Schema is valid', function() {
    pm.expect(ajv.validate(schema, jsonData), JSON.stringify(ajv.errors)).to.be.true
});

这是一个失败的例子，我已经包含了 allErrors标记以便它将返回所有错误，而不仅仅是它看到的第一个错误。在pm.expect()方法，我添加了 JSON.stringify(ajv.errors)所以你可以在 Test Result 中看到错误标签。它有点乱，可以整理一下，但所有错误信息都在那里。

将属性设置为 string显示验证通过:

如果需要 Keys 之一不存在，它也会为此出错:

使用模式非常困难，而且创建它们(嵌套数组和对象很棘手)并确保它们按照您的意愿行事并不容易。

在某些情况下，我认为某些东西应该失败并且它通过了验证测试。它只需要一点学习/练习，一旦您理解了模式结构，它们就会变得非常有用。