Merge pull request #794 from microsoft/enhancement/nested-postman-collection

Parse Nested postman collections

Author: darrelmiller

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -397,24 +397,47 @@ public static Dictionary<string, List<string>> ParseJsonCollectionFile(Stream st
             logger.LogTrace("Parsing the json collection file into a JsonDocument");
             using var document = JsonDocument.Parse(stream);
             var root = document.RootElement;
-            var itemElement = root.GetProperty("item");
-            foreach (var requestObject in itemElement.EnumerateArray().Select(item => item.GetProperty("request")))
-            {
-                // Fetch list of methods and urls from collection, store them in a dictionary
-                var path = requestObject.GetProperty("url").GetProperty("raw").ToString();
-                var method = requestObject.GetProperty("method").ToString();
 
-                if (!requestUrls.ContainsKey(path))
+            requestUrls = EnumerateJsonDocument(root, requestUrls);
+            logger.LogTrace("Finished fetching the list of paths and Http methods defined in the Postman collection.");
+
+            return requestUrls;
+        }
+
+        private static Dictionary<string, List<string>> EnumerateJsonDocument(JsonElement itemElement, Dictionary<string, List<string>> paths)
+        {
+            var itemsArray = itemElement.GetProperty("item");
+             
+            foreach (var item in itemsArray.EnumerateArray())
+            {
+                if(item.ValueKind == JsonValueKind.Object)
                 {
-                    requestUrls.Add(path, new List<string> { method });
+                   if(item.TryGetProperty("request", out var request))
+                   {
+                        // Fetch list of methods and urls from collection, store them in a dictionary
+                        var path = request.GetProperty("url").GetProperty("raw").ToString();
+                        var method = request.GetProperty("method").ToString();
+                        if (!paths.ContainsKey(path))
+                        {
+                            paths.Add(path, new List<string> { method });
+                        }
+                        else
+                        {
+                            paths[path].Add(method);
+                        }
+                   }
+                   else
+                   {
+                        EnumerateJsonDocument(item, paths);
+                   }
                 }
                 else
                 {
-                    requestUrls[path].Add(method);
+                    EnumerateJsonDocument(item, paths);
                 }
             }
-            logger.LogTrace("Finished fetching the list of paths and Http methods defined in the Postman collection.");
-            return requestUrls;
+
+            return paths;
         }
 
         /// <summary>

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs

@@ -73,23 +73,24 @@ public static class OpenApiFilterService
                     var rootNode = CreateOpenApiUrlTreeNode(sources);
 
                     // Iterate through urls dictionary and fetch operations for each url
-                    foreach (var path in requestUrls)
+                    foreach (var url in requestUrls)
                     {
                         var serverList = source.Servers;
-                        var url = FormatUrlString(path.Key, serverList);
+                        var path = ExtractPath(url.Key, serverList);
 
-                        var openApiOperations = GetOpenApiOperations(rootNode, url, apiVersion);
+                        var openApiOperations = GetOpenApiOperations(rootNode, path, apiVersion);
                         if (openApiOperations == null)
                         {
+                            Console.WriteLine($"The url {url.Key} could not be found in the OpenApi description");
                             continue;
                         }
 
                         // Add the available ops if they are in the postman collection. See path.Value
                         foreach (var ops in openApiOperations)
                         {
-                            if (path.Value.Contains(ops.Key.ToString().ToUpper()))
+                            if (url.Value.Contains(ops.Key.ToString().ToUpper()))
                             {
-                                operationTypes.Add(ops.Key + url);
+                                operationTypes.Add(ops.Key + path);
                             }
                         }
                     }
@@ -322,7 +323,7 @@ private static bool AddReferences(OpenApiComponents newComponents, OpenApiCompon
             return moreStuff;
         }
 
-        private static string FormatUrlString(string url, IList<OpenApiServer> serverList)
+        private static string ExtractPath(string url, IList<OpenApiServer> serverList)
         {
             var queryPath = string.Empty;
             foreach (var server in serverList)
@@ -333,8 +334,8 @@ private static string FormatUrlString(string url, IList<OpenApiServer> serverLis
                     continue;
                 }
 
-                var querySegments = url.Split(new[]{ serverUrl }, StringSplitOptions.None);
-                queryPath = querySegments[1];
+                var urlComponents = url.Split(new[]{ serverUrl }, StringSplitOptions.None);
+                queryPath = urlComponents[1];
             }
 
             return queryPath;

test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj

@@ -44,6 +44,12 @@
     <None Update="UtilityFiles\postmanCollection_ver2.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="UtilityFiles\postmanCollection_ver3.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="UtilityFiles\postmanCollection_ver4.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="UtilityFiles\Todo.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

test/Microsoft.OpenApi.Tests/Services/OpenApiFilterServiceTests.cs

@@ -69,6 +69,23 @@ public void ReturnFilteredOpenApiDocumentBasedOnPostmanCollection()
             Assert.Equal(3, subsetOpenApiDocument.Paths.Count);
         }
 
+        [Fact]
+        public void ShouldParseNestedPostmanCollection()
+        {
+            // Arrange
+            var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\postmanCollection_ver3.json");
+            var fileInput = new FileInfo(filePath);
+            var stream = fileInput.OpenRead();
+
+            // Act
+            var requestUrls = OpenApiService.ParseJsonCollectionFile(stream, _logger);
+            var pathCount = requestUrls.Count;
+
+            // Assert
+            Assert.NotNull(requestUrls);
+            Assert.Equal(30, pathCount);
+        }
+
         [Fact]
         public void ThrowsExceptionWhenUrlsInCollectionAreMissingFromSourceDocument()
         {
@@ -86,6 +103,28 @@ public void ThrowsExceptionWhenUrlsInCollectionAreMissingFromSourceDocument()
             Assert.Equal("The urls in the Postman collection supplied could not be found.", message);
         }
 
+        [Fact]
+        public void ContinueProcessingWhenUrlsInCollectionAreMissingFromSourceDocument()
+        {
+            // Arrange
+            var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\postmanCollection_ver4.json");
+            var fileInput = new FileInfo(filePath);
+            var stream = fileInput.OpenRead();
+
+            // Act
+            var requestUrls = OpenApiService.ParseJsonCollectionFile(stream, _logger);
+            var pathCount = requestUrls.Count;
+            var predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source: _openApiDocumentMock);
+            var subsetOpenApiDocument = OpenApiFilterService.CreateFilteredDocument(_openApiDocumentMock, predicate);
+            var subsetPathCount = subsetOpenApiDocument.Paths.Count;
+
+            // Assert
+            Assert.NotNull(subsetOpenApiDocument);
+            Assert.NotEmpty(subsetOpenApiDocument.Paths);
+            Assert.Equal(2, subsetPathCount);
+            Assert.NotEqual(pathCount, subsetPathCount);
+        }
+
         [Fact]
         public void ThrowsInvalidOperationExceptionInCreatePredicateWhenInvalidArgumentsArePassed()
         {