Skip to content

Commit a82b00f

Browse files
baywetbaywet
authored
Merge pull request #1344 from microsoft/feature/NRT
enables NRT, analysis all and treat warning as errors on hidi
2 parents 6933ada + fa032dd commit a82b00f

28 files changed

+260
-174
lines changed

‎.azure-pipelines/ci-build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ stages:
216216
displayName: publish Hidi as executable
217217
inputs:
218218
command: 'publish'
219-
arguments: -c Release --runtime win-x64 /p:PublishSingleFile=true --self-contained --output $(Build.ArtifactStagingDirectory)/Microsoft.OpenApi.Hidi-v$(hidiversion) -p:PublishTrimmed=true
219+
arguments: -c Release --runtime win-x64 /p:PublishSingleFile=true --self-contained --output $(Build.ArtifactStagingDirectory)/Microsoft.OpenApi.Hidi-v$(hidiversion)
220220
projects: 'src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj'
221221
publishWebProjects: False
222222
zipAfterPublish: false

‎.vscode/settings.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,9 @@
33
"activityBar.background": "#03323C",
44
"titleBar.activeBackground": "#054754",
55
"titleBar.activeForeground": "#F0FCFE"
6-
}
6+
},
7+
"cSpell.words": [
8+
"csdl",
9+
"Hidi"
10+
]
711
}

‎src/Microsoft.OpenApi.Hidi/Extensions/OpenApiExtensibleExtensions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ internal static class OpenApiExtensibleExtensions
1212
/// <param name="extensions">A dictionary of <see cref="IOpenApiExtension"/>.</param>
1313
/// <param name="extensionKey">The key corresponding to the <see cref="IOpenApiExtension"/>.</param>
1414
/// <returns>A <see cref="string"/> value matching the provided extensionKey. Return null when extensionKey is not found. </returns>
15-
public static string GetExtension(this IDictionary<string, IOpenApiExtension> extensions, string extensionKey)
15+
internal static string GetExtension(this IDictionary<string, IOpenApiExtension> extensions, string extensionKey)
1616
{
1717
if (extensions.TryGetValue(extensionKey, out var value) && value is OpenApiString castValue)
1818
{
1919
return castValue.Value;
2020
}
21-
return default;
21+
return string.Empty;
2222
}
2323
}
2424
}

