Merge pull request #2098 from microsoft/chore/additional-reference-inlining-tests

chore/additional reference inlining tests

Author: MaggieKimani1

src/Microsoft.OpenApi/Models/OpenApiReference.cs

@@ -158,11 +158,12 @@ public OpenApiReference(OpenApiReference reference)
         /// </summary>
         public void SerializeAsV31(IOpenApiWriter writer)
         {
-            // summary and description are in 3.1 but not in 3.0
-            writer.WriteProperty(OpenApiConstants.Summary, Summary);
-            writer.WriteProperty(OpenApiConstants.Description, Description);
-
-            SerializeInternal(writer);
+            SerializeInternal(writer, w =>
+            {
+                // summary and description are in 3.1 but not in 3.0
+                w.WriteProperty(OpenApiConstants.Summary, Summary);
+                w.WriteProperty(OpenApiConstants.Description, Description);
+            });
         }
 
         /// <summary>
@@ -176,7 +177,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
         /// <summary>
         /// Serialize <see cref="OpenApiReference"/>
         /// </summary>
-        private void SerializeInternal(IOpenApiWriter writer)
+        private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter> callback = null)
         {
             Utils.CheckArgumentNull(writer);
 
@@ -188,6 +189,10 @@ private void SerializeInternal(IOpenApiWriter writer)
             }
 
             writer.WriteStartObject();
+            if (callback is not null)
+            {
+                callback(writer);
+            }
 
             // $ref
             writer.WriteProperty(OpenApiConstants.DollarRef, ReferenceV3);

src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs

@@ -80,7 +80,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
         }
         else
         {
-            SerializeInternal(writer, (writer, element) => CopyReferenceAsTargetElementWithOverrides(element).SerializeAsV3(writer));
+            SerializeInternal(writer, (writer, element) => element.SerializeAsV3(writer));
         }
     }
 
@@ -106,7 +106,7 @@ public virtual void SerializeAsV2(IOpenApiWriter writer)
         }
         else
         {
-            SerializeInternal(writer, (writer, element) => CopyReferenceAsTargetElementWithOverrides(element).SerializeAsV2(writer));
+            SerializeInternal(writer, (writer, element) => element.SerializeAsV2(writer));
         }
     }
 

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=False_inlineLocalReferences=False.verified.txt

@@ -159,37 +159,41 @@ public void CallbackReferenceResolutionWorks()
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeCallbackReferenceAsV3JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeCallbackReferenceAsV3JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineExternalReferences = true });            
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineExternalReferences = true, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _externalCallbackReference.SerializeAsV3(writer);
             await writer.FlushAsync();
 
             // Assert            
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeCallbackReferenceAsV31JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeCallbackReferenceAsV31JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineExternalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineExternalReferences = true, InlineLocalReferences = inlineLocalReferences});
 
             // Act
             _externalCallbackReference.SerializeAsV31(writer);
             await writer.FlushAsync();
 
             // Assert
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
     }
 }

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=False_inlineLocalReferences=True.verified.txt

@@ -1,10 +1,5 @@
 {
   "summary": "Example of a local user",
   "description": "This is an example of a local user",
-  "value": [
-    {
-      "id": 1,
-      "name": "John Doe"
-    }
-  ]
+  "$ref": "#/components/examples/UserExample"
 }

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=True_inlineLocalReferences=False.verified.txt

@@ -0,0 +1 @@
+{"summary":"Example of a local user","description":"This is an example of a local user","$ref":"#/components/examples/UserExample"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=True_inlineLocalReferences=True.verified.txt

@@ -0,0 +1,3 @@
+{
+  "$ref": "#/components/examples/UserExample"
+}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeReferencedCallbackAsV31JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=False_inlineLocalReferences=False.verified.txt

@@ -3,7 +3,7 @@
   "description": "This is is an example of a user",
   "value": [
     {
-      "id": "1",
+      "id": 1,
       "name": "John Doe"
     }
   ]

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeReferencedCallbackAsV3JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=False_inlineLocalReferences=True.verified.txt

@@ -0,0 +1 @@
+{"$ref":"#/components/examples/UserExample"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeReferencedCallbackAsV31JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=True_inlineLocalReferences=False.verified.txt

@@ -1 +1 @@
-{"summary":"Example of a user","description":"This is is an example of a user","value":[{"id":"1","name":"John Doe"}]}
+{"summary":"Example of a user","description":"This is is an example of a user","value":[{"id":1,"name":"John Doe"}]}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeReferencedCallbackAsV3JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=True_inlineLocalReferences=True.verified.txt

@@ -150,37 +150,41 @@ public void ExampleReferenceResolutionWorks()
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeExampleReferenceAsV3JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeExampleReferenceAsV3JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _localExampleReference.SerializeAsV3(writer);
             await writer.FlushAsync();
 
             // Assert            
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeExampleReferenceAsV31JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeExampleReferenceAsV31JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _localExampleReference.SerializeAsV31(writer);
             await writer.FlushAsync();
 
             // Assert
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
     }    
 }

