test: more test cases

Author: restfulhead

src/ajv-opts.ts

@@ -47,6 +47,10 @@ export const AJV_FORMATS = {
     // 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
 
 export const DEFAULT_AJV_SETTINGS: Options = {

…st/fixtures/accept-custom-formats.js.txt …cept-custom-date-time-query-param.js.txttest/fixtures/accept-custom-formats.js.txt renamed to test/fixtures/accept-custom-date-time-query-param.js.txt test/fixtures/accept-custom-formats.js.txt renamed to test/fixtures/accept-custom-date-time-query-param.js.txt

@@ -0,0 +1,28 @@
+module.exports = {
+    validateArgs: {
+      paths: {
+          '/foo': {
+              get: {
+                  parameters: [
+                      {
+                          in: 'query',
+                          name: 'foo',
+                          schema: {
+                            type: 'string',
+                            format: 'uuid',
+                          },
+                      },
+                  ],
+              }
+          }
+      },
+    },
+    request: {
+      route: 'foo',
+      query: {
+        foo: '0210a341-d7f9-4d5f-80e5-db5e8143ea12'
+      }
+    },
+  };
+  
+  

test/fixtures/accept-custom-uuid-query-param.js.txt

@@ -0,0 +1,50 @@
+module.exports = {
+  validateArgs: {
+    requestBody: {
+      description: 'a test body',
+      content: {
+        'application/json; charset=utf-8': {
+          schema: {
+            properties: {
+              test1: {
+                $ref: '#/components/schemas/Test1',
+              },
+              test2: {
+                $ref: '#/components/schemas/Test2',
+              },
+            },
+            required: ['test1', 'test2'],
+          },
+        },
+      },
+    },
+    schemas: {
+      Test1: {
+        properties: {
+          foo: {
+            type: 'string',
+          },
+        },
+        required: ['foo'],
+      },
+      Test2: {
+        properties: {
+          boo: {
+            type: 'string',
+          },
+        },
+        required: ['boo'],
+      },
+    },
+  },
+  request: {
+    body: {
+      test1: {
+        foo: 'asdf',
+      },
+      test2: {
+        boo: 'ccccc',
+      },
+    },
+  },
+};

test/fixtures/accept-multiple-local-refs-in-body-as-object.js.txt

@@ -0,0 +1,29 @@
+module.exports = {
+  validateArgs: {
+    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-no-parameters.js.txt

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

test/fixtures/accept-recursive-ref-in-body-as-object.js.txt

@@ -0,0 +1,38 @@
+module.exports = {
+    validateArgs: {
+      paths: {
+          '/foo': {
+              get: {
+                  parameters: [
+                      {
+                          in: 'query',
+                          name: 'foo',
+                          schema: {
+                            type: 'string',
+                            format: 'uuid',
+                          },
+                      },
+                  ],
+              }
+          }
+      },
+    },
+    request: {
+      route: 'foo',
+      query: {
+        foo: 'hello'
+      }
+    },
+    expectedErrors: [
+        { 
+            code: 'Validation-format', 
+            source: { 
+                pointer: '#/paths/foo/get/parameters/foo/format'
+            }, 
+            status: 400, 
+            "title": 'must match format "uuid"'
+        }
+    ]
+  };
+  
+  

test/fixtures/fail-custom-formats.js.txt …fail-custom-date-time-query-param.js.txttest/fixtures/fail-custom-formats.js.txt renamed to test/fixtures/fail-custom-date-time-query-param.js.txt test/fixtures/fail-custom-formats.js.txt renamed to test/fixtures/fail-custom-date-time-query-param.js.txt

@@ -0,0 +1,33 @@
+module.exports = {
+  validateArgs: {
+    parameters: [],
+    requestBody: {
+      description: 'a multipart',
+      content: {
+        'multipart/form-data': {
+          schema: {
+            type: 'object',
+            properties: {
+              files: {
+                type: 'array',
+                items: { type: 'string', format: 'binary' },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  request: {
+    body: {
+      files: [],
+    },
+    headers: {
+      'content-type':
+        'multipart/form-data; boundary=----WebKitFormBoundaryWyK9kAU7d35AKf26',
+    },
+  },
+  requestOpts: {
+    strictRequestBodyValidation: false
+  }
+};

test/fixtures/fail-custom-uuid-query-param.js.txt

@@ -45,13 +45,14 @@ interface TestFixture {
 
   requestOpts?: {
     strictQueryParamValidation?: boolean
+    strictRequestBodyValidation?: boolean
   }
 
   expectedErrors?: ErrorObj[]
 }
 
 // read all *.ts files from the fixtures directory
-const onlyInclude: string[] = ['accept-empty-body-when-body-is-not-required-and-body-schema-has-no-required-properties.js.txt'] // can be used to only run specific tests. for local testing only!
+const onlyInclude: string[] = [] // can be used to only run specific tests. for local testing only!
 const fixtureDir = `${__dirname}/../fixtures`
 const files = fs.readdirSync(fixtureDir)
 const testCases: { [key: string]: TestFixture } = {}
@@ -95,7 +96,8 @@ describe('The api validator', () => {
       const result = validator.validateRequestBody(
         `/${fixture.request.route ?? 'test'}`,
         fixture.request.method ?? 'post',
-        fixture.request.body
+        fixture.request.body,
+        fixture.requestOpts?.strictRequestBodyValidation ?? true
       )
       if (fixture.expectedErrors) {
         expect(result).toEqual(fixture.expectedErrors)
@@ -125,7 +127,12 @@ describe('The api validator', () => {
                 }
               }
               if (operation.requestBody && fixture.request.body) {
-                const result = validator.validateRequestBody(path, methodName, fixture.request.body)
+                const result = validator.validateRequestBody(
+                  path,
+                  methodName,
+                  fixture.request.body,
+                  fixture.requestOpts?.strictRequestBodyValidation ?? true
+                )
                 if (fixture.expectedErrors) {
                   expect(result).toEqual(fixture.expectedErrors)
                 } else {