Merge pull request #267 from Microsoft/dm/1.1/fixes

darrelmiller · web-flow · commit 3277e463e1c5 · 2018-06-07T10:53:18.000-04:00
A variety of bug fixes for 1.1 preview
diff --git a/src/Microsoft.OpenApi.Readers/Exceptions/OpenApiUnsupportedSpecVersionException.cs b/src/Microsoft.OpenApi.Readers/Exceptions/OpenApiUnsupportedSpecVersionException.cs
@@ -12,7 +12,7 @@ namespace Microsoft.OpenApi.Readers.Exceptions
     [Serializable]
     public class OpenApiUnsupportedSpecVersionException : OpenApiReaderException
     {
-        const string messagePattern = "OpenAPI specification version {0} is not supported.";
+        const string messagePattern = "OpenAPI specification version '{0}' is not supported.";
 
         /// <summary>
         /// Initializes the <see cref="OpenApiUnsupportedSpecVersionException"/> class with a specification version.
@@ -21,11 +21,6 @@ public class OpenApiUnsupportedSpecVersionException : OpenApiReaderException
         public OpenApiUnsupportedSpecVersionException(string specificationVersion)
             : base(string.Format(CultureInfo.InvariantCulture, messagePattern, specificationVersion))
         {
-            if (string.IsNullOrWhiteSpace(specificationVersion))
-            {
-                throw new ArgumentException("Value cannot be null or white space.", nameof(specificationVersion));
-            }
-
             this.SpecificationVersion = specificationVersion;
         }
 
@@ -38,11 +33,6 @@ public OpenApiUnsupportedSpecVersionException(string specificationVersion)
         public OpenApiUnsupportedSpecVersionException(string specificationVersion, Exception innerException)
             : base(string.Format(CultureInfo.InvariantCulture, messagePattern, specificationVersion), innerException)
         {
-            if (string.IsNullOrWhiteSpace(specificationVersion))
-            {
-                throw new ArgumentException("Value cannot be null or white space.", nameof(specificationVersion));
-            }
-
             this.SpecificationVersion = specificationVersion;
         }
 
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs b/src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs
@@ -49,5 +49,9 @@ public class OpenApiReaderSettings
         /// </summary>
         public ValidationRuleSet RuleSet { get; set; } = ValidationRuleSet.GetDefaultRuleSet();
 
+        /// <summary>
+        /// URL where relative references should be resolved from if the description does not contain Server definitions
+        /// </summary>
+        public Uri BaseUrl { get; set; } 
     }
 }
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs
@@ -57,7 +57,8 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
 
             context = new ParsingContext
             {
-                ExtensionParsers = _settings.ExtensionParsers
+                ExtensionParsers = _settings.ExtensionParsers,
+                BaseUrl = _settings.BaseUrl
             };
 
             OpenApiDocument document = null;
diff --git a/src/Microsoft.OpenApi.Readers/ParsingContext.cs b/src/Microsoft.OpenApi.Readers/ParsingContext.cs
@@ -28,6 +28,7 @@ public class ParsingContext
         internal Dictionary<string, Func<IOpenApiAny, IOpenApiExtension>> ExtensionParsers { get; set; }  = new Dictionary<string, Func<IOpenApiAny, IOpenApiExtension>>();
         internal RootNode RootNode { get; set; }
         internal List<OpenApiTag> Tags { get; private set; } = new List<OpenApiTag>();
+        internal Uri BaseUrl { get; set; }
 
         /// <summary>
         /// Initiates the parsing process.  Not thread safe and should only be called once on a parsing context
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs
@@ -119,21 +119,82 @@ internal static partial class OpenApiV2Deserializer
             {s => s.StartsWith("x-"), (o, p, n) => o.AddExtension(p, n.CreateAny())}
         };
 
