Merge Cmd tool updates to master for release

.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:

.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

.github/workflows/codeql-analysis.yml

@@ -33,7 +33,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 {

.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

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

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

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

src/Microsoft.OpenApi.Tool/Microsoft.OpenApi.Tool.csproj → 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>

src/Microsoft.OpenApi.Tool/OpenApiService.cs → src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -1,5 +1,7 @@
-using System;
-using System.Collections.Generic;
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
 using System.IO;
 using System.Linq;
 using System.Net;
@@ -12,7 +14,7 @@
 using Microsoft.OpenApi.Validations;
 using Microsoft.OpenApi.Writers;
 
-namespace Microsoft.OpenApi.Tool
+namespace Microsoft.OpenApi.Hidi
 {
     static class OpenApiService
     {
@@ -21,29 +23,55 @@ public static void ProcessOpenApiDocument(
             FileInfo output,
             OpenApiSpecVersion version,
             OpenApiFormat format,
+            string filterByOperationIds,
+            string filterByTags,
             bool inline,
             bool resolveExternal)
         {
-            if (input == null)
+            if (string.IsNullOrEmpty(input))
             {
-                throw new ArgumentNullException("input");
+                throw new ArgumentNullException(nameof(input));
+            }
+            if(output == null)
+            {
+                throw new ArgumentException(nameof(output));
+            }
+            if (output.Exists)
+            {
+                throw new IOException("The file you're writing to already exists. Please input a new output path.");
             }
 
             var stream = GetStream(input);
-
-            OpenApiDocument document;
-
             var result = new OpenApiStreamReader(new OpenApiReaderSettings
             {
-                ReferenceResolution = resolveExternal == true ? ReferenceResolutionSetting.ResolveAllReferences : ReferenceResolutionSetting.ResolveLocalReferences,
+                ReferenceResolution = resolveExternal ? ReferenceResolutionSetting.ResolveAllReferences : ReferenceResolutionSetting.ResolveLocalReferences,
                 RuleSet = ValidationRuleSet.GetDefaultRuleSet()
             }
             ).ReadAsync(stream).GetAwaiter().GetResult();
 
+            OpenApiDocument document;
             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(operationIds: filterByOperationIds);
+                document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
+            }
+            if (!string.IsNullOrEmpty(filterByTags))
+            {
+                var predicate = OpenApiFilterService.CreatePredicate(tags: filterByTags);
+                document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
+            }
+
             var context = result.OpenApiDiagnostic;
 
-            if (context.Errors.Count != 0)
+            if (context.Errors.Count > 0)
             {
                 var errorReport = new StringBuilder();
 
@@ -52,43 +80,26 @@ public static void ProcessOpenApiDocument(
                     errorReport.AppendLine(error.ToString());
                 }
 
-                throw new ArgumentException(String.Join(Environment.NewLine, context.Errors.Select(e => e.Message).ToArray()));
+                throw new ArgumentException(string.Join(Environment.NewLine, context.Errors.Select(e => e.Message).ToArray()));
             }
 
-            using (var outputStream = output?.Create())
-            {
-                TextWriter textWriter;
+            using var outputStream = output?.Create();
 
-                if (outputStream != null)
-                {
-                    textWriter = new StreamWriter(outputStream);
-                }
-                else
-                {
-                    textWriter = Console.Out;
-                }
+            var textWriter = outputStream != null ? new StreamWriter(outputStream) : Console.Out;
 
-                var settings = new OpenApiWriterSettings()
-                {
-                    ReferenceInline = inline == true ? ReferenceInlineSetting.InlineLocalReferences : ReferenceInlineSetting.DoNotInlineReferences
-                };
-                IOpenApiWriter writer;
-                switch (format)
-                {
-                    case OpenApiFormat.Json:
-                        writer = new OpenApiJsonWriter(textWriter, settings);
-                        break;
-                    case OpenApiFormat.Yaml:
-                        writer = new OpenApiYamlWriter(textWriter, settings);
-                        break;
-                    default:
-                        throw new ArgumentException("Unknown format");
-                }
-
-                document.Serialize(writer, version);
+            var settings = new OpenApiWriterSettings()
+            {
+                ReferenceInline = inline ? ReferenceInlineSetting.InlineLocalReferences : ReferenceInlineSetting.DoNotInlineReferences
+            };
+            IOpenApiWriter writer = format switch
+            {
+                OpenApiFormat.Json => new OpenApiJsonWriter(textWriter, settings),
+                OpenApiFormat.Yaml => new OpenApiYamlWriter(textWriter, settings),
+                _ => throw new ArgumentException("Unknown format"),
+            };
+            document.Serialize(writer, version);
 
-                textWriter.Flush();
-            }
+            textWriter.Flush();
         }
 
         private static Stream GetStream(string input)
@@ -127,7 +138,6 @@ internal static void ValidateOpenApiDocument(string input)
 
             document = new OpenApiStreamReader(new OpenApiReaderSettings
             {
-                //ReferenceResolution = resolveExternal == true ? ReferenceResolutionSetting.ResolveAllReferences : ReferenceResolutionSetting.ResolveLocalReferences,
                 RuleSet = ValidationRuleSet.GetDefaultRuleSet()
             }
             ).Read(stream, out var context);

src/Microsoft.OpenApi.Tool/Program.cs → src/Microsoft.OpenApi.Hidi/Program.cs

@@ -1,34 +1,15 @@
-using System;
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
 using System.CommandLine;
 using System.CommandLine.Invocation;
 using System.IO;
 using System.Threading.Tasks;
-using Microsoft.OpenApi;
 
-namespace Microsoft.OpenApi.Tool
+namespace Microsoft.OpenApi.Hidi
 {
-    class Program
+    static class Program
     {
-        static async Task<int> OldMain(string[] args)
-        {
-
-            var command = new RootCommand
-            {
-               new Option("--input", "Input OpenAPI description file path or URL", typeof(string) ),
-                new Option("--output","Output OpenAPI description file", typeof(FileInfo), arity: ArgumentArity.ZeroOrOne),
-                new Option("--version", "OpenAPI specification version", typeof(OpenApiSpecVersion)),
-                new Option("--format", "File format",typeof(OpenApiFormat) ),
-                new Option("--inline", "Inline $ref instances", typeof(bool) ),
-                new Option("--resolveExternal","Resolve external $refs", typeof(bool)) 
-            };
-
-            command.Handler = CommandHandler.Create<string,FileInfo,OpenApiSpecVersion,OpenApiFormat,bool, bool>(
-                OpenApiService.ProcessOpenApiDocument);
-
-            // Parse the incoming args and invoke the handler
-            return await command.InvokeAsync(args);
-        }
-
         static async Task<int> Main(string[] args)
         {
             var rootCommand = new RootCommand() {
@@ -47,9 +28,11 @@ static async Task<int> Main(string[] args)
                 new Option("--version", "OpenAPI specification version", typeof(OpenApiSpecVersion)),
                 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("--resolveExternal","Resolve external $refs", typeof(bool)),
+                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, bool, bool>(
+            transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion, OpenApiFormat, string, string, bool, bool>(
                 OpenApiService.ProcessOpenApiDocument);
 
             rootCommand.Add(transformCommand);

src/Microsoft.OpenApi.Tool/StatsVisitor.cs → 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
     {

src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT license. 
+// Licensed under the MIT license.
 
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
@@ -61,11 +61,17 @@ public class OpenApiReaderSettings
         public Uri BaseUrl { get; set; }
 
         /// <summary>
-        /// Function used to provide an alternative loader for accessing external references.  
+        /// Function used to provide an alternative loader for accessing external references.
         /// </summary>
         /// <remarks>
         /// Default loader will attempt to dereference http(s) urls and file urls.
         /// </remarks>
         public IStreamLoader CustomExternalLoader { get; set; }
+
+        /// <summary>
+        /// Whether to leave the <see cref="Stream"/> object open after reading
+        /// from an <see cref="OpenApiStreamReader"/> object.
+        /// </summary>
+        public bool LeaveStreamOpen { get; set; }
     }
 }

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT license. 
+// Licensed under the MIT license.
 
 using System.IO;
 using System.Threading.Tasks;
@@ -29,14 +29,18 @@ public OpenApiStreamReader(OpenApiReaderSettings settings = null)
         /// Reads the stream input and parses it into an Open API document.
         /// </summary>
         /// <param name="input">Stream containing OpenAPI description to parse.</param>
-        /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
-        /// <returns>Instance of newly created OpenApiDocument</returns>
+        /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing.</param>
+        /// <returns>Instance of newly created OpenApiDocument.</returns>
         public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
         {
-            using (var reader = new StreamReader(input))
+            var reader = new StreamReader(input);
+            var result = new OpenApiTextReaderReader(_settings).Read(reader, out diagnostic);
+            if (!_settings.LeaveStreamOpen)
             {
-                return new OpenApiTextReaderReader(_settings).Read(reader, out diagnostic);
+                reader.Dispose();
             }
+
+            return result;
         }
 
         /// <summary>
@@ -50,8 +54,8 @@ public async Task<ReadResult> ReadAsync(Stream input)
             if (input is MemoryStream)
             {
                 bufferedStream = (MemoryStream)input;
-            } 
-            else 
+            }
+            else
             {
                 // Buffer stream so that OpenApiTextReaderReader can process it synchronously
                 // YamlDocument doesn't support async reading.