Merge pull request #1131 from json-api-dotnet/small-fixes

Bart Koelman · web-flow · commit c2cf07239790 · 2021-12-21T11:10:34.000+01:00
Various small corrections
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,4 +7,3 @@ Closes #{ISSUE_NUMBER}
 - [ ] Complies with our [contributing guidelines](./.github/CONTRIBUTING.md)
 - [ ] Adapted tests
 - [ ] Documentation updated
-- [ ] Created issue to update [Templates](https://github.com/json-api-dotnet/Templates/issues/new): {ISSUE_NUMBER}
diff --git a/src/JsonApiDotNetCore/Configuration/TypeLocator.cs b/src/JsonApiDotNetCore/Configuration/TypeLocator.cs
@@ -89,7 +89,7 @@ internal sealed class TypeLocator
     private static (Type implementationType, Type serviceInterface)? GetContainerRegistrationFromType(Type nextType, Type unboundInterface,
         Type[] interfaceTypeArguments)
     {
-        if (!nextType.IsNested)
+        if (!nextType.IsNested && !nextType.IsAbstract && !nextType.IsInterface)
         {
             foreach (Type nextConstructedInterface in nextType.GetInterfaces().Where(type => type.IsGenericType))
             {
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/HostingInIIS/HostingStartup.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/HostingInIIS/HostingStartup.cs
@@ -1,9 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Hosting;
 using Microsoft.EntityFrameworkCore;
-using Microsoft.Extensions.Logging;
 using TestBuildingBlocks;
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.HostingInIIS;
@@ -20,10 +18,10 @@ protected override void SetJsonApiOptions(JsonApiOptions options)
         options.IncludeTotalResourceCount = true;
     }
 
-    public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)
+    public override void Configure(IApplicationBuilder app)
     {
         app.UsePathBase("/iis-application-virtual-directory");
 
-        base.Configure(app, environment, loggerFactory);
+        base.Configure(app);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/DuplicateResourceControllerTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/DuplicateResourceControllerTests.cs
@@ -22,9 +22,4 @@ public void Fails_at_startup_when_multiple_controllers_exist_for_same_resource_t
         // Assert
         action.Should().ThrowExactly<InvalidConfigurationException>().WithMessage("Multiple controllers found for resource type 'knownResources'.");
     }
-
-    public override void Dispose()
-    {
-        // Prevents crash when test cleanup tries to access lazily constructed Factory.
-    }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/NonJsonApiControllerTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/NonJsonApiControllerTests.cs
@@ -23,10 +23,10 @@ public async Task Get_skips_middleware_and_formatters()
         // Arrange
         using var request = new HttpRequestMessage(HttpMethod.Get, "/NonJsonApi");
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
@@ -52,10 +52,10 @@ public async Task Post_skips_middleware_and_formatters()
             }
         };
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
@@ -72,10 +72,10 @@ public async Task Post_skips_error_handler()
         // Arrange
         using var request = new HttpRequestMessage(HttpMethod.Post, "/NonJsonApi");
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.BadRequest);
@@ -101,10 +101,10 @@ public async Task Put_skips_middleware_and_formatters()
             }
         };
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
@@ -121,10 +121,10 @@ public async Task Patch_skips_middleware_and_formatters()
         // Arrange
         using var request = new HttpRequestMessage(HttpMethod.Patch, "/NonJsonApi?name=Janice");
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
@@ -141,10 +141,10 @@ public async Task Delete_skips_middleware_and_formatters()
         // Arrange
         using var request = new HttpRequestMessage(HttpMethod.Delete, "/NonJsonApi");
 
-        HttpClient client = _testContext.Factory.CreateClient();
+        using HttpClient client = _testContext.Factory.CreateClient();
 
         // Act
-        HttpResponseMessage httpResponse = await client.SendAsync(request);
+        using HttpResponseMessage httpResponse = await client.SendAsync(request);
 
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/UnknownResourceControllerTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/NonJsonApiControllers/UnknownResourceControllerTests.cs
@@ -22,9 +22,4 @@ public void Fails_at_startup_when_using_controller_for_resource_type_that_is_not
         action.Should().ThrowExactly<InvalidConfigurationException>().WithMessage($"Controller '{typeof(UnknownResourcesController)}' " +
             $"depends on resource type '{typeof(UnknownResource)}', which does not exist in the resource graph.");
     }
