Refactoring of OpenApiReferencable units; add parameterised tests replacing multiple existing tests

Author: simon-pearson-lmk

src/Microsoft.OpenApi/Extensions/OpenApiReferencableExtensions.cs

@@ -26,7 +26,7 @@ public static class OpenApiReferencableExtensions
         /// <returns>An IEnumerable of errors.  This function will never return null.</returns>
         public static IOpenApiReferenceable ResolveReference(this IOpenApiReferenceable element, string jsonPointer)
         {
-            if (jsonPointer == string.Empty)
+            if (jsonPointer == "/")
                 return element;
             try
             {
@@ -45,16 +45,14 @@ public static IOpenApiReferenceable ResolveReference(this IOpenApiReferenceable
         private static IOpenApiReferenceable ResolveReferenceOnParameterElement(OpenApiParameter parameterElement, string jsonPointer)
         {
             var jsonPointerTokens = jsonPointer.Split('/');
-            var propertyName = jsonPointerTokens.First();
+            var propertyName = jsonPointerTokens.ElementAtOrDefault(1);
             switch (propertyName)
             {
                 case OpenApiConstants.Schema:
                     return parameterElement.Schema;
                 case OpenApiConstants.Examples:
                     {
-                        var mapKey = jsonPointerTokens.ElementAtOrDefault(1);
-                        if (!(jsonPointerTokens.Length >= 2 && parameterElement.Examples.ContainsKey(mapKey)))
-                            throw new OpenApiException(string.Format(SRResource.InvalidReferenceId, jsonPointer));
+                        var mapKey = jsonPointerTokens.ElementAtOrDefault(2);
                         return parameterElement.Examples[mapKey];
                     }
                 default:

test/Microsoft.OpenApi.Tests/Workspaces/OpenApiReferencableTests.cs

@@ -15,76 +15,62 @@ namespace Microsoft.OpenApi.Tests.Workspaces
 
     public class OpenApiReferencableTests
     {
-        public static IEnumerable<object[]> ReferencableElementResolvesEmptyJsonPointerToItselfTestData =>
-        new List<object[]>
+        private static readonly OpenApiCallback _callbackFragment = new OpenApiCallback();
+        private static readonly OpenApiExample _exampleFragment = new OpenApiExample();
+        private static readonly OpenApiLink _linkFragment = new OpenApiLink();
+        private static readonly OpenApiHeader _headerFragment = new OpenApiHeader();
+        private static readonly OpenApiParameter _parameterFragment = new OpenApiParameter
         {
-            new object[] { new OpenApiCallback() },
-            new object[] { new OpenApiExample() },
-            new object[] { new OpenApiHeader() },
-            new object[] { new OpenApiLink() },
-            new object[] { new OpenApiParameter() },
-            new object[] { new OpenApiRequestBody() },
-            new object[] { new OpenApiResponse() },
-            new object[] { new OpenApiSchema() },
-            new object[] { new OpenApiSecurityScheme() },
-            new object[] { new OpenApiTag() }
-
+            Schema = new OpenApiSchema(),
+            Examples = new Dictionary<string, OpenApiExample>
+            {
+                { "example1", new OpenApiExample() }
+            }
         };
+        private static readonly OpenApiRequestBody _requestBodyFragment = new OpenApiRequestBody();
+        private static readonly OpenApiResponse _responseFragment = new OpenApiResponse();
+        private static readonly OpenApiSchema _schemaFragment = new OpenApiSchema();
+        private static readonly OpenApiSecurityScheme _securitySchemeFragment = new OpenApiSecurityScheme();
+        private static readonly OpenApiTag _tagFragment = new OpenApiTag();
 
-        [Theory]
-        [MemberData(nameof(ReferencableElementResolvesEmptyJsonPointerToItselfTestData))]
-        public void ReferencableElementResolvesEmptyJsonPointerToItself(IOpenApiReferenceable referencableElement)
-        {
-            // Arrange - above
-
-            // Act
-            var resolvedReference = referencableElement.ResolveReference(string.Empty);
-
-            // Assert
-            Assert.Same(referencableElement, resolvedReference);
-        }
-
-        [Fact]
-        public void ParameterElementCanResolveReferenceToSchemaProperty()
+        public static IEnumerable<object[]> ReferencableElementsCanResolveReferencesTestData =>
+        new List<object[]>
         {
-            // Arrange
-            var parameterElement = new OpenApiParameter
-            {
-                Schema = new OpenApiSchema()
-            };
-
-            // Act
-            var resolvedReference = parameterElement.ResolveReference("schema");
-
-            // Assert
-            Assert.Same(parameterElement.Schema, resolvedReference);
-        }
+            new object[] { _callbackFragment, "/", _callbackFragment },
+            new object[] { _exampleFragment, "/", _exampleFragment },
+            new object[] { _linkFragment, "/", _linkFragment },
+            new object[] { _headerFragment, "/", _headerFragment },
+            new object[] { _parameterFragment, "/", _parameterFragment },
+            new object[] { _parameterFragment, "/schema", _parameterFragment.Schema },
+            new object[] { _parameterFragment, "/examples/example1", _parameterFragment.Examples["example1"] },
+            new object[] { _requestBodyFragment, "/", _requestBodyFragment },
+            new object[] { _responseFragment, "/", _responseFragment },
+            new object[] { _schemaFragment, "/", _schemaFragment},
+            new object[] { _securitySchemeFragment, "/", _securitySchemeFragment},
+            new object[] { _tagFragment, "/", _tagFragment},
+        };
 
-        [Fact]
-        public void ParameterElementCanResolveReferenceToExampleTmpDbgImproveMyName()
+        [Theory]
+        [MemberData(nameof(ReferencableElementsCanResolveReferencesTestData))]
+        public void ReferencableElementsCanResolveReferences(
+            IOpenApiReferenceable element,
+            string pointer,
+            IOpenApiElement expectedResolvedElement)
         {
-            // Arrange
-            var parameterElement = new OpenApiParameter
-            {
-                Examples = new Dictionary<string, OpenApiExample>()
-            {
-                { "example1", new OpenApiExample() }
-            },
-            };
-
             // Act
-            var resolvedReference = parameterElement.ResolveReference("examples/example1");
+            var actualResolvedElement = element.ResolveReference(pointer);
 
             // Assert
-            Assert.Same(parameterElement.Examples["example1"], resolvedReference);
+            Assert.Same(expectedResolvedElement, actualResolvedElement);
         }
 
         public static IEnumerable<object[]> ParameterElementShouldThrowOnInvalidReferenceIdTestData =>
         new List<object[]>
         {
-            new object[] { "/" },
+            new object[] { "" },
             new object[] { "a" },
             new object[] { "examples" },
+            new object[] { "examples/" },
             new object[] { "examples/a" },
 
         };
@@ -93,21 +79,12 @@ public void ParameterElementCanResolveReferenceToExampleTmpDbgImproveMyName()
         [MemberData(nameof(ParameterElementShouldThrowOnInvalidReferenceIdTestData))]
         public void ParameterElementShouldThrowOnInvalidReferenceId(string jsonPointer)
         {
-            // Arrange
-            var parameterElement = new OpenApiParameter
-            {
-                Examples = new Dictionary<string, OpenApiExample>()
-            {
-                { "example1", new OpenApiExample() }
-            },
-            };
-
             // Act
-            Action resolveReference = () => parameterElement.ResolveReference(jsonPointer);
+            Action resolveReference = () => _parameterFragment.ResolveReference(jsonPointer);
 
             // Assert
             var exception = Assert.Throws<OpenApiException>(resolveReference);
-            Assert.Equal(String.Format(SRResource.InvalidReferenceId, jsonPointer), exception.Message);
+            Assert.Equal(string.Format(SRResource.InvalidReferenceId, jsonPointer), exception.Message);
         }
     }
 }