Merge branch 'vnext' into feature/add-path-signature-unique-validation

darrelmiller · web-flow · commit 7fcef5bb7256 · 2020-07-02T21:51:04.000-04:00
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model.
 
-**See more information on the OpenAPI specification and its history here: <a href="https://www.openapis.org">Open API Initiative</a>**
+**See more information on the OpenAPI specification and its history here: <a href="https://www.openapis.org">OpenAPI Initiative</a>**
 
 Project Objectives 
 
diff --git a/build.cmd b/build.cmd
@@ -2,16 +2,16 @@
 Echo Building Microsoft.OpenApi 
 
 SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj 
-dotnet build %PROJ% /t:restore /p:Configuration=Release
-dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
+dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
+dotnet msbuild %PROJ% /t:build /p:Configuration=Release
+dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 Echo Building Microsoft.OpenApi.Readers
 
 SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj 
-dotnet build %PROJ% /t:restore /p:Configuration=Release
-dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
+dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
+dotnet msbuild %PROJ% /t:build /p:Configuration=Release
+dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 goto :end
 :error
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.2.0-preview.3</Version>
+        <Version>1.2.1</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs
@@ -37,7 +37,7 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
         {
             YamlDocument yamlDocument;
 
-            // Parse the YAML/JSON
+            // Parse the YAML/JSON text in the TextReader into the YamlDocument
             try
             {
                 yamlDocument = LoadYamlDocument(input);
diff --git a/src/Microsoft.OpenApi/Any/OpenApiString.cs b/src/Microsoft.OpenApi/Any/OpenApiString.cs
@@ -10,12 +10,21 @@ public class OpenApiString : OpenApiPrimitive<string>
     {
         private bool isExplicit;
 
+        /// <summary>
+        /// Initializes the <see cref="OpenApiString"/> class.
+        /// </summary>
+        /// <param name="value"></param>
+        public OpenApiString(string value)
+            : this(value, false)
+        {
+        }
+        
         /// <summary>
         /// Initializes the <see cref="OpenApiString"/> class.
         /// </summary>
         /// <param name="value"></param>
         /// <param name="isExplicit">Used to indicate if a string is quoted.</param>
-        public OpenApiString(string value, bool isExplicit = false)
+        public OpenApiString(string value, bool isExplicit)
             : base(value)
         {
             this.isExplicit = isExplicit;
diff --git a/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs b/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs
@@ -41,6 +41,25 @@ public static void SerializeAsYaml<T>(this T element, Stream stream, OpenApiSpec
             element.Serialize(stream, specVersion, OpenApiFormat.Yaml);
         }
 
+        /// <summary>
+        /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document using
+        /// the given stream, specification version and the format.
+        /// </summary>
+        /// <typeparam name="T">the <see cref="IOpenApiSerializable"/></typeparam>
+        /// <param name="element">The Open API element.</param>
+        /// <param name="stream">The given stream.</param>
+        /// <param name="specVersion">The Open API specification version.</param>
+        /// <param name="format">The output format (JSON or YAML).</param>
+        public static void Serialize<T>(
+            this T element,
+            Stream stream,
+            OpenApiSpecVersion specVersion,
+            OpenApiFormat format)
+            where T : IOpenApiSerializable
+        {
+            element.Serialize(stream, specVersion, format, null);
+        }
+
         /// <summary>
         /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document using
         /// the given stream, specification version and the format.
@@ -56,7 +75,7 @@ public static void Serialize<T>(
             Stream stream,
             OpenApiSpecVersion specVersion,
             OpenApiFormat format, 
-            OpenApiWriterSettings settings = null)
+            OpenApiWriterSettings settings)
             where T : IOpenApiSerializable
         {
             if (stream == null)
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.2.0-preview.3</Version>
+        <Version>1.2.1</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiOperation.cs b/src/Microsoft.OpenApi/Models/OpenApiOperation.cs
@@ -248,7 +248,8 @@ public void SerializeAsV2(IOpenApiWriter writer)
                         // Our library does not support this at the moment.
                         Name = "body",
                         Schema = content?.Schema ?? new OpenApiSchema(),
-                        Required = RequestBody.Required
+                        Required = RequestBody.Required,
+                        Extensions = RequestBody.Extensions
                     };
 
                     parameters.Add(bodyParameter);
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs
@@ -10,12 +10,20 @@ namespace Microsoft.OpenApi.Writers
     /// </summary>
     public class OpenApiJsonWriter : OpenApiWriterBase
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
+        /// </summary>
+        /// <param name="textWriter">The text writer.</param>
+        public OpenApiJsonWriter(TextWriter textWriter) : base(textWriter, null)
+        {
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
         /// <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
-        public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings = null) : base(textWriter, settings)
+        public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings) : base(textWriter, settings)
         {
         }
 
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs
@@ -5,7 +5,6 @@
 using System.Collections.Generic;
 using System.IO;
 using Microsoft.OpenApi.Exceptions;
-using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Properties;
 
 namespace Microsoft.OpenApi.Writers
@@ -24,7 +23,7 @@ public abstract class OpenApiWriterBase : IOpenApiWriter
         /// <summary>
         /// The indentation string to prepand to each line for each indentation level.
         /// </summary>
-        private const string IndentationString = "  ";
+        protected const string IndentationString = "  ";
 
         /// <summary>
         /// Scope of the Open API element - object, array, property.
@@ -40,25 +39,27 @@ public abstract class OpenApiWriterBase : IOpenApiWriter
         /// Initializes a new instance of the <see cref="OpenApiWriterBase"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
-        public OpenApiWriterBase(TextWriter textWriter)
+        public OpenApiWriterBase(TextWriter textWriter) : this(textWriter, null)
         {
-            Writer = textWriter;
-            Writer.NewLine = "\n";
-
-            Scopes = new Stack<Scope>();
         }
 
         /// <summary>
-        /// 
+        /// Initializes a new instance of the <see cref="OpenApiWriterBase"/> class.
         /// </summary>
         /// <param name="textWriter"></param>
         /// <param name="settings"></param>
-        public OpenApiWriterBase(TextWriter textWriter, OpenApiWriterSettings settings = null) : this(textWriter)
+        public OpenApiWriterBase(TextWriter textWriter, OpenApiWriterSettings settings) 
         {
+            Writer = textWriter;
+            Writer.NewLine = "\n";
+
+            Scopes = new Stack<Scope>();
+
             if (settings == null)
             {
                 settings = new OpenApiWriterSettings();
             }
+
             Settings = settings;
         }
 
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs
@@ -10,16 +10,25 @@ namespace Microsoft.OpenApi.Writers
     /// </summary>
     public class OpenApiYamlWriter : OpenApiWriterBase
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiYamlWriter"/> class.
+        /// </summary>
+        /// <param name="textWriter">The text writer.</param>
+        public OpenApiYamlWriter(TextWriter textWriter) : this(textWriter, null)
+        {
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OpenApiYamlWriter"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
         /// <param name="settings"></param>
-        public OpenApiYamlWriter(TextWriter textWriter, OpenApiWriterSettings settings = null) : base(textWriter, settings)
+        public OpenApiYamlWriter(TextWriter textWriter, OpenApiWriterSettings settings) : base(textWriter, settings)
         {
-           
         }
 
+        public bool UseLiteralStyle { get; set; }
+
         /// <summary>
         /// Base Indentation Level.
         /// This denotes how many indentations are needed for the property in the base object.
@@ -156,11 +165,105 @@ public override void WritePropertyName(string name)
         /// <param name="value">The string value.</param>
         public override void WriteValue(string value)
         {
-            WriteValueSeparator();
+            if (!UseLiteralStyle || value.IndexOfAny(new [] { '\n', '\r' }) == -1)
+            {
+                WriteValueSeparator();
 
-            value = value.GetYamlCompatibleString();
+                value = value.GetYamlCompatibleString();
 
-            Writer.Write(value);
+                Writer.Write(value);
+            }
+            else
+            {
+                if (CurrentScope() != null)
+                {
+                    WriteValueSeparator();
+                }
+
+                Writer.Write("|");
+                
+                WriteChompingIndicator(value);
+
+                // Write indentation indicator when it starts with spaces
+                if (value.StartsWith(" "))
+                {
+                    Writer.Write(IndentationString.Length);
+                }
+                
+                Writer.WriteLine();
+
+                IncreaseIndentation();
+
+                using (var reader = new StringReader(value))
+                {
+                    bool firstLine = true;
+                    while (reader.ReadLine() is var line && line != null)
+                    {
+                        if (firstLine)
+                            firstLine = false;
+                        else
+                            Writer.WriteLine();
+                        
+                        // Indentations for empty lines aren't needed.
+                        if (line.Length > 0)
+                        {
+                            WriteIndentation();
+                        }
+
+                        Writer.Write(line);
+                    }
+                }
+
+                DecreaseIndentation();
+            }
+        }
+
+        private void WriteChompingIndicator(string value)
+        {
+            var trailingNewlines = 0;
+            var end = value.Length - 1;
+            // We only need to know whether there are 0, 1, or more trailing newlines
+            while (end >= 0 && trailingNewlines < 2)
+            {
+                var found = value.LastIndexOfAny(new[] { '\n', '\r' }, end, 2);
+                if (found == -1 || found != end)
+                {
+                    // does not ends with newline
+                    break;
+                }
+
+                if (value[end] == '\r')
+                {
+                    // ends with \r
+                    end--;
+                }
+                else if (end > 0 && value[end - 1] == '\r')
+                {
+                    // ends with \r\n
+                    end -= 2;
+                }
+                else
+                {
+                    // ends with \n
+                    end -= 1;
+                }
+                trailingNewlines++;
+            }
+
+            switch (trailingNewlines)
+            {
+                case 0:
+                    // "strip" chomping indicator
+                    Writer.Write("-");
+                    break;
+                case 1:
+                    // "clip"
+                    break;
+                default:
+                    // "keep" chomping indicator
+                    Writer.Write("+");
+                    break;
+            }
         }
 
         /// <summary>
diff --git a/test/Microsoft.OpenApi.Tests/Writers/OpenApiWriterSpecialCharacterTests.cs b/test/Microsoft.OpenApi.Tests/Writers/OpenApiWriterSpecialCharacterTests.cs
@@ -75,5 +75,59 @@ public void WriteStringWithSpecialCharactersAsYamlWorks(string input, string exp
             // Assert
             actual.Should().Be(expected);
         }
+        
+        [Theory]
+        [InlineData("multiline\r\nstring", "test: |-\n  multiline\n  string")]
+        [InlineData("ends with\r\nline break\r\n", "test: |\n  ends with\n  line break")]
+        [InlineData("ends with\r\n2 line breaks\r\n\r\n", "test: |+\n  ends with\n  2 line breaks\n")]
+        [InlineData("ends with\r\n3 line breaks\r\n\r\n\r\n", "test: |+\n  ends with\n  3 line breaks\n\n")]
+        [InlineData("  starts with\nspaces", "test: |-2\n    starts with\n  spaces")]
+        [InlineData("  starts with\nspaces, and ends with line break\n", "test: |2\n    starts with\n  spaces, and ends with line break")]
+        [InlineData("contains\n\n\nempty lines", "test: |-\n  contains\n\n\n  empty lines")]
+        [InlineData("no line breaks fallback ", "test: 'no line breaks fallback '")]
+        public void WriteStringWithNewlineCharactersInObjectAsYamlWorks(string input, string expected)
+        {
+            // Arrange
+            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
+            var writer = new OpenApiYamlWriter(outputStringWriter) { UseLiteralStyle = true, };
+
+            // Act
+            writer.WriteStartObject();
+            writer.WritePropertyName("test");
+            writer.WriteValue(input);
+            writer.WriteEndObject();
+            var actual = outputStringWriter.GetStringBuilder().ToString()
+                // Normalize newline for cross platform
+                .Replace("\r", "");
+
+            // Assert
+            actual.Should().Be(expected);
+        }
+        
+        [Theory]
+        [InlineData("multiline\r\nstring", "- |-\n  multiline\n  string")]
+        [InlineData("ends with\r\nline break\r\n", "- |\n  ends with\n  line break")]
+        [InlineData("ends with\r\n2 line breaks\r\n\r\n", "- |+\n  ends with\n  2 line breaks\n")]
+        [InlineData("ends with\r\n3 line breaks\r\n\r\n\r\n", "- |+\n  ends with\n  3 line breaks\n\n")]
+        [InlineData("  starts with\nspaces", "- |-2\n    starts with\n  spaces")]
+        [InlineData("  starts with\nspaces, and ends with line break\n", "- |2\n    starts with\n  spaces, and ends with line break")]
+        [InlineData("contains\n\n\nempty lines", "- |-\n  contains\n\n\n  empty lines")]
+        [InlineData("no line breaks fallback ", "- 'no line breaks fallback '")]
+        public void WriteStringWithNewlineCharactersInArrayAsYamlWorks(string input, string expected)
+        {
+            // Arrange
+            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
+            var writer = new OpenApiYamlWriter(outputStringWriter) { UseLiteralStyle = true, };
+
+            // Act
+            writer.WriteStartArray();
+            writer.WriteValue(input);
+            var actual = outputStringWriter.GetStringBuilder().ToString()
+                // Normalize newline for cross platform
+                .Replace("\r", "");
+
+            // Assert
+            actual.Should().Be(expected);
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)`
`37`	`37`	`{`
`38`	`38`	`YamlDocument yamlDocument;`
`39`	`39`
`40`		`- // Parse the YAML/JSON`
	`40`	`+ // Parse the YAML/JSON text in the TextReader into the YamlDocument`
`41`	`41`	`try`
`42`	`42`	`{`
`43`	`43`	`yamlDocument = LoadYamlDocument(input);`