test: add more test cases

Author: restfulhead

README.md

@@ -13,8 +13,12 @@ the request body and response body against the schema.
 * Does not support external schemas (inline schemas are supported)
 * Does not (yet?) validate headers
 * Does not (really) validate path params, but supports them in the definition and request route
+* Does not support references to properties (e.g. `$ref: '#/components/schemas/Test1/properties/bar/allOf/0/properties/baz'`)
+* Does not support `readOnly` or `writeOnly`.
 * This library does not validate the Open API specification itself. I suggest you use another tool for this for now.
 
+To check out what is supported, take a look at the [test fixtures](/test/fixtures/)
+
 ## Getting started
 
 Because the Open API specification can come in different flavors and from different sources, loading the specification file is not in scope

package-lock.json

@@ -36,6 +36,7 @@
     "@azure/functions": "^4.2.0",
     "ajv": "^8.12.0",
     "ajv-draft-04": "^1.0.0",
+    "ajv-formats": "^2.1.1",
     "allof-merge": "^0.6.1"
   },
   "devDependencies": {

package.json

@@ -2,6 +2,7 @@
 /* eslint-disable no-invalid-this */
 import AjvDraft4 from 'ajv-draft-04'
 import Ajv, { ErrorObject, ValidateFunction, Options } from 'ajv'
+import addFormats from 'ajv-formats'
 import { OpenAPIV3 } from 'openapi-types'
 import {
   convertDatesToISOString,
@@ -14,7 +15,7 @@ import {
   hasComponentSchemas,
   isReferenceObject,
 } from './openapi-validator'
-import { DEFAULT_AJV_SETTINGS } from './ajv-opts'
+import { AjvExtras, DEFAULT_AJV_EXTRAS, DEFAULT_AJV_SETTINGS } from './ajv-opts'
 import { merge, openApiMergeRules } from 'allof-merge'
 
 const REQ_BODY_COMPONENT_PREFIX_LENGTH = 27 // #/components/requestBodies/PetBody
@@ -83,10 +84,25 @@ export class AjvOpenApiValidator {
    * @param spec - Parsed OpenAPI V3 specification
    * @param ajvOpts - Optional Ajv options
    * @param validatorOpts - Optional additional validator options
+   * @param ajvExtras - Optional additional Ajv features
    */
-  constructor(spec: OpenAPIV3.Document, validatorOpts?: ValidatorOpts, ajvOpts: Options = DEFAULT_AJV_SETTINGS) {
+  constructor(
+    spec: OpenAPIV3.Document,
+    validatorOpts?: ValidatorOpts,
+    ajvOpts: Options = DEFAULT_AJV_SETTINGS,
+    ajvExtras: AjvExtras = DEFAULT_AJV_EXTRAS
+  ) {
     // always disable removeAdditional, because it has unexpected results with allOf
     this.ajv = new AjvDraft4({ ...DEFAULT_AJV_SETTINGS, ...ajvOpts, removeAdditional: false })
+    if (ajvExtras?.addStandardFormats === true) {
+      addFormats(this.ajv)
+    }
+    if (ajvExtras?.customKeywords) {
+      ajvExtras.customKeywords.forEach((kwd) => {
+        this.ajv.addKeyword(kwd)
+      })
+    }
+
     this.validatorOpts = validatorOpts ? { ...DEFAULT_VALIDATOR_OPTS, ...validatorOpts } : DEFAULT_VALIDATOR_OPTS
     if (this.validatorOpts.log == undefined) {
       this.validatorOpts.log = () => {}

src/ajv-openapi-validator.ts

@@ -1,62 +1,20 @@
 // based on express-openapi-validator released under MIT
 // Copyright (c) 2019 Carmine M. DiMascio
 
-import { Options } from 'ajv'
-
-const maxInt32 = 2 ** 31 - 1
-const minInt32 = (-2) ** 31
-
-const maxInt64 = 2 ** 63 - 1
-const minInt64 = (-2) ** 63
-
-const maxFloat = (2 - 2 ** -23) * 2 ** 127
-const minPosFloat = 2 ** -126
-const minFloat = -1 * maxFloat
-const maxNegFloat = -1 * minPosFloat
-
-const alwaysTrue = () => true
-const base64regExp = /^[A-Za-z0-9+/]*(=|==)?$/
-
-export const AJV_FORMATS = {
-  int32: {
-    validate: (i: number) => Number.isInteger(i) && i <= maxInt32 && i >= minInt32,
-    type: 'number',
-  },
-  int64: {
-    validate: (i: number) => Number.isInteger(i) && i <= maxInt64 && i >= minInt64,
-    type: 'number',
-  },
-  float: {
-    validate: (i: number) =>
-      typeof i === 'number' && (i === 0 || (i <= maxFloat && i >= minPosFloat) || (i >= minFloat && i <= maxNegFloat)),
-    type: 'number',
-  },
-  double: {
-    validate: (i: number) => typeof i === 'number',
-    type: 'number',
-  },
-  byte: (b: string) => b.length % 4 === 0 && base64regExp.test(b),
-  binary: alwaysTrue,
-  password: alwaysTrue,
-  'uri-reference': true,
-  'date-time': (dateTimeString: unknown) => {
-    if (typeof dateTimeString === 'object' && dateTimeString instanceof Date) {
-      dateTimeString = dateTimeString.toISOString()
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return !isNaN(Date.parse(dateTimeString as any)) // any test that returns true/false
-  },
-  uuid: (uuid: string) => {
-    const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
-    return uuidRegex.test(uuid)
-  },
-} as const
+import { KeywordDefinition, Options } from 'ajv'
 
 export const DEFAULT_AJV_SETTINGS: Options = {
   allErrors: true,
   useDefaults: true,
   discriminator: true,
-  formats: AJV_FORMATS,
-  coerceTypes: true,
+  coerceTypes: false,
+}
+
+export interface AjvExtras {
+  addStandardFormats?: boolean
+  customKeywords?: KeywordDefinition[]
+}
+
+export const DEFAULT_AJV_EXTRAS: AjvExtras = {
+  addStandardFormats: true,
 }

src/ajv-opts.ts

@@ -0,0 +1,29 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            $ref: '#/components/schemas/Test1',
+          },
+        },
+      },
+    },
+    schemas: {
+      Test1: {
+        properties: {
+          foo: {
+            type: 'string',
+            default: 'foo',
+          },
+        },
+        required: ['foo'],
+      },
+    },
+  },
+  request: {
+    body: {}
+  },
+};

test/fixtures/accept-requestBody-with-components-default.js.txt

@@ -0,0 +1,30 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            $ref: '#/components/schemas/Test1',
+          },
+        },
+      },
+    },
+    schemas: {
+      Test1: {
+        properties: {
+          foo: {
+            type: 'string',
+          },
+        },
+        required: ['foo'],
+      },
+    },
+  },
+  request: {
+    body: {
+      foo: 'asdf',
+    },
+  },
+};

