Merge branch 'vnext' into is/resolve-conflicts

microsoft · Sep 30, 2024 · 310b999 · 310b999
2 parents ef58bf6 + e035981
commit 310b999
Show file tree

Hide file tree

Showing 10 changed files with 124 additions and 15 deletions.
diff --git a/.config/1espt/PipelineAutobaseliningConfig.yml b/.config/1espt/PipelineAutobaseliningConfig.yml
@@ -0,0 +1,15 @@
+## DO NOT MODIFY THIS FILE MANUALLY. This is part of auto-baselining from 1ES Pipeline Templates. Go to [https://aka.ms/1espt-autobaselining] for more details.
+
+pipelines:
+  107:
+    usedNonDefaultBranch: true
+    retail:
+      source:
+        credscan:
+          lastModifiedDate: 2024-09-13
+        eslint:
+          lastModifiedDate: 2024-09-13
+        psscriptanalyzer:
+          lastModifiedDate: 2024-09-13
+        armory:
+          lastModifiedDate: 2024-09-13
diff --git a/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj b/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
@@ -9,7 +9,7 @@
     <Nullable>enable</Nullable>
     <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>1.4.9</Version>
+    <Version>1.4.10</Version>
     <Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
     <SignAssembly>true</SignAssembly>
     <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -3,7 +3,7 @@
         <TargetFramework>netstandard2.0</TargetFramework>
         <LangVersion>Latest</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>1.6.21</Version>
+        <Version>1.6.22</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <SignAssembly>true</SignAssembly>
         <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

diff --git a/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs b/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
@@ -112,7 +112,10 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun
                     {
                         foreach (var parameter in result.Parameters)
                         {
-                            pathItem.Parameters.Add(parameter);
+                            if (!pathItem.Parameters.Contains(parameter))
+                            {
+                                pathItem.Parameters.Add(parameter);
+                            }                          
                         }
                     }
                 }

diff --git a/src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs b/src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
@@ -150,6 +150,13 @@ public OpenApiUrlTreeNode Attach(string path,
             }
 
             var segments = path.Split('/');
+            if (path.EndsWith("/", StringComparison.OrdinalIgnoreCase))
+            {
+                // Remove the last element, which is empty, and append the trailing slash to the new last element
+                // This is to support URLs with trailing slashes
+                Array.Resize(ref segments, segments.Length - 1);
+                segments[segments.Length - 1] += @"\";
+            }
 
             return Attach(segments: segments,
                           pathItem: pathItem,

diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj b/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj
@@ -12,10 +12,10 @@
 
   <ItemGroup>
     <PackageReference Include="coverlet.msbuild" Version="6.0.2" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
-    <PackageReference Include="Moq" Version="4.20.71" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="Moq" Version="4.20.72" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-    <PackageReference Include="xunit" Version="2.9.0" />
+    <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="all" />
     <PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
   </ItemGroup>

diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using Microsoft.Extensions.Logging;
@@ -105,6 +105,57 @@ public void TestPredicateFiltersUsingRelativeRequestUrls()
             Assert.False(predicate("/foo", OperationType.Patch, null));
         }
 
