Fixes bugs and failing tests

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,8 +10,8 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
-Steps to reproduce the current behavior:
+**OpenApi File To Reproduce**
+Add the OpenApi file you're using or a link to it as well as the steps to reproduce the current behavior.
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.

.github/workflows/ci-cd.yml

@@ -14,7 +14,7 @@ jobs:
       GITHUB_RUN_NUMBER: ${{ github.run_number }}
     steps:
       - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 7.0.x
 

.github/workflows/codeql-analysis.yml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 7.0.x
 

.github/workflows/sonarcloud.yml

@@ -30,16 +30,16 @@ jobs:
     runs-on: windows-latest
     steps:
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
           java-version: 17
       - name: Setup .NET 5 # At the moment the scanner requires dotnet 5 https://www.nuget.org/packages/dotnet-sonarscanner
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 5.0.x
       - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 7.0.x
       - uses: actions/checkout@v4

src/Microsoft.OpenApi.Hidi/Formatters/PowerShellFormatter.cs

@@ -44,8 +44,8 @@ static PowerShellFormatter()
         // 6. Add AdditionalProperties to object schemas.
 
         public override void Visit(ref JsonSchema schema)
-        {
-            AddAdditionalPropertiesToSchema(schema);
+         {
+            AddAdditionalPropertiesToSchema(ref schema);
             schema = ResolveAnyOfSchema(ref schema);
             schema = ResolveOneOfSchema(ref schema);
 
@@ -174,7 +174,7 @@ private static IList<OpenApiParameter> ResolveFunctionParameters(IList<OpenApiPa
             return parameters;
         }
 
-        private void AddAdditionalPropertiesToSchema(JsonSchema schema)
+        private void AddAdditionalPropertiesToSchema(ref JsonSchema schema)
         {
             if (schema != null && !_schemaLoop.Contains(schema) && schema.GetJsonType().Equals(SchemaValueType.Object))
             {
@@ -200,6 +200,7 @@ private void AddAdditionalPropertiesToSchema(JsonSchema schema)
                     _schemaLoop.Push(additionalProps);
                 }
             }
+
         }
 
         private static JsonSchema ResolveOneOfSchema(ref JsonSchema schema)
@@ -254,6 +255,14 @@ private static JsonSchema FlattenSchema(JsonSchema schema, JsonSchema newSchema)
         private static JsonSchema CopySchema(JsonSchema schema, JsonSchema newSchema)
         {
             var schemaBuilder = new JsonSchemaBuilder();
+            var keywords = schema.Keywords;
+            if (keywords != null)
+            {
+                foreach (var keyword in keywords)
+                {
+                    schemaBuilder.Add(keyword);
+                }
+            }
 
             if (schema.GetTitle() == null && newSchema.GetTitle() is { } title)
             {

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

@@ -9,7 +9,7 @@
     <Nullable>enable</Nullable>
     <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>1.3.5</Version>
+    <Version>1.3.6</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 -->
@@ -34,8 +34,8 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="8.0.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
-    <PackageReference Include="Microsoft.OData.Edm" Version="7.18.0" />
-    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.5.0-preview9" />
+    <PackageReference Include="Microsoft.OData.Edm" Version="7.20.0" />
+    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.5.0" />
     <PackageReference Include="Microsoft.OpenApi.ApiManifest" Version="0.5.0-preview" />
     <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
   </ItemGroup>

src/Microsoft.OpenApi.Hidi/Utilities/SettingsUtilities.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System.IO;
 using Microsoft.Extensions.Configuration;
 using Microsoft.OpenApi.OData;
 
@@ -11,15 +12,19 @@ internal static class SettingsUtilities
         internal static IConfiguration GetConfiguration(string? settingsFile = null)
         {
             if (string.IsNullOrEmpty(settingsFile))
+            {
                 settingsFile = "appsettings.json";
+            }
+
+            var settingsFilePath = Path.Combine(Directory.GetCurrentDirectory(), settingsFile);
 
             IConfiguration config = new ConfigurationBuilder()
-            .AddJsonFile(settingsFile, true)
-            .Build();
+                .AddJsonFile(settingsFilePath, true)
+                .Build();
 
             return config;
         }
-
+        
         internal static OpenApiConvertSettings GetOpenApiConvertSettings(IConfiguration config, string? metadataVersion)
         {
             if (config == null) { throw new System.ArgumentNullException(nameof(config)); }

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -1,9 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFramework>netstandard2.0</TargetFramework>
         <LangVersion>latest</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>1.6.10</Version>
+        <Version>1.6.11</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <SignAssembly>true</SignAssembly>
         <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
@@ -21,7 +21,6 @@
         <PackageReference Include="JsonSchema.Net" Version="4.1.5" />
         <PackageReference Include="JsonSchema.Net.OpenApi" Version="1.1.0" />
         <PackageReference Include="SharpYaml" Version="2.1.0" />
-        <PackageReference Include="Yaml2JsonNode" Version="1.1.1" />
         <PackageReference Include="System.Text.Json" Version="7.0.2" />
     </ItemGroup>
 

src/Microsoft.OpenApi.Readers/ParseNodes/MapNode.cs

@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Text.Json;
 using System.Text.Json.Nodes;
+using Json.Schema;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -123,6 +124,57 @@ public override Dictionary<string, T> CreateMapWithReference<T>(
             return nodes.Where(n => n != default).ToDictionary(k => k.key, v => v.value);
         }
 
+        public override Dictionary<string, JsonSchema> CreateJsonSchemaMapWithReference(
+            ReferenceType referenceType,
+            Func<MapNode, JsonSchema> map,
+            OpenApiSpecVersion version)
+        {
+            var jsonMap = _node ?? throw new OpenApiReaderException($"Expected map while parsing {typeof(JsonSchema).Name}", Context);
+
+            var nodes = jsonMap.Select(
+                n =>
+                {
+                    var key = n.Key;
+                    (string key, JsonSchema value) entry;
+                    try
+                    {
+                        Context.StartObject(key);
+                        entry = (key,
+                            value: map(new MapNode(Context, (JsonObject)n.Value))
+                        );
+                        if (entry.value == null)
+                        {
+                            return default;  // Body Parameters shouldn't be converted to Parameters
+                        }
+                        // If the component isn't a reference to another component, then point it to itself.
+                        if (entry.value.GetRef() == null)
+                        {
+                            var builder = new JsonSchemaBuilder();
+
+                            // construct the Ref and append it to the builder
+                            var reference = version == OpenApiSpecVersion.OpenApi2_0 ? string.Concat("#/definitions/", entry.key) :
+                                string.Concat("#/components/schemas/", entry.key);
+
+                            builder.Ref(reference);
+
+                            // Append all the keywords in original schema to our new schema using a builder instance
+                            foreach (var keyword in entry.value.Keywords)
+                            {
+                                builder.Add(keyword);
+                            }
+                            entry.value = builder.Build();
+                        }
+                    }
+                    finally
+                    {
+                        Context.EndObject();
+                    }
+                    return entry;
+                }
+                );
+            return nodes.Where(n => n != default).ToDictionary(k => k.key, v => v.value);
+        }
+
         public override Dictionary<string, T> CreateSimpleMap<T>(Func<ValueNode, T> map)
         {
             var jsonMap = _node ?? throw new OpenApiReaderException($"Expected map while parsing {typeof(T).Name}", Context);

src/Microsoft.OpenApi.Readers/ParseNodes/ParseNode.cs

@@ -1,9 +1,10 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using System;
 using System.Collections.Generic;
 using System.Text.Json.Nodes;
+using Json.Schema;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -66,6 +67,14 @@ public virtual Dictionary<string, T> CreateMapWithReference<T>(
             throw new OpenApiReaderException("Cannot create map from this reference.", Context);
         }
 
+        public virtual Dictionary<string, JsonSchema> CreateJsonSchemaMapWithReference(
+            ReferenceType referenceType,
+            Func<MapNode, JsonSchema> map,
+            OpenApiSpecVersion version)
+        {
+            throw new OpenApiReaderException("Cannot create map from this reference.", Context);
+        }
+
         public virtual List<T> CreateSimpleList<T>(Func<ValueNode, T> map)
         {
             throw new OpenApiReaderException("Cannot create simple list from this type of node.", Context);

src/Microsoft.OpenApi.Readers/ParseNodes/ParserHelper.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.Globalization;
+
+namespace Microsoft.OpenApi.Readers.ParseNodes
+{
+    /// <summary>
+    /// Useful tools to parse data
+    /// </summary>
+    internal class ParserHelper
+    {
+        /// <summary>
+        /// Parses decimal in invariant culture.
+        /// If the decimal is too big or small, it returns the default value
+        /// 
+        /// Note: sometimes developers put Double.MaxValue or Long.MaxValue as min/max values for numbers in json schema even if their numbers are not expected to be that big/small.
+        /// As we have already released the library with Decimal type for Max/Min, let's not introduce the breaking change and just fallback to Decimal.Max / Min. This should satisfy almost every scenario.
+        /// We can revisit this if somebody really needs to have double or long here.
+        /// </summary>
+        /// <returns></returns>
+        public static decimal ParseDecimalWithFallbackOnOverflow(string value, decimal defaultValue)
+        {
+            try
+            {
+                return decimal.Parse(value, NumberStyles.Float, CultureInfo.InvariantCulture);
+            }
+            catch (OverflowException)
+            {
+                return defaultValue;
+            }
+        }
+    }
+}

src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs

@@ -59,12 +59,8 @@ internal static partial class OpenApiV2Deserializer
                 "definitions",
                 (o, n) =>
                 {
-                    if (o.Components == null)
-                    {
-                        o.Components = new();
-                    }
-
-                    o.Components.Schemas = n.CreateMap(LoadSchema);
+                    o.Components ??= new();
+                    o.Components.Schemas = n.CreateJsonSchemaMapWithReference(ReferenceType.Schema, LoadSchema, OpenApiSpecVersion.OpenApi2_0);
                 }
             },
             {

src/Microsoft.OpenApi.Readers/V2/OpenApiHeaderDeserializer.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 System;