-        private static void MakeServers(IList<OpenApiServer> servers, ParsingContext context)
+        private static void MakeServers(IList<OpenApiServer> servers, ParsingContext context, Uri defaultUrl)
         {
             var host = context.GetFromTempStorage<string>("host");
             var basePath = context.GetFromTempStorage<string>("basePath");
             var schemes = context.GetFromTempStorage<List<string>>("schemes");
 
+            // If nothing is provided, don't create a server
+            if (host == null && basePath == null && schemes == null)
+            {
+                return;
+            }
+
+            // Fill in missing information based on the defaultUrl
+            if (defaultUrl != null)
+            {
+                host = host ?? defaultUrl.GetComponents(UriComponents.NormalizedHost, UriFormat.SafeUnescaped);
+                basePath = basePath ?? defaultUrl.GetComponents(UriComponents.Path, UriFormat.SafeUnescaped);
+                schemes = schemes ?? new List<string> { defaultUrl.GetComponents(UriComponents.Scheme, UriFormat.SafeUnescaped) };
+            }
+            else if (String.IsNullOrEmpty(host) && String.IsNullOrEmpty(basePath))
+            {
+                return;  // Can't make a server object out of just a Scheme
+            }
+            
+            // Create the Server objects
             if (schemes != null)
             {
                 foreach (var scheme in schemes)
                 {
-                    var server = new OpenApiServer();
-                    server.Url = scheme + "://" + (host ?? "example.org/") + (basePath ?? "/");
+                    if (String.IsNullOrEmpty(scheme))
+                    {
+                        host = "//" + host;  // The double slash prefix creates a relative url where the scheme is defined by the BaseUrl
+                    }
+
+                    var uriBuilder = new UriBuilder(scheme, host)
+                    {
+                        Path = basePath
+                    };
+
+                    var server = new OpenApiServer
+                    {
+                        Url = uriBuilder.ToString()
+                    };
+
                     servers.Add(server);
                 }
             }
+            else
+            {
+                if (!String.IsNullOrEmpty(host))
+                {
+                    host = "//" + host;  // The double slash prefix creates a relative url where the scheme is defined by the BaseUrl
+                }
+                var uriBuilder = new UriBuilder()
+                {
+                    Scheme = null,
+                    Host = host,
+                    Path = basePath
+                };
+                var server = new OpenApiServer
+                {
+                    Url = uriBuilder.ToString()
+                };
+
+                servers.Add(server);
+            }
+
+            foreach (var server in servers)
+            {
+                // Server Urls are always appended to Paths and Paths must start with /
+                // so removing the slash prevents a double slash.
+                if (server.Url.EndsWith("/"))
+                {
+                    server.Url = server.Url.Substring(0, server.Url.Length - 1);
+                }
+            }
         }
 
         public static OpenApiDocument LoadOpenApi(RootNode rootNode)
@@ -151,7 +212,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
                 openApidoc.Servers = new List<OpenApiServer>();
             }
 
-            MakeServers(openApidoc.Servers, openApiNode.Context);
+            MakeServers(openApidoc.Servers, openApiNode.Context, rootNode.Context.BaseUrl);
 
             FixRequestBodyReferences(openApidoc);
             return openApidoc;
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs
@@ -131,7 +131,12 @@ internal static OpenApiOperation LoadOperation(ParseNode node)
                     operation.RequestBody = CreateFormBody(node.Context, formParameters);
                 }
             }
-            
+
+            foreach (var response in operation.Responses.Values)
+            {
+                ProcessProduces(response, node.Context);
+            }
+
             return operation;
         }
 
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiResponseDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiResponseDeserializer.cs
@@ -53,15 +53,22 @@ private static void ProcessProduces(OpenApiResponse response, ParsingContext con
             var produces = context.GetFromTempStorage<List<string>>(TempStorageKeys.OperationProduces) ??
                 context.GetFromTempStorage<List<string>>(TempStorageKeys.GlobalProduces) ?? new List<string>();
 
-            response.Content = new Dictionary<string, OpenApiMediaType>();
+            if (response.Content == null)
+            {
+                response.Content = new Dictionary<string, OpenApiMediaType>();
+            }
+
             foreach (var produce in produces)
             {
-                var mediaType = new OpenApiMediaType
+                if (!response.Content.ContainsKey(produce))
                 {
-                    Schema = context.GetFromTempStorage<OpenApiSchema>(TempStorageKeys.ResponseSchema)
-                };
+                    var mediaType = new OpenApiMediaType
+                    {
+                        Schema = context.GetFromTempStorage<OpenApiSchema>(TempStorageKeys.ResponseSchema)
+                    };
 
-                response.Content.Add(produce, mediaType);
+                    response.Content.Add(produce, mediaType);
+                }
             }
         }
 
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiExampleDeserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiExampleDeserializer.cs
@@ -33,6 +33,13 @@ internal static partial class OpenApiV3Deserializer
                     o.Value = n.CreateAny();
                 }
             },
