Merge pull request #280 from Microsoft/dm/vnext/visitorcontext

darrelmiller · web-flow · commit 0fb9f1d89db1 · 2018-06-13T09:35:58.000-04:00
Added ContextKeys object to VisitorBase
diff --git a/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs b/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs
@@ -15,7 +15,12 @@ namespace Microsoft.OpenApi.Services
     public abstract class OpenApiVisitorBase
     {
         private readonly Stack<string> _path = new Stack<string>();
-       
+
+        /// <summary>
+        /// Properties available to identify context of where an object is within OpenAPI Document
+        /// </summary>
+        public CurrentKeys CurrentKeys { get; } = new CurrentKeys();
+
         /// <summary>
         /// Allow Rule to indicate validation error occured at a deeper context level.  
         /// </summary>
@@ -44,8 +49,6 @@ public string PathString
             }
         }
 
-    
-
         /// <summary>
         /// Visits <see cref="OpenApiDocument"/>
         /// </summary>
diff --git a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs
@@ -18,6 +18,7 @@ public class OpenApiWalker
         private readonly OpenApiVisitorBase _visitor;
         private readonly Stack<OpenApiSchema> _schemaLoop = new Stack<OpenApiSchema>();
         private readonly Stack<OpenApiPathItem> _pathItemLoop = new Stack<OpenApiPathItem>();
+
         private bool _inComponents = false;
 
         /// <summary>
@@ -53,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>
@@ -75,7 +77,6 @@ internal void Walk(IList<OpenApiTag> tags)
                     Walk(i.ToString(), () => Walk(tags[i]));
                 }
             }
-
         }
 
         /// <summary>
@@ -219,7 +220,9 @@ 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;
                 }
             }
         }
@@ -280,7 +283,9 @@ 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;
                 }
             }
         }
@@ -340,8 +345,10 @@ 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;
                 }
             }
         }
@@ -392,7 +399,9 @@ 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;
                 }
             }
         }
@@ -457,7 +466,9 @@ 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;
                 }
             }
         }
@@ -561,7 +572,9 @@ 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);
@@ -622,7 +635,9 @@ 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;
                 }
             }
         }
@@ -640,9 +655,11 @@ 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;
                 }
             }
         }
@@ -662,7 +679,9 @@ 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;
                 }
             }
         }
@@ -701,7 +720,9 @@ 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;
                 }
             }
         }
@@ -787,7 +808,9 @@ internal void Walk(IDictionary<string,OpenApiExample> examples)
             {
                 foreach (var example in examples)
                 {
+                    _visitor.CurrentKeys.Example = example.Key;
                     Walk(example.Key, () => Walk(example.Value));
+                    _visitor.CurrentKeys.Example = null;
                 }
             }
         }
@@ -904,7 +927,9 @@ 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;
                 }
             }
         }
@@ -1045,4 +1070,65 @@ private void ExitComponents()
             _inComponents = false;
         }
     }
+
+    /// <summary>
+    /// Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument
+    /// </summary>
+    public class CurrentKeys
+    {
+        /// <summary>
+        /// Current Path key
+        /// </summary>
+        public string Path { get; set; }
+
+        /// <summary>
+        /// Current Operation Type
+        /// </summary>
+        public OperationType? Operation { get; set; }
+
+        /// <summary>
+        /// Current Response Status Code
+        /// </summary>
+        public string Response { get; set; }
+
+        /// <summary>
+        /// Current Content Media Type
+        /// </summary>
+        public string Content { get; set; }
+
+        /// <summary>
+        /// Current Callback Key
+        /// </summary>
+        public string Callback { get; set; }
+
+        /// <summary>
+        /// Current Link Key
+        /// </summary>
+        public string Link { get; set; }
+
+        /// <summary>
+        /// Current Header Key
+        /// </summary>
+        public string Header { get; internal set; }
+
+        /// <summary>
+        /// Current Encoding Key
+        /// </summary>
+        public string Encoding { get; internal set; }
+
+        /// <summary>
+        /// Current Example Key
+        /// </summary>
+        public string Example { get; internal set; }
+
+        /// <summary>
+        /// Current Extension Key
+        /// </summary>
+        public string Extension { get; internal set; }
+
+        /// <summary>
+        /// Current ServerVariable
+        /// </summary>
+        public string ServerVariable { get; internal set; }
+    }
 }
