使用TV4的邮递员架构验证

时间:2019-08-14 23:46:11

标签: automated-tests postman web-api-testing postman-testcase

我在使用“测试”标签中的tv4验证Postman中的模式时遇到了麻烦-无论我提供什么,它总是返回真实的测试。我完全不知所措,真的可以伸出援手-这是我的示例JSON响应和测试:

我已经尝试过我可以找到的每个Stack Overflow / tutorial的大量变化,但是没有任何效果-它总是返回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,因为所有三个属性都是字符串,但都是传递的。我愿意使用其他验证程序或其他技术,只要我可以将其导出为邮递员收藏以与CI / CD流程中的newman一起使用即可。我期待您能提供任何帮助。

1 个答案:

答案 0 :(得分:0)

我建议您不要在Postman中使用tv4,该项目不受积极支持,并且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标签中看到错误。有点混乱,可以整理一下,但是所有错误信息都在那儿。

Postman Failing 1

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

Postman Passing

如果所需的Keys之一不存在,也会因此出错:

Postman Failing 2

使用模式非常困难,创建它们(嵌套数组和对象很棘手)并确保它们正在执行您想做的事情并不容易。

在某些情况下,我认为应该失败,并且它通过了验证测试。只需一点学习/实践,一旦您了解了架构结构,它们就会变得非常有用。