Add Components unit test to verify that top-level references are serialized correctly

Author: PerthCharern

test/Microsoft.OpenApi.Tests/Models/OpenApiComponentsTests.cs

@@ -77,8 +77,11 @@ public class OpenApiComponentsTests
                         },
                         ["property3"] = new OpenApiSchema
                         {
-                            Type = "string",
-                            MaxLength = 15
+                            Reference = new OpenApiReference
+                            {
+                                Type = ReferenceType.Schema,
+                                Id = "schema2"
+                            }
                         }
                     },
                     Reference = new OpenApiReference
@@ -87,6 +90,16 @@ public class OpenApiComponentsTests
                         Id = "schema1"
                     }
                 },
+                ["schema2"] = new OpenApiSchema
+                {
+                    Properties = new Dictionary<string, OpenApiSchema>
+                    {
+                        ["property2"] = new OpenApiSchema
+                        {
+                            Type = "integer"
+                        }
+                    }
+                },
             },
             SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>
             {
@@ -157,6 +170,81 @@ public class OpenApiComponentsTests
             }
         };
 
+        public static OpenApiComponents TopLevelReferencingComponents = new OpenApiComponents()
+        {
+            Schemas =
+            {
+                ["schema1"] = new OpenApiSchema
+                {
+                    Reference = new OpenApiReference()
+                    {
+                        Type = ReferenceType.Schema,
+                        Id = "schema2"
+                    }
+                },
+                ["schema2"] = new OpenApiSchema
+                {
+                    Type = "object",
+                    Properties =
+                    {
+                        ["property1"] = new OpenApiSchema()
+                        {
+                            Type = "string"
+                        }
+                    }
+                },
+            }
+        };
+
+        public static OpenApiComponents TopLevelSelfReferencingComponentsWithOtherProperties = new OpenApiComponents()
+        {
+            Schemas =
+            {
+                ["schema1"] = new OpenApiSchema
+                {
+                    Type = "object",
+                    Properties =
+                    {
+                        ["property1"] = new OpenApiSchema()
+                        {
+                            Type = "string"
+                        }
+                    },
+                    Reference = new OpenApiReference()
+                    {
+                        Type = ReferenceType.Schema,
+                        Id = "schema1"
+                    }
+                },
+                ["schema2"] = new OpenApiSchema
+                {
+                    Type = "object",
+                    Properties =
+                    {
+                        ["property1"] = new OpenApiSchema()
+                        {
+                            Type = "string"
+                        }
+                    }
+                },
+            }
+        };
+
+        public static OpenApiComponents TopLevelSelfReferencingComponents = new OpenApiComponents()
+        {
+            Schemas =
+            {
+                ["schema1"] = new OpenApiSchema
+                {
+                    Reference = new OpenApiReference()
+                    {
+                        Type = ReferenceType.Schema,
+                        Id = "schema1"
+                    }
+                }
+            }
+        };
+
         private readonly ITestOutputHelper _output;
 
         public OpenApiComponentsTests(ITestOutputHelper output)
@@ -255,8 +343,14 @@ public void SerializeAdvancedComponentsWithReferenceAsJsonV3Works()
           ""type"": ""integer""
         },
         ""property3"": {
-          ""maxLength"": 15,
-          ""type"": ""string""
+          ""$ref"": ""#/components/schemas/schema2""
+        }
+      }
+    },
+    ""schema2"": {
+      ""properties"": {
+        ""property2"": {
+          ""type"": ""integer""
         }
       }
     }
@@ -284,8 +378,8 @@ public void SerializeAdvancedComponentsWithReferenceAsJsonV3Works()
 }";
 
             // Act
-            var actual = AdvancedComponentsWithReference.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0_0);
-
+                var actual = AdvancedComponentsWithReference.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0_0);
+            _output.WriteLine(actual);
             // Assert
             actual = actual.MakeLineBreaksEnvironmentNeutral();
             expected = expected.MakeLineBreaksEnvironmentNeutral();
@@ -338,8 +432,11 @@ public void SerializeAdvancedComponentsWithReferenceAsYamlV3Works()
       property2:
         type: integer
       property3:
-        maxLength: 15
-        type: string
+        $ref: '#/components/schemas/schema2'
+  schema2:
+    properties:
+      property2:
+        type: integer
 securitySchemes:
   securityScheme1:
     type: oauth2
@@ -358,6 +455,8 @@ public void SerializeAdvancedComponentsWithReferenceAsYamlV3Works()
             // Act
             var actual = AdvancedComponentsWithReference.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0_0);
 
+            _output.WriteLine(actual);
+
             // Assert
             actual = actual.MakeLineBreaksEnvironmentNeutral();
             expected = expected.MakeLineBreaksEnvironmentNeutral();
@@ -425,5 +524,73 @@ public void SerializeBrokenComponentsAsYamlWorks()
             expected = expected.MakeLineBreaksEnvironmentNeutral();
             actual.Should().Be(expected);
         }
+
+        [Fact(Skip = "Issue #157 We are not serializing top-level reference in components correctly")]
+        public void SerializeTopLevelReferencingComponentsAsYamlWorks()
+        {
+            // Arrange
+            var expected = @"schemas:
+  schema1:
+    $ref: '#/components/schemas/schema2'
+  schema2:
+    type: object
+    properties:
+      property1:
+        type: string";
+
+            // Act
+            var actual = TopLevelReferencingComponents.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0_0);
+
+            _output.WriteLine(actual);
+
+            // Assert
+            actual = actual.MakeLineBreaksEnvironmentNeutral();
+            expected = expected.MakeLineBreaksEnvironmentNeutral();
+            actual.Should().Be(expected);
+        }
+
+        [Fact(Skip = "Issue #157 We are not serializing top-level reference in components correctly")]
+        public void SerializeTopLevelSelfReferencingComponentsAsYamlWorks()
+        {
+            // Arrange
+            var expected = @"schemas:
+  schema1:
+    $ref: '#/components/schemas/schema1'";
+
+            // Act
+            var actual = TopLevelSelfReferencingComponents.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0_0);
+
+            // Assert
+            actual = actual.MakeLineBreaksEnvironmentNeutral();
+            expected = expected.MakeLineBreaksEnvironmentNeutral();
+            actual.Should().Be(expected);
+        }
+
+        [Fact]
+        public void SerializeTopLevelSelfReferencingWithOtherPropertiesComponentsAsYamlWorks()
+        {
+            // Arrange
+            var expected = @"schemas:
+  schema1:
+    type: object
+    properties:
+      property1:
+        type: string
+  schema2:
+    type: object
+    properties:
+      property1:
+        type: string";
+
+            // Act
+            var actual = TopLevelSelfReferencingComponentsWithOtherProperties.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0_0);
+
+            _output.WriteLine(actual);
+
+            // Assert
+            actual = actual.MakeLineBreaksEnvironmentNeutral();
+            expected = expected.MakeLineBreaksEnvironmentNeutral();
+            actual.Should().Be(expected);
+        }
     }
 }