Added context keys to visitor base

Author: darrelmiller

src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs

@@ -15,7 +15,21 @@ namespace Microsoft.OpenApi.Services
     public abstract class OpenApiVisitorBase
     {
         private readonly Stack<string> _path = new Stack<string>();
-       
+        private CurrentKeys _currentKeys = new CurrentKeys();
+
+
+
+        /// <summary>
+        /// Properties available to identify context of where an object is within OpenAPI Document
+        /// </summary>
+        public CurrentKeys CurrentKeys
+        {
+            get
+            {
+                return _currentKeys;
+            }
+        }
+
         /// <summary>
         /// Allow Rule to indicate validation error occured at a deeper context level.  
         /// </summary>
@@ -44,6 +58,15 @@ public string PathString
             }
         }
 
+        internal void AttachCurrentKeys(CurrentKeys currentKeys)
+        {
+
+        }
+
+        internal void ClearCurrentKeys()
+        {
+
+        }
 
 
         /// <summary>

src/Microsoft.OpenApi/Services/OpenApiWalker.cs

@@ -18,7 +18,6 @@ public class OpenApiWalker
         private readonly OpenApiVisitorBase _visitor;
         private readonly Stack<OpenApiSchema> _schemaLoop = new Stack<OpenApiSchema>();
         private readonly Stack<OpenApiPathItem> _pathItemLoop = new Stack<OpenApiPathItem>();
-        private Dictionary<string, string> _currentKeys = new Dictionary<string, string>();
 
         private bool _inComponents = false;
 
@@ -55,6 +54,7 @@ public void Walk(OpenApiDocument doc)
             Walk(OpenApiConstants.ExternalDocs, () => Walk(doc.ExternalDocs));
             Walk(OpenApiConstants.Tags, () => Walk(doc.Tags));
             Walk(doc as IOpenApiExtensible);
+
         }
 
         /// <summary>
@@ -77,7 +77,6 @@ internal void Walk(IList<OpenApiTag> tags)
                     Walk(i.ToString(), () => Walk(tags[i]));
                 }
             }
-
         }
 
         /// <summary>
@@ -221,8 +220,10 @@ internal void Walk(OpenApiPaths paths)
             {
                 foreach (var pathItem in paths)
                 {
+                    _visitor.CurrentKeys.Path = pathItem.Key;
                     Walk(pathItem.Key, () => Walk(pathItem.Value));// JSON Pointer uses ~1 as an escape character for /
                 }
+                _visitor.CurrentKeys.Path = null;
             }
         }
 
@@ -282,8 +283,10 @@ internal void Walk(IOpenApiExtensible openApiExtensible)
             {
                 foreach (var item in openApiExtensible.Extensions)
                 {
+                    _visitor.CurrentKeys.Extension = item.Key;
                     Walk(item.Key, () => Walk(item.Value));
                 }
+                _visitor.CurrentKeys.Extension = null;
             }
         }
 
@@ -342,9 +345,11 @@ internal void Walk(OpenApiCallback callback)
             {
                 foreach (var item in callback.PathItems)
                 {
+                    _visitor.CurrentKeys.Callback = item.Key.ToString();
                     var pathItem = item.Value;
                     Walk(item.Key.ToString(), () => Walk(pathItem));
                 }
+                _visitor.CurrentKeys.Callback = null;
             }
         }
 
@@ -394,8 +399,10 @@ internal void Walk(IDictionary<string,OpenApiServerVariable> serverVariables)
             {
                 foreach (var variable in serverVariables)
                 {
+                    _visitor.CurrentKeys.ServerVariable = variable.Key;
                     Walk(variable.Key, () => Walk(variable.Value));
                 }
+                _visitor.CurrentKeys.ServerVariable = null;
             }
         }
 
@@ -459,8 +466,10 @@ internal void Walk(IDictionary<OperationType, OpenApiOperation> operations)
             {
                 foreach (var operation in operations)
                 {
+                    _visitor.CurrentKeys.Operation = operation.Key;
                     Walk(operation.Key.GetDisplayName(), () => Walk(operation.Value));
                 }
+                _visitor.CurrentKeys.Operation = null;
             }
         }
 
@@ -563,8 +572,10 @@ internal void Walk(OpenApiResponses responses)
             {
                 foreach (var response in responses)
                 {
+                    _visitor.CurrentKeys.Response = response.Key;
                     Walk(response.Key, () => Walk(response.Value));
                 }
+                _visitor.CurrentKeys.Response = null;
             }
             Walk(responses as IOpenApiExtensible);
         }
