Merge branch 'vnext' into release/2.0.0

Author: MaggieKimani1

.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

.github/workflows/docker.yml

@@ -6,7 +6,7 @@ on:
     paths: ['src/Microsoft.OpenApi.Hidi/**', '.github/workflows/**']
 env:
   REGISTRY: msgraphprod.azurecr.io
-  IMAGE_NAME: public/hidi
+  IMAGE_NAME: public/openapi/hidi
 jobs:
   push_to_registry:
     environment:
@@ -17,7 +17,7 @@ jobs:
       - name: Check out the repo
         uses: actions/checkout@v3
       - name: Login to GitHub package feed
-        uses: docker/login-action@v2.0.0 
+        uses: docker/login-action@v2.1.0 
         with:
           username: ${{ secrets.ACR_USERNAME }}
           password: ${{ secrets.ACR_PASSWORD }}
@@ -30,13 +30,13 @@ jobs:
         id: getversion
       - name: Push to GitHub Packages - Nightly
         if: ${{ github.ref == 'refs/heads/vnext' }}
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v4.0.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@v3.1.1
+        uses: docker/build-push-action@v4.0.0
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.getversion.outputs.version }}

.github/workflows/sonarcloud.yml

@@ -0,0 +1,78 @@
+name: Sonarcloud
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths-ignore: ['.vscode/**']
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths-ignore: ['.vscode/**']
+
+env:
+  SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+jobs:
+  checksecret:
+    name: check if SONAR_TOKEN is set in github secrets
+    runs-on: ubuntu-latest
+    outputs:
+      is_SONAR_TOKEN_set: ${{ steps.checksecret_job.outputs.is_SONAR_TOKEN_set }}
+    steps:
+      - name: Check whether unity activation requests should be done
+        id: checksecret_job
+        run: |
+            echo "is_SONAR_TOKEN_set=${{ env.SONAR_TOKEN != '' }}" >> $GITHUB_OUTPUT
+  build:
+    needs: [checksecret]
+    if: needs.checksecret.outputs.is_SONAR_TOKEN_set == 'true'
+    name: Build
+    runs-on: windows-latest
+    steps:
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: 11
+      - name: Setup .NET 5 # At the moment the scanner requires dotnet 5 https://www.nuget.org/packages/dotnet-sonarscanner
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 5.0.x
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 7.0.x
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache SonarCloud scanner
+        id: cache-sonar-scanner
+        uses: actions/cache@v3
+        with:
+          path: ./.sonar/scanner
+          key: ${{ runner.os }}-sonar-scanner
+          restore-keys: ${{ runner.os }}-sonar-scanner
+      - name: Install SonarCloud scanner
+        if: steps.cache-sonar-scanner.outputs.cache-hit != 'true'
+        shell: pwsh
+        run: |
+          New-Item -Path ./.sonar/scanner -ItemType Directory
+          dotnet tool update dotnet-sonarscanner --tool-path ./.sonar/scanner
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          CollectCoverage: true
+          CoverletOutputFormat: 'opencover' # https://github.com/microsoft/vstest/issues/4014#issuecomment-1307913682
+        shell: pwsh
+        run: |
+          ./.sonar/scanner/dotnet-sonarscanner begin /k:"microsoft_OpenAPI.NET" /o:"microsoft" /d:sonar.login="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io" /d:sonar.cs.opencover.reportsPaths="test/**/coverage.opencover.xml"
+          dotnet workload restore
+          dotnet build
+          dotnet test Microsoft.OpenApi.sln --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
+          ./.sonar/scanner/dotnet-sonarscanner end /d:sonar.login="${{ secrets.SONAR_TOKEN }}"

.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/ShowCommandHandler.cs

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.CommandLine;
+using System.CommandLine.Invocation;
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.OpenApi.Hidi.Handlers
+{
+    internal class ShowCommandHandler : ICommandHandler
+    {
+        public Option<string> DescriptionOption { get; set; }
+        public Option<FileInfo> OutputOption { get; set; }
+        public Option<LogLevel> LogLevelOption { get; set; }
+        public Option<string> CsdlOption { get; set; }
+        public Option<string> CsdlFilterOption { get; set; }
+
+
+        public int Invoke(InvocationContext context)
+        {
+            return InvokeAsync(context).GetAwaiter().GetResult();
+        }
+        public async Task<int> InvokeAsync(InvocationContext context)
+        {
+            string openapi = context.ParseResult.GetValueForOption(DescriptionOption);
+            FileInfo output = context.ParseResult.GetValueForOption(OutputOption);
+            LogLevel logLevel = context.ParseResult.GetValueForOption(LogLevelOption);
+            string csdlFilter = context.ParseResult.GetValueForOption(CsdlFilterOption);
+            string csdl = context.ParseResult.GetValueForOption(CsdlOption);
+            CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
+
+            using var loggerFactory = Logger.ConfigureLogger(logLevel);
+            var logger = loggerFactory.CreateLogger<OpenApiService>();
+            try
+            {
+                await OpenApiService.ShowOpenApiDocument(openapi, csdl, csdlFilter, output, logger, cancellationToken);
+
+                return 0;
+            }
+            catch (Exception ex)
+            {
+#if DEBUG
+                logger.LogCritical(ex, ex.Message);
+                throw; // so debug tools go straight to the source of the exception when attached
+#else
+                logger.LogCritical( ex.Message);
+                return 1;
+#endif
+            }
+        }
+    }
+}

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

@@ -19,8 +19,10 @@ internal class TransformCommandHandler : ICommandHandler
         public Option<FileInfo> OutputOption { get; set; }
         public Option<bool> CleanOutputOption { get; set; }
         public Option<string?> VersionOption { get; set; }
+        public Option<string?> MetadataVersionOption { 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; }
@@ -40,21 +42,24 @@ public async Task<int> InvokeAsync(InvocationContext context)
             FileInfo output = context.ParseResult.GetValueForOption(OutputOption);
             bool cleanOutput = context.ParseResult.GetValueForOption(CleanOutputOption);
             string? version = context.ParseResult.GetValueForOption(VersionOption);
+            string metadataVersion = context.ParseResult.GetValueForOption(MetadataVersionOption);
             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);
             string filterbyoperationids = context.ParseResult.GetValueForOption(FilterByOperationIdsOption);
             string filterbytags = context.ParseResult.GetValueForOption(FilterByTagsOption);
             string filterbycollection = context.ParseResult.GetValueForOption(FilterByCollectionOption);
+
             CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
 
             using var loggerFactory = Logger.ConfigureLogger(logLevel);
             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, metadataVersion, format, terseOutput, settingsFile, inlineLocal, inlineExternal, filterbyoperationids, filterbytags, filterbycollection, logger, cancellationToken);
 
                 return 0;
             }

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

@@ -30,7 +30,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
             var logger = loggerFactory.CreateLogger<OpenApiService>();
             try
             {
-                await OpenApiService.ValidateOpenApiDocument(openapi, logLevel, cancellationToken);
+                await OpenApiService.ValidateOpenApiDocument(openapi, logger, cancellationToken);
                 return 0;
             }
             catch (Exception ex)