-
-    public override void Dispose()
-    {
-        // Prevents crash when test cleanup tries to access lazily constructed Factory.
-    }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Blog.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Blog.cs
@@ -17,6 +17,8 @@ public sealed class Blog : Identifiable<int>
     [Attr(Capabilities = AttrCapabilities.All & ~(AttrCapabilities.AllowCreate | AttrCapabilities.AllowChange))]
     public bool ShowAdvertisements => PlatformName.EndsWith("(using free account)", StringComparison.Ordinal);
 
+    public bool IsPublished { get; set; }
+
     [HasMany]
     public IList<BlogPost> Posts { get; set; } = new List<BlogPost>();
 
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDataTypeTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDataTypeTests.cs
@@ -26,10 +26,9 @@ public FilterDataTypeTests(IntegrationTestContext<TestableStartup<FilterDbContex
         var options = (JsonApiOptions)testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();
         options.EnableLegacyFilterNotation = false;
 
-        if (!options.SerializerOptions.Converters.Any(converter => converter is JsonStringEnumMemberConverter))
+        if (!options.SerializerOptions.Converters.Any(converter => converter is JsonStringEnumConverter))
         {
-            options.SerializerOptions.Converters.Add(new JsonStringEnumMemberConverter());
-            options.SerializerOptions.Converters.Add(new JsonTimeSpanConverter());
+            options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
         }
     }
 
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/LabelColor.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/LabelColor.cs
@@ -4,7 +4,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-[JsonConverter(typeof(JsonStringEnumMemberConverter))]
+[JsonConverter(typeof(JsonStringEnumConverter))]
 public enum LabelColor
 {
     Red,
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/SparseFieldSets/SparseFieldSetTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/SparseFieldSets/SparseFieldSetTests.cs
@@ -749,6 +749,7 @@ public async Task Retrieves_all_properties_when_fieldset_contains_readonly_attri
         store.Clear();
 
         Blog blog = _fakers.Blog.Generate();
+        blog.IsPublished = true;
 
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
@@ -771,7 +772,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         responseDocument.Data.SingleValue.Relationships.Should().BeNull();
 
         var blogCaptured = (Blog)store.Resources.Should().ContainSingle(resource => resource is Blog).And.Subject.Single();
-        blogCaptured.ShowAdvertisements.Should().Be(blogCaptured.ShowAdvertisements);
+        blogCaptured.ShowAdvertisements.Should().Be(blog.ShowAdvertisements);
+        blogCaptured.IsPublished.Should().Be(blog.IsPublished);
         blogCaptured.Title.Should().Be(blog.Title);
     }
 
@@ -817,7 +819,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         var postCaptured = (BlogPost)store.Resources.Should().ContainSingle(resource => resource is BlogPost).And.Subject.Single();
         postCaptured.Id.Should().Be(post.Id);
         postCaptured.Caption.Should().Be(post.Caption);
-        postCaptured.Url.Should().Be(postCaptured.Url);
+        postCaptured.Url.Should().Be(post.Url);
     }
 
     [Fact]
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/Updating/Relationships/UpdateToOneRelationshipTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/Updating/Relationships/UpdateToOneRelationshipTests.cs
@@ -168,6 +168,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         // Act
         (HttpResponseMessage httpResponse, string responseDocument) = await _testContext.ExecutePatchAsync<string>(route, requestBody);
 
+        // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.NoContent);
 
         responseDocument.Should().BeEmpty();
@@ -222,6 +223,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         // Act
         (HttpResponseMessage httpResponse, string responseDocument) = await _testContext.ExecutePatchAsync<string>(route, requestBody);
 
+        // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.NoContent);
 
         responseDocument.Should().BeEmpty();
@@ -760,6 +762,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.NoContent);
 