diff --git a/test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs b/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);
         }
 

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ public class OpenApiWalker`
`18`	`18`	`private readonly OpenApiVisitorBase _visitor;`
`19`	`19`	`private readonly Stack<OpenApiSchema> _schemaLoop = new Stack<OpenApiSchema>();`
`20`	`20`	`private readonly Stack<OpenApiPathItem> _pathItemLoop = new Stack<OpenApiPathItem>();`
	`21`	`+`
`21`	`22`	`private bool _inComponents = false;`
`22`	`23`
`23`	`24`	`/// <summary>`
`@@ -53,6 +54,7 @@ public void Walk(OpenApiDocument doc)`
`53`	`54`	`Walk(OpenApiConstants.ExternalDocs, () => Walk(doc.ExternalDocs));`
`54`	`55`	`Walk(OpenApiConstants.Tags, () => Walk(doc.Tags));`
`55`	`56`	`Walk(doc as IOpenApiExtensible);`
	`57`	`+`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`/// <summary>`
`@@ -75,7 +77,6 @@ internal void Walk(IList<OpenApiTag> tags)`
`75`	`77`	`Walk(i.ToString(), () => Walk(tags[i]));`
`76`	`78`	`}`
`77`	`79`	`}`
`78`		`-`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`/// <summary>`
`@@ -219,7 +220,9 @@ internal void Walk(OpenApiPaths paths)`
`219`	`220`	`{`
`220`	`221`	`foreach (var pathItem in paths)`
`221`	`222`	`{`
	`223`	`+ _visitor.CurrentKeys.Path = pathItem.Key;`
`222`	`224`	`Walk(pathItem.Key, () => Walk(pathItem.Value));// JSON Pointer uses ~1 as an escape character for /`
	`225`	`+ _visitor.CurrentKeys.Path = null;`
`223`	`226`	`}`
`224`	`227`	`}`
`225`	`228`	`}`
`@@ -280,7 +283,9 @@ internal void Walk(IOpenApiExtensible openApiExtensible)`
`280`	`283`	`{`
`281`	`284`	`foreach (var item in openApiExtensible.Extensions)`
`282`	`285`	`{`
	`286`	`+ _visitor.CurrentKeys.Extension = item.Key;`
`283`	`287`	`Walk(item.Key, () => Walk(item.Value));`
	`288`	`+ _visitor.CurrentKeys.Extension = null;`
`284`	`289`	`}`
`285`	`290`	`}`
`286`	`291`	`}`
`@@ -340,8 +345,10 @@ internal void Walk(OpenApiCallback callback)`
`340`	`345`	`{`
`341`	`346`	`foreach (var item in callback.PathItems)`
`342`	`347`	`{`
	`348`	`+ _visitor.CurrentKeys.Callback = item.Key.ToString();`
`343`	`349`	`var pathItem = item.Value;`
`344`	`350`	`Walk(item.Key.ToString(), () => Walk(pathItem));`
	`351`	`+ _visitor.CurrentKeys.Callback = null;`
`345`	`352`	`}`
`346`	`353`	`}`
`347`	`354`	`}`
`@@ -392,7 +399,9 @@ internal void Walk(IDictionary<string,OpenApiServerVariable> serverVariables)`
`392`	`399`	`{`
`393`	`400`	`foreach (var variable in serverVariables)`
`394`	`401`	`{`
	`402`	`+ _visitor.CurrentKeys.ServerVariable = variable.Key;`
`395`	`403`	`Walk(variable.Key, () => Walk(variable.Value));`
	`404`	`+ _visitor.CurrentKeys.ServerVariable = null;`
`396`	`405`	`}`
`397`	`406`	`}`
`398`	`407`	`}`
`@@ -457,7 +466,9 @@ internal void Walk(IDictionary<OperationType, OpenApiOperation> operations)`
`457`	`466`	`{`
`458`	`467`	`foreach (var operation in operations)`
`459`	`468`	`{`
	`469`	`+ _visitor.CurrentKeys.Operation = operation.Key;`
`460`	`470`	`Walk(operation.Key.GetDisplayName(), () => Walk(operation.Value));`
	`471`	`+ _visitor.CurrentKeys.Operation = null;`
`461`	`472`	`}`
`462`	`473`	`}`
`463`	`474`	`}`
`@@ -561,7 +572,9 @@ internal void Walk(OpenApiResponses responses)`
`561`	`572`	`{`
`562`	`573`	`foreach (var response in responses)`
`563`	`574`	`{`
	`575`	`+ _visitor.CurrentKeys.Response = response.Key;`
`564`	`576`	`Walk(response.Key, () => Walk(response.Value));`
	`577`	`+ _visitor.CurrentKeys.Response = null;`
