Merge pull request #914 from microsoft/vnext

baywet · web-flow · commit 5fe88e8e4a81 · 2022-06-23T15:00:58.000-04:00
hidi docker image release
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -0,0 +1,42 @@
+name: Publish Docker image
+on:
+  workflow_dispatch:
+  push:
+    branches: [master, vnext]
+    paths: ['src/Microsoft.OpenApi.Hidi/**', '.github/workflows/**']
+env:
+  REGISTRY: msgraphprod.azurecr.io
+  IMAGE_NAME: public/hidi
+jobs:
+  push_to_registry:
+    environment:
+      name: acr
+    name: Push Docker image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+      - name: Login to GitHub package feed
+        uses: docker/login-action@v2.0.0 
+        with:
+          username: ${{ secrets.ACR_USERNAME }}
+          password: ${{ secrets.ACR_PASSWORD }}
+          registry: ${{ env.REGISTRY }}
+      - run: |
+          $content = [XML](Get-Content ./src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj)
+          $version = $content.Project.PropertyGroup.Version
+          echo "::set-output name=version::${version}"
+        shell: pwsh
+        id: getversion
+      - name: Push to GitHub Packages - Nightly
+        if: contains(github.ref, 'refs/head/vnext')
+        uses: docker/build-push-action@v3.0.0
+        with:
+          push: true
+          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly
+      - name: Push to GitHub Packages - Release
+        if: contains(github.ref, 'refs/head/master')
+        uses: docker/build-push-action@v3.0.0
+        with:
+          push: true
+          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.getversion.outputs.version }}
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,21 @@
+FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build-env
+WORKDIR /app
+
+COPY ./src ./hidi/src
+WORKDIR /app/hidi
+RUN dotnet publish ./src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj -c Release
+
+FROM mcr.microsoft.com/dotnet/runtime:6.0 as runtime
+WORKDIR /app
+
+COPY --from=build-env /app/hidi/src/Microsoft.OpenApi.Hidi/bin/Release/net6.0 ./
+
+VOLUME /app/output
+VOLUME /app/openapi.yml
+VOLUME /app/api.csdl
+VOLUME /app/collection.json
+ENV HIDI_CONTAINER=true DOTNET_TieredPGO=1 DOTNET_TC_QuickJitForLoops=1
+ENTRYPOINT ["dotnet", "Microsoft.OpenApi.Hidi.dll"]
+LABEL description="# Welcome to Hidi \
+To start transforming OpenAPI documents checkout [the getting started documentation](https://github.com/microsoft/OpenAPI.NET/tree/vnext/src/Microsoft.OpenApi.Hidi)  \
+[Source dockerfile](https://github.com/microsoft/OpenAPI.NET/blob/vnext/Dockerfile)"
diff --git a/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj b/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
@@ -15,15 +15,15 @@
     <PackageId>Microsoft.OpenApi.Hidi</PackageId>
     <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>1.0.0-preview5</Version>
+    <Version>1.0.0-preview6</Version>
     <Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageTags>OpenAPI .NET</PackageTags>
     <RepositoryUrl>https://github.com/Microsoft/OpenAPI.NET</RepositoryUrl>
     <PackageReleaseNotes>
-- Enables discriminator values
-- Adds new OpenAPI convert setting, ExpandDerivedTypesNavigationProperties and sets it to false
-- Bumps up the Microsoft.OpenApi.OData library to v1.0.11-preview2
+- Bumps up the Microsoft.OpenAPI library to v1.3.2
+- Bumps up the Microsoft.OData library to v7.12.0
+- Bumps up the Microsoft.OpenApi.OData library to v1.0.11-preview3
     </PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.Hidi</AssemblyName>
     <RootNamespace>Microsoft.OpenApi.Hidi</RootNamespace>
@@ -46,8 +46,8 @@
     <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.11.0" />
-    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.0.11-preview2" />
+    <PackageReference Include="Microsoft.OData.Edm" Version="7.12.0" />
+    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.0.11-preview3" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -10,13 +10,13 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.3.1</Version>
+        <Version>1.3.2</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
         <RepositoryUrl>https://github.com/Microsoft/OpenAPI.NET</RepositoryUrl>
         <PackageReleaseNotes>
-- Publish symbols.
+- Fixed a bug where contact information would not read properly. #892
         </PackageReleaseNotes>
         <AssemblyName>Microsoft.OpenApi.Readers</AssemblyName>
         <RootNamespace>Microsoft.OpenApi.Readers</RootNamespace>