test/Microsoft.OpenApi.Tests/Models/References/OpenApiCallbackReferenceTests.cs

@@ -0,0 +1,3 @@
+{
+  "$ref": "#/headers/LocationHeader"
+}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=False.verified.txt

@@ -1,6 +1,4 @@
 {
   "description": "The URL of the newly created post",
-  "schema": {
-    "type": "string"
-  }
+  "type": "string"
 }

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeCallbackReferenceAsV3JsonWorks_produceTerseOutput=True.verified.txt

@@ -0,0 +1 @@
+{"$ref":"#/headers/LocationHeader"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=False_inlineLocalReferences=False.verified.txt

@@ -0,0 +1 @@
+{"description":"The URL of the newly created post","type":"string"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=False_inlineLocalReferences=True.verified.txt

@@ -1,6 +1,4 @@
 {
   "description": "Location of the locally referenced post",
-  "schema": {
-    "type": "string"
-  }
+  "$ref": "#/components/headers/LocationHeader"
 }

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=True_inlineLocalReferences=False.verified.txt

@@ -0,0 +1 @@
+{"description":"Location of the locally referenced post","$ref":"#/components/headers/LocationHeader"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV31JsonWorks_produceTerseOutput=True_inlineLocalReferences=True.verified.txt

@@ -0,0 +1,3 @@
+{
+  "$ref": "#/components/headers/LocationHeader"
+}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=False_inlineLocalReferences=False.verified.txt

@@ -0,0 +1 @@
+{"$ref":"#/components/headers/LocationHeader"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=False.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=False_inlineLocalReferences=True.verified.txt

@@ -109,54 +109,60 @@ public void HeaderReferenceResolutionWorks()
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeHeaderReferenceAsV3JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeHeaderReferenceAsV3JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _localHeaderReference.SerializeAsV3(writer);
             await writer.FlushAsync();
 
             // Assert            
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeHeaderReferenceAsV31JsonWorks(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeHeaderReferenceAsV31JsonWorks(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _localHeaderReference.SerializeAsV31(writer);
             await writer.FlushAsync();
 
             // Assert
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
 
         [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task SerializeHeaderReferenceAsV2JsonWorksAsync(bool produceTerseOutput)
+        [InlineData(true, true)]
+        [InlineData(false, true)]
+        [InlineData(true, false)]
+        [InlineData(false, false)]
+        public async Task SerializeHeaderReferenceAsV2JsonWorksAsync(bool produceTerseOutput, bool inlineLocalReferences)
         {
             // Arrange
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = true });
+            var writer = new OpenApiJsonWriter(outputStringWriter, new OpenApiJsonWriterSettings { Terse = produceTerseOutput, InlineLocalReferences = inlineLocalReferences });
 
             // Act
             _localHeaderReference.SerializeAsV2(writer);
             await writer.FlushAsync();
 
             // Assert
-            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput, inlineLocalReferences);
         }
 
         [Fact]

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=True.verified.txt

@@ -0,0 +1,4 @@
+{
+  "description": "Use the id returned as the userId in `GET /users/{userId}`",
+  "$ref": "#/components/links/GetUserByUserId"
+}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=True_inlineLocalReferences=False.verified.txt

@@ -0,0 +1 @@
+{"description":"Use the id returned as the userId in `GET /users/{userId}`","$ref":"#/components/links/GetUserByUserId"}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeCallbackReferenceAsV31JsonWorks_produceTerseOutput=True.verified.txt test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.SerializeExampleReferenceAsV3JsonWorks_produceTerseOutput=True_inlineLocalReferences=True.verified.txt

@@ -0,0 +1,3 @@
+{
+  "$ref": "#/components/links/GetUserByUserId"
+}

test/Microsoft.OpenApi.Tests/Models/References/OpenApiExampleReferenceTests.cs

@@ -0,0 +1 @@
+{"$ref":"#/components/links/GetUserByUserId"}