`565`	`578`	`}`
`566`	`579`	`}`
`567`	`580`	`Walk(responses as IOpenApiExtensible);`
`@@ -622,7 +635,9 @@ internal void Walk(IDictionary<string, OpenApiHeader> headers)`
`622`	`635`	`{`
`623`	`636`	`foreach (var header in headers)`
`624`	`637`	`{`
	`638`	`+ _visitor.CurrentKeys.Header = header.Key;`
`625`	`639`	`Walk(header.Key, () => Walk(header.Value));`
	`640`	`+ _visitor.CurrentKeys.Header = null;`
`626`	`641`	`}`
`627`	`642`	`}`
`628`	`643`	`}`
`@@ -640,9 +655,11 @@ internal void Walk(IDictionary<string, OpenApiCallback> callbacks)`
`640`	`655`	`_visitor.Visit(callbacks);`
`641`	`656`	`if (callbacks != null)`
`642`	`657`	`{`
`643`		`- foreach (var header in callbacks)`
	`658`	`+ foreach (var callback in callbacks)`
`644`	`659`	`{`
`645`		`- Walk(header.Key, () => Walk(header.Value));`
	`660`	`+ _visitor.CurrentKeys.Callback = callback.Key;`
	`661`	`+ Walk(callback.Key, () => Walk(callback.Value));`
	`662`	`+ _visitor.CurrentKeys.Callback = null;`
`646`	`663`	`}`
`647`	`664`	`}`
`648`	`665`	`}`
`@@ -662,7 +679,9 @@ internal void Walk(IDictionary<string, OpenApiMediaType> content)`
`662`	`679`	`{`
`663`	`680`	`foreach (var mediaType in content)`
`664`	`681`	`{`
	`682`	`+ _visitor.CurrentKeys.Content = mediaType.Key;`
`665`	`683`	`Walk(mediaType.Key, () => Walk(mediaType.Value));`
	`684`	`+ _visitor.CurrentKeys.Content = null;`
`666`	`685`	`}`
`667`	`686`	`}`
`668`	`687`	`}`
`@@ -701,7 +720,9 @@ internal void Walk(IDictionary<string, OpenApiEncoding> encodings)`
`701`	`720`	`{`
`702`	`721`	`foreach (var item in encodings)`
`703`	`722`	`{`
	`723`	`+ _visitor.CurrentKeys.Encoding = item.Key;`
`704`	`724`	`Walk(item.Key, () => Walk(item.Value));`
	`725`	`+ _visitor.CurrentKeys.Encoding = null;`
`705`	`726`	`}`
`706`	`727`	`}`
`707`	`728`	`}`
`@@ -787,7 +808,9 @@ internal void Walk(IDictionary<string,OpenApiExample> examples)`
`787`	`808`	`{`
`788`	`809`	`foreach (var example in examples)`
`789`	`810`	`{`
	`811`	`+ _visitor.CurrentKeys.Example = example.Key;`
`790`	`812`	`Walk(example.Key, () => Walk(example.Value));`
	`813`	`+ _visitor.CurrentKeys.Example = null;`
`791`	`814`	`}`
`792`	`815`	`}`
`793`	`816`	`}`
`@@ -904,7 +927,9 @@ internal void Walk(IDictionary<string,OpenApiLink> links)`
`904`	`927`	`{`
`905`	`928`	`foreach (var item in links)`
`906`	`929`	`{`
	`930`	`+ _visitor.CurrentKeys.Link = item.Key;`
`907`	`931`	`Walk(item.Key, () => Walk(item.Value));`
	`932`	`+ _visitor.CurrentKeys.Link = null;`
