Merge branch 'vnext' into mk/enhancement-create-hash-code

Author: MaggieKimani1

.azure-pipelines/ci-build.yml

@@ -266,7 +266,6 @@ stages:
                 echo "$artifactName"
                 echo "$artifactVersion"
               displayName: 'Fetch Artifact Name'
-
             - task: NuGetCommand@2
               displayName: 'NuGet push'
               inputs:
@@ -276,6 +275,7 @@ stages:
                 publishFeedCredentials: 'OpenAPI Nuget Connection'
             - task: GitHubRelease@1
               displayName: 'GitHub release (edit)'
+              condition: succeededOrFailed()
               inputs:
                 gitHubConnection: 'Github-MaggieKimani1'
                 action: edit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the current behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots/Code Snippets**
+If applicable, add screenshots of the stack trace or a code snippet to help explain your problem.
+If applicable, add a link to your project
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/docker.yml

@@ -30,13 +30,13 @@ jobs:
         id: getversion
       - name: Push to GitHub Packages - Nightly
         if: ${{ github.ref == 'refs/heads/vnext' }}
-        uses: docker/[email protected].0
+        uses: docker/[email protected].1
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly
       - name: Push to GitHub Packages - Release
         if: ${{ github.ref == 'refs/heads/master' }}
-        uses: docker/[email protected].0
+        uses: docker/[email protected].1
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.getversion.outputs.version }}

Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj

@@ -9,7 +9,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0-preview-20220612-01" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0" />
     <PackageReference Include="Moq" Version="4.18.2" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">

README.md

@@ -21,8 +21,8 @@ Project Objectives
 
 # Installation
 