+        // Assert
         responseDocument.Should().BeEmpty();
 
         await _testContext.RunOnDatabaseAsync(async dbContext =>
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/Updating/Resources/UpdateToOneRelationshipTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/Updating/Resources/UpdateToOneRelationshipTests.cs
@@ -114,6 +114,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         // Act
         (HttpResponseMessage httpResponse, string responseDocument) = await _testContext.ExecutePatchAsync<string>(route, requestBody);
 
+        // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.NoContent);
 
         responseDocument.Should().BeEmpty();
@@ -283,6 +284,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         // Act
         (HttpResponseMessage httpResponse, Document responseDocument) = await _testContext.ExecutePatchAsync<Document>(route, requestBody);
 
+        // Assert
         httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
         responseDocument.Data.SingleValue.ShouldNotBeNull();
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/WorkItemPriority.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/WorkItemPriority.cs
@@ -4,7 +4,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-[JsonConverter(typeof(JsonStringEnumMemberConverter))]
+[JsonConverter(typeof(JsonStringEnumConverter))]
 public enum WorkItemPriority
 {
     Low,
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs
@@ -331,7 +331,7 @@ public async Task Filter_from_resource_definition_is_applied_on_secondary_endpoi
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
             await dbContext.ClearTableAsync<Planet>();
-            dbContext.Stars.AddRange(star);
+            dbContext.Stars.Add(star);
             await dbContext.SaveChangesAsync();
         });
 
@@ -387,7 +387,7 @@ public async Task Filter_from_resource_definition_is_applied_on_relationship_end
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
             await dbContext.ClearTableAsync<Planet>();
