Merge pull request #1084 from microsoft/vnext

Release libs

.azure-pipelines/ci-build.yml

@@ -31,9 +31,14 @@ stages:
     - job: build
       steps:
       - task: UseDotNet@2
-        displayName: 'Use .NET 6'
+        displayName: 'Use .NET 2' # needed for ESRP signing
         inputs:
-          version: 6.x
+          version: 2.x
+
+      - task: UseDotNet@2
+        displayName: 'Use .NET 7'
+        inputs:
+          version: 7.x
 
       - task: PoliCheck@1
         displayName: 'Run PoliCheck "/src"'

.github/workflows/ci-cd.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 6.0.x
+          dotnet-version: 7.0.x
 
       - name: Data gatherer
         id: data_gatherer
@@ -49,7 +49,7 @@ jobs:
       - if: steps.conditionals_handler.outputs.is_default_branch == 'true'
         name: Bump GH tag
         id: tag_generator
-        uses: mathieudutour/github-tag-action@v6.0
+        uses: mathieudutour/github-tag-action@v6.1
         with: 
           github_token: ${{ secrets.GITHUB_TOKEN }}
           default_bump: false

.github/workflows/codeql-analysis.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 6.0.x
+          dotnet-version: 7.0.x
 
       - name: Initialize CodeQL
         id: init_codeql

.vscode/launch.json

@@ -10,7 +10,7 @@
             "request": "launch",
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
-            "program": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi/bin/Debug/net6.0/Microsoft.OpenApi.Hidi.dll",
+            "program": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi/bin/Debug/net7.0/Microsoft.OpenApi.Hidi.dll",
             "args": [],
             "cwd": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console

Dockerfile

@@ -1,14 +1,14 @@
-FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build-env
+FROM mcr.microsoft.com/dotnet/sdk:7.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
+FROM mcr.microsoft.com/dotnet/runtime:7.0 as runtime
 WORKDIR /app
 
-COPY --from=build-env /app/hidi/src/Microsoft.OpenApi.Hidi/bin/Release/net6.0 ./
+COPY --from=build-env /app/hidi/src/Microsoft.OpenApi.Hidi/bin/Release/net7.0 ./
 
 VOLUME /app/output
 VOLUME /app/openapi.yml

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

@@ -21,6 +21,7 @@ internal class TransformCommandHandler : ICommandHandler
         public Option<string?> VersionOption { get; set; }
         public Option<OpenApiFormat?> FormatOption { get; set; }
         public Option<bool> TerseOutputOption { get; set; }
+        public Option<string> SettingsFileOption { get; set; }
         public Option<LogLevel> LogLevelOption { get; set; }
         public Option<string> FilterByOperationIdsOption { get; set; }
         public Option<string> FilterByTagsOption { get; set; }
@@ -42,6 +43,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
             string? version = context.ParseResult.GetValueForOption(VersionOption);
             OpenApiFormat? format = context.ParseResult.GetValueForOption(FormatOption);
             bool terseOutput = context.ParseResult.GetValueForOption(TerseOutputOption);
+            string settingsFile = context.ParseResult.GetValueForOption(SettingsFileOption);
             LogLevel logLevel = context.ParseResult.GetValueForOption(LogLevelOption);
             bool inlineLocal = context.ParseResult.GetValueForOption(InlineLocalOption);
             bool inlineExternal = context.ParseResult.GetValueForOption(InlineExternalOption);
@@ -54,7 +56,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
             var logger = loggerFactory.CreateLogger<OpenApiService>();
             try
             {
-                await OpenApiService.TransformOpenApiDocument(openapi, csdl, csdlFilter, output, cleanOutput, version, format, terseOutput, logLevel, inlineLocal, inlineExternal, filterbyoperationids, filterbytags, filterbycollection, cancellationToken);
+                await OpenApiService.TransformOpenApiDocument(openapi, csdl, csdlFilter, output, cleanOutput, version, format, terseOutput, settingsFile, logLevel, inlineLocal, inlineExternal, filterbyoperationids, filterbytags, filterbycollection, cancellationToken);
 
                 return 0;
             }

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

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <LangVersion>9.0</LangVersion>
     <PackAsTool>true</PackAsTool>
     <PackageIconUrl>http://go.microsoft.com/fwlink/?LinkID=288890</PackageIconUrl>
