Local references working

darrelmiller · darrelmiller · commit 1697d8ab9f8e · 2018-02-07T17:30:45.000-08:00
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs b/src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs
@@ -37,7 +37,7 @@ public class OpenApiReaderSettings
         /// <summary>
         /// Indicates how references in the source document should be handled.
         /// </summary>
-        public ReferenceResolutionSetting ReferenceResolution { get; set; } = ReferenceResolutionSetting.ResolveRemoteReferences;
+        public ReferenceResolutionSetting ReferenceResolution { get; set; } = ReferenceResolutionSetting.ResolveLocalReferences;
 
         /// <summary>
         /// Dictionary of parsers for converting extensions into strongly typed classes
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs
@@ -1,13 +1,14 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
+using System;
 using System.IO;
 using System.Linq;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Interface;
+using Microsoft.OpenApi.Readers.Services;
 using Microsoft.OpenApi.Services;
-using Microsoft.OpenApi.Validations;
 using SharpYaml;
 using SharpYaml.Serialization;
 
@@ -64,6 +65,7 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             switch (_settings.ReferenceResolution) 
             {
                 case ReferenceResolutionSetting.ResolveRemoteReferences:
+                    throw new ArgumentException(Properties.SRResource.CannotResolveRemoteReferencesSynchronously);
                 case ReferenceResolutionSetting.ResolveLocalReferences:
                     var resolver = new OpenApiReferenceResolver(document);
                     var walker = new OpenApiWalker(resolver);
diff --git a/src/Microsoft.OpenApi.Readers/ParseNodes/MapNode.cs b/src/Microsoft.OpenApi.Readers/ParseNodes/MapNode.cs
@@ -80,7 +80,6 @@ public override Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)
 
          public override Dictionary<string, T> CreateMapWithReference<T>(
              ReferenceType referenceType,
-             string refpointerbase,
              Func<MapNode, T> map)
          {
              var yamlMap = _node;
diff --git a/src/Microsoft.OpenApi.Readers/ParseNodes/ParseNode.cs b/src/Microsoft.OpenApi.Readers/ParseNodes/ParseNode.cs
@@ -79,7 +79,6 @@ public virtual Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)
 
         public virtual Dictionary<string, T> CreateMapWithReference<T>(
             ReferenceType referenceType,
-            string refpointer,
             Func<MapNode, T> map)
             where T : class, IOpenApiReferenceable
         {
diff --git a/src/Microsoft.OpenApi.Readers/Properties/SRResource.Designer.cs b/src/Microsoft.OpenApi.Readers/Properties/SRResource.Designer.cs
diff --git a/src/Microsoft.OpenApi.Readers/Properties/SRResource.resx b/src/Microsoft.OpenApi.Readers/Properties/SRResource.resx
@@ -120,6 +120,9 @@
   <data name="ArgumentNullOrWhiteSpace" xml:space="preserve">
     <value>The argument '{0}' is null, empty or consists only of white-space.</value>
   </data>
+  <data name="CannotResolveRemoteReferencesSynchronously" xml:space="preserve">
+    <value>"Cannot resolve remote references automatically in a syncronous call."</value>
+  </data>
   <data name="LoadReferencedObjectFromExternalNotImplmented" xml:space="preserve">
     <value>Not implemented to find referenced element from external resource.</value>
   </data>
diff --git a/src/Microsoft.OpenApi.Readers/Services/OpenApiReferenceResolver.cs b/src/Microsoft.OpenApi.Readers/Services/OpenApiReferenceResolver.cs
@@ -8,7 +8,7 @@
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
 
-namespace Microsoft.OpenApi.Readers
+namespace Microsoft.OpenApi.Readers.Services
 {
     /// <summary>
     /// This class is used to walk an OpenApiDocument and convert unresolved references to references to populated objects
@@ -18,7 +18,7 @@ internal class OpenApiReferenceResolver : OpenApiVisitorBase
         private OpenApiDocument _currentDocument;
         private bool _resolveRemoteReferences;
 
-        public OpenApiReferenceResolver(OpenApiDocument currentDocument, bool resolveRemoteReferences = true)  // In future pass in Workbench for remote references
+        public OpenApiReferenceResolver(OpenApiDocument currentDocument, bool resolveRemoteReferences = true) 
         {
             _currentDocument = currentDocument;
             _resolveRemoteReferences = resolveRemoteReferences;
@@ -34,12 +34,22 @@ public override void Visit(OpenApiDocument doc)
 
         public override void Visit(OpenApiComponents components)
         {
+            ResolveMap(components.Parameters);
+            ResolveMap(components.RequestBodies);
+            ResolveMap(components.Responses);
+            ResolveMap(components.Links);
+            ResolveMap(components.Callbacks);
+            ResolveMap(components.Examples);
             ResolveMap(components.Schemas);
+            ResolveMap(components.SecuritySchemes);
         }
-        // TODO: Resolve Paths
-        // TODO: Resolve Callbacks
 
 
+        public override void Visit(IDictionary<string, OpenApiCallback> callbacks)
+        {
+            ResolveMap(callbacks);
+        }
+
         /// <summary>
         /// Resolve all references used in an operation
         /// </summary>
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs
@@ -50,7 +50,6 @@ internal static partial class OpenApiV2Deserializer
 
                     o.Components.Schemas = n.CreateMapWithReference(
                         ReferenceType.Schema,
-                        "#/definitions/",
                         LoadSchema);
                 }
             },
@@ -65,7 +64,6 @@ internal static partial class OpenApiV2Deserializer
 
                     o.Components.Parameters = n.CreateMapWithReference(
                         ReferenceType.Parameter,
-                        "#/parameters/",
                         LoadParameter);
                 }
             },
