Merge pull request #1703 from microsoft/vnext

irvinesunday · web-flow · commit e222e36f2c9a · 2024-06-27T12:07:34.000+03:00
Releases Hidi
diff --git a/.github/workflows/docker.yml b/.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/build-push-action@v5.4.0
+        uses: docker/build-push-action@v6.1.0
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly
       - name: Push to GitHub Packages - Release
         if: ${{ github.ref == 'refs/heads/master' }}
-        uses: docker/build-push-action@v5.4.0
+        uses: docker/build-push-action@v6.1.0
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.getversion.outputs.version }}
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>1.4.5</Version>
+    <Version>1.4.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 -->
@@ -35,7 +35,7 @@
     <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.21.3" />
-    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.6" />
+    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.7" />
     <PackageReference Include="Microsoft.OpenApi.ApiManifest" Version="0.5.0-preview" />
     <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
   </ItemGroup>
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiV2Deserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiV2Deserializer.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.Collections.Generic;
@@ -113,11 +113,11 @@ public static IOpenApiAny LoadAny(ParseNode node)
 
         private static IOpenApiExtension LoadExtension(string name, ParseNode node)
         {
-            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser))
+            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser) && parser(
+                   OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),
+                   OpenApiSpecVersion.OpenApi2_0) is { } result)
             {
-                return parser(
-                    OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),
-                    OpenApiSpecVersion.OpenApi2_0);
+                return result;
             }
             else
             {
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3Deserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3Deserializer.cs
@@ -171,11 +171,11 @@ public static IOpenApiAny LoadAny(ParseNode node)
 
         private static IOpenApiExtension LoadExtension(string name, ParseNode node)
         {
-            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser))
+            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser) && parser(
+                   OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),
+                   OpenApiSpecVersion.OpenApi3_0) is { } result)
             {
-                return parser(
-                    OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),
-                    OpenApiSpecVersion.OpenApi3_0);
+                return result;
             }
             else
             {
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiDeprecationExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiDeprecationExtension.cs
@@ -78,7 +78,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
     public static OpenApiDeprecationExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiObject rawObject) return null;
         var extension = new OpenApiDeprecationExtension();
         if (rawObject.TryGetValue(nameof(RemovalDate).ToFirstCharacterLowerCase(), out var removalDate) && removalDate is OpenApiDateTime removalDateValue)
             extension.RemovalDate = removalDateValue.Value;
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumFlagsExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumFlagsExtension.cs
@@ -45,7 +45,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
     public static OpenApiEnumFlagsExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiObject rawObject) return null;
         var extension = new OpenApiEnumFlagsExtension();
         if (rawObject.TryGetValue(nameof(IsFlags).ToFirstCharacterLowerCase(), out var flagsValue) && flagsValue is OpenApiBoolean isFlags)
         {
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtension.cs
@@ -64,7 +64,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
     public static OpenApiEnumValuesDescriptionExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiObject rawObject) return null;
         var extension = new OpenApiEnumValuesDescriptionExtension();
         if (rawObject.TryGetValue("values", out var values) && values is OpenApiArray valuesArray)
         {
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPagingExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPagingExtension.cs
@@ -73,7 +73,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
     public static OpenApiPagingExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiObject rawObject) return null;
         var extension = new OpenApiPagingExtension();
         if (rawObject.TryGetValue(nameof(NextLinkName).ToFirstCharacterLowerCase(), out var nextLinkName) && nextLinkName is OpenApiString nextLinkNameStr)
         {
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPrimaryErrorMessageExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPrimaryErrorMessageExtension.cs
@@ -1,4 +1,4 @@
-// ------------------------------------------------------------
+﻿// ------------------------------------------------------------
 //  Copyright (c) Microsoft Corporation.  All rights reserved.
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
@@ -39,7 +39,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <returns>The <see cref="OpenApiPrimaryErrorMessageExtension"/>.</returns>
     public static OpenApiPrimaryErrorMessageExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiBoolean rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiBoolean rawObject) return null;
         return new()
         {
             IsPrimaryErrorMessage = rawObject.Value
diff --git a/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiReservedParameterExtension.cs b/src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiReservedParameterExtension.cs
@@ -41,7 +41,7 @@ public bool? IsReserved
     /// <returns></returns>
     public static OpenApiReservedParameterExtension Parse(IOpenApiAny source)
     {
-        if (source is not OpenApiBoolean rawBoolean) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not OpenApiBoolean rawBoolean) return null;
         return new()
         {
             IsReserved = rawBoolean.Value
diff --git a/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs b/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs
diff --git a/src/Microsoft.OpenApi/Properties/SRResource.resx b/src/Microsoft.OpenApi/Properties/SRResource.resx
@@ -139,7 +139,7 @@
     <value>Invalid Reference identifier '{0}'.</value>
   </data>
   <data name="InvalidReferenceType" xml:space="preserve">
-    <value>Invalid Reference Type.</value>
+    <value>Invalid Reference Type '{0}'.</value>
   </data>
   <data name="LocalReferenceRequiresType" xml:space="preserve">
     <value>Local reference must have type specified.</value>
diff --git a/src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs b/src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs
@@ -259,6 +259,13 @@ private void ResolveTags(IList<OpenApiTag> tags)
             {
                 try
                 {
+                    var referencedObject = typeof(T).Name;
+                    var referenceType = reference?.Type.ToString();
+                    if (referenceType is not null && !referencedObject.Contains(referenceType))
+                    {
+                        throw new OpenApiException(string.Format(Properties.SRResource.InvalidReferenceType, referenceType));
+                    }
+
                     return _currentDocument.ResolveReference(reference, false) as T;
                 }
                 catch (OpenApiException ex)
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs
@@ -9,8 +9,10 @@
 using System.Threading;
 using FluentAssertions;
 using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Exceptions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.Interface;
 using Microsoft.OpenApi.Validations;
 using Microsoft.OpenApi.Validations.Rules;
 using Microsoft.OpenApi.Writers;
@@ -1355,5 +1357,15 @@ public void ValidateExampleShouldNotHaveDataTypeMismatch()
             var warnings = diagnostic.Warnings;
             Assert.False(warnings.Any());
         }
+
+        [Fact]
+        public void ParseDocumetWithWrongReferenceTypeShouldReturnADiagnosticError()
+        {
+            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "docWithWrongRef.json"));
+            _ = new OpenApiStreamReader().Read(stream, out var diagnostic);
+
+            diagnostic.Errors.Should().BeEquivalentTo(new List<OpenApiError> {
+                new( new OpenApiException("Invalid Reference Type 'Schema'.")) });
+        }
     }
 }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiDocument/docWithWrongRef.json b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiDocument/docWithWrongRef.json