@@ -15,7 +15,7 @@
     <PackageId>Microsoft.OpenApi.Hidi</PackageId>
     <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>1.1.0-preview3</Version>
+    <Version>1.1.0</Version>
     <Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageTags>OpenAPI .NET</PackageTags>
@@ -37,18 +37,27 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.2" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="7.0.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
-    <PackageReference Include="Microsoft.OData.Edm" Version="7.12.4" />
-    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.2.0-preview5" />
+    <PackageReference Include="Microsoft.OData.Edm" Version="7.12.5" />
+    <PackageReference Include="Microsoft.OpenApi.OData" Version="1.2.0-preview8" />
+    <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj" />
     <ProjectReference Include="..\Microsoft.OpenApi\Microsoft.OpenApi.csproj" />
   </ItemGroup>
 
+  <!-- Make internals available for Unit Testing -->
+  <ItemGroup>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
+      <_Parameter1>Microsoft.OpenApi.Hidi.Tests</_Parameter1>
+    </AssemblyAttribute>
+  </ItemGroup>
+    <!-- End Unit test Internals -->
+
 </Project>

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -27,6 +27,8 @@
 using System.Xml.Xsl;
 using System.Xml;
 using System.Reflection;
+using Microsoft.Extensions.Configuration;
+using System.Runtime.CompilerServices;
 
 namespace Microsoft.OpenApi.Hidi
 {
@@ -44,6 +46,7 @@ public static async Task TransformOpenApiDocument(
             string? version,
             OpenApiFormat? format,
             bool terseOutput,
+            string settingsFile,
             LogLevel logLevel,
             bool inlineLocal,
             bool inlineExternal,
@@ -98,7 +101,8 @@ CancellationToken cancellationToken
                             stream = ApplyFilter(csdl, csdlFilter, transform);
                             stream.Position = 0;
                         }
-                        document = await ConvertCsdlToOpenApi(stream);
+
+                        document = await ConvertCsdlToOpenApi(stream, settingsFile);
                         stopwatch.Stop();
                         logger.LogTrace("{timestamp}ms: Generated OpenAPI with {paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths.Count);
                     }
@@ -304,25 +308,37 @@ public static async Task ValidateOpenApiDocument(
             }
         }
 
+        internal static IConfiguration GetConfiguration(string settingsFile)
+        {
+            settingsFile ??= "appsettings.json";
+
+            IConfiguration config = new ConfigurationBuilder()
+            .AddJsonFile(settingsFile, true)
+            .Build();
+
+            return config;
+        }
+
         /// <summary>
         /// Converts CSDL to OpenAPI
         /// </summary>
         /// <param name="csdl">The CSDL stream.</param>
         /// <returns>An OpenAPI document.</returns>
