support multiple default types (#249)

Co-authored-by: jianye xi <[email protected]>

Author: jianyexi

openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger/new/default_changed_01.json

@@ -0,0 +1,69 @@
+{
+  "swagger": 2.0,
+  "info": {
+    "title": "type_changed",
+    "version": "1.0"
+  },
+  "host": "localhost:8000",
+  "schemes": [ "http", "https" ],
+  "consumes": [ "text/plain", "text/json" ],
+  "produces": [ "text/plain" ],
+  "paths": {
+    "/api/Parameters": {
+      "put": {
+        "tag": [ "Parameters" ],
+        "operationId": "Parameters_Put",
+        "produces": [
+          "text/plain"
+        ],
+        "parameters": [
+          {
+            "name": "database",
+            "in": "body",
+            "required": true,
+            "type": "object",
+            "schema": { "$ref": "#/definitions/Database" }
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "Database": {
+      "properties": {
+        "a": {
+          "type": "string",
+          "readOnly": true,
+          "description": "This is a system generated property.\nThe _rid value is empty for this operation.",
+          "default":"aa"
+        },
+        "b": {
+          "type": "string",
+          "enum": [
+            "A",
+            "B"
+          ],
+          "x-ms-enum": {
+            "name": "ResourceIdentityType",
+            "modelAsString": true
+          },
+          "default":"A",
+          "description": "This property shows the number of databases returned."
+        },
+         "c": {
+          "type": "number",
+          "description": "This is a system generated property.\nThe _rid value is empty for this operation.",
+          "default":2
+        }
+      },
+      "default": { "c":"test"}
+    }
+  },
+  "DatabaseList":{ 
+    "type":"array",
+     "items": {
+       "$ref": "#/definitions/Database"
+     },
+     "default": [{"c":4}]
+  }
+}

openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger/new/operation_check_02.json

@@ -120,7 +120,8 @@
         "b": {
           "type": "integer",
           "readOnly": true,
-          "description": "This is a system generated property.\nThe resource id (_rid) is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement of and navigation to the database resource."
+          "description": "This is a system generated property.\nThe resource id (_rid) is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement of and navigation to the database resource.",
+          "default": 11
         },
         "c": {
           "type": "integer",
@@ -144,6 +145,10 @@
           "description": "This is a system generated property.\nIt specifies the addressable path of the users resource."
         }
       }
+      ,
+      "default": {
+        "id": "test"
+      }
     }
   }
 }

openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger/old/default_changed_01.json

@@ -0,0 +1,68 @@
+{
+  "swagger": 2.0,
+  "info": {
+    "title": "type_changed",
+    "version": "1.0"
+  },
+  "host": "localhost:8000",
+  "schemes": [ "http", "https" ],
+  "consumes": [ "text/plain", "text/json" ],
+  "produces": [ "text/plain" ],
+  "paths": {
+    "/api/Parameters": {
+      "put": {
+        "tag": [ "Parameters" ],
+        "operationId": "Parameters_Put",
+        "produces": [
+          "text/plain"
+        ],
+        "parameters": [
+          {
+            "name": "database",
+            "in": "body",
+            "required": true,
+            "type": "object",
+            "schema": { "$ref": "#/definitions/Database" }
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "Database": {
+      "properties": {
+        "a": {
+          "type": "string",
+          "readOnly": true,
+          "description": "This is a system generated property.\nThe _rid value is empty for this operation.",
+          "default":"a"
+        },
+        "b": {
+          "type": "string",
+          "enum": [
+            "A",
+            "B"
+          ],
+          "x-ms-enum": {
+            "name": "ResourceIdentityType",
+            "modelAsString": true
+          },
+          "description": "This property shows the number of databases returned."
+        },
+         "c": {
+          "type": "number",
+          "description": "This is a system generated property.\nThe _rid value is empty for this operation.",
+          "default":1
+        }
+      },
+      "default": { "b":"test"}
+    }
+  },
+  "DatabaseList":{ 
+    "type":"array",
+     "items": {
+       "$ref": "#/definitions/Database"
+     },
+     "default": [{"c":2}]
+  }
+}

openapi-diff/src/modeler/AutoRest.Swagger.Tests/Resource/Swagger/old/operation_check_02.json

@@ -142,6 +142,9 @@
           "readOnly": true,
           "description": "This is a system generated property.\nIt specifies the addressable path of the users resource."
         }
+      },
+      "default": {
+        "id": "test"
       }
     }
   }

openapi-diff/src/modeler/AutoRest.Swagger.Tests/SwaggerModelerCompareTests.cs

@@ -165,6 +165,18 @@ public void TypeObjectChanged()
             Assert.Equal("new/type_changed_01.json#/definitions/Database/properties/a", error.NewJsonRef);
         }
 
+        /// <summary>
+        /// Verifies that if if you change the default value of a schema, it's caught .
+        /// </summary>
+        [Fact]
+        public void DefaultValueChanged()
+        {
+            var messages = CompareSwagger("default_changed_01.json").ToArray();
+            var errors = messages.Where(m => m.Id == ComparisonMessages.DefaultValueChanged.Id).ToArray();
+            Assert.NotNull(errors);
+            Assert.Equal(errors.Count(), 8);
+        }
+
         /// <summary>
         /// Verifies that if you change the type format of a schema property, it's caught.
         /// </summary>

openapi-diff/src/modeler/AutoRest.Swagger/Model/SwaggerObject.cs

@@ -6,6 +6,8 @@
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
 
 namespace AutoRest.Swagger.Model
 {
@@ -51,7 +53,7 @@ public abstract class SwaggerObject<T> : SwaggerBase<T>
         /// <summary>
         /// Sets a default value to the parameter.
         /// </summary>
-        public virtual string Default { get; set; }
+        public virtual dynamic Default { get; set; }
 
         public virtual string MultipleOf { get; set; }
 
@@ -154,7 +156,7 @@ T previous
 
             CompareItems(context, prior);
 
-            if (Default != null && !Default.Equals(prior.Default) || (Default == null && !string.IsNullOrEmpty(prior.Default)))
+            if ((Default != null || prior.Default != null) && !JToken.DeepEquals(Default,prior.Default))
             {
                 context.LogBreakingChange(ComparisonMessages.DefaultValueChanged);
             }