-- Install core Nuget package `Microsoft.OpenApi`
-- Install readers Nuget package `Microsoft.OpenApi.Readers`
+- Install core Nuget package [**Microsoft.OpenApi**](https://www.nuget.org/packages/Microsoft.OpenApi)
+- Install readers Nuget package [**Microsoft.OpenApi.Readers**](https://www.nuget.org/packages/Microsoft.OpenApi.Readers)
 
 # Processors
 The OpenAPI.NET project holds the base object model for representing OpenAPI documents as .NET objects. Some developers have found the need to write processors that convert other data formats into this OpenAPI.NET object model. We'd like to curate that list of processors in this section of the readme. 

src/Microsoft.OpenApi.Hidi/Handlers/TransformCommandHandler.cs

@@ -0,0 +1,73 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.CommandLine;
+using System.CommandLine.Invocation;
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.OpenApi.Hidi.Handlers
+{
+    internal class TransformCommandHandler : ICommandHandler
+    {
+        public Option<string> DescriptionOption { get; set; }
+        public Option<string> CsdlOption { get; set; }
+        public Option<string> CsdlFilterOption { get; set; }
+        public Option<FileInfo> OutputOption { get; set; }
+        public Option<bool> CleanOutputOption { get; set; }
+        public Option<string?> VersionOption { get; set; }
+        public Option<OpenApiFormat?> FormatOption { get; set; }
+        public Option<bool> TerseOutputOption { get; set; }
+        public Option<LogLevel> LogLevelOption { get; set; }
+        public Option<string> FilterByOperationIdsOption { get; set; }
+        public Option<string> FilterByTagsOption { get; set; }
+        public Option<string> FilterByCollectionOption { get; set; }
+        public Option<bool> InlineLocalOption { get; set; }
+        public Option<bool> InlineExternalOption { get; set; }
+
+        public int Invoke(InvocationContext context)
+        {
+            return InvokeAsync(context).GetAwaiter().GetResult();
+        }
+        public async Task<int> InvokeAsync(InvocationContext context)
+        {
+            string openapi = context.ParseResult.GetValueForOption(DescriptionOption);
+            string csdlFilter = context.ParseResult.GetValueForOption(CsdlFilterOption);
+            string csdl = context.ParseResult.GetValueForOption(CsdlOption);
+            FileInfo output = context.ParseResult.GetValueForOption(OutputOption);
+            bool cleanOutput = context.ParseResult.GetValueForOption(CleanOutputOption);
+            string? version = context.ParseResult.GetValueForOption(VersionOption);
+            OpenApiFormat? format = context.ParseResult.GetValueForOption(FormatOption);
+            bool terseOutput = context.ParseResult.GetValueForOption(TerseOutputOption);
+            LogLevel logLevel = context.ParseResult.GetValueForOption(LogLevelOption);
+            bool inlineLocal = context.ParseResult.GetValueForOption(InlineLocalOption);
+            bool inlineExternal = context.ParseResult.GetValueForOption(InlineExternalOption);
+            string filterbyoperationids = context.ParseResult.GetValueForOption(FilterByOperationIdsOption);
+            string filterbytags = context.ParseResult.GetValueForOption(FilterByTagsOption);
+            string filterbycollection = context.ParseResult.GetValueForOption(FilterByCollectionOption);
+            CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
+
+            using var loggerFactory = Logger.ConfigureLogger(logLevel);
+            var logger = loggerFactory.CreateLogger<OpenApiService>();
+            try
+            {
+                await OpenApiService.TransformOpenApiDocument(openapi, csdl, csdlFilter, output, cleanOutput, version, format, terseOutput, logLevel, inlineLocal, inlineExternal, filterbyoperationids, filterbytags, filterbycollection, cancellationToken);
+
+                return 0;
+            }
+            catch (Exception ex)
+            {
+#if DEBUG
+                logger.LogCritical(ex, ex.Message);
+                throw; // so debug tools go straight to the source of the exception when attached
+#else
+                logger.LogCritical( ex.Message);
+                return 1;
+#endif
+            }
+        }
+    }
+}

src/Microsoft.OpenApi.Hidi/Handlers/ValidateCommandHandler.cs

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.CommandLine;
+using System.CommandLine.Invocation;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.OpenApi.Hidi.Handlers
+{
+    internal class ValidateCommandHandler : ICommandHandler
+    {
+        public Option<string> DescriptionOption { get; set; }
+        public Option<LogLevel> LogLevelOption { get; set; }
+
+        public int Invoke(InvocationContext context)
+        {
+            return InvokeAsync(context).GetAwaiter().GetResult();
+        }
+        public async Task<int> InvokeAsync(InvocationContext context)
+        {
+            string openapi = context.ParseResult.GetValueForOption(DescriptionOption);
+            LogLevel logLevel = context.ParseResult.GetValueForOption(LogLevelOption);
+            CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
+
+
+            using var loggerFactory = Logger.ConfigureLogger(logLevel);
+            var logger = loggerFactory.CreateLogger<OpenApiService>();
+            try
+            {
+                await OpenApiService.ValidateOpenApiDocument(openapi, logLevel, cancellationToken);
+                return 0;
+            }
+            catch (Exception ex)
+            {
+#if DEBUG
+                logger.LogCritical(ex, ex.Message);
+                throw; // so debug tools go straight to the source of the exception when attached
+#else
+                logger.LogCritical( ex.Message);
+                return 1;
+#endif
+            }
+        }
+    }
+}

src/Microsoft.OpenApi.Hidi/Logger.cs

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.OpenApi.Hidi
+{
+    public class Logger
+    {
+        public static ILoggerFactory ConfigureLogger(LogLevel logLevel)
+        {
+            // Configure logger options
+#if DEBUG
+            logLevel = logLevel > LogLevel.Debug ? LogLevel.Debug : logLevel;
+#endif
+
+            return LoggerFactory.Create((builder) =>
+            {
+                builder
+                    .AddSimpleConsole(c =>
+                    {
+                        c.IncludeScopes = true;
+                    })
+#if DEBUG   
+                    .AddDebug()
+#endif
+                    .SetMinimumLevel(logLevel);
+            });
+        }
+    }
+}

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

@@ -41,8 +41,8 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="6.0.0" />
-    <PackageReference Include="System.CommandLine" Version="2.0.0-beta3.22114.1" />
-    <PackageReference Include="Microsoft.OData.Edm" Version="7.12.1" />
+    <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
+    <PackageReference Include="Microsoft.OData.Edm" Version="7.12.2" />
     <PackageReference Include="Microsoft.OpenApi.OData" Version="1.0.11" />
   </ItemGroup>