Refactor tests (#941)

* Refactored tests for HttpReadOnly/NoHttpPost/Patch/Delete controller attributes

* Refactored tests for casing convention

* Refactored tests for custom exception handler

* Refactored tests for nulls/default query string parameters; removed some duplication and fixed an equality bug.

* Refactored tests for DisableQueryStringAttribute

* Refactored tests for resource injection

* Fixed assertions on DateTime/DateTimeOffset in tests

* Refactored tests for non-json:api controllers

* Refactored tests for ActionResult usage

* Refactored tests for custom routes

* Refactored tests for links rendering

* Refactored tests for exception handling in serializer

* Refactored tests for serialization

* Refactored tests for resource hooks

* General cleanup

* Extracted test building blocks in shared project

* Auto-adjust namespaces

* Refactored tests for service discovery

* Refactored tests for no EF Core

* Renamed IntegrationTestContext to ExampleIntegrationTestContext because it has a strong dependency on EmptyStartup from JsonApiDotNetCoreExamples project.

* Adjusted test names for ModelStateValidationTests

* Adjusted test names for pagination

* Adjusted test names for meta

* Fixed broken tests; simpler bootstrap setup

* Adjusted test names for hooks

* Enable concurrent testruns (makes running all tests 60% faster)

* Removed unused using

* Cleanup tests for hooks

* Cleanup example models

* Revert "Enable concurrent testruns (makes running all tests 60% faster)" to investigate why cibuild hangs

This reverts commit d3ff09a.

* fixed failing testrunner

* Enable running integration tests in parallel

* test

* Disable duplicate builds

* Revert "Disable duplicate builds"

This reverts commit 38c127a.

* Addressed review feedback

* Moved integration tests for filter/include/page/sort/fields into QueryStrings subfolder and auto-adjusted namespaces.

* Move types into separate files

* Moved unit tests for query string parameters into ExampleTests project, so they can share private models with integration tests for query strings. They are likely to evolve simultaneously, so I prefer not to make a copy of them.

Renamed Blog to LegacyBlog in preparation for refactoring to make query string tests run against private models. LegacyBlog is going away at the end.

* Refactored query string integration tests to use private models. Changes:

LegacyBlog -> Blog
	Title -> Title
	CompanyName -> PlatformName
	HasMany Articles -> Posts
	HasOne Owner -> Owner

Article -> BlogPost
	Caption -> Caption
	Url -> Url
	HasOne Author -> Author
	+ HasOne Reviewer
	HasManyThrough Tags -> Labels
	HasMany Revisions -> Comments
	HasOne Blog -> Parent

Tag -> Label
	Name -> Name
	Color -> Color
	HasManyThrough Articles -> Posts

Revision -> Comment
	+ Text
	PublishTime -> CreatedAt
	HasOne Author -> Author
	HasOne Article -> Parent

Author -> WebAccount
	FirstName/LastName -> UserName/DisplayName
	+ Password
	DateOfBirth -> DateOfBirth
	BusinessEmail -> EmailAddress
	LivingAddress -> Preferences
	HasMany Articles -> Posts

Address -> AccountPreferences
	+ UseDarkTheme

* Refactored query string unit tests to use private models.

* Cleanup models in example project

* Addressed review feedback

* Rename

* Refactored tests for logging

* Refactored tests for meta

* renamed ResourceHook tests and fixed a few wrong assertions

Co-authored-by: maurei <[email protected]>

Author: Bart Koelman

JsonApiDotNetCore.sln

@@ -45,6 +45,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MultiDbContextExample", "sr
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MultiDbContextTests", "test\MultiDbContextTests\MultiDbContextTests.csproj", "{EC3202C6-1D4C-4B14-A599-B9D3F27FE3BA}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestBuildingBlocks", "test\TestBuildingBlocks\TestBuildingBlocks.csproj", "{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -199,6 +201,18 @@ Global
 		{EC3202C6-1D4C-4B14-A599-B9D3F27FE3BA}.Release|x64.Build.0 = Release|Any CPU
 		{EC3202C6-1D4C-4B14-A599-B9D3F27FE3BA}.Release|x86.ActiveCfg = Release|Any CPU
 		{EC3202C6-1D4C-4B14-A599-B9D3F27FE3BA}.Release|x86.Build.0 = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|x64.Build.0 = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Debug|x86.Build.0 = Debug|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|Any CPU.Build.0 = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|x64.ActiveCfg = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|x64.Build.0 = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|x86.ActiveCfg = Release|Any CPU
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -216,6 +230,7 @@ Global
 		{21D27239-138D-4604-8E49-DCBE41BCE4C8} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
 		{6CAFDDBE-00AB-4784-801B-AB419C3C3A26} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
 		{EC3202C6-1D4C-4B14-A599-B9D3F27FE3BA} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
+		{210FD61E-FF5D-4CEE-8E0D-C739ECCCBA21} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A2421882-8F0A-4905-928F-B550B192F9A4}

docs/usage/extensibility/controllers.md

@@ -74,7 +74,7 @@ The next option is to use the ActionFilter attributes that ship with the library
 - `HttpReadOnly`: all of the above
 
 Not only does this reduce boilerplate, but it also provides a more meaningful HTTP response code.
-An attempt to use one blacklisted methods will result in a HTTP 405 Method Not Allowed response.
+An attempt to use one of the blacklisted methods will result in a HTTP 405 Method Not Allowed response.
 
 ```c#
 [HttpReadOnly]

src/Examples/GettingStarted/Data/SampleDbContext.cs

@@ -12,9 +12,9 @@ public SampleDbContext(DbContextOptions<SampleDbContext> options)
         {
         }
 
-        protected override void OnModelCreating(ModelBuilder modelBuilder)
+        protected override void OnModelCreating(ModelBuilder builder)
         {
-            modelBuilder.Entity<Person>();
+            builder.Entity<Person>();
         }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/NonJsonApiController.cs

@@ -0,0 +1,51 @@
+using System.IO;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+
+namespace JsonApiDotNetCoreExample.Controllers
+{
+    [Route("[controller]")]
+    public sealed class NonJsonApiController : ControllerBase
+    {
+        [HttpGet]
+        public IActionResult Get()
+        {
+            var result = new[] {"Welcome!"};
+            return Ok(result);
+        }
+
+        [HttpPost]
+        public async Task<IActionResult> PostAsync()
+        {
+            string name = await new StreamReader(Request.Body).ReadToEndAsync();
+
+            if (string.IsNullOrEmpty(name))
+            {
+                return BadRequest("Please send your name.");
+            }
+
+            var result = "Hello, " + name;
+            return Ok(result);
+        }
+
+        [HttpPut]
+        public IActionResult Put([FromBody] string name)
+        {
+            var result = "Hi, " + name;
+            return Ok(result);
+        }
+
+        [HttpPatch]
+        public IActionResult Patch(string name)
+        {
+            var result = "Good day, " + name;
+            return Ok(result);
+        }
+
+        [HttpDelete]
+        public IActionResult Delete()
+        {
+            return Ok("Bye.");
+        }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Controllers/PassportsController.cs

@@ -8,7 +8,7 @@ namespace JsonApiDotNetCoreExample.Controllers
 {
     public sealed class PassportsController : JsonApiController<Passport>
     {
-        public PassportsController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Passport, int> resourceService)
+        public PassportsController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Passport> resourceService)
             : base(options, loggerFactory, resourceService)
         {
         }