@@ -0,0 +1,27 @@
+{
+    "openapi":"3.0.0",
+    "info":{
+        "title":"some api",
+        "description":"some description",
+        "version": "1"
+    },
+    "servers":[{"url":"https://localhost"}],
+    "paths":{
+        "/count":{
+            "get":{
+                "responses":{
+                    "200":{
+                        "$ref":"#/components/schemas/count"
+                    },
+                },
+            }
+        }
+    },
+    "components":{
+        "schemas":{
+            "count":{
+                "type": "number"
+            }
+        }
+    }
+}
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -15,7 +15,7 @@
     <PackageReference Include="Moq" Version="4.20.70" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="SharpYaml" Version="2.1.1" />
-    <PackageReference Include="Verify.Xunit" Version="25.0.1" />
+    <PackageReference Include="Verify.Xunit" Version="25.0.4" />
     <PackageReference Include="xunit" Version="2.8.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.8.1" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
diff --git a/test/Microsoft.OpenApi.Tests/MicrosoftExtensions/OpenApiReservedParameterExtensionTests.cs b/test/Microsoft.OpenApi.Tests/MicrosoftExtensions/OpenApiReservedParameterExtensionTests.cs
@@ -17,6 +17,19 @@ public void Parses()
         Assert.NotNull(value);
         Assert.True(value.IsReserved);
     }
+
+    [Fact]
+    public void DoesNotThrowExceptionIfValueIsNull()
+    {
+        var oaiValue = new OpenApiObject
+        {
+            ["foo"] = new OpenApiString("foo")
+        };
+
+        var value = OpenApiReservedParameterExtension.Parse(oaiValue);
+        Assert.Null(value);
+    }
+
     [Fact]
     public void Serializes()
     {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) Microsoft Corporation. All rights reserved.`
	`1`	`+// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`
`4`	`4`	`using System.Collections.Generic;`
`@@ -113,11 +113,11 @@ public static IOpenApiAny LoadAny(ParseNode node)`
`113`	`113`
`114`	`114`	`private static IOpenApiExtension LoadExtension(string name, ParseNode node)`
`115`	`115`	`{`
`116`		`- if (node.Context.ExtensionParsers.TryGetValue(name, out var parser))`
	`116`	`+ if (node.Context.ExtensionParsers.TryGetValue(name, out var parser) && parser(`
	`117`	`+ OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),`
	`118`	`+ OpenApiSpecVersion.OpenApi2_0) is { } result)`
`117`	`119`	`{`
`118`		`- return parser(`
`119`		`- OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),`
`120`		`- OpenApiSpecVersion.OpenApi2_0);`
	`120`	`+ return result;`