-            dbContext.Stars.AddRange(star);
+            dbContext.Stars.Add(star);
             await dbContext.SaveChangesAsync();
         });
 
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/StarKind.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/StarKind.cs
@@ -4,7 +4,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.ResourceDefinitions.Reading;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-[JsonConverter(typeof(JsonStringEnumMemberConverter))]
+[JsonConverter(typeof(JsonStringEnumConverter))]
 public enum StarKind
 {
     Other,
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Serialization/SerializationTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Serialization/SerializationTests.cs
@@ -1,6 +1,5 @@
 using System.Globalization;
 using System.Net;
-using System.Text.Json.Serialization;
 using FluentAssertions;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Resources;
@@ -34,11 +33,6 @@ public SerializationTests(IntegrationTestContext<TestableStartup<SerializationDb
         options.AllowClientGeneratedIds = true;
         options.IncludeJsonApiVersion = false;
         options.IncludeTotalResourceCount = true;
-
-        if (!options.SerializerOptions.Converters.Any(converter => converter is JsonTimeSpanConverter))
-        {
-            options.SerializerOptions.Converters.Add(new JsonTimeSpanConverter());
-        }
     }
 
     [Fact]
diff --git a/test/JsonApiDotNetCoreTests/JsonApiDotNetCoreTests.csproj b/test/JsonApiDotNetCoreTests/JsonApiDotNetCoreTests.csproj
@@ -17,7 +17,6 @@
 
   <ItemGroup>
     <PackageReference Include="coverlet.collector" Version="$(CoverletVersion)" PrivateAssets="All" />
-    <PackageReference Include="Macross.Json.Extensions" Version="2.0.0" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(AspNetVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="$(EFCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Proxies" Version="$(EFCoreVersion)" />
diff --git a/test/TestBuildingBlocks/HttpResponseMessageExtensions.cs b/test/TestBuildingBlocks/HttpResponseMessageExtensions.cs
@@ -17,8 +17,8 @@ public sealed class HttpResponseMessageAssertions : ReferenceTypeAssertions<Http
     {
         protected override string Identifier => "response";
 
-        public HttpResponseMessageAssertions(HttpResponseMessage instance)
-            : base(instance)
+        public HttpResponseMessageAssertions(HttpResponseMessage subject)
+            : base(subject)
         {
         }
 
diff --git a/test/TestBuildingBlocks/IntegrationTestContext.cs b/test/TestBuildingBlocks/IntegrationTestContext.cs
@@ -103,11 +103,14 @@ private WebApplicationFactory<TStartup> CreateFactory()
         return factoryWithConfiguredContentRoot;
     }
 
-    public virtual void Dispose()
+    public void Dispose()
     {
-        RunOnDatabaseAsync(async dbContext => await dbContext.Database.EnsureDeletedAsync()).Wait();
+        if (_lazyFactory.IsValueCreated)
+        {
+            RunOnDatabaseAsync(async dbContext => await dbContext.Database.EnsureDeletedAsync()).Wait();
 
-        Factory.Dispose();
+            _lazyFactory.Value.Dispose();
+        }
     }
 
     public void ConfigureLogging(Action<ILoggingBuilder> loggingConfiguration)
diff --git a/test/TestBuildingBlocks/TestableStartup.cs b/test/TestBuildingBlocks/TestableStartup.cs
@@ -1,9 +1,7 @@
 using JsonApiDotNetCore.Configuration;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Hosting;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Logging;
 
 namespace TestBuildingBlocks;
 
@@ -24,7 +22,7 @@ protected virtual void SetJsonApiOptions(JsonApiOptions options)
         options.SerializerOptions.WriteIndented = true;
     }
 
-    public virtual void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)
+    public virtual void Configure(IApplicationBuilder app)
     {
         app.UseRouting();
         app.UseJsonApi();

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ internal sealed class TypeLocator`
`89`	`89`	`private static (Type implementationType, Type serviceInterface)? GetContainerRegistrationFromType(Type nextType, Type unboundInterface,`
`90`	`90`	`Type[] interfaceTypeArguments)`
`91`	`91`	`{`
`92`		`- if (!nextType.IsNested)`
	`92`	`+ if (!nextType.IsNested && !nextType.IsAbstract && !nextType.IsInterface)`
`93`	`93`	`{`
`94`	`94`	`foreach (Type nextConstructedInterface in nextType.GetInterfaces().Where(type => type.IsGenericType))`
`95`	`95`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,7 @@`
`1`	`1`	`using JetBrains.Annotations;`
`2`	`2`	`using JsonApiDotNetCore.Configuration;`
`3`	`3`	`using Microsoft.AspNetCore.Builder;`
`4`		`-using Microsoft.AspNetCore.Hosting;`
`5`	`4`	`using Microsoft.EntityFrameworkCore;`
`6`		`-using Microsoft.Extensions.Logging;`
`7`	`5`	`using TestBuildingBlocks;`
`8`	`6`
`9`	`7`	`namespace JsonApiDotNetCoreTests.IntegrationTests.HostingInIIS;`
`@@ -20,10 +18,10 @@ protected override void SetJsonApiOptions(JsonApiOptions options)`
`20`	`18`	`options.IncludeTotalResourceCount = true;`
`21`	`19`	`}`
`22`	`20`
`23`		`- public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)`
	`21`	`+ public override void Configure(IApplicationBuilder app)`
`24`	`22`	`{`
`25`	`23`	`app.UsePathBase("/iis-application-virtual-directory");`
`26`	`24`
`27`		`- base.Configure(app, environment, loggerFactory);`
	`25`	`+ base.Configure(app);`
`28`	`26`	`}`
`29`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,4 @@ public void Fails_at_startup_when_multiple_controllers_exist_for_same_resource_t`
`22`	`22`	`// Assert`
`23`	`23`	`action.Should().ThrowExactly<InvalidConfigurationException>().WithMessage("Multiple controllers found for resource type 'knownResources'.");`
`24`	`24`	`}`
`25`		`-`
`26`		`- public override void Dispose()`
`27`		`- {`
`28`		`- // Prevents crash when test cleanup tries to access lazily constructed Factory.`
`29`		`- }`
`30`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,9 @@ public FilterDataTypeTests(IntegrationTestContext<TestableStartup<FilterDbContex`
`26`	`26`	`var options = (JsonApiOptions)testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();`
`27`	`27`	`options.EnableLegacyFilterNotation = false;`
`28`	`28`
`29`		`- if (!options.SerializerOptions.Converters.Any(converter => converter is JsonStringEnumMemberConverter))`
	`29`	`+ if (!options.SerializerOptions.Converters.Any(converter => converter is JsonStringEnumConverter))`
`30`	`30`	`{`
`31`		`- options.SerializerOptions.Converters.Add(new JsonStringEnumMemberConverter());`
`32`		`- options.SerializerOptions.Converters.Add(new JsonTimeSpanConverter());`
	`31`	`+ options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());`
`33`	`32`	`}`
`34`	`33`	`}`
`35`	`34`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`namespace JsonApiDotNetCoreTests.IntegrationTests.QueryStrings;`
`5`	`5`
`6`	`6`	`[UsedImplicitly(ImplicitUseTargetFlags.Members)]`
`7`		`-[JsonConverter(typeof(JsonStringEnumMemberConverter))]`
	`7`	`+[JsonConverter(typeof(JsonStringEnumConverter))]`
`8`	`8`	`public enum LabelColor`
`9`	`9`	`{`
`10`	`10`	`Red,`