@@ -77,7 +75,9 @@ internal static partial class OpenApiV2Deserializer
                         o.Components = new OpenApiComponents();
                     }
 
-                    o.Components.Responses = n.CreateMap(LoadResponse);
+                    o.Components.Responses = n.CreateMapWithReference(
+                        ReferenceType.Response,
+                        LoadResponse);
                 }
             },
             {
@@ -88,7 +88,10 @@ internal static partial class OpenApiV2Deserializer
                         o.Components = new OpenApiComponents();
                     }
 
-                    o.Components.SecuritySchemes = n.CreateMap(LoadSecurityScheme);
+                    o.Components.SecuritySchemes = n.CreateMapWithReference(
+                        ReferenceType.SecurityScheme,
+                        LoadSecurityScheme
+                        );
                 }
             },
             {"security", (o, n) => o.SecurityRequirements = n.CreateList(LoadSecurityRequirement)},
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiComponentsDeserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiComponentsDeserializer.cs
@@ -18,19 +18,16 @@ internal static partial class OpenApiV3Deserializer
         private static FixedFieldMap<OpenApiComponents> _componentsFixedFields = new FixedFieldMap<OpenApiComponents>
         {
             {
-                "schemas", (o, n) =>
-                {
-                    o.Schemas = n.CreateMapWithReference(ReferenceType.Schema, "", LoadSchema);
-                }
+                "schemas", (o, n) => o.Schemas = n.CreateMapWithReference(ReferenceType.Schema, LoadSchema)
             },
-            {"responses", (o, n) => o.Responses = n.CreateMap(LoadResponse)},
-            {"parameters", (o, n) => o.Parameters = n.CreateMap(LoadParameter)},
-            {"examples", (o, n) => o.Examples = n.CreateMap(LoadExample)},
-            {"requestBodies", (o, n) => o.RequestBodies = n.CreateMap(LoadRequestBody)},
-            {"headers", (o, n) => o.Headers = n.CreateMap(LoadHeader)},
-            {"securitySchemes", (o, n) => o.SecuritySchemes = n.CreateMap(LoadSecurityScheme)},
-            {"links", (o, n) => o.Links = n.CreateMap(LoadLink)},
-            {"callbacks", (o, n) => o.Callbacks = n.CreateMap(LoadCallback)},
+            {"responses", (o, n) => o.Responses = n.CreateMapWithReference(ReferenceType.Response, LoadResponse)},
+            {"parameters", (o, n) => o.Parameters = n.CreateMapWithReference(ReferenceType.Parameter, LoadParameter)},
+            {"examples", (o, n) => o.Examples = n.CreateMapWithReference(ReferenceType.Example, LoadExample)},
+            {"requestBodies", (o, n) => o.RequestBodies = n.CreateMapWithReference(ReferenceType.RequestBody, LoadRequestBody)},
+            {"headers", (o, n) => o.Headers = n.CreateMapWithReference(ReferenceType.Header, LoadHeader)},
+            {"securitySchemes", (o, n) => o.SecuritySchemes = n.CreateMapWithReference(ReferenceType.SecurityScheme, LoadSecurityScheme)},
+            {"links", (o, n) => o.Links = n.CreateMapWithReference(ReferenceType.Link, LoadLink)},
+            {"callbacks", (o, n) => o.Callbacks = n.CreateMapWithReference(ReferenceType.Callback, LoadCallback)},
         };
 
 