-        public static async Task<OpenApiDocument> ConvertCsdlToOpenApi(Stream csdl)
+        public static async Task<OpenApiDocument> ConvertCsdlToOpenApi(Stream csdl, string settingsFile = null)
         {
             using var reader = new StreamReader(csdl);
             var csdlText = await reader.ReadToEndAsync();
             var edmModel = CsdlReader.Parse(XElement.Parse(csdlText).CreateReader());
-
+
+            var config = GetConfiguration(settingsFile);
             var settings = new OpenApiConvertSettings()
             {
                 AddSingleQuotesForStringParameters = true,
                 AddEnumDescriptionExtension = true,
                 DeclarePathParametersOnPathItem = true,
                 EnableKeyAsSegment = true,
                 EnableOperationId = true,
-                ErrorResponsesAsDefault  = false,
+                ErrorResponsesAsDefault = false,
                 PrefixEntityTypeNameBeforeKey = true,
                 TagDepth = 2,
                 EnablePagination = true,
@@ -335,6 +351,8 @@ public static async Task<OpenApiDocument> ConvertCsdlToOpenApi(Stream csdl)
                 EnableCount = true,
                 UseSuccessStatusCodeRange = true
             };
+            config.GetSection("OpenApiConvertSettings").Bind(settings);
+
             OpenApiDocument document = edmModel.ConvertToOpenApi(settings);
 
             document = FixReferences(document);

src/Microsoft.OpenApi.Hidi/Program.cs

@@ -2,8 +2,14 @@
 // Licensed under the MIT license.
 
 using System.CommandLine;
+using System.CommandLine.Builder;
+using System.CommandLine.Hosting;
+using System.CommandLine.Parsing;
+
 using System.IO;
 using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Hidi.Handlers;
 
@@ -41,6 +47,9 @@ static async Task Main(string[] args)
             var terseOutputOption = new Option<bool>("--terse-output", "Produce terse json output");
             terseOutputOption.AddAlias("--to");
 
+            var settingsFileOption = new Option<string>("--settings-path", "The configuration file with CSDL conversion settings.");
+            settingsFileOption.AddAlias("--sp");
+
             var logLevelOption = new Option<LogLevel>("--log-level", () => LogLevel.Information, "The log level to use when logging messages to the main output.");
             logLevelOption.AddAlias("--ll");
 
@@ -81,6 +90,7 @@ static async Task Main(string[] args)
                 versionOption,
                 formatOption,
                 terseOutputOption,
+                settingsFileOption,
                 logLevelOption,               
                 filterByOperationIdsOption,
                 filterByTagsOption,
@@ -99,6 +109,7 @@ static async Task Main(string[] args)
                 VersionOption = versionOption,
                 FormatOption = formatOption,
                 TerseOutputOption = terseOutputOption,
+                SettingsFileOption = settingsFileOption,
                 LogLevelOption = logLevelOption,
                 FilterByOperationIdsOption = filterByOperationIdsOption,
                 FilterByTagsOption = filterByTagsOption,

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

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.4.4-preview1</Version>
+        <Version>1.4.4</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs

@@ -105,11 +105,12 @@ public OpenApiReference ConvertToOpenApiReference(
                         catch (OpenApiException ex)
                         {
                             Diagnostic.Errors.Add(new OpenApiError(ex));
-                            return null;
                         }
                     }
                     // Where fragments point into a non-OpenAPI document, the id will be the complete fragment identifier
                     string id = segments[1];
+                    var openApiReference = new OpenApiReference();
+
                     // $ref: externalSource.yaml#/Pet
                     if (id.StartsWith("/components/"))
                     {
@@ -128,13 +129,16 @@ public OpenApiReference ConvertToOpenApiReference(
                         }
                         id = localSegments[3];
                     }
-
-                    return new OpenApiReference
+                    else
                     {
-                        ExternalResource = segments[0],
-                        Type = type,
-                        Id = id
-                    };
+                        openApiReference.IsFragrament = true;
+                    }
+
+                    openApiReference.ExternalResource = segments[0];
+                    openApiReference.Type = type;
+                    openApiReference.Id = id;
+
+                    return openApiReference;
                 }
             }
 

src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj

@@ -1,16 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net6.0-windows</TargetFramework>
+    <TargetFramework>net7.0-windows</TargetFramework>
     <OutputType>WinExe</OutputType>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <UseWPF>true</UseWPF>
     <ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.346202">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.Windows.Compatibility" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Windows.Compatibility" Version="7.0.0" />
   </ItemGroup>
   <ItemGroup>
     <Resource Include="Themes\Metro\HowToApplyTheme.txt" />

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -11,7 +11,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.4.4-preview1</Version>
+        <Version>1.4.4</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi/Models/OpenApiReference.cs

@@ -45,6 +45,11 @@ public class OpenApiReference : IOpenApiSerializable
         /// </summary>
         public bool IsLocal => ExternalResource == null;
 
+        /// <summary>
+        /// Gets a flag indicating whether a file is a valid OpenAPI document or a fragment
+        /// </summary>
+        public bool IsFragrament = false;
+
         /// <summary>
         /// The OpenApiDocument that is hosting the OpenApiReference instance. This is used to enable dereferencing the reference.
         /// </summary>
@@ -196,7 +201,12 @@ private string GetExternalReferenceV3()
         {
             if (Id != null)
             {
-                    return ExternalResource + "#/components/" + Type.GetDisplayName() + "/"+ Id;
+                if (IsFragrament)
+                {
+                    return ExternalResource + "#" + Id;
+                }
+
+                return ExternalResource + "#/components/" + Type.GetDisplayName() + "/"+ Id;
             }
 
             return ExternalResource;