test/fixtures/accept-requestBody-with-components-ref.js.txt

@@ -0,0 +1,33 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            properties: {
+              foo: {
+                allOf: [{ $ref: '#/components/schemas/MyType' }],
+                type: 'string',
+                nullable: true,
+              },
+            },
+          },
+        },
+      },
+    },
+    schemas: {
+      MyType: {
+        type: "string",
+        pattern: "^[A-Za-z0-9\\u00C0-÷\\u017F\\s!'¿¡@$€_+=\\-;:/.,?>)(<[]*$",
+      },
+    },
+  },
+  request: {
+    body: {
+      foo: null,
+    },
+  },
+};

test/fixtures/accept-requestBody-with-nullable-and-type-on-allof.js.txt

@@ -0,0 +1,33 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            properties: {
+              foo: {
+                oneOf: [
+                  { type: 'null' },
+                  {
+                    type: 'string',
+                    nullable: true,
+                    enum: ['HOME', 'CAR'],
+                  },
+                ]
+              },
+            },
+          },
+        },
+      },
+    },
+    schemas: null,
+  },
+  request: {
+    body: {
+      foo: null,
+    },
+  },
+};

test/fixtures/accept-requestBody-with-nullable-enum-oneof.js.txt

@@ -0,0 +1,28 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            properties: {
+              foo: {
+                type: 'string',
+                nullable: true,
+                enum: [null, 'HOME', 'CAR'],
+              },
+            },
+          },
+        },
+      },
+    },
+    schemas: null,
+  },
+  request: {
+    body: {
+      foo: null,
+    },
+  },
+};

test/fixtures/accept-requestBody-with-nullable-enum.js.txt

@@ -0,0 +1,41 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json': {
+          schema: {
+            $ref: '#/components/schemas/Test1',
+          },
+        },
+      },
+    },
+    schemas: {
+      Test1: {
+        properties: {
+          foo: {
+            type: 'string',
+            default: 'foo',
+          },
+        },
+        required: ['foo'],
+      },
+    },
+  },
+  request: {
+    body: {
+        "something-else": 123
+    }
+  },
+  expectedErrors: [
+        { 
+            code: 'Validation-additionalProperties', 
+            source: { 
+                pointer: '#/components/schemas/Test1/additionalProperties'
+            }, 
+            status: 400, 
+            "title": 'must NOT have additional properties'
+        }
+    ]
+};