Skip to content

Parse Nested postman collections #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
darrelmiller merged 11 commits into from
Mar 27, 2022
Merged

Parse Nested postman collections #794

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
194576e
Fix exception thrown when OpenSpecVersion is null
MaggieKimani1 Mar 10, 2022
af25fe4
Add recursive solution for nested collection item object
MaggieKimani1 Mar 10, 2022
bc87d1e
Code refactoring
MaggieKimani1 Mar 10, 2022
c666c4a
Add nested sample collection file and copy it to output directory
MaggieKimani1 Mar 10, 2022
2a8996d
Add unit test
MaggieKimani1 Mar 10, 2022
3350d86
Rename method
MaggieKimani1 Mar 14, 2022
3445c1d
Log warning to console if url in collection isn't in the input OpenAp…
MaggieKimani1 Mar 15, 2022
904cd8d
Fixed merge conflicts with vnext
darrelmiller Mar 27, 2022
caa87da
Fixed reporting collections with urls not in OpenAPI
darrelmiller Mar 27, 2022
014cb70
Merge remote-tracking branch 'origin/vnext' into enhancement/nested-p…
darrelmiller Mar 27, 2022
53c56f7
Removed openapi file that snook in.
darrelmiller Mar 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Log warning to console if url in collection isn't in the input OpenAp… 
…i doc and continue processing the rest of the urls and add unit test
  • Loading branch information
@MaggieKimani1
MaggieKimani1 committed Mar 15, 2022
commit 3445c1d3199ebd8dc598d8d08a05f27904b4faca
1 change: 1 addition & 0 deletions src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public static class OpenApiFilterService
var openApiOperations = GetOpenApiOperations(rootNode, url, apiVersion);
if (openApiOperations == null)
{
Console.WriteLine($"The url {url} could not be found in the OpenApi description");
continue;
}

Expand Down
3 changes: 3 additions & 0 deletions test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@
<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>
Expand Down
22 changes: 22 additions & 0 deletions test/Microsoft.OpenApi.Tests/Services/OpenApiFilterServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,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()
{
Expand Down
145 changes: 145 additions & 0 deletions test/Microsoft.OpenApi.Tests/UtilityFiles/postmanCollection_ver4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
{
"info": {
"_postman_id": "43402ca3-f018-7c9b-2315-f176d9b171a3",
"name": "Graph-Collection",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "users-GET",
"request": {
"method": "GET",
"url": {
"raw": "https://graph.microsoft.com/v1.0/users",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"users"
]
}
}
},
{
"name": "users-POST",
"request": {
"method": "POST",
"url": {
"raw": "https://graph.microsoft.com/v1.0/users",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"users"
]
}
}
},
{
"name": "/appCatalogs",
"request": {
"method": "GET",
"url": {
"raw": "https://graph.microsoft.com/v1.0/appCatalogs",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"appCatalogs"
]
}
}
},
{
"name": "/agreementAcceptances",
"request": {
"method": "GET",
"url": {
"raw": "https://graph.microsoft.com/v1.0/agreementAcceptances",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"agreementAcceptances"
]
}
}
},
{
"name": "{user-id}-GET",
"request": {
"method": "GET",
"url": {
"raw": "https://graph.microsoft.com/v1.0/users/{user-id}",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"users",
"{user-id}"
]
}
}
},
{
"name": "{user-id}-PATCH",
"request": {
"method": "PATCH",
"url": {
"raw": "https://graph.microsoft.com/v1.0/users/{user-id}",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"users",
"{user-id}"
]
}
}
},
{
"name": "{user-id}-DELETE",
"request": {
"method": "DELETE",
"url": {
"raw": "https://graph.microsoft.com/v1.0/users/{user-id}",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"v1.0",
"users",
"{user-id}"
]
}
}
}
]
}