Merge pull request #263 from sergey-shandar-forks/sergey-nullref

Fixing multiple `oneOf`s

.vscode/launch.json

@@ -84,7 +84,10 @@
       "stopOnEntry": false,
       "args": [
         "--no-timeouts",
-        "test/modelValidatorTests.js"
+        "test/modelValidatorTests.ts",
+        "-r",
+        "ts-node/register",
+        "--no-timeouts"
       ],
       "env": {}
     },

ChangeLog.md

@@ -1,3 +1,7 @@
+### 06/19/2018 0.4.49
+- Bug fix: Data is valid against more than one schema from `oneOf` [#248](https://github.com/Azure/oav/pull/248)
+  The problem occurs when referenced model may also accept `null`. The fix is replacing `oneOf` with `anyOf`.
+
 ### 05/14/2018 0.4.38
 - Bug fix: `oav extract-xmsexamples` also extracts request headers. [#241](https://github.com/Azure/oav/pull/241)
 - Bug fix: x-ms-parametrized-host is not validated correctly [#240](https://github.com/Azure/oav/issues/240)

lib/util/utils.ts

@@ -559,11 +559,12 @@ export interface Model {
   additionalProperties?: Model|false
   "x-nullable"?: Unknown
   in?: Unknown
-  oneOf?: Unknown
+  oneOf?: Model[]
   $ref?: string
   required?: Unknown[]|false
   schema?: Model
   allOf?: Ref[]
+  anyOf?: Model[]
   description?: Unknown
   discriminator?: string
   "x-ms-discriminator-value"?: string
@@ -698,8 +699,9 @@ export function allowNullType(entity: Model, isPropRequired?: boolean|{}): Model
     && entity.$ref
     && shouldAcceptNullValue(entity["x-nullable"], isPropRequired)) {
     const savedEntity = entity
-    entity = {}
-    entity.oneOf = [savedEntity, { type: "null" }]
+    entity = {
+      anyOf: [savedEntity, { type: "null" }]
+    }
   }
   return entity
 }

lib/validate.ts

@@ -3,9 +3,6 @@
 
 import * as fs from "fs"
 import * as path from "path"
-import * as msrest from "ms-rest"
-import * as msrestazure from "ms-rest-azure"
-import { ResourceManagementClient } from "azure-arm-resource"
 import { log } from "./util/logging"
 import * as utils from "./util/utils"
 import { SpecValidator, SpecValidationResult } from "./validators/specValidator"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "oav",
-  "version": "0.4.48",
+  "version": "0.4.49",
   "author": {
     "name": "Microsoft Corporation",
     "email": "[email protected]",

test/modelValidation/swaggers/specification/nullableTypes/examples/definitionWithReferenceNullOperation.json

@@ -0,0 +1,11 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "namedProp": null
+      }
+    }
+  }
+}

test/modelValidation/swaggers/specification/nullableTypes/invalid_type_test.json

@@ -314,6 +314,29 @@
         }
       }
     },
+    "/foo/definitionWithReferenceNullOperation": {
+      "get": {
+        "tags": [
+          "getTag"
+        ],
+        "operationId": "definitionWithReferenceNull_Get",
+        "description": "Operation to test invalid_type for nulls",
+        "x-ms-examples": {
+          "required prop operation": {
+            "$ref": "./examples/definitionWithReferenceNullOperation.json"
+          }
+        },
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "success response",
+            "schema": {
+              "$ref": "#/definitions/DefinitionWithReference"
+            }
+          }
+        }
+      }
+    },
     "/foo/definitionWithReferenceNotNullableOperation": {
       "get": {
         "tags": [
@@ -389,7 +412,7 @@
   },
   "definitions": {
     "Result": {
-      "description": "Result decription",
+      "description": "Result description",
       "properties": {
         "prop1": {
           "type": "string",

test/modelValidatorTests.ts

@@ -329,6 +329,18 @@ describe("Model Validation", () => {
       console.log(result)
     })
 
+    it("should pass for definitionWithReferenceNull_Get", async () => {
+      const specPath2 =
+        `${__dirname}/modelValidation/swaggers/specification/nullableTypes/invalid_type_test.json`
+      const operationIds = "definitionWithReferenceNull_Get"
+      const result = await validate.validateExamples(
+        specPath2, operationIds, { consoleLogLevel: "off" })
+      assert(
+        result.validityStatus === true,
+        `swagger "${specPath2}" with operation "${operationIds}" contains model validation errors.`)
+      console.log(result)
+    })
+
     it("should pass for definitionWithReferenceNotNullableOperation_Get", async () => {
       const specPath2 =
         `${__dirname}/modelValidation/swaggers/specification/nullableTypes/invalid_type_test.json`