@@ -40,7 +40,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="SharpYaml" Version="1.9.1" />
+        <PackageReference Include="SharpYaml" Version="1.9.2" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs
@@ -34,6 +34,7 @@ public OpenApiV2VersionService(OpenApiDiagnostic diagnostic)
         private IDictionary<Type, Func<ParseNode, object>> _loaders = new Dictionary<Type, Func<ParseNode, object>>
         {
             [typeof(IOpenApiAny)] = OpenApiV2Deserializer.LoadAny,
+            [typeof(OpenApiContact)] = OpenApiV2Deserializer.LoadContact,
             [typeof(OpenApiExternalDocs)] = OpenApiV2Deserializer.LoadExternalDocs,
             [typeof(OpenApiHeader)] = OpenApiV2Deserializer.LoadHeader,
             [typeof(OpenApiInfo)] = OpenApiV2Deserializer.LoadInfo,
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs
@@ -35,6 +35,7 @@ public OpenApiV3VersionService(OpenApiDiagnostic diagnostic)
             [typeof(IOpenApiAny)] = OpenApiV3Deserializer.LoadAny,
             [typeof(OpenApiCallback)] = OpenApiV3Deserializer.LoadCallback,
             [typeof(OpenApiComponents)] = OpenApiV3Deserializer.LoadComponents,
+            [typeof(OpenApiContact)] = OpenApiV3Deserializer.LoadContact,
             [typeof(OpenApiEncoding)] = OpenApiV3Deserializer.LoadEncoding,
             [typeof(OpenApiExample)] = OpenApiV3Deserializer.LoadExample,
             [typeof(OpenApiExternalDocs)] = OpenApiV3Deserializer.LoadExternalDocs,
diff --git a/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj b/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.3.326103">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.3.330701">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.Windows.Compatibility" Version="6.0.0" />
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -11,13 +11,13 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.3.1</Version>
+        <Version>1.3.2</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
         <RepositoryUrl>https://github.com/Microsoft/OpenAPI.NET</RepositoryUrl>
         <PackageReleaseNotes>
-- Publish symbols.
+- Adds support for c-style hex notation strings. #908
         </PackageReleaseNotes>
         <AssemblyName>Microsoft.OpenApi</AssemblyName>
         <RootNamespace>Microsoft.OpenApi</RootNamespace>
diff --git a/src/Microsoft.OpenApi/Writers/SpecialCharacterStringExtensions.cs b/src/Microsoft.OpenApi/Writers/SpecialCharacterStringExtensions.cs
@@ -187,9 +187,10 @@ internal static string GetYamlCompatibleString(this string input)
                 return $"'{input}'";
             }
 
-            // If string can be mistaken as a number, a boolean, or a timestamp,
-            // wrap it in quote to indicate that this is indeed a string, not a number, a boolean, or a timestamp
+            // If string can be mistaken as a number, c-style hexadecimal notation, a boolean, or a timestamp,
+            // wrap it in quote to indicate that this is indeed a string, not a number, c-style hexadecimal notation, a boolean, or a timestamp
             if (decimal.TryParse(input, NumberStyles.Float, CultureInfo.InvariantCulture, out var _) ||
+                IsHexadecimalNotation(input) ||
                 bool.TryParse(input, out var _) ||
                 DateTime.TryParse(input, out var _))
             {
@@ -225,5 +226,10 @@ internal static string GetJsonCompatibleString(this string value)
 
             return $"\"{value}\"";
         }
+
+        internal static bool IsHexadecimalNotation(string input)
+        {
+            return input.StartsWith("0x") && int.TryParse(input.Substring(2), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out var _);
+        }
     }
 }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -247,7 +247,7 @@
         </PackageReference>
         <PackageReference Include="Newtonsoft.Json" Version="13.0.1">
         </PackageReference>
-        <PackageReference Include="SharpYaml" Version="1.9.1">
+        <PackageReference Include="SharpYaml" Version="1.9.2">
         </PackageReference>
         <PackageReference Include="xunit" Version="2.4.1">
         </PackageReference>
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiContactTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiContactTests.cs
@@ -0,0 +1,41 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using FluentAssertions;
+using Microsoft.OpenApi.Models;
+using System;
+using Xunit;
+
+namespace Microsoft.OpenApi.Readers.Tests.V2Tests
+{
+    public class OpenApiContactTests
+    {
+        [Fact]
+        public void ParseStringContactFragmentShouldSucceed()
+        {
+            var input = @"
+{
+  ""name"": ""API Support"",
+  ""url"": ""http://www.swagger.io/support"",
+  ""email"": ""support@swagger.io""
+}
+";
+            var reader = new OpenApiStringReader();
+            var diagnostic = new OpenApiDiagnostic();
+
+            // Act
+            var contact = reader.ReadFragment<OpenApiContact>(input, OpenApiSpecVersion.OpenApi2_0, out diagnostic);
+
+            // Assert
+            diagnostic.Should().BeEquivalentTo(new OpenApiDiagnostic());
+
+            contact.Should().BeEquivalentTo(
+                new OpenApiContact
+                {
+                    Email = "support@swagger.io",
+                    Name = "API Support",
+                    Url = new Uri("http://www.swagger.io/support")
+                });
+        }
+    }
+}
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiContactTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiContactTests.cs
@@ -0,0 +1,41 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using FluentAssertions;
+using Microsoft.OpenApi.Models;
+using System;
+using Xunit;
+
+namespace Microsoft.OpenApi.Readers.Tests.V3Tests
+{
+    public class OpenApiContactTests
+    {
+        [Fact]
+        public void ParseStringContactFragmentShouldSucceed()
+        {
+            var input = @"
+{
+  ""name"": ""API Support"",
+  ""url"": ""http://www.swagger.io/support"",
+  ""email"": ""support@swagger.io""
+}
+";
+            var reader = new OpenApiStringReader();
+            var diagnostic = new OpenApiDiagnostic();
+
+            // Act
+            var contact = reader.ReadFragment<OpenApiContact>(input, OpenApiSpecVersion.OpenApi3_0, out diagnostic);
+
+            // Assert
+            diagnostic.Should().BeEquivalentTo(new OpenApiDiagnostic());
+
+            contact.Should().BeEquivalentTo(
+                new OpenApiContact
+                {
+                    Email = "support@swagger.io",
+                    Name = "API Support",
+                    Url = new Uri("http://www.swagger.io/support")
+                });
+        }
+    }
+}
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -19,9 +19,9 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.2.0" />
     <PackageReference Include="Moq" Version="4.18.1" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageReference Include="SharpYaml" Version="1.9.1" />