+            {
+                "externalValue", (o, n) =>
+                {
+                    o.ExternalValue = n.GetScalarValue();
+                }
+            },
+
         };
 
         private static readonly PatternFieldMap<OpenApiExample> _examplePatternFields =
diff --git a/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs b/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs
@@ -114,6 +114,18 @@ public static void Serialize<T>(this T element, IOpenApiWriter writer, OpenApiSp
             writer.Flush();
         }
 
+        /// <summary>
+        /// Serializes the <see cref="IOpenApiSerializable"/> to Open API document using the given specification version and writer.
+        /// </summary>
+        /// <typeparam name="T">the <see cref="IOpenApiSerializable"/></typeparam>
+        /// <param name="element">The Open API element.</param>
+        /// <param name="writer">The output writer.</param>
+        public static void Serialize<T>(this T element, IOpenApiWriter writer)
+            where T : IOpenApiSerializable
+        {
+            element.Serialize(writer, writer.Settings.SpecVersion);
+        }
+
         /// <summary>
         /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document as a string in JSON format.
         /// </summary>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -29,7 +29,7 @@ public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
         /// <summary>
         /// REQUIRED. The available paths and operations for the API.
         /// </summary>
-        public OpenApiPaths Paths { get; set; } = new OpenApiPaths();
+        public OpenApiPaths Paths { get; set; }
 
         /// <summary>
         /// An element to hold various schemas for the specification.
@@ -240,7 +240,10 @@ private static void WriteHostInfoV2(IOpenApiWriter writer, IList<OpenApiServer>
                 firstServerUrl.GetComponents(UriComponents.Host | UriComponents.Port, UriFormat.SafeUnescaped));
 
             // basePath
-            writer.WriteProperty(OpenApiConstants.BasePath, firstServerUrl.AbsolutePath);
+            if (firstServerUrl.AbsolutePath != "/")
+            {
+                writer.WriteProperty(OpenApiConstants.BasePath, firstServerUrl.AbsolutePath);
+            }
 
             // Consider all schemes of the URLs in the server list that have the same
             // host, port, and base path as the first server.
diff --git a/src/Microsoft.OpenApi/Models/OpenApiResponse.cs b/src/Microsoft.OpenApi/Models/OpenApiResponse.cs
@@ -136,12 +136,20 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
                         (w, s) => s.SerializeAsV2(w));
 
                     // examples
-                    if (mediatype.Value.Example != null)
+                    if (Content.Values.Any(m => m.Example != null))
                     {
                         writer.WritePropertyName(OpenApiConstants.Examples);
                         writer.WriteStartObject();
-                        writer.WritePropertyName(mediatype.Key);
-                        writer.WriteAny(mediatype.Value.Example);
+
+                        foreach (var mediaTypePair in Content)
+                        {
+                            if (mediaTypePair.Value.Example != null)
+                            {
+                                writer.WritePropertyName(mediaTypePair.Key);
+                                writer.WriteAny(mediaTypePair.Value.Example);
+                            }
+                        }
+
                         writer.WriteEndObject();
                     }
                 }