‎src/Microsoft.OpenApi.Hidi/Extensions/StringExtensions.cs‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ internal static class StringExtensions
1212
/// <summary>
1313
/// Checks if the specified searchValue is equal to the target string based on the specified <see cref="StringComparison"/>.
1414
/// </summary>
15-
/// <param name="target">The target string to commpare to.</param>
15+
/// <param name="target">The target string to compare to.</param>
1616
/// <param name="searchValue">The search string to seek.</param>
1717
/// <param name="comparison">The <see cref="StringComparison"/> to use. This defaults to <see cref="StringComparison.OrdinalIgnoreCase"/>.</param>
1818
/// <returns>true if the searchValue parameter occurs within this string; otherwise, false.</returns>
19-
public static bool IsEquals(this string target, string searchValue, StringComparison comparison = StringComparison.OrdinalIgnoreCase)
19+
public static bool IsEquals(this string? target, string? searchValue, StringComparison comparison = StringComparison.OrdinalIgnoreCase)
2020
{
21-
if (string.IsNullOrWhiteSpace(target) || string.IsNullOrWhiteSpace(searchValue))
21+
if (string.IsNullOrWhiteSpace(target) && string.IsNullOrWhiteSpace(searchValue))
22+
{
23+
return true;
24+
} else if (string.IsNullOrWhiteSpace(target))
2225
{
2326
return false;
2427
}

‎src/Microsoft.OpenApi.Hidi/Formatters/PowerShellFormatter.cs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public override void Visit(OpenApiOperation operation)
8888
private static string ResolveVerbSegmentInOpertationId(string operationId)
8989
{
9090
var charPos = operationId.LastIndexOf('.', operationId.Length - 1);
91-
if (operationId.Contains('_') || charPos < 0)
91+
if (operationId.Contains('_', StringComparison.OrdinalIgnoreCase) || charPos < 0)
9292
return operationId;
9393
var newOperationId = new StringBuilder(operationId);
9494
newOperationId[charPos] = '_';
@@ -99,7 +99,7 @@ private static string ResolveVerbSegmentInOpertationId(string operationId)
9999
private static string ResolvePutOperationId(string operationId)
100100
{
101101
return operationId.Contains(DefaultPutPrefix, StringComparison.OrdinalIgnoreCase) ?
102-
operationId.Replace(DefaultPutPrefix, PowerShellPutPrefix) : operationId;
102+
operationId.Replace(DefaultPutPrefix, PowerShellPutPrefix, StringComparison.Ordinal) : operationId;
103103
}
104104

105105
private static string ResolveByRefOperationId(string operationId)
@@ -191,19 +191,17 @@ private void AddAdditionalPropertiesToSchema(OpenApiSchema schema)
191191

192192
private static void ResolveOneOfSchema(OpenApiSchema schema)
193193
{
194-
if (schema.OneOf?.Any() ?? false)
194+
if (schema.OneOf?.FirstOrDefault() is {} newSchema)
195195
{
196-
var newSchema = schema.OneOf.FirstOrDefault();
197196
schema.OneOf = null;
198197
FlattenSchema(schema, newSchema);
199198
}
200199
}
201200

202201
private static void ResolveAnyOfSchema(OpenApiSchema schema)
203202
{
204-
if (schema.AnyOf?.Any() ?? false)
203+
if (schema.AnyOf?.FirstOrDefault() is {} newSchema)
205204
{
206-
var newSchema = schema.AnyOf.FirstOrDefault();
207205
schema.AnyOf = null;
208206
FlattenSchema(schema, newSchema);
209207
}

‎src/Microsoft.OpenApi.Hidi/Handlers/PluginCommandHandler.cs‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using System.CommandLine.Invocation;
66
using System.Threading;
77
using System.Threading.Tasks;
8+
using Microsoft.Extensions.DependencyInjection;
89
using Microsoft.Extensions.Logging;
910
using Microsoft.OpenApi.Hidi.Options;
1011

@@ -24,26 +25,34 @@ public int Invoke(InvocationContext context)
2425
public async Task<int> InvokeAsync(InvocationContext context)
2526
{
2627
HidiOptions hidiOptions = new HidiOptions(context.ParseResult, CommandOptions);
27-
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
28+
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetRequiredService(typeof(CancellationToken));
2829

2930
using var loggerFactory = Logger.ConfigureLogger(hidiOptions.LogLevel);
3031
var logger = loggerFactory.CreateLogger<PluginCommandHandler>();
3132
try
3233
{
33-
await OpenApiService.PluginManifest(hidiOptions, logger, cancellationToken);
34+
await OpenApiService.PluginManifest(hidiOptions, logger, cancellationToken).ConfigureAwait(false);
3435

3536
return 0;
3637
}
38+
#if RELEASE
39+
#pragma warning disable CA1031 // Do not catch general exception types
40+
#endif
3741
catch (Exception ex)
3842
{
3943
#if DEBUG
4044
logger.LogCritical(ex, "Command failed");
4145
throw; // so debug tools go straight to the source of the exception when attached
4246
#else
47+
#pragma warning disable CA2254
4348
logger.LogCritical(ex.Message);
49+
#pragma warning restore CA2254
4450
return 1;
4551
#endif
4652
}
53+
#if RELEASE
54+
#pragma warning restore CA1031 // Do not catch general exception types
55+
#endif
4756
}
4857
}
4958
}

‎src/Microsoft.OpenApi.Hidi/Handlers/ShowCommandHandler.cs‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using System.CommandLine.Invocation;
66
using System.Threading;
77
using System.Threading.Tasks;
8+
using Microsoft.Extensions.DependencyInjection;
89
using Microsoft.Extensions.Logging;
910
using Microsoft.OpenApi.Hidi.Options;
1011

@@ -24,26 +25,34 @@ public int Invoke(InvocationContext context)
2425
public async Task<int> InvokeAsync(InvocationContext context)
2526
{
2627
HidiOptions hidiOptions = new HidiOptions(context.ParseResult, CommandOptions);
27-
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
28+
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetRequiredService(typeof(CancellationToken));
2829

2930
using var loggerFactory = Logger.ConfigureLogger(hidiOptions.LogLevel);
3031
var logger = loggerFactory.CreateLogger<ShowCommandHandler>();
3132
try
3233
{
33-
await OpenApiService.ShowOpenApiDocument(hidiOptions, logger, cancellationToken);
34+
await OpenApiService.ShowOpenApiDocument(hidiOptions, logger, cancellationToken).ConfigureAwait(false);
3435

3536
return 0;
3637
}
38+
#if RELEASE
39+
#pragma warning disable CA1031 // Do not catch general exception types
40+
#endif
3741
catch (Exception ex)
3842
{
3943
#if DEBUG
4044
logger.LogCritical(ex, "Command failed");
4145
throw; // so debug tools go straight to the source of the exception when attached
4246
#else
47+
#pragma warning disable CA2254
4348
logger.LogCritical( ex.Message);
49+
#pragma warning restore CA2254
4450
return 1;
4551
#endif
4652
}
53+
#if RELEASE
54+
#pragma warning restore CA1031 // Do not catch general exception types
55+
#endif
4756
}
4857
}
4958
}

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using System.CommandLine.Invocation;
66
using System.Threading;
77
using System.Threading.Tasks;
8+
using Microsoft.Extensions.DependencyInjection;
89
using Microsoft.Extensions.Logging;
910
using Microsoft.OpenApi.Hidi.Options;
1011

