Merge branch 'vnext' into mk/add-push-trigger-filter

MaggieKimani1 · web-flow · commit 77bdafec7589 · 2021-11-24T00:01:49.000+03:00
diff --git a/.azure-pipelines/ci-build.yml b/.azure-pipelines/ci-build.yml
@@ -30,7 +30,7 @@ steps:
   inputs:
     testAssemblyVer2: |
      **\*.Tests.dll
-     
+
     vsTestVersion: 16.0
     codeCoverageEnabled: true
 
@@ -94,6 +94,13 @@ steps:
     configuration: Release
     msbuildArguments: '/t:pack /p:PackageOutputPath=$(Build.ArtifactStagingDirectory) /p:IncludeSymbols=true /p:SymbolPackageFormat=snupkg'
 
+- task: MSBuild@1
+  displayName: 'Pack OpenApi Hidi'
+  inputs:
+    solution: src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
+    configuration: Release
+    msbuildArguments: '/t:pack /p:PackageOutputPath=$(Build.ArtifactStagingDirectory) /p:IncludeSymbols=true /p:SymbolPackageFormat=snupkg'
+
 - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
   displayName: 'ESRP CodeSigning Nuget Packages'
   inputs:
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -62,7 +62,7 @@ jobs:
           $projectsArray = @(
             '.\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj',
             '.\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj',
-            '.\src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj'
+            '.\src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj'
           )
           $gitNewVersion = if ("${{ steps.tag_generator.outputs.new_version }}") {"${{ steps.tag_generator.outputs.new_version }}"} else {$null}
           $projectCurrentVersion = ([xml](Get-Content .\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj)).Project.PropertyGroup.Version
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -34,7 +34,7 @@ jobs:
           $projectsArray = @(
             '.\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj',
             '.\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj',
-            '.\src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj'
+            '.\src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj'
           )
 
           $projectsArray | ForEach-Object {
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -10,9 +10,9 @@
             "request": "launch",
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
-            "program": "${workspaceFolder}/src/Microsoft.OpenApi.Tool/bin/Debug/netcoreapp3.1/Microsoft.OpenApi.Tool.dll",
+            "program": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi/bin/Debug/netcoreapp3.1/Microsoft.OpenApi.Hidi.dll",
             "args": [],
-            "cwd": "${workspaceFolder}/src/Microsoft.OpenApi.Tool",
+            "cwd": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
             "console": "internalConsole",
             "stopAtEntry": false
diff --git a/Microsoft.OpenApi.sln b/Microsoft.OpenApi.sln
@@ -26,7 +26,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{6357D7FD-2
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.SmokeTests", "test\Microsoft.OpenApi.SmokeTests\Microsoft.OpenApi.SmokeTests.csproj", "{AD79B61D-88CF-497C-9ED5-41AE3867C5AC}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Tool", "src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj", "{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Hidi", "src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj", "{254841B5-7DAC-4D1D-A9C5-44FE5CE467BE}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
diff --git a/build.cmd b/build.cmd
@@ -1,21 +1,21 @@
 @echo off
-Echo Building Microsoft.OpenApi 
+Echo Building Microsoft.OpenApi
 
-SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj 
+SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj
 dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
 dotnet msbuild %PROJ% /t:build /p:Configuration=Release
 dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 Echo Building Microsoft.OpenApi.Readers
 
-SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj 
+SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj
 dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
 dotnet msbuild %PROJ% /t:build /p:Configuration=Release
 dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
-Echo Building Microsoft.OpenApi.Tool
+Echo Building Microsoft.OpenApi.Hidi
 
-SET PROJ=%~dp0src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj 
+SET PROJ=%~dp0src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj
 dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
 dotnet msbuild %PROJ% /t:build /p:Configuration=Release
 dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
diff --git a/install-tool.ps1 b/install-tool.ps1
@@ -1,7 +1,7 @@
-$latest = Get-ChildItem .\artifacts\ Microsoft.OpenApi.Tool* | select-object -Last 1
+$latest = Get-ChildItem .\artifacts\Microsoft.OpenApi.Hidi* | select-object -Last 1
 $version = $latest.Name.Split(".")[3..5] | join-string -Separator "."
 
-if (Test-Path -Path ./artifacts/openapi-parser.exe) {
-  dotnet tool uninstall --tool-path artifacts Microsoft.OpenApi.Tool
+if (Test-Path -Path ./artifacts/hidi.exe) {
+  dotnet tool uninstall --tool-path artifacts Microsoft.OpenApi.Hidi
 }
-dotnet tool install --tool-path artifacts --add-source .\artifacts\ --version $version Microsoft.OpenApi.Tool
+dotnet tool install --tool-path artifacts --add-source .\artifacts\ --version $version Microsoft.OpenApi.Hidi
diff --git a/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj b/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
@@ -4,9 +4,9 @@
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <PackAsTool>true</PackAsTool>
-    <ToolCommandName>openapi-parser</ToolCommandName>
+    <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>1.3.0-preview</Version>
+    <Version>0.5.0-preview</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
@@ -14,7 +14,7 @@
 using Microsoft.OpenApi.Validations;
 using Microsoft.OpenApi.Writers;
 
-namespace Microsoft.OpenApi.Tool
+namespace Microsoft.OpenApi.Hidi
 {
     static class OpenApiService
     {
@@ -24,6 +24,7 @@ public static void ProcessOpenApiDocument(
             OpenApiSpecVersion version,
             OpenApiFormat format,
             string filterByOperationIds,
+            string filterByTags,
             bool inline,
             bool resolveExternal)
         {
@@ -52,9 +53,19 @@ public static void ProcessOpenApiDocument(
             document = result.OpenApiDocument;
 
             // Check if filter options are provided, then execute
+            if (!string.IsNullOrEmpty(filterByOperationIds) && !string.IsNullOrEmpty(filterByTags))
+            {
+                throw new InvalidOperationException("Cannot filter by operationIds and tags at the same time.");
+            }
+
             if (!string.IsNullOrEmpty(filterByOperationIds))
             {
-                var predicate = OpenApiFilterService.CreatePredicate(filterByOperationIds);
+                var predicate = OpenApiFilterService.CreatePredicate(operationIds: filterByOperationIds);
+                document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
+            }
+            if (!string.IsNullOrEmpty(filterByTags))
+            {
+                var predicate = OpenApiFilterService.CreatePredicate(tags: filterByTags);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
             }
 
diff --git a/src/Microsoft.OpenApi.Hidi/Program.cs b/src/Microsoft.OpenApi.Hidi/Program.cs
@@ -6,7 +6,7 @@
 using System.IO;
 using System.Threading.Tasks;
 
-namespace Microsoft.OpenApi.Tool
+namespace Microsoft.OpenApi.Hidi
 {
     static class Program
     {
@@ -29,9 +29,10 @@ static async Task<int> Main(string[] args)
                 new Option("--format", "File format",typeof(OpenApiFormat) ),
                 new Option("--inline", "Inline $ref instances", typeof(bool) ),
                 new Option("--resolveExternal","Resolve external $refs", typeof(bool)),
-                new Option("--filterByOperationIds", "Filters by OperationId provided", typeof(string))
+                new Option("--filterByOperationIds", "Filters OpenApiDocument by OperationId(s) provided", typeof(string)),
+                new Option("--filterByTags", "Filters OpenApiDocument by Tag(s) provided", typeof(string))
             };
-            transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion, OpenApiFormat, string, bool, bool>(
+            transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion, OpenApiFormat, string, string, bool, bool>(
                 OpenApiService.ProcessOpenApiDocument);
 
             rootCommand.Add(transformCommand);
diff --git a/src/Microsoft.OpenApi.Hidi/StatsVisitor.cs b/src/Microsoft.OpenApi.Hidi/StatsVisitor.cs
@@ -3,13 +3,10 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
 
-namespace Microsoft.OpenApi.Tool
+namespace Microsoft.OpenApi.Hidi
 {
     internal class StatsVisitor : OpenApiVisitorBase
     {
diff --git a/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs b/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text.RegularExpressions;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Services
@@ -17,10 +18,15 @@ public static class OpenApiFilterService
         /// Create predicate function based on passed query parameters
         /// </summary>
         /// <param name="operationIds">Comma delimited list of operationIds or * for all operations.</param>
+        /// <param name="tags">Comma delimited list of tags or a single regex.</param>
         /// <returns>A predicate.</returns>
-        public static Func<OpenApiOperation, bool> CreatePredicate(string operationIds)
+        public static Func<OpenApiOperation, bool> CreatePredicate(string operationIds = null, string tags = null)
         {
             Func<OpenApiOperation, bool> predicate;
+            if (!string.IsNullOrEmpty(operationIds) && !string.IsNullOrEmpty(tags))
+            {
+                throw new InvalidOperationException("Cannot specify both operationIds and tags at the same time.");
+            }
             if (operationIds != null)
             {
                 if (operationIds == "*")
@@ -33,10 +39,23 @@ public static Func<OpenApiOperation, bool> CreatePredicate(string operationIds)
                     predicate = (o) => operationIdsArray.Contains(o.OperationId);
                 }
             }
+            else if (tags != null)
+            {
+                var tagsArray = tags.Split(',');
+                if (tagsArray.Length == 1)
+                {
+                    var regex = new Regex(tagsArray[0]);
 
+                    predicate = (o) => o.Tags.Any(t => regex.IsMatch(t.Name));
+                }
+                else
+                {
+                    predicate = (o) => o.Tags.Any(t => tagsArray.Contains(t.Name));
+                }
+            }
             else
             {
-                throw new InvalidOperationException("OperationId needs to be specified.");
+                throw new InvalidOperationException("Either operationId(s) or tag(s) need to be specified.");
             }
 
             return predicate;
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -957,7 +957,7 @@ namespace Microsoft.OpenApi.Services
     public static class OpenApiFilterService
     {
         public static Microsoft.OpenApi.Models.OpenApiDocument CreateFilteredDocument(Microsoft.OpenApi.Models.OpenApiDocument source, System.Func<Microsoft.OpenApi.Models.OpenApiOperation, bool> predicate) { }
-        public static System.Func<Microsoft.OpenApi.Models.OpenApiOperation, bool> CreatePredicate(string operationIds) { }
+        public static System.Func<Microsoft.OpenApi.Models.OpenApiOperation, bool> CreatePredicate(string operationIds = null, string tags = null) { }
     }
     public class OpenApiReferenceError : Microsoft.OpenApi.Models.OpenApiError
     {
diff --git a/test/Microsoft.OpenApi.Tests/Services/OpenApiFilterServiceTests.cs b/test/Microsoft.OpenApi.Tests/Services/OpenApiFilterServiceTests.cs
@@ -19,27 +19,38 @@ public OpenApiFilterServiceTests()
         }
 
         [Theory]
-        [InlineData("users.user.ListUser")]
-        [InlineData("users.user.GetUser")]
-        [InlineData("administrativeUnits.restore")]
-        [InlineData("graphService.GetGraphService")]
-        public void ReturnFilteredOpenApiDocumentBasedOnOperationIds(string operationId)
+        [InlineData("users.user.ListUser", null, 1)]
+        [InlineData("users.user.GetUser", null, 1)]
+        [InlineData("users.user.ListUser,users.user.GetUser", null, 2)]
+        [InlineData("*", null, 12)]
+        [InlineData("administrativeUnits.restore", null, 1)]
+        [InlineData("graphService.GetGraphService", null, 1)]
+        [InlineData(null, "users.user,applications.application", 3)]
+        [InlineData(null, "^users\\.", 3)]
+        [InlineData(null, "users.user", 2)]
+        [InlineData(null, "applications.application", 1)]
+        [InlineData(null, "reports.Functions", 2)]
+        public void ReturnFilteredOpenApiDocumentBasedOnOperationIdsAndTags(string operationIds, string tags, int expectedPathCount)
         {
             // Act
-            var predicate = OpenApiFilterService.CreatePredicate(operationId);
+            var predicate = OpenApiFilterService.CreatePredicate(operationIds, tags);
             var subsetOpenApiDocument = OpenApiFilterService.CreateFilteredDocument(_openApiDocumentMock, predicate);
 
             // Assert
             Assert.NotNull(subsetOpenApiDocument);
-            Assert.Single(subsetOpenApiDocument.Paths);
+            Assert.NotEmpty(subsetOpenApiDocument.Paths);
+            Assert.Equal(expectedPathCount, subsetOpenApiDocument.Paths.Count);
         }
 
         [Fact]
-        public void ThrowsInvalidOperationExceptionInCreatePredicateWhenInvalidOperationIdIsSpecified()
+        public void ThrowsInvalidOperationExceptionInCreatePredicateWhenInvalidArgumentsArePassed()
         {
             // Act and Assert
-            var message = Assert.Throws<InvalidOperationException>(() =>OpenApiFilterService.CreatePredicate(null)).Message;
-            Assert.Equal("OperationId needs to be specified.", message);
+            var message1 = Assert.Throws<InvalidOperationException>(() => OpenApiFilterService.CreatePredicate(null, null)).Message;
+            Assert.Equal("Either operationId(s) or tag(s) need to be specified.", message1);
+
+            var message2 = Assert.Throws<InvalidOperationException>(() => OpenApiFilterService.CreatePredicate("users.user.ListUser", "users.user")).Message;
+            Assert.Equal("Cannot specify both operationIds and tags at the same time.", message2);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ jobs:`
`62`	`62`	`$projectsArray = @(`
`63`	`63`	`'.\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj',`
`64`	`64`	`'.\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj',`
`65`		`- '.\src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj'`
	`65`	`+ '.\src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj'`
`66`	`66`	`)`
`67`	`67`	`$gitNewVersion = if ("${{ steps.tag_generator.outputs.new_version }}") {"${{ steps.tag_generator.outputs.new_version }}"} else {$null}`
`68`	`68`	`$projectCurrentVersion = ([xml](Get-Content .\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj)).Project.PropertyGroup.Version`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ jobs:`
`34`	`34`	`$projectsArray = @(`
`35`	`35`	`'.\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj',`
`36`	`36`	`'.\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj',`
`37`		`- '.\src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj'`
	`37`	`+ '.\src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj'`
`38`	`38`	`)`
`39`	`39`
`40`	`40`	`$projectsArray \| ForEach-Object {`