diff --git a/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs b/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs
@@ -158,6 +158,12 @@ public virtual void Visit(IDictionary<string, OpenApiHeader> headers)
         {
         }
 
+        /// <summary>
+        /// Visits headers.
+        /// </summary>
+        public virtual void Visit(IDictionary<string, OpenApiCallback> callbacks)
+        {
+        }
 
         /// <summary>
         /// Visits <see cref="OpenApiResponse"/>
diff --git a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs
@@ -468,6 +468,8 @@ internal void Walk(OpenApiOperation operation)
             Walk(OpenApiConstants.Parameters, () => Walk(operation.Parameters));
             Walk(OpenApiConstants.RequestBody, () => Walk(operation.RequestBody));
             Walk(OpenApiConstants.Responses, () => Walk(operation.Responses));
+            Walk(OpenApiConstants.Callbacks, () => Walk(operation.Callbacks));
+
             Walk(operation as IOpenApiExtensible);
         }
 
@@ -591,6 +593,25 @@ internal void Walk(IDictionary<string, OpenApiHeader> headers)
             }
         }
 
+        /// <summary>
+        /// Visits dictionary of <see cref="OpenApiCallback"/>
+        /// </summary>
+        internal void Walk(IDictionary<string, OpenApiCallback> callbacks)
+        {
+            if (callbacks == null)
+            {
+                return;
+            }
+
+            _visitor.Visit(callbacks);
+            if (callbacks != null)
+            {
+                foreach (var header in callbacks)
+                {
+                    Walk(header.Key.Replace("/", "~1"), () => Walk(header.Value));
+                }
+            }
+        }
 
         /// <summary>
         /// Visits dictionary of <see cref="OpenApiMediaType"/>
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiCallbackTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiCallbackTests.cs
@@ -94,7 +94,35 @@ public void ParseAdvancedCallbackWithReferenceShouldSucceed()
                 callback.ShouldBeEquivalentTo(
                     new OpenApiCallback
                     {
-                        UnresolvedReference =true,
+                        PathItems = 
+                        {
+                            [RuntimeExpression.Build("$request.body#/url")]= new OpenApiPathItem {
+                                Operations = {
+                                    [OperationType.Post] = new OpenApiOperation()
+                                    {
+                                        RequestBody = new OpenApiRequestBody
+                                        {
+                                            Content =
+                                            {
+                                                ["application/json"] = new OpenApiMediaType
+                                                {
+                                                    Schema = new OpenApiSchema()
+                                                    {
+                                                        Type = "object"
+                                                    }
+                                                }
+                                            }
+                                        },
+                                        Responses = {
+                                            ["200"]= new OpenApiResponse
+                                            {
+                                                Description = "Success"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        },
                         Reference = new OpenApiReference
                         {
                             Type = ReferenceType.Callback,
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs
@@ -666,12 +666,23 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
                         {
                             Type = SecuritySchemeType.ApiKey,
                             Name = "apiKeyName1",
-                            In = ParameterLocation.Header
+                            In = ParameterLocation.Header,
+                            Reference = new OpenApiReference
+                            {
+                                Id = "securitySchemeName1",
+                                Type = ReferenceType.SecurityScheme
+                            }
+
                         },
                         ["securitySchemeName2"] = new OpenApiSecurityScheme
                         {
                             Type = SecuritySchemeType.OpenIdConnect,
-                            OpenIdConnectUrl = new Uri("http://example.com")
+                            OpenIdConnectUrl = new Uri("http://example.com"),
+                            Reference = new OpenApiReference
+                            {
+                                Id = "securitySchemeName2",
+                                Type = ReferenceType.SecurityScheme
+                            }
                         }
                     }
                 };

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,6 @@ public override Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)`
`80`	`80`
`81`	`81`	`public override Dictionary<string, T> CreateMapWithReference<T>(`
`82`	`82`	`ReferenceType referenceType,`
`83`		`- string refpointerbase,`
`84`	`83`	`Func<MapNode, T> map)`
`85`	`84`	`{`
`86`	`85`	`var yamlMap = _node;`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,6 @@ public virtual Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)`
`79`	`79`
`80`	`80`	`public virtual Dictionary<string, T> CreateMapWithReference<T>(`
`81`	`81`	`ReferenceType referenceType,`
`82`		`- string refpointer,`
`83`	`82`	`Func<MapNode, T> map)`
`84`	`83`	`where T : class, IOpenApiReferenceable`
`85`	`84`	`{`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,6 @@ internal static partial class OpenApiV2Deserializer`
`50`	`50`
`51`	`51`	`o.Components.Schemas = n.CreateMapWithReference(`
`52`	`52`	`ReferenceType.Schema,`
`53`		`- "#/definitions/",`
`54`	`53`	`LoadSchema);`
`55`	`54`	`}`
`56`	`55`	`},`
`@@ -65,7 +64,6 @@ internal static partial class OpenApiV2Deserializer`
`65`	`64`
`66`	`65`	`o.Components.Parameters = n.CreateMapWithReference(`
`67`	`66`	`ReferenceType.Parameter,`
`68`		`- "#/parameters/",`
`69`	`67`	`LoadParameter);`
`70`	`68`	`}`
`71`	`69`	`},`
`@@ -77,7 +75,9 @@ internal static partial class OpenApiV2Deserializer`
`77`	`75`	`o.Components = new OpenApiComponents();`
`78`	`76`	`}`
`79`	`77`
`80`		`- o.Components.Responses = n.CreateMap(LoadResponse);`
	`78`	`+ o.Components.Responses = n.CreateMapWithReference(`
	`79`	`+ ReferenceType.Response,`
	`80`	`+ LoadResponse);`
`81`	`81`	`}`
`82`	`82`	`},`
`83`	`83`	`{`
`@@ -88,7 +88,10 @@ internal static partial class OpenApiV2Deserializer`
`88`	`88`	`o.Components = new OpenApiComponents();`
`89`	`89`	`}`
`90`	`90`
`91`		`- o.Components.SecuritySchemes = n.CreateMap(LoadSecurityScheme);`
	`91`	`+ o.Components.SecuritySchemes = n.CreateMapWithReference(`
	`92`	`+ ReferenceType.SecurityScheme,`
	`93`	`+ LoadSecurityScheme`
	`94`	`+ );`
`92`	`95`	`}`
`93`	`96`	`},`
`94`	`97`	`{"security", (o, n) => o.SecurityRequirements = n.CreateList(LoadSecurityRequirement)},`
Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,12 @@ public virtual void Visit(IDictionary<string, OpenApiHeader> headers)`
`158`	`158`	`{`
`159`	`159`	`}`
`160`	`160`
	`161`	`+ /// <summary>`
	`162`	`+ /// Visits headers.`
	`163`	`+ /// </summary>`
	`164`	`+ public virtual void Visit(IDictionary<string, OpenApiCallback> callbacks)`
	`165`	`+ {`
	`166`	`+ }`
`161`	`167`
`162`	`168`	`/// <summary>`
`163`	`169`	`/// Visits <see cref="OpenApiResponse"/>`