Integration of the oneOf test in the responseBodyTest

[jdevosMagento]

Hello,

My API randomly responds an items list, and I want to test an item from this list.

Actually :

My API respond this :

{
    "XxxxxxXxxxxxx": [
        {
            "string": "XXXXXXXXXX",
            "Xxxxxx": [
                {
                    "state1": true,
                    "state2": false,
                    "state3": true,
                    "string_id": "AAA"
                },
                {
                    "state1": true,
                    "state2": false,
                    "state3": true,
                    "string_id": "BBB"
                },
                {
                    "state1": true,
                    "state2": false,
                    "state3": true,
                    "string_id": "CCC"
                },
                {
                    "state1": true,
                    "state2": false,
                    "state3": true,
                    "string_id": "DDD"
                },
                {
                    "state1": true,
                    "state2": false,
                    "state3": true,
                    "string_id": "EEE"
                }
            ]
        }
    ]
}

My test :

{
     "contentTests": {
        "openApiOperationId": "Xxxxxx",
        "responseBodyTests": [
            {
                "key": "XxxxxxXxxxxxx",
                "minLength": 1
            },
            {
                "key": "XxxxxxXxxxxxx[0].Xxxxxx",
                "minLength": 1
            },
            {
                "key": "XxxxxxXxxxxxx[0].Xxxxxx[0].state1",
                "value": true
            },
            {
                "key": "XxxxxxXxxxxxx[0].Xxxxxx[0].state2",
                "value": false
            },
            {
                "key": "XxxxxxXxxxxxx[0].Xxxxxx[0].string_id",
                "value": "AAA"
            }
        ]
    }
}

My problem :

AAA is not always the first result to appear.
On postman it is possible to do a test with for example "to.be.oneOf" :

if (jsonData?.XxxxxxXxxxxxx[0].Xxxxxx[0].string_id) {
    pm.test("[XXX]::/xxxxxx/param1/:param1/param2/:param2 - Content check if value for 'XxxxxxXxxxxxx[0].Xxxxxx[0].string_id' in one of 'AAA,BBB,CCC,DDD,EEE'", function () {
        pm.expect(jsonData.XxxxxxXxxxxxx[0].Xxxxxx[0].string_id).to.be.oneOf(['AAA', 'BBB', 'CCC', 'DDD', 'EEE'])
    })
}

Is it possible to plan to integrate, as there is already a test "value", "contains", "minLength", "maxLength" this type of test?

Jeremy

[thim81]

@jdevosMagento This seems like a very good additional contentTest that we could add for Portman.

How would you define the configuration in Portman?
Something like this?

{
  "version": 1,
  "contentTests": [
    {
      "openApiOperationId": "leadsAll",
      "responseBodyTests": [
        {
          "key": "data[0]. string_id",
          "oneOf": ["AAA", "BBB"]
        }
      ]
    }
  ]
}

[thim81]

@jdevosMagento There is a PR created for this request. If things keep progressing, this request will land in the next Portman release.

[thim81]

@nicklloyd Any preference to mark the "oneOf" option?

In JS it would be .includes (I guess).

[nicklloyd]

Think oneOf is good as it's clear to folks used to jsonSchema. Should be sure to differentiate from 'contains' though as could cause confusion.

Is the idea to limit this to string values or could a schema def/ref be passed in here?

[thim81]

for response body, the types are string, number, boolean
for response header, only string types are supported.

[thim81]

@jdevosMagento We just release Portman v1.17, which includes new content check: oneOf.