tests: more unit tests

Author: restfulhead

test/fixtures/accept-a-charset-on-content-type.js.txt

@@ -25,8 +25,5 @@ module.exports = {
   },
   request: {
     body: {},
-    headers: {
-      'content-type': 'application/json',
-    },
   },
 }

test/fixtures/accept-a-required-query-param.js.txt

@@ -22,7 +22,6 @@ module.exports = {
     },
   },
   request: {
-    path: '/foo/asdf?foo=asdf',
     route: 'foo/{path1}',
     query: {
       foo: 'asdf'

test/fixtures/accept-an-additional-query-param.js.txt

@@ -0,0 +1,29 @@
+module.exports = {
+  validateArgs: {
+    paths: {
+        '/foo': {
+            get: {
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'foo',
+                        type: 'string',
+                        required: true,
+                    },
+                ],
+            }
+        }
+    },
+  },
+  request: {
+    path: 'foo',
+    query: {
+      foo: 'asdf',
+      additional1: 'bbbbb',
+    }
+  },
+  requestOpts: {
+    strictQueryParamValidation: false
+  }
+};
+

test/fixtures/accept-an-optional-query-param.js.txt

@@ -0,0 +1,23 @@
+module.exports = {
+  validateArgs: {
+    paths: {
+        '/foo': {
+            get: {
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'foo',
+                        type: 'string',
+                        required: false,
+                    },
+                ],
+            }
+        }
+    },
+  },
+  request: {
+    path: 'foo',
+    query: { }
+  }
+};
+

test/fixtures/accept-custom-formats-openapi3.js.txt

@@ -0,0 +1,27 @@
+module.exports = {
+  validateArgs: {
+    paths: {
+        '/foo': {
+            get: {
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'startDate',
+                        schema: {
+                            type: 'string',
+                            format: 'date-time',
+                        },
+                    },
+                ],
+            }
+        }
+    },
+  },
+  request: {
+    path: 'foo',
+    query: {
+      startDate: '2024-02-01T01:34:03.001Z',
+    }
+  },
+};
+

test/fixtures/fail-a-missing-query-param.js.txt

@@ -1,15 +1,9 @@
 module.exports = {
   validateArgs: {
     paths: {
-        '/foo/{path1}': {
+        '/foo': {
             get: {
                 parameters: [
-                    {
-                        in: 'path',
-                        name: 'path1',
-                        type: 'string',
-                        required: true,
-                    },
                     {
                         in: 'query',
                         name: 'foo',
@@ -22,16 +16,14 @@ module.exports = {
     },
   },
   request: {
-    path: '/foo/asdf?',
-    route: 'foo/{path1}',
-    query: {}
-  },
-  expectedErrors: [
-    {
-        status: 400,
-        code: 'Validation-required-query-parameter',
-        source: { parameter: 'foo' },
-        title: "The query parameter is required."
+    path: 'foo',
+    query: {
+      foo: 'asdf',
+      additional1: 'bbbbb',
     }
-  ],
+  },
+  requestOpts: {
+    strictQueryParamValidation: false
+  }
 };
+

test/fixtures/fail-custom-formats-openapi3.js.txt

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

test/fixtures/fail-reject-an-additional-query-param.js.txt

@@ -0,0 +1,34 @@
+module.exports = {
+  validateArgs: {
+    paths: {
+        '/foo': {
+            get: {
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'foo',
+                        type: 'string',
+                        required: true,
+                    },
+                ],
+            }
+        }
+    },
+  },
+  request: {
+    path: 'foo',
+    query: {
+      foo: 'asdf',
+      additional1: 'bbbbb',
+    }
+  },
+  expectedErrors: [
+    {
+        status: 400,
+        code: 'Validation-invalid-query-parameter',
+        source: { parameter: 'additional1' },
+        title: "The query parameter is not supported."
+    }
+  ],
+};
+

test/unit/ajv-validator-api.spec.ts

@@ -33,14 +33,11 @@ interface TestFixture {
   }
   request: {
     method?: string
-    path?: string
+    route?: string
     body?: unknown
     params?: {
       [key: string]: string
     }
-    headers?: {
-      [key: string]: string
-    }
     query?: {
       [key: string]: string
     }
@@ -77,7 +74,7 @@ describe('The api validator', () => {
     } else {
       if (fixture.validateArgs.requestBody || fixture.validateArgs.parameters) {
         const operations: { [method in OpenAPIV3.HttpMethods]?: OpenAPIV3.OperationObject<any> } = {}
-        spec.paths[fixture.request.path ?? '/test'] = operations
+        spec.paths[`/${fixture.request.route}` ?? '/test'] = operations
         operations[(fixture.request.method as OpenAPIV3.HttpMethods) ?? 'post'] = {
           requestBody: fixture.validateArgs.requestBody,
           responses: {},
@@ -88,7 +85,11 @@ describe('The api validator', () => {
     const validator = new AjvOpenApiValidator(spec)
 
     if (fixture.validateArgs.requestBody && fixture.request.body) {
-      const result = validator.validateRequestBody(fixture.request.path ?? '/test', fixture.request.method ?? 'post', fixture.request.body)
+      const result = validator.validateRequestBody(
+        `/${fixture.request.route}` ?? '/test',
+        fixture.request.method ?? 'post',
+        fixture.request.body
+      )
       if (fixture.expectedErrors) {
         expect(result).toEqual(fixture.expectedErrors)
       } else {
@@ -117,11 +118,7 @@ describe('The api validator', () => {
                 }
               }
               if (operation.requestBody && fixture.request.body) {
-                const result = validator.validateRequestBody(
-                  fixture.request.path ?? '/test',
-                  fixture.request.method ?? 'post',
-                  fixture.request.body
-                )
+                const result = validator.validateRequestBody(path, methodName, fixture.request.body)
                 if (fixture.expectedErrors) {
                   expect(result).toEqual(fixture.expectedErrors)
                 } else {