@@ -24,26 +25,34 @@ public int Invoke(InvocationContext context)
2425
public async Task<int> InvokeAsync(InvocationContext context)
2526
{
2627
HidiOptions hidiOptions = new HidiOptions(context.ParseResult, CommandOptions);
27-
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
28+
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetRequiredService(typeof(CancellationToken));
2829

2930
using var loggerFactory = Logger.ConfigureLogger(hidiOptions.LogLevel);
3031
var logger = loggerFactory.CreateLogger<TransformCommandHandler>();
3132
try
3233
{
33-
await OpenApiService.TransformOpenApiDocument(hidiOptions, logger, cancellationToken);
34+
await OpenApiService.TransformOpenApiDocument(hidiOptions, logger, cancellationToken).ConfigureAwait(false);
3435

3536
return 0;
3637
}
38+
#if RELEASE
39+
#pragma warning disable CA1031 // Do not catch general exception types
40+
#endif
3741
catch (Exception ex)
3842
{
3943
#if DEBUG
4044
logger.LogCritical(ex, "Command failed");
4145
throw; // so debug tools go straight to the source of the exception when attached
4246
#else
47+
#pragma warning disable CA2254
4348
logger.LogCritical( ex.Message);
49+
#pragma warning restore CA2254
4450
return 1;
4551
#endif
4652
}
53+
#if RELEASE
54+
#pragma warning restore CA1031 // Do not catch general exception types
55+
#endif
4756
}
4857
}
4958
}

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

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using System.CommandLine.Invocation;
66
using System.Threading;
77
using System.Threading.Tasks;
8+
using Microsoft.Extensions.DependencyInjection;
89
using Microsoft.Extensions.Logging;
910
using Microsoft.OpenApi.Hidi.Options;
1011

@@ -26,24 +27,33 @@ public int Invoke(InvocationContext context)
2627
public async Task<int> InvokeAsync(InvocationContext context)
2728
{
2829
HidiOptions hidiOptions = new HidiOptions(context.ParseResult, CommandOptions);
29-
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetService(typeof(CancellationToken));
30+
CancellationToken cancellationToken = (CancellationToken)context.BindingContext.GetRequiredService(typeof(CancellationToken));
3031
using var loggerFactory = Logger.ConfigureLogger(hidiOptions.LogLevel);
3132
var logger = loggerFactory.CreateLogger<ValidateCommandHandler>();
3233
try
3334
{
34-
await OpenApiService.ValidateOpenApiDocument(hidiOptions.OpenApi, logger, cancellationToken);
35+
if (hidiOptions.OpenApi is null) throw new InvalidOperationException("OpenApi file is required");
36+
await OpenApiService.ValidateOpenApiDocument(hidiOptions.OpenApi, logger, cancellationToken).ConfigureAwait(false);
3537
return 0;
3638
}
39+
#if RELEASE
40+
#pragma warning disable CA1031 // Do not catch general exception types
41+
#endif
3742
catch (Exception ex)
3843
{
3944
#if DEBUG
4045
logger.LogCritical(ex, "Command failed");
4146
throw; // so debug tools go straight to the source of the exception when attached
4247
#else
43-
logger.LogCritical( ex.Message);
48+
#pragma warning disable CA2254
49+
logger.LogCritical(ex.Message);
50+
#pragma warning restore CA2254
4451
return 1;
4552
#endif
4653
}
54+
#if RELEASE
55+
#pragma warning restore CA1031 // Do not catch general exception types
56+
#endif
4757
}
4858
}
4959
}

‎src/Microsoft.OpenApi.Hidi/Logger.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace Microsoft.OpenApi.Hidi
77
{
8-
public class Logger
8+
public static class Logger
99
{
1010
public static ILoggerFactory ConfigureLogger(LogLevel logLevel)
1111
{

0 commit comments

Comments
 (0)