`908`	`933`	`}`
`909`	`934`	`}`
`910`	`935`	`}`
`@@ -1045,4 +1070,65 @@ private void ExitComponents()`
`1045`	`1070`	`_inComponents = false;`
`1046`	`1071`	`}`
`1047`	`1072`	`}`
	`1073`	`+`
	`1074`	`+ /// <summary>`
	`1075`	`+ /// Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument`
	`1076`	`+ /// </summary>`
	`1077`	`+ public class CurrentKeys`
	`1078`	`+ {`
	`1079`	`+ /// <summary>`
	`1080`	`+ /// Current Path key`
	`1081`	`+ /// </summary>`
	`1082`	`+ public string Path { get; set; }`
	`1083`	`+`
	`1084`	`+ /// <summary>`
	`1085`	`+ /// Current Operation Type`
	`1086`	`+ /// </summary>`
	`1087`	`+ public OperationType? Operation { get; set; }`
	`1088`	`+`
	`1089`	`+ /// <summary>`
	`1090`	`+ /// Current Response Status Code`
	`1091`	`+ /// </summary>`
	`1092`	`+ public string Response { get; set; }`
	`1093`	`+`
	`1094`	`+ /// <summary>`
	`1095`	`+ /// Current Content Media Type`
	`1096`	`+ /// </summary>`
	`1097`	`+ public string Content { get; set; }`
	`1098`	`+`
	`1099`	`+ /// <summary>`
	`1100`	`+ /// Current Callback Key`
	`1101`	`+ /// </summary>`
	`1102`	`+ public string Callback { get; set; }`
	`1103`	`+`
	`1104`	`+ /// <summary>`
	`1105`	`+ /// Current Link Key`
	`1106`	`+ /// </summary>`
	`1107`	`+ public string Link { get; set; }`
	`1108`	`+`
	`1109`	`+ /// <summary>`
	`1110`	`+ /// Current Header Key`
	`1111`	`+ /// </summary>`
	`1112`	`+ public string Header { get; internal set; }`
	`1113`	`+`
	`1114`	`+ /// <summary>`
	`1115`	`+ /// Current Encoding Key`
	`1116`	`+ /// </summary>`
	`1117`	`+ public string Encoding { get; internal set; }`
	`1118`	`+`
	`1119`	`+ /// <summary>`
	`1120`	`+ /// Current Example Key`
	`1121`	`+ /// </summary>`
	`1122`	`+ public string Example { get; internal set; }`
	`1123`	`+`
	`1124`	`+ /// <summary>`
	`1125`	`+ /// Current Extension Key`
	`1126`	`+ /// </summary>`
	`1127`	`+ public string Extension { get; internal set; }`
	`1128`	`+`
	`1129`	`+ /// <summary>`
	`1130`	`+ /// Current ServerVariable`
	`1131`	`+ /// </summary>`
	`1132`	`+ public string ServerVariable { get; internal set; }`
	`1133`	`+ }`
`1048`	`1134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,8 @@ public void LocatePathOperationContentSchema()`
`107`	`107`	`"#/paths/~1test/get/responses/200/content/application~1json/schema",`
`108`	`108`
`109`	`109`	`});`
	`110`	`+`
	`111`	`+ locator.Keys.ShouldAllBeEquivalentTo(new List<string> { "/test","Get","200", "application/json" });`
`110`	`112`	`}`
`111`	`113`
`112`	`114`	`[Fact]`
`@@ -153,6 +155,8 @@ public void WalkDOMWithCycles()`
`153`	`155`	`internal class LocatorVisitor : OpenApiVisitorBase`
`154`	`156`	`{`
`155`	`157`	`public List<string> Locations = new List<string>();`
	`158`	`+ public List<string> Keys = new List<string>();`
	`159`	`+`
`156`	`160`	`public override void Visit(OpenApiInfo info)`
`157`	`161`	`{`
`158`	`162`	`Locations.Add(this.PathString);`
`@@ -175,6 +179,7 @@ public override void Visit(OpenApiPaths paths)`
`175`	`179`
`176`	`180`	`public override void Visit(OpenApiPathItem pathItem)`
`177`	`181`	`{`
	`182`	`+ Keys.Add(CurrentKeys.Path);`
`178`	`183`	`Locations.Add(this.PathString);`
`179`	`184`	`}`
`180`	`185`
`@@ -185,10 +190,12 @@ public override void Visit(OpenApiResponses responses)`
`185`	`190`
`186`	`191`	`public override void Visit(OpenApiOperation operation)`
`187`	`192`	`{`
	`193`	`+ Keys.Add(CurrentKeys.Operation.ToString());`
`188`	`194`	`Locations.Add(this.PathString);`
`189`	`195`	`}`
`190`	`196`	`public override void Visit(OpenApiResponse response)`
`191`	`197`	`{`
	`198`	`+ Keys.Add(CurrentKeys.Response);`
`192`	`199`	`Locations.Add(this.PathString);`
`193`	`200`	`}`
`194`	`201`
`@@ -199,6 +206,7 @@ public override void Visit(IDictionary<string,OpenApiMediaType> content)`
`199`	`206`
`200`	`207`	`public override void Visit(OpenApiMediaType mediaType)`
`201`	`208`	`{`
	`209`	`+ Keys.Add(CurrentKeys.Content);`
`202`	`210`	`Locations.Add(this.PathString);`
`203`	`211`	`}`
`204`	`212`