`121`	`121`	`}`
`122`	`122`	`else`
`123`	`123`	`{`
Original file line number	Diff line number	Diff line change
`@@ -171,11 +171,11 @@ public static IOpenApiAny LoadAny(ParseNode node)`
`171`	`171`
`172`	`172`	`private static IOpenApiExtension LoadExtension(string name, ParseNode node)`
`173`	`173`	`{`
`174`		`- if (node.Context.ExtensionParsers.TryGetValue(name, out var parser))`
	`174`	`+ if (node.Context.ExtensionParsers.TryGetValue(name, out var parser) && parser(`
	`175`	`+ OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),`
	`176`	`+ OpenApiSpecVersion.OpenApi3_0) is { } result)`
`175`	`177`	`{`
`176`		`- return parser(`
`177`		`- OpenApiAnyConverter.GetSpecificOpenApiAny(node.CreateAny()),`
`178`		`- OpenApiSpecVersion.OpenApi3_0);`
	`178`	`+ return result;`
`179`	`179`	`}`
`180`	`180`	`else`
`181`	`181`	`{`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)`
`78`	`78`	`/// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>`
`79`	`79`	`public static OpenApiDeprecationExtension Parse(IOpenApiAny source)`
`80`	`80`	`{`
`81`		`- if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));`
	`81`	`+ if (source is not OpenApiObject rawObject) return null;`
`82`	`82`	`var extension = new OpenApiDeprecationExtension();`
`83`	`83`	`if (rawObject.TryGetValue(nameof(RemovalDate).ToFirstCharacterLowerCase(), out var removalDate) && removalDate is OpenApiDateTime removalDateValue)`
`84`	`84`	`extension.RemovalDate = removalDateValue.Value;`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)`
`45`	`45`	`/// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>`
`46`	`46`	`public static OpenApiEnumFlagsExtension Parse(IOpenApiAny source)`
`47`	`47`	`{`
`48`		`- if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));`
	`48`	`+ if (source is not OpenApiObject rawObject) return null;`
`49`	`49`	`var extension = new OpenApiEnumFlagsExtension();`
`50`	`50`	`if (rawObject.TryGetValue(nameof(IsFlags).ToFirstCharacterLowerCase(), out var flagsValue) && flagsValue is OpenApiBoolean isFlags)`
`51`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)`
`64`	`64`	`/// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>`
`65`	`65`	`public static OpenApiEnumValuesDescriptionExtension Parse(IOpenApiAny source)`
`66`	`66`	`{`
`67`		`- if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));`
	`67`	`+ if (source is not OpenApiObject rawObject) return null;`
`68`	`68`	`var extension = new OpenApiEnumValuesDescriptionExtension();`
`69`	`69`	`if (rawObject.TryGetValue("values", out var values) && values is OpenApiArray valuesArray)`
`70`	`70`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)`
`73`	`73`	`/// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>`
`74`	`74`	`public static OpenApiPagingExtension Parse(IOpenApiAny source)`
`75`	`75`	`{`
`76`		`- if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));`
	`76`	`+ if (source is not OpenApiObject rawObject) return null;`
`77`	`77`	`var extension = new OpenApiPagingExtension();`
`78`	`78`	`if (rawObject.TryGetValue(nameof(NextLinkName).ToFirstCharacterLowerCase(), out var nextLinkName) && nextLinkName is OpenApiString nextLinkNameStr)`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// ------------------------------------------------------------`
	`1`	`+// ------------------------------------------------------------`
`2`	`2`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
`3`	`3`	`// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.`
`4`	`4`	`// ------------------------------------------------------------`
`@@ -39,7 +39,7 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)`
`39`	`39`	`/// <returns>The <see cref="OpenApiPrimaryErrorMessageExtension"/>.</returns>`
`40`	`40`	`public static OpenApiPrimaryErrorMessageExtension Parse(IOpenApiAny source)`
`41`	`41`	`{`
`42`		`- if (source is not OpenApiBoolean rawObject) throw new ArgumentOutOfRangeException(nameof(source));`
	`42`	`+ if (source is not OpenApiBoolean rawObject) return null;`
`43`	`43`	`return new()`
`44`	`44`	`{`
`45`	`45`	`IsPrimaryErrorMessage = rawObject.Value`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public bool? IsReserved`
`41`	`41`	`/// <returns></returns>`
`42`	`42`	`public static OpenApiReservedParameterExtension Parse(IOpenApiAny source)`
`43`	`43`	`{`
`44`		`- if (source is not OpenApiBoolean rawBoolean) throw new ArgumentOutOfRangeException(nameof(source));`
	`44`	`+ if (source is not OpenApiBoolean rawBoolean) return null;`
`45`	`45`	`return new()`
`46`	`46`	`{`
`47`	`47`	`IsReserved = rawBoolean.Value`