@@ -624,8 +635,10 @@ internal void Walk(IDictionary<string, OpenApiHeader> headers)
             {
                 foreach (var header in headers)
                 {
+                    _visitor.CurrentKeys.Header = header.Key;
                     Walk(header.Key, () => Walk(header.Value));
                 }
+                _visitor.CurrentKeys.Header = null;
             }
         }
 
@@ -642,10 +655,12 @@ internal void Walk(IDictionary<string, OpenApiCallback> callbacks)
             _visitor.Visit(callbacks);
             if (callbacks != null)
             {
-                foreach (var header in callbacks)
+                foreach (var callback in callbacks)
                 {
-                    Walk(header.Key, () => Walk(header.Value));
+                    _visitor.CurrentKeys.Callback = callback.Key;
+                    Walk(callback.Key, () => Walk(callback.Value));
                 }
+                _visitor.CurrentKeys.Callback = null;
             }
         }
 
@@ -664,8 +679,10 @@ internal void Walk(IDictionary<string, OpenApiMediaType> content)
             {
                 foreach (var mediaType in content)
                 {
+                    _visitor.CurrentKeys.Content = mediaType.Key;
                     Walk(mediaType.Key, () => Walk(mediaType.Value));
                 }
+                _visitor.CurrentKeys.Content = null;
             }
         }
 
@@ -703,8 +720,10 @@ internal void Walk(IDictionary<string, OpenApiEncoding> encodings)
             {
                 foreach (var item in encodings)
                 {
+                    _visitor.CurrentKeys.Encoding = item.Key;
                     Walk(item.Key, () => Walk(item.Value));
                 }
+                _visitor.CurrentKeys.Encoding = null;
             }
         }
 
@@ -789,6 +808,7 @@ internal void Walk(IDictionary<string,OpenApiExample> examples)
             {
                 foreach (var example in examples)
                 {
+                    _visitor.CurrentKeys.Example = example.Key;
                     Walk(example.Key, () => Walk(example.Value));
                 }
             }
@@ -906,8 +926,10 @@ internal void Walk(IDictionary<string,OpenApiLink> links)
             {
                 foreach (var item in links)
                 {
+                    _visitor.CurrentKeys.Link = item.Key;
                     Walk(item.Key, () => Walk(item.Value));
                 }
+                _visitor.CurrentKeys.Link = null;
             }
         }
 
@@ -1047,4 +1069,19 @@ private void ExitComponents()
             _inComponents = false;
         }
     }
+
+    public class CurrentKeys
+    {
+        public string Path { get; set; }
+        public OperationType? Operation { get; set; }
+        public string Response { get; set; }
+        public string Content { get; set; }
+        public string Callback { get; set; }
+        public string Link { get; set; }
+        public string Header { get; internal set; }
+        public string Encoding { get; internal set; }
+        public string Example { get; internal set; }
+        public string Extension { get; internal set; }
+        public string ServerVariable { get; internal set; }
+    }
 }

test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs

@@ -107,6 +107,8 @@ public void LocatePathOperationContentSchema()
                 "#/paths/~1test/get/responses/200/content/application~1json/schema",
 
             });
+
+            locator.Keys.ShouldAllBeEquivalentTo(new List<string> { "/test","Get","200", "application/json" });
         }
 
         [Fact]
@@ -153,6 +155,8 @@ public void WalkDOMWithCycles()
     internal class LocatorVisitor : OpenApiVisitorBase
     {
         public List<string> Locations = new List<string>();
+        public List<string> Keys = new List<string>();
+
         public override void Visit(OpenApiInfo info)
         {
             Locations.Add(this.PathString);
@@ -175,6 +179,7 @@ public override void Visit(OpenApiPaths paths)
 
         public override void Visit(OpenApiPathItem pathItem)
         {
+            Keys.Add(CurrentKeys.Path);
             Locations.Add(this.PathString);
         }
 
@@ -185,10 +190,12 @@ public override void Visit(OpenApiResponses responses)
 
         public override void Visit(OpenApiOperation operation)
         {
+            Keys.Add(CurrentKeys.Operation.ToString());
             Locations.Add(this.PathString);
         }
         public override void Visit(OpenApiResponse response)
         {
+            Keys.Add(CurrentKeys.Response);
             Locations.Add(this.PathString);
         }
 
@@ -199,6 +206,7 @@ public override void Visit(IDictionary<string,OpenApiMediaType> content)
 
         public override void Visit(OpenApiMediaType mediaType)
         {
+            Keys.Add(CurrentKeys.Content);
             Locations.Add(this.PathString);
         }