expect jsonSchema is not working as expected

[erkeen]

jsonSchema is not working as expected:

expect({ a: 1, b: "two" }).to.have.jsonSchema({
    type: "object",
    properties: {
      a: {
        type: "number",
      },
      b: {
        type: "string",
      },
    },
  });

This is giving following error:

AssertionError [ERR_ASSERTION]: Response doesn't match with JSON schema - [
         {
           "keywordLocation": "#/type",
           "instanceLocation": "#"
         }
       ]

if I delete type: "object", it is working, but it is not checking the type correctly for properties:

expect({ a: 1, b: "two" }).to.have.jsonSchema({
    properties: {
      a: {
        type: "string",
      },
      b: {
        type: "boolean",
      },
    },
  });

[ASaiAnudeep]

In general, expect method accepts a response object which contains a json property. To make it working for custom inputs, we need to wrap the object inside a property named json.

const { expect } = require('pactum');

expect({ json: { a: 1, b: "two" } }).to.have.jsonSchema({
  type: "object",
  properties: {
    a: {
      type: "string",
    },
    b: {
      type: "string",
    },
  },
});

[erkeen]

But, most of API response objects don't include json property. It would be better without json property to test.

[ASaiAnudeep]

When working with pactum, in most cases response body will be parsed as a JSON content and attached to json property. So we don't need to attach the json property manually.

const { expect, spec } = require('pactum');

const response = await spec().get('https://jsonplaceholder.typicode.com/todos/1')

expect(response).to.have.jsonSchema({
  type: "object",
  properties: {
    userId: {
      type: "number",
    },
    title: {
      type: "string",
    },
  },
});