-    <PackageReference Include="Verify" Version="17.1.1" />
-    <PackageReference Include="Verify.Xunit" Version="16.8.1" />
+    <PackageReference Include="SharpYaml" Version="1.9.2" />
+    <PackageReference Include="Verify" Version="17.1.4" />
+    <PackageReference Include="Verify.Xunit" Version="17.1.4" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
       <PrivateAssets>all</PrivateAssets>
diff --git a/test/Microsoft.OpenApi.Tests/Writers/OpenApiWriterSpecialCharacterTests.cs b/test/Microsoft.OpenApi.Tests/Writers/OpenApiWriterSpecialCharacterTests.cs
@@ -38,6 +38,7 @@ from inputExpected in new[] {
                        new[]{ "Test\\Test", "\"Test\\\\Test\""},
                        new[]{ "Test\"Test", "\"Test\\\"Test\""},
                        new[]{ "StringsWith\"Quotes\"", "\"StringsWith\\\"Quotes\\\"\""},
+                       new[]{ "0x1234", "\"0x1234\""},
                      }
                     from shouldBeTerse in shouldProduceTerseOutputValues
                     select new object[] { inputExpected[0], inputExpected[1], shouldBeTerse };
@@ -79,6 +80,7 @@ public void WriteStringWithSpecialCharactersAsJsonWorks(string input, string exp
         [InlineData("trailingspace ", " 'trailingspace '")]
         [InlineData("     trailingspace", " '     trailingspace'")]
         [InlineData("terminal:", " 'terminal:'")]
+        [InlineData("0x1234", " '0x1234'")]
         public void WriteStringWithSpecialCharactersAsYamlWorks(string input, string expected)
         {
             // Arrange

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public OpenApiV2VersionService(OpenApiDiagnostic diagnostic)`
`34`	`34`	`private IDictionary<Type, Func<ParseNode, object>> _loaders = new Dictionary<Type, Func<ParseNode, object>>`
`35`	`35`	`{`
`36`	`36`	`[typeof(IOpenApiAny)] = OpenApiV2Deserializer.LoadAny,`
	`37`	`+ [typeof(OpenApiContact)] = OpenApiV2Deserializer.LoadContact,`
`37`	`38`	`[typeof(OpenApiExternalDocs)] = OpenApiV2Deserializer.LoadExternalDocs,`
`38`	`39`	`[typeof(OpenApiHeader)] = OpenApiV2Deserializer.LoadHeader,`
`39`	`40`	`[typeof(OpenApiInfo)] = OpenApiV2Deserializer.LoadInfo,`
Original file line number	Diff line number	Diff line change
`@@ -187,9 +187,10 @@ internal static string GetYamlCompatibleString(this string input)`
`187`	`187`	`return $"'{input}'";`
`188`	`188`	`}`
`189`	`189`
`190`		`- // If string can be mistaken as a number, a boolean, or a timestamp,`
`191`		`- // wrap it in quote to indicate that this is indeed a string, not a number, a boolean, or a timestamp`
	`190`	`+ // If string can be mistaken as a number, c-style hexadecimal notation, a boolean, or a timestamp,`
	`191`	`+ // wrap it in quote to indicate that this is indeed a string, not a number, c-style hexadecimal notation, a boolean, or a timestamp`
`192`	`192`	`if (decimal.TryParse(input, NumberStyles.Float, CultureInfo.InvariantCulture, out var _) \|\|`
	`193`	`+ IsHexadecimalNotation(input) \|\|`
`193`	`194`	`bool.TryParse(input, out var _) \|\|`
`194`	`195`	`DateTime.TryParse(input, out var _))`
`195`	`196`	`{`
`@@ -225,5 +226,10 @@ internal static string GetJsonCompatibleString(this string value)`
`225`	`226`
`226`	`227`	`return $"\"{value}\"";`
`227`	`228`	`}`
	`229`	`+`
	`230`	`+ internal static bool IsHexadecimalNotation(string input)`
	`231`	`+ {`
	`232`	`+ return input.StartsWith("0x") && int.TryParse(input.Substring(2), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out var _);`
	`233`	`+ }`
`228`	`234`	`}`
`229`	`235`	`}`