Merge pull request #2028 from microsoft/dev

dev
microsoft · Dec 24, 2024 · cce2495 · cce2495
2 parents 249ff45 + f5fb254
commit cce2495
Show file tree

Hide file tree

Showing 10 changed files with 99 additions and 11 deletions.
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>2.0.0-preview3</Version>
+    <Version>2.0.0-preview4</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.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -1,9 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
-        <TargetFramework>netstandard2.0</TargetFramework>
+        <TargetFrameworks>netstandard2.0;net6.0;</TargetFrameworks>
+        <!-- net6.0 target is present because of the conditional build in OpenApiYamlReader.Read -->
         <LangVersion>latest</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>2.0.0-preview3</Version>
+        <Version>2.0.0-preview4</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 -->

diff --git a/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs
@@ -12,6 +12,7 @@
 using System.Linq;
 using Microsoft.OpenApi.Models;
 using System;
+using System.Text;
 
 namespace Microsoft.OpenApi.Readers
 {
@@ -53,7 +54,13 @@ public ReadResult Read(MemoryStream input,
             // Parse the YAML text in the stream into a sequence of JsonNodes
             try
             {
+#if NET
+// this represents net core, net5 and up
                 using var stream = new StreamReader(input, default, true, -1, settings.LeaveStreamOpen);
+#else
+// the implementation differs and results in a null reference exception in NETFX
+                using var stream = new StreamReader(input, Encoding.UTF8, true, 4096, settings.LeaveStreamOpen);
+#endif
                 jsonNode = LoadJsonNodesFromYamlDocument(stream);
             }
             catch (JsonException ex)

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>2.0.0-preview3</Version>
+        <Version>2.0.0-preview4</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/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtension.cs
@@ -11,6 +11,8 @@
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Writers;
 using System.Text.Json.Nodes;
+using System.Text.Json;
+using System.Globalization;
 
 namespace Microsoft.OpenApi.MicrosoftExtensions;
 
@@ -97,7 +99,10 @@ public EnumDescription(JsonObject source)
     {
         if (source is null) throw new ArgumentNullException(nameof(source));
         if (source.TryGetPropertyValue(nameof(Value).ToFirstCharacterLowerCase(), out var rawValue) && rawValue is JsonNode value)
-            Value = value.GetValue<string>();
+            if (value.GetValueKind() == JsonValueKind.Number)
+                Value = value.GetValue<decimal>().ToString(CultureInfo.InvariantCulture);
+            else
+                Value = value.GetValue<string>();
         if (source.TryGetPropertyValue(nameof(Description).ToFirstCharacterLowerCase(), out var rawDescription) && rawDescription is JsonNode description)
             Description = description.GetValue<string>();
         if (source.TryGetPropertyValue(nameof(Name).ToFirstCharacterLowerCase(), out var rawName) && rawName is JsonNode name)

diff --git a/src/Microsoft.OpenApi/Reader/ReadResult.cs b/src/Microsoft.OpenApi/Reader/ReadResult.cs
@@ -18,5 +18,13 @@ public class ReadResult
         /// OpenApiDiagnostic contains the Errors reported while parsing
         /// </summary>
         public OpenApiDiagnostic Diagnostic { get; set; }
+        /// <summary>
+        /// Deconstructs the result for easier assignment on the client application.
+        /// </summary>
+        public void Deconstruct(out OpenApiDocument document, out OpenApiDiagnostic diagnostic)
+        {
+            document = Document;
+            diagnostic = Diagnostic;
+        }
     }
 }
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -14,7 +14,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="Moq" Version="4.20.72" />
     <PackageReference Include="SharpYaml" Version="2.1.1" />
-    <PackageReference Include="Verify.Xunit" Version="28.6.1" />
+    <PackageReference Include="Verify.Xunit" Version="28.7.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />

diff --git a/...Microsoft.OpenApi.Tests/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtensionTests.cs b/...Microsoft.OpenApi.Tests/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtensionTests.cs
@@ -1,4 +1,5 @@
 using System.IO;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.MicrosoftExtensions;
 using Microsoft.OpenApi.Writers;
 using Xunit;
@@ -22,7 +23,7 @@ public void WritesNothingWhenNoValues()
     {
         // Arrange
         OpenApiEnumValuesDescriptionExtension extension = new();
-        using TextWriter sWriter = new StringWriter();
+        using var sWriter = new StringWriter();
         OpenApiJsonWriter writer = new(sWriter);
 
         // Act
@@ -41,16 +42,16 @@ public void WritesEnumDescription()
         OpenApiEnumValuesDescriptionExtension extension = new()
         {
             EnumName = "TestEnum",
-            ValuesDescriptions = new()
-        {
+            ValuesDescriptions =
+        [
             new() {
                 Description = "TestDescription",
                 Value = "TestValue",
                 Name = "TestName"
             }
-        }
+        ]
         };
-        using TextWriter sWriter = new StringWriter();
+        using var sWriter = new StringWriter();
         OpenApiJsonWriter writer = new(sWriter);
 
         // Act
@@ -65,5 +66,49 @@ public void WritesEnumDescription()
         Assert.Contains("value\": \"TestValue", result);
         Assert.Contains("name\": \"TestName", result);
     }
+    [Fact]
+    public void ParsesEnumDescription()
+    {
+        var extensionValue =
+"""
+{
+    "value": "Standard_LRS",
+    "description": "Locally redundant storage.",
+    "name": "StandardLocalRedundancy"
+}
+""";
+        var source = JsonNode.Parse(extensionValue);
+        Assert.NotNull(source);
+        var sourceAsObject = source.AsObject();
+        Assert.NotNull(sourceAsObject);
+
+        var descriptionItem = new EnumDescription(sourceAsObject);
+        Assert.NotNull(descriptionItem);
+        Assert.Equal("Standard_LRS", descriptionItem.Value);
+        Assert.Equal("Locally redundant storage.", descriptionItem.Description);
+        Assert.Equal("StandardLocalRedundancy", descriptionItem.Name);
+    }
+       [Fact]
+    public void ParsesEnumDescriptionWithDecimalValue()
+    {
+        var extensionValue =
+"""
+{
+    "value": -1,
+    "description": "Locally redundant storage.",
+    "name": "StandardLocalRedundancy"
+}
+""";
+        var source = JsonNode.Parse(extensionValue);
+        Assert.NotNull(source);
+        var sourceAsObject = source.AsObject();
+        Assert.NotNull(sourceAsObject);
+
+        var descriptionItem = new EnumDescription(sourceAsObject);
+        Assert.NotNull(descriptionItem);
+        Assert.Equal("-1", descriptionItem.Value);
+        Assert.Equal("Locally redundant storage.", descriptionItem.Description);
+        Assert.Equal("StandardLocalRedundancy", descriptionItem.Name);
+    }
 }
 
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -1380,6 +1380,7 @@ namespace Microsoft.OpenApi.Reader
         public ReadResult() { }
         public Microsoft.OpenApi.Reader.OpenApiDiagnostic Diagnostic { get; set; }
         public Microsoft.OpenApi.Models.OpenApiDocument Document { get; set; }
+        public void Deconstruct(out Microsoft.OpenApi.Models.OpenApiDocument document, out Microsoft.OpenApi.Reader.OpenApiDiagnostic diagnostic) { }
     }
     public enum ReferenceResolutionSetting
     {

diff --git a/test/Microsoft.OpenApi.Tests/Reader/ReadResultTests.cs b/test/Microsoft.OpenApi.Tests/Reader/ReadResultTests.cs
@@ -0,0 +1,21 @@
+using Xunit;
+using Microsoft.OpenApi.Reader;
+using Microsoft.OpenApi.Models;
+
+namespace Microsoft.OpenApi.Tests.Reader;
+
+public class ReadResultTests
+{
+    [Fact]
+    public void Deconstructs()
+    {
+        var readResult = new ReadResult()
+        {
+            Document = new OpenApiDocument(),
+            Diagnostic = new OpenApiDiagnostic()
+        };
+        var (document, diagnostic) = readResult;
+        Assert.Equal(readResult.Document, document);
+        Assert.Equal(readResult.Diagnostic, diagnostic);
+    }
+}