Wrong portman variation tests while using OpenAPI keyword as schema property name about portman

[tillig]

We just ran into a similar issue where we have a property required on one of our objects.

[tillig]

Doing some research on where/how to fix this. For a property named required I see the exception during test generation looks like this:

/Users/tillig/specification/node_modules/@apideck/portman/dist/application/Fuzzer.js:497
                var requiredFuzz = node.required.map(function (req) { return "" + requiredPath + req; });
                                                 ^

TypeError: node.required.map is not a function
    at Object.<anonymous> (/Users/tillig/specification/node_modules/@apideck/portman/dist/application/Fuzzer.js:497:50)
    at walker (/Users/tillig/specification/node_modules/traverse/index.js:150:16)
    at /Users/tillig/specification/node_modules/traverse/index.js:171:17
    at Array.forEach (<anonymous>)
    at forEach (/Users/tillig/specification/node_modules/traverse/index.js:19:30)
    at walker (/Users/tillig/specification/node_modules/traverse/index.js:166:4)
    at /Users/tillig/specification/node_modules/traverse/index.js:171:17
    at Array.forEach (<anonymous>)
    at forEach (/Users/tillig/specification/node_modules/traverse/index.js:19:30)
    at walker (/Users/tillig/specification/node_modules/traverse/index.js:166:4)
    at /Users/tillig/specification/node_modules/traverse/index.js:171:17
    at Array.forEach (<anonymous>)
    at forEach (/Users/tillig/specification/node_modules/traverse/index.js:19:30)
    at walker (/Users/tillig/specification/node_modules/traverse/index.js:166:4)
    at /Users/tillig/specification/node_modules/traverse/index.js:171:17
    at Array.forEach (<anonymous>)

Working backwards, I can see that things start happening right around line 854 in Fuzzer.analyzeFuzzJsonSchema with the required issue happening specifically at line 888.

I'm not entirely sure how to fix that yet, but it looks like there are similar sections in there for other reserved words like minimum, maxiumum, maxLength, minLength, and nullable.

[tillig]

Looks like a failing Jest test is something like:

  it('should analyse JSON schema of request body with properties named after reserved words for fuzz detection', async () => {
    // Analyse JSON schema with properties that use reserved words
    const schema = {
      properties: {
        nullable: {
          type: 'object',
          properties: {
            required: {
              type: 'object',
              properties: {
                minimum: {
                  type: 'object',
                  required: ['maxLength'],
                  properties: {
                    maxLength: {
                      type: 'number',
                      example: 1,
                      minimum: 1,
                      maximum: 100,
                      minLength: 1,
                      maxLength: 5
                    }
                  }
                }
              }
            }
          }
        }
      }
    } as OpenAPIV3.SchemaObject

    const result = fuzzer.analyzeFuzzJsonSchema(schema)
    expect(result).toMatchSnapshot()
  })