Validate and update for use with AspNetCore 5.0 #68 (#71)

* Multi-target netcoreapp3.1 and net5.0 frameworks * Fix warnings * Remove global.json for multiple target frameworks
ofpinewood · Dec 14, 2020 · a94f17f · a94f17f
1 parent 01ec7d6
commit a94f17f
Show file tree

Hide file tree

Showing 27 changed files with 169 additions and 79 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -36,6 +36,13 @@ steps:
     packageType: 'sdk'
     version: '3.1.200'
 
+# https://dotnet.microsoft.com/download/dotnet/5.0
+- task: UseDotNet@2
+  displayName: Install .Net Core 5.0.101
+  inputs:
+    packageType: 'sdk'
+    version: '5.0.101'
+
 - task: DotNetCoreCLI@2
   displayName: Build
   inputs:

diff --git a/global.json b/global.json
diff --git a/samples/Opw.HttpExceptions.AspNetCore.Sample/CustomErrors/CustomErrorResult.cs b/samples/Opw.HttpExceptions.AspNetCore.Sample/CustomErrors/CustomErrorResult.cs
@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Net.Http.Headers;
+using System;
 
 namespace Opw.HttpExceptions.AspNetCore.Sample.CustomErrors
 {
@@ -13,6 +14,8 @@ public class CustomErrorResult : ObjectResult
 
         public CustomErrorResult(CustomError customError) : base(customError)
         {
+            _ = customError ?? throw new ArgumentNullException(nameof(customError));
+
             StatusCode = customError.Status;
             DeclaredType = customError.GetType();
 

diff --git a/samples/Opw.HttpExceptions.AspNetCore.Sample/Opw.HttpExceptions.AspNetCore.Sample.csproj b/samples/Opw.HttpExceptions.AspNetCore.Sample/Opw.HttpExceptions.AspNetCore.Sample.csproj
@@ -1,16 +1,20 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
-    <PropertyGroup>
-        <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
-        <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
-    </PropertyGroup>
+  <PropertyGroup>
+    <TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
+    <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
+  </PropertyGroup>
 
-    <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.2" />
-    </ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.2" />
+  </ItemGroup>
 
-    <ItemGroup>
-        <ProjectReference Include="..\..\src\Opw.HttpExceptions.AspNetCore\Opw.HttpExceptions.AspNetCore.csproj" />
-    </ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="5.0.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Opw.HttpExceptions.AspNetCore\Opw.HttpExceptions.AspNetCore.csproj" />
+  </ItemGroup>
 
 </Project>
diff --git a/samples/Opw.HttpExceptions.AspNetCore.Sample/Startup.cs b/samples/Opw.HttpExceptions.AspNetCore.Sample/Startup.cs
@@ -31,7 +31,8 @@ public void ConfigureServices(IServiceCollection services)
                 // This is a simplified version of the default behavior; only map exceptions for 4xx and 5xx responses.
                 options.IsExceptionResponse = context => (context.Response.StatusCode >= 400 && context.Response.StatusCode < 600);
                 // Only log the when it has a status code of 500 or higher, or when it not is a HttpException.
-                options.ShouldLogException = exception => {
+                options.ShouldLogException = exception =>
+                {
                     if ((exception is HttpExceptionBase httpException && (int)httpException.StatusCode >= 500) || !(exception is HttpExceptionBase))
                         return true;
                     return false;

diff --git a/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsMiddleware.cs b/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsMiddleware.cs
@@ -41,6 +41,8 @@ public HttpExceptionsMiddleware(
         /// </summary>
         public async Task Invoke(HttpContext context)
         {
+            _ = context ?? throw new ArgumentNullException(nameof(context));
+
             try
             {
                 await _next(context);

diff --git a/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsOptionsExtensions.cs b/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsOptionsExtensions.cs
@@ -19,6 +19,8 @@ public static void ExceptionMapper<TException, TExceptionMapper>(this HttpExcept
             where TException : Exception
             where TExceptionMapper : IExceptionMapper
         {
+            _ = options ?? throw new ArgumentNullException(nameof(options));
+
             if (options.ExceptionMapperDescriptors.ContainsKey(typeof(TException)))
             {
                 options.ExceptionMapperDescriptors[typeof(TException)] = new ExceptionMapperDescriptor
@@ -46,6 +48,8 @@ public static void ExceptionMapper<TException, TExceptionMapper>(this HttpExcept
         public static void HttpResponseMapper<THttpResponseMapper>(this HttpExceptionsOptions options, int status = int.MinValue, params object[] arguments)
             where THttpResponseMapper : IHttpResponseMapper
         {
+            _ = options ?? throw new ArgumentNullException(nameof(options));
+
             if (options.HttpResponseMapperDescriptors.ContainsKey(status))
             {
                 options.HttpResponseMapperDescriptors[status] = new HttpResponseMapperDescriptor

diff --git a/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsOptionsSetup.cs b/src/Opw.HttpExceptions.AspNetCore/HttpExceptionsOptionsSetup.cs
@@ -30,6 +30,8 @@ public HttpExceptionsOptionsSetup(IServiceProvider serviceProvider)
         /// <param name="options">The options instance to configure.</param>
         public void Configure(HttpExceptionsOptions options)
         {
+            _ = options ?? throw new ArgumentNullException(nameof(options));
+
             if (options.IncludeExceptionDetails == null)
                 options.IncludeExceptionDetails = IncludeExceptionDetails;
 

diff --git a/src/Opw.HttpExceptions.AspNetCore/Mappers/ProblemDetailsExceptionMapper.cs b/src/Opw.HttpExceptions.AspNetCore/Mappers/ProblemDetailsExceptionMapper.cs
@@ -43,6 +43,8 @@ public virtual bool CanMap(Type type)
         /// <param name="actionResult">A representation of the exception as a ProblemDetailsResult.</param>
         public virtual bool TryMap(Exception exception, HttpContext context, out IStatusCodeActionResult actionResult)
         {
+            _ = exception ?? throw new ArgumentNullException(nameof(exception));
+
             actionResult = default;
 
             if (!CanMap(exception.GetType()))
@@ -108,6 +110,9 @@ public virtual IStatusCodeActionResult Map(Exception exception, HttpContext cont
         /// <returns>Returns either the request path, the exception help link or null.</returns>
         protected virtual string MapInstance(TException exception, HttpContext context)
         {
+            _ = exception ?? throw new ArgumentNullException(nameof(exception));
+            _ = context ?? throw new ArgumentNullException(nameof(context));
+
             if (Options.Value.ExceptionInstanceMapping != null)
             {
                 string instance = Options.Value.ExceptionInstanceMapping(exception);
@@ -157,6 +162,9 @@ protected virtual int MapStatus(TException exception, HttpContext context)
         /// <returns>Returns the Exception type name without the "Exception" suffix.</returns>
         protected virtual string MapTitle(TException exception, HttpContext context)
         {
+            _ = exception ?? throw new ArgumentNullException(nameof(exception));
+            _ = context ?? throw new ArgumentNullException(nameof(context));
+
             string name = null;
 
             if (Options.Value.ExceptionTitleMapping != null)
@@ -182,6 +190,8 @@ protected virtual string MapTitle(TException exception, HttpContext context)
         /// <returns>Returns the Exception message.</returns>
         protected virtual string MapDetail(TException exception, HttpContext context)
         {
+            _ = exception ?? throw new ArgumentNullException(nameof(exception));
+
             if (Options.Value.ExceptionDetailMapping != null)
             {
                 string detail = Options.Value.ExceptionDetailMapping(exception);
@@ -200,6 +210,9 @@ protected virtual string MapDetail(TException exception, HttpContext context)
         /// <returns>Returns the Exception.HelpLink or an URI with the Exception type name ("error:[Type:slug]").</returns>
         protected virtual string MapType(TException exception, HttpContext context)
         {
+            _ = exception ?? throw new ArgumentNullException(nameof(exception));
+            _ = context ?? throw new ArgumentNullException(nameof(context));
+
             Uri uri = null;
 
             if (Options.Value.ExceptionTypeMapping != null)

diff --git a/src/Opw.HttpExceptions.AspNetCore/Mappers/ProblemDetailsHttpResponseMapper.cs b/src/Opw.HttpExceptions.AspNetCore/Mappers/ProblemDetailsHttpResponseMapper.cs
@@ -46,6 +46,8 @@ public bool CanMap(int status)
         /// <param name="actionResult">A representation of the HTTP response error as a ProblemDetailsResult.</param>
         public bool TryMap(HttpResponse response, out IStatusCodeActionResult actionResult)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             actionResult = default;
 
             if (!CanMap(response.StatusCode))
@@ -69,6 +71,8 @@ public bool TryMap(HttpResponse response, out IStatusCodeActionResult actionResu
         /// <returns>A representation of the response error as a ProblemDetailsResult.</returns>
         public IStatusCodeActionResult Map(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             if (!CanMap(response.StatusCode))
                 throw new ArgumentOutOfRangeException(nameof(response), response, $"HttpResponse status is not {Status}.");
 
@@ -91,6 +95,8 @@ public IStatusCodeActionResult Map(HttpResponse response)
         /// <returns>Returns the request path, or null.</returns>
         protected virtual string MapInstance(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             if (Options.Value.HttpContextInstanceMapping != null)
             {
                 string instance = Options.Value.HttpContextInstanceMapping(response.HttpContext);
@@ -111,6 +117,8 @@ protected virtual string MapInstance(HttpResponse response)
         /// <returns>Returns the status of the response.</returns>
         protected virtual int MapStatus(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             if (Options.Value.HttpContextStatusMapping != null)
             {
                 int? status = Options.Value.HttpContextStatusMapping(response.HttpContext);
@@ -128,6 +136,8 @@ protected virtual int MapStatus(HttpResponse response)
         /// <returns>Returns the HTTP status name or the status code.</returns>
         protected virtual string MapTitle(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             string status = null;
 
             if (Options.Value.HttpContextTitleMapping != null)
@@ -154,6 +164,8 @@ protected virtual string MapTitle(HttpResponse response)
         /// <returns>Returns the HTTP status name or the status code.</returns>
         protected virtual string MapDetail(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             if (Options.Value.HttpContextDetailMapping != null)
             {
                 string detail = Options.Value.HttpContextDetailMapping(response.HttpContext);
@@ -171,6 +183,8 @@ protected virtual string MapDetail(HttpResponse response)
         /// <returns>Returns a status code information link (https://tools.ietf.org/html/rfc7231) or the URI with the HTTP status name ("error:[status:slug]").</returns>
         protected virtual string MapType(HttpResponse response)
         {
+            _ = response ?? throw new ArgumentNullException(nameof(response));
+
             Uri uri = null;
 
             if (Options.Value.HttpContextTypeMapping != null)

diff --git a/src/Opw.HttpExceptions.AspNetCore/MvcBuilderExtensions.cs b/src/Opw.HttpExceptions.AspNetCore/MvcBuilderExtensions.cs
@@ -17,6 +17,8 @@ public static class MvcBuilderExtensions
         /// <param name="configureOptions">An action used to configure the provided options.</param>
         public static IMvcCoreBuilder AddHttpExceptions(this IMvcCoreBuilder builder, Action<HttpExceptionsOptions> configureOptions = null)
         {
+            _ = builder ?? throw new ArgumentNullException(nameof(builder));
+
             builder.Services.AddHttpExceptions(configureOptions);
 
             var options = builder.Services.BuildServiceProvider().GetRequiredService<IOptions<HttpExceptionsOptions>>();
@@ -32,6 +34,8 @@ public static IMvcCoreBuilder AddHttpExceptions(this IMvcCoreBuilder builder, Ac
         /// <param name="configureOptions">An action used to configure the provided options.</param>
         public static IMvcBuilder AddHttpExceptions(this IMvcBuilder builder, Action<HttpExceptionsOptions> configureOptions = null)
         {
+            _ = builder ?? throw new ArgumentNullException(nameof(builder));
+
             builder.Services.AddHttpExceptions(configureOptions);
 
             var options = builder.Services.BuildServiceProvider().GetRequiredService<IOptions<HttpExceptionsOptions>>();

diff --git a/src/Opw.HttpExceptions.AspNetCore/Opw.HttpExceptions.AspNetCore.csproj b/src/Opw.HttpExceptions.AspNetCore/Opw.HttpExceptions.AspNetCore.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
+    <TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
     <RootNamespace>Opw.HttpExceptions.AspNetCore</RootNamespace>
     <Description>Middleware and extensions for returning exceptions over HTTP, e.g. as ASP.NET Core Problem Details (RFC7807).</Description>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

diff --git a/src/Opw.HttpExceptions.AspNetCore/ProblemDetailsExtensions.cs b/src/Opw.HttpExceptions.AspNetCore/ProblemDetailsExtensions.cs
@@ -1,7 +1,6 @@
 using Microsoft.AspNetCore.Mvc;
-using Opw.HttpExceptions.AspNetCore.Serialization;
+using System;
 using System.Collections.Generic;
-using System.Text;
 using System.Text.Json;
 
 namespace Opw.HttpExceptions.AspNetCore
@@ -19,6 +18,8 @@ public static class ProblemDetailsExtensions
         /// <returns>true if the ProblemDetails contains an exception; otherwise, false.</returns>
         public static bool TryGetExceptionDetails(this ProblemDetails problemDetails, out SerializableException exception)
         {
+            _ = problemDetails ?? throw new ArgumentNullException(nameof(problemDetails));
+
             if (problemDetails.Extensions.TryGetValue(nameof(ProblemDetailsExtensionMembers.ExceptionDetails).ToCamelCase(), out var value))
                 return value.TryParseSerializableException(out exception);
 
@@ -56,6 +57,8 @@ public static bool TryParseSerializableException(this object value, out Serializ
         /// <returns>true if the ProblemDetails contains errors dictionary; otherwise, false.</returns>
         public static bool TryGetErrors(this ProblemDetails problemDetails, out IDictionary<string, object[]> errors)
         {
+            _ = problemDetails ?? throw new ArgumentNullException(nameof(problemDetails));
+
             if (problemDetails.Extensions.TryGetValue(nameof(ProblemDetailsExtensionMembers.Errors).ToCamelCase(), out var value))
                 return value.TryParseErrors(out errors);
 

diff --git a/src/Opw.HttpExceptions.AspNetCore/ProblemDetailsResult.cs b/src/Opw.HttpExceptions.AspNetCore/ProblemDetailsResult.cs
@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Net.Http.Headers;
+using System;
 
 namespace Opw.HttpExceptions.AspNetCore
 {
@@ -23,6 +24,8 @@ public class ProblemDetailsResult : ObjectResult
         /// <param name="problemDetails">The ProblemDetails</param>
         public ProblemDetailsResult(ProblemDetails problemDetails) : base(problemDetails)
         {
+            _ = problemDetails ?? throw new ArgumentNullException(nameof(problemDetails));
+
             StatusCode = problemDetails.Status;
             DeclaredType = problemDetails.GetType();
 

diff --git a/src/Opw.HttpExceptions.AspNetCore/Serialization/SerializableExceptionJsonConverter.cs b/src/Opw.HttpExceptions.AspNetCore/Serialization/SerializableExceptionJsonConverter.cs
@@ -26,7 +26,7 @@ public override SerializableException Read(ref Utf8JsonReader reader, Type typeT
 
             while (reader.Read() && reader.TokenType != JsonTokenType.EndObject)
             {
-                ReadValue(ref reader, serializableException, options);
+                ReadValue(ref reader, serializableException);
             }
 
             if (reader.TokenType != JsonTokenType.EndObject)
@@ -42,7 +42,7 @@ public override void Write(Utf8JsonWriter writer, SerializableException value, J
             throw new NotImplementedException();
         }
 
-        internal static void ReadValue(ref Utf8JsonReader reader, SerializableException value, JsonSerializerOptions options)
+        internal static void ReadValue(ref Utf8JsonReader reader, SerializableException value)
         {
             if (TryReadStringProperty(ref reader, Type, out var propertyValue))
             {

diff --git a/tests/Opw.HttpExceptions.AspNetCore.IntegrationTests/DefaultApiBehaviorTests.cs b/tests/Opw.HttpExceptions.AspNetCore.IntegrationTests/DefaultApiBehaviorTests.cs
@@ -1,5 +1,6 @@
 using FluentAssertions;
 using Opw.HttpExceptions.AspNetCore._Test;
+using System;
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
@@ -14,6 +15,8 @@ public class DefaultApiBehaviorTests : IClassFixture<TestWebApplicationFactory<D
 
         public DefaultApiBehaviorTests(TestWebApplicationFactory<DefaultApiBehaviorStartup> factory)
         {
+            _ = factory ?? throw new ArgumentNullException(nameof(factory));
+
             _client = factory.CreateClient();
         }
 

diff --git a/...eptions.AspNetCore.IntegrationTests/Opw.HttpExceptions.AspNetCore.IntegrationTests.csproj b/...eptions.AspNetCore.IntegrationTests/Opw.HttpExceptions.AspNetCore.IntegrationTests.csproj
@@ -1,33 +1,43 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <PropertyGroup>
-        <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
-        <IsPackable>false</IsPackable>
-        <RootNamespace>Opw.HttpExceptions.AspNetCore</RootNamespace>
-    </PropertyGroup>
+  <PropertyGroup>
+    <TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
+    <IsPackable>false</IsPackable>
+    <RootNamespace>Opw.HttpExceptions.AspNetCore</RootNamespace>
+  </PropertyGroup>
 
-    <ItemGroup>
-        <PackageReference Include="coverlet.msbuild" Version="2.9.0">
-          <PrivateAssets>all</PrivateAssets>
-          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-        </PackageReference>
-        <PackageReference Include="FluentAssertions" Version="5.10.3" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
-        <PackageReference Include="xunit" Version="2.4.1" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
-          <PrivateAssets>all</PrivateAssets>
-          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-        </PackageReference>
-    </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="coverlet.msbuild" Version="2.9.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="FluentAssertions" Version="5.10.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 
-    <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.2" />
-        <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="3.1.2" />
-    </ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.2" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="3.1.2" />
+  </ItemGroup>
 
-    <ItemGroup>
-        <ProjectReference Include="..\..\src\Opw.HttpExceptions.AspNetCore\Opw.HttpExceptions.AspNetCore.csproj" />
-        <ProjectReference Include="..\Opw.HttpExceptions.AspNetCore.Tests\Opw.HttpExceptions.AspNetCore.Tests.csproj" />
-    </ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="5.0.1" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="5.0.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.2" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="3.1.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Opw.HttpExceptions.AspNetCore\Opw.HttpExceptions.AspNetCore.csproj" />
+    <ProjectReference Include="..\Opw.HttpExceptions.AspNetCore.Tests\Opw.HttpExceptions.AspNetCore.Tests.csproj" />
+  </ItemGroup>
 
 </Project>