+        [Fact]
+        public void CreateFilteredDocumentUsingPredicateFromRequestUrl()
+        {
+            // Arrange
+            var openApiDocument = new OpenApiDocument
+            {
+                Info = new() { Title = "Test", Version = "1.0" },
+                Servers = new List<OpenApiServer> { new() { Url = "https://localhost/" } },
+                Paths = new()
+                {
+                    ["/test/{id}"] = new()
+                    {
+                        Operations = new Dictionary<OperationType, OpenApiOperation>
+                        {
+                            { OperationType.Get, new() },
+                            { OperationType.Patch, new() }
+                        },
+                        Parameters = new List<OpenApiParameter>
+                        {
+                            new()
+                            {
+                                Name = "id",
+                                In = ParameterLocation.Path,
+                                Required = true,
+                                Schema = new()
+                                {
+                                    Type = "string"
+                                }
+                            }
+                        }
+                    }
+
+
+                }
+            };
+
+            var requestUrls = new Dictionary<string, List<string>>
+            {
+                    {"/test/{id}", new List<string> {"GET","PATCH"}}
+            };
+
+            // Act
+            var predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source: openApiDocument);
+            var subsetDoc = OpenApiFilterService.CreateFilteredDocument(openApiDocument, predicate);
+
+            // Assert that there's only 1 parameter in the subset document
+            Assert.NotNull(subsetDoc);
+            Assert.NotEmpty(subsetDoc.Paths);
+            Assert.Single(subsetDoc.Paths.First().Value.Parameters);
+        }
+
         [Fact]
         public void ShouldParseNestedPostmanCollection()
         {

diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -17,11 +17,11 @@
     <ItemGroup>
         <PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
         <PackageReference Include="coverlet.msbuild" Version="6.0.2" PrivateAssets="all" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
-        <PackageReference Include="FluentAssertions" Version="6.12.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+        <PackageReference Include="FluentAssertions" Version="6.12.1" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
         <PackageReference Include="SharpYaml" Version="2.1.1" />
-        <PackageReference Include="xunit" Version="2.9.0" />
+        <PackageReference Include="xunit" Version="2.9.2" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="all" />
         <!--STJ required until Microsoft.Extensions.Logging.Console and Microsoft.Extensions.Configuration.Json update their dependencies -->
         <PackageReference Include="System.Text.Json" Version="8.0.4" />

diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -10,13 +10,13 @@
   <ItemGroup>
     <PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
     <PackageReference Include="coverlet.msbuild" Version="6.0.2" PrivateAssets="all" />
-    <PackageReference Include="FluentAssertions" Version="6.12.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
-    <PackageReference Include="Moq" Version="4.20.71" />
+    <PackageReference Include="FluentAssertions" Version="6.12.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="Moq" Version="4.20.72" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="SharpYaml" Version="2.1.1" />
-    <PackageReference Include="Verify.Xunit" Version="26.3.1" />
-    <PackageReference Include="xunit" Version="2.9.0" />
+    <PackageReference Include="Verify.Xunit" Version="26.6.0" />
+    <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageReference Include="PublicApiGenerator" Version="11.1.0" />

diff --git a/test/Microsoft.OpenApi.Tests/Services/OpenApiUrlTreeNodeTests.cs b/test/Microsoft.OpenApi.Tests/Services/OpenApiUrlTreeNodeTests.cs
@@ -466,5 +466,38 @@ public async Task VerifyDiagramFromSampleOpenAPIAsync()
 
             await Verifier.Verify(diagram);
         }
+
+        public static TheoryData<string, string[], string, string> SupportsTrailingSlashesInPathData => new TheoryData<string, string[], string, string>
+        {
+            // Path, children up to second to leaf, last expected leaf node name, expected leaf node path
+            { "/cars/{car-id}/build/", ["cars", "{car-id}"], @"build\", @"\cars\{car-id}\build\" },
+            { "/cars/", [], @"cars\", @"\cars\" },
+        };
+
+        [Theory]
+        [MemberData(nameof(SupportsTrailingSlashesInPathData))]
+        public void SupportsTrailingSlashesInPath(string path, string[] childrenBeforeLastNode, string expectedLeafNodeName, string expectedLeafNodePath)
+        {
+            var openApiDocument = new OpenApiDocument
+            {
+                Paths = new()
+                {
+                    [path] = new()
+                }
+            };
+
+            var label = "trailing-slash";
+            var rootNode = OpenApiUrlTreeNode.Create(openApiDocument, label);
+
+            var secondToLeafNode = rootNode;
+            foreach (var childName in childrenBeforeLastNode)
+            {
+                secondToLeafNode = secondToLeafNode.Children[childName];
+            }
+
+            Assert.True(secondToLeafNode.Children.TryGetValue(expectedLeafNodeName, out var leafNode));
+            Assert.Equal(expectedLeafNodePath, leafNode.Path);
+            Assert.Empty(leafNode.Children);
+        }
     }
 }