Add location context to all messages

Author: darrelmiller

src/Microsoft.OpenApi.Readers/Exceptions/OpenApiReaderException.cs

@@ -24,6 +24,15 @@ public OpenApiReaderException() { }
         /// <param name="message">Plain text error message for this exception.</param>
         public OpenApiReaderException(string message) : base(message) { }
 
+        /// <summary>
+        /// Initializes the <see cref="OpenApiReaderException"/> class with a custom message.
+        /// </summary>
+        /// <param name="message">Plain text error message for this exception.</param>
+        /// <param name="context">Context of current parsing process.</param>
+        public OpenApiReaderException(string message, ParsingContext context) : base(message) {
+            Pointer = context.GetLocation();
+        }
+
         /// <summary>
         /// Initializes the <see cref="OpenApiReaderException"/> class with a message and line, column location of error.
         /// </summary>

src/Microsoft.OpenApi.Readers/ParseNodes/ParseNode.cs

@@ -26,7 +26,7 @@ public MapNode CheckMapNode(string nodeName)
         {
             if (!(this is MapNode mapNode))
             {
-                throw new OpenApiReaderException($"{nodeName} must be a map/object");
+                throw new OpenApiReaderException($"{nodeName} must be a map/object", Context);
             }
 
             return mapNode;
@@ -50,51 +50,50 @@ public static ParseNode Create(ParsingContext context, YamlNode node)
 
         public virtual List<T> CreateList<T>(Func<MapNode, T> map)
         {
-            throw new OpenApiReaderException("Cannot create list from this type of node.");
+            throw new OpenApiReaderException("Cannot create list from this type of node.", Context);
         }
 
         public virtual Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)
         {
-            throw new OpenApiReaderException("Cannot create map from this type of node.");
+            throw new OpenApiReaderException("Cannot create map from this type of node.", Context);
         }
 
         public virtual Dictionary<string, T> CreateMapWithReference<T>(
             ReferenceType referenceType,
             Func<MapNode, T> map)
             where T : class, IOpenApiReferenceable
         {
-            throw new OpenApiReaderException("Cannot create map from this reference.");
+            throw new OpenApiReaderException("Cannot create map from this reference.", Context);
         }
 
         public virtual List<T> CreateSimpleList<T>(Func<ValueNode, T> map)
         {
-            throw new OpenApiReaderException("Cannot create simple list from this type of node.");
+            throw new OpenApiReaderException("Cannot create simple list from this type of node.", Context);
         }
 
         public virtual Dictionary<string, T> CreateSimpleMap<T>(Func<ValueNode, T> map)
         {
-            throw new OpenApiReaderException("Cannot create simple map from this type of node.");
+            throw new OpenApiReaderException("Cannot create simple map from this type of node.", Context);
         }
 
         public virtual IOpenApiAny CreateAny()
         {
-            throw new OpenApiReaderException("Cannot create an Any object this type of node.");
+            throw new OpenApiReaderException("Cannot create an Any object this type of node.", Context);
         }
 
         public virtual string GetRaw()
         {
-            throw new OpenApiReaderException("Cannot get raw value from this type of node.");
+            throw new OpenApiReaderException("Cannot get raw value from this type of node.", Context);
         }
 
         public virtual string GetScalarValue()
         {
-            throw new OpenApiReaderException("Cannot create a scalar value from this type of node.");
+            throw new OpenApiReaderException("Cannot create a scalar value from this type of node.", Context);
         }
 
         public virtual List<IOpenApiAny> CreateListOfAny()
         {
-            throw new OpenApiReaderException("Cannot create a list from this type of node.");
+            throw new OpenApiReaderException("Cannot create a list from this type of node.", Context);
         }
-
     }
 }

src/Microsoft.OpenApi.Readers/ParsingContext.cs

@@ -141,7 +141,7 @@ public void EndObject()
         /// </summary>
         public string GetLocation()
         {
-            return "#/" + string.Join("/", _currentLocation.Reverse().ToArray());
+            return "#/" + string.Join("/", _currentLocation.Reverse().Select(s=> s.Replace("~","~0").Replace("/","~1")).ToArray());
         }
 
         /// <summary>

test/Microsoft.OpenApi.Readers.Tests/ParseNodeTests.cs

@@ -31,5 +31,34 @@ public void BrokenSimpleList()
                 })
             });
         }
+
+        [Fact]
+        public void BadSchema()
+        {
+            var input = @"openapi: 3.0.0
+info:
+  title: foo
+  version: bar
+paths:
+  '/foo':
+    get:
+      responses:
+        200: 
+          description: ok
+          content:
+            application/json:  
+              schema: asdasd
+";
+
+            var reader = new OpenApiStringReader();
+            reader.Read(input, out var diagnostic);
+
+            diagnostic.Errors.Should().BeEquivalentTo(new List<OpenApiError>() {
+                new OpenApiError(new OpenApiReaderException("Expected a value.") {
+                    Pointer = "#/~1foo/get/responses/200/content/application~1json/schema"
+                })
+            });
+        }
     }
 }
+