tests: more test cases

Author: restfulhead

README.md

@@ -1,16 +1,18 @@
 # Azure Functions Open API v3 specification validation
 
-This library contains an Open API v3 validator and an Azure Functions v4 hook that validates http function requests.
+This library contains an Open API v3.0 validator and an Azure Functions v4 hook that validates http function requests.
 
 It identifies the Azure function route and tries to find a matching route in the Open API specification. It then validates query parameters, 
 the request body and response body against the schema.
 
 ## Caveats
 
-* Early version: Bugs most likely exist. Bug fixes welcome and more test cases very welcom. :-)
-* So far only tested with Open API specifications in v3
+* Early version: Bugs most likely exist. Bug fixes welcome and more test cases very welcome, too. :-)
+* Only supports v3.0 of the Open API specifications (v3.1 has not been tested, contributions welcome)
+* Only supports content of type `application/json` (and not `multipart/form-data` for example)
+* Does not support external schemas (inline schemas are supported)
 * Does not (yet?) validate headers
-* Does not (really) validate path params, but supports them
+* Does not (really) validate path params, but supports them in the definition and request route
 * This library does not validate the Open API specification itself. I suggest you use another tool for this for now.
 
 ## Getting started

test/fixtures/accept-empty-body-when-body-is-not-required-and-body-schema-has-no-required-properties.js.txt

@@ -0,0 +1,43 @@
+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',
+                },
+            },
+          },
+        },
+      },
+    },
+    schemas:
+      {
+        Test1: {
+            type: 'object',
+            properties: {
+                foo: {
+                    type: 'string',
+                },
+            },
+        },
+        Test2: {
+            type: 'object',
+            properties: {
+                boo: {
+                    type: 'string',
+                },
+            },
+        },
+      },
+  },
+  request: {
+    body: {}
+  },
+};

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

@@ -51,15 +51,22 @@ interface TestFixture {
 }
 
 // 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 fixtureDir = `${__dirname}/../fixtures`
 const files = fs.readdirSync(fixtureDir)
 const testCases: { [key: string]: TestFixture } = {}
 for (const file of files) {
   if (file.endsWith('.js.txt')) {
     const testName = path.basename(file, '.js.txt').replace(/-/g, ' ')
     const fixtureContent = fs.readFileSync(path.resolve(fixtureDir, file), { encoding: 'utf-8' })
-    const fixture: TestFixture = eval(fixtureContent)
-    testCases[testName] = fixture
+    try {
+      const fixture: TestFixture = eval(fixtureContent)
+      if (!onlyInclude || onlyInclude.length === 0 || onlyInclude.includes(file)) {
+        testCases[testName] = fixture
+      }
+    } catch (e: any) {
+      throw new Error(`Error parsing fixture ${file}: ${e.message}`)
+    }
   }
 }
 
@@ -74,7 +81,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.route}` ?? '/test'] = operations
+        spec.paths[`/${fixture.request.route ?? 'test'}`] = operations
         operations[(fixture.request.method as OpenAPIV3.HttpMethods) ?? 'post'] = {
           requestBody: fixture.validateArgs.requestBody,
           responses: {},
@@ -86,7 +93,7 @@ describe('The api validator', () => {
 
     if (fixture.validateArgs.requestBody && fixture.request.body) {
       const result = validator.validateRequestBody(
-        `/${fixture.request.route}` ?? '/test',
+        `/${fixture.request.route ?? 'test'}`,
         fixture.request.method ?? 'post',
         fixture.request.body
       )