diff --git a/src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs b/src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs
@@ -8,6 +8,11 @@ namespace Microsoft.OpenApi.Writers
     /// </summary>
     public interface IOpenApiWriter
     {
+        /// <summary>
+        /// Returns the settings being used the Writer for controlling serialization
+        /// </summary>
+        OpenApiSerializerSettings Settings { get; }
+
         /// <summary>
         /// Write the start object.
         /// </summary>
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs
@@ -48,6 +48,11 @@ public OpenApiWriterBase(TextWriter textWriter, OpenApiSerializerSettings settin
             this._settings = settings;
         }
 
+        /// <summary>
+        /// Returns the settings being used the Writer for controlling serialization
+        /// </summary>
+        public OpenApiSerializerSettings Settings { get; }
+
         /// <summary>
         /// Base Indentation Level.
         /// This denotes how many indentations are needed for the property in the base object.
diff --git a/src/Microsoft.OpenApi/Writers/SpecialCharacterStringExtensions.cs b/src/Microsoft.OpenApi/Writers/SpecialCharacterStringExtensions.cs
@@ -196,6 +196,11 @@ internal static string GetYamlCompatibleString(this string input)
         /// </summary>
         internal static string GetJsonCompatibleString(this string value)
         {
+            if (value == null)
+            {
+                return "null";
+            }
+
             // Show the control characters as strings
             // http://json.org/
 
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiServerTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiServerTests.cs
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs
diff --git a/test/Microsoft.OpenApi.Tests/Services/OpenApiValidatorTests.cs b/test/Microsoft.OpenApi.Tests/Services/OpenApiValidatorTests.cs
diff --git a/test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs b/test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace Microsoft.OpenApi.Readers.Exceptions`
`12`	`12`	`[Serializable]`
`13`	`13`	`public class OpenApiUnsupportedSpecVersionException : OpenApiReaderException`
`14`	`14`	`{`
`15`		`- const string messagePattern = "OpenAPI specification version {0} is not supported.";`
	`15`	`+ const string messagePattern = "OpenAPI specification version '{0}' is not supported.";`
`16`	`16`
`17`	`17`	`/// <summary>`
`18`	`18`	`/// Initializes the <see cref="OpenApiUnsupportedSpecVersionException"/> class with a specification version.`
`@@ -21,11 +21,6 @@ public class OpenApiUnsupportedSpecVersionException : OpenApiReaderException`
`21`	`21`	`public OpenApiUnsupportedSpecVersionException(string specificationVersion)`
`22`	`22`	`: base(string.Format(CultureInfo.InvariantCulture, messagePattern, specificationVersion))`
`23`	`23`	`{`
`24`		`- if (string.IsNullOrWhiteSpace(specificationVersion))`
`25`		`- {`
`26`		`- throw new ArgumentException("Value cannot be null or white space.", nameof(specificationVersion));`
`27`		`- }`
`28`		`-`
`29`	`24`	`this.SpecificationVersion = specificationVersion;`
`30`	`25`	`}`
`31`	`26`
`@@ -38,11 +33,6 @@ public OpenApiUnsupportedSpecVersionException(string specificationVersion)`
`38`	`33`	`public OpenApiUnsupportedSpecVersionException(string specificationVersion, Exception innerException)`
`39`	`34`	`: base(string.Format(CultureInfo.InvariantCulture, messagePattern, specificationVersion), innerException)`
`40`	`35`	`{`
`41`		`- if (string.IsNullOrWhiteSpace(specificationVersion))`
`42`		`- {`
`43`		`- throw new ArgumentException("Value cannot be null or white space.", nameof(specificationVersion));`
`44`		`- }`
`45`		`-`
`46`	`36`	`this.SpecificationVersion = specificationVersion;`
`47`	`37`	`}`
`48`	`38`
Original file line number	Diff line number	Diff line change
`@@ -49,5 +49,9 @@ public class OpenApiReaderSettings`
`49`	`49`	`/// </summary>`
`50`	`50`	`public ValidationRuleSet RuleSet { get; set; } = ValidationRuleSet.GetDefaultRuleSet();`
`51`	`51`
	`52`	`+ /// <summary>`
	`53`	`+ /// URL where relative references should be resolved from if the description does not contain Server definitions`
	`54`	`+ /// </summary>`
	`55`	`+ public Uri BaseUrl { get; set; }`
`52`	`56`	`}`
`53`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,8 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)`
`57`	`57`
`58`	`58`	`context = new ParsingContext`
`59`	`59`	`{`
`60`		`- ExtensionParsers = _settings.ExtensionParsers`
	`60`	`+ ExtensionParsers = _settings.ExtensionParsers,`
	`61`	`+ BaseUrl = _settings.BaseUrl`
`61`	`62`	`};`
`62`	`63`
`63`	`64`	`OpenApiDocument document = null;`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,12 @@ internal static OpenApiOperation LoadOperation(ParseNode node)`
`131`	`131`	`operation.RequestBody = CreateFormBody(node.Context, formParameters);`
`132`	`132`	`}`
`133`	`133`	`}`
`134`		`-`
	`134`	`+`
	`135`	`+ foreach (var response in operation.Responses.Values)`
	`136`	`+ {`
	`137`	`+ ProcessProduces(response, node.Context);`
	`138`	`+ }`
	`139`	`+`
`135`	`140`	`return operation;`
`136`	`141`	`}`
`137`	`142`