Refactor tests

src/Examples/JsonApiDotNetCoreExample/Controllers/CountriesController.cs

@@ -1,14 +1,11 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
-using JsonApiDotNetCore.Controllers.Annotations;
-using JsonApiDotNetCore.QueryStrings;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    [DisableQueryString(StandardQueryStringParameters.Sort | StandardQueryStringParameters.Page)]
     public sealed class CountriesController : JsonApiController<Country>
     {
         public CountriesController(

src/Examples/JsonApiDotNetCoreExample/Controllers/TagsController.cs

@@ -1,13 +1,11 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
-using JsonApiDotNetCore.Controllers.Annotations;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    [DisableQueryString("skipCache")]
     public sealed class TagsController : JsonApiController<Tag>
     {
         public TagsController(

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -1,8 +1,6 @@
 using System;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.QueryStrings;
 using JsonApiDotNetCoreExample.Data;
-using JsonApiDotNetCoreExample.Services;
 using Microsoft.AspNetCore.Authentication;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
@@ -28,9 +26,6 @@ public override void ConfigureServices(IServiceCollection services)
         {
             ConfigureClock(services);
 
-            services.AddScoped<SkipCacheQueryStringParameterReader>();
-            services.AddScoped<IQueryStringParameterReader>(sp => sp.GetRequiredService<SkipCacheQueryStringParameterReader>());
-
             services.AddDbContext<AppDbContext>(options =>
             {
                 options.EnableSensitiveDataLogging();

test/JsonApiDotNetCoreExampleTests/IntegrationTests/RestrictedControllers/BlockingHttpDeleteController.cs

@@ -1,12 +1,14 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Controllers.Annotations;
+using JsonApiDotNetCore.QueryStrings;
 using JsonApiDotNetCore.Services;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.RestrictedControllers
 {
     [NoHttpDelete]
+    [DisableQueryString(StandardQueryStringParameters.Sort | StandardQueryStringParameters.Page)]
     public sealed class BlockingHttpDeleteController : JsonApiController<Sofa>
     {
         public BlockingHttpDeleteController(IJsonApiOptions options, ILoggerFactory loggerFactory,

test/JsonApiDotNetCoreExampleTests/IntegrationTests/RestrictedControllers/BlockingWritesController.cs

@@ -7,6 +7,7 @@
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.RestrictedControllers
 {
     [HttpReadOnly]
+    [DisableQueryString("skipCache")]
     public sealed class BlockingWritesController : JsonApiController<Bed>
     {
         public BlockingWritesController(IJsonApiOptions options, ILoggerFactory loggerFactory,

test/JsonApiDotNetCoreExampleTests/IntegrationTests/RestrictedControllers/DisableQueryStringTests.cs

@@ -0,0 +1,85 @@
+using System.Net;
+using System.Threading.Tasks;
+using FluentAssertions;
+using JsonApiDotNetCore.QueryStrings;
+using JsonApiDotNetCore.Serialization.Objects;
+using Microsoft.Extensions.DependencyInjection;
+using Xunit;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.RestrictedControllers
+{
+    public sealed class DisableQueryStringTests
+        : IClassFixture<IntegrationTestContext<TestableStartup<RestrictionDbContext>, RestrictionDbContext>>
+    {
+        private readonly IntegrationTestContext<TestableStartup<RestrictionDbContext>, RestrictionDbContext> _testContext;
+        private readonly RestrictionFakers _fakers = new RestrictionFakers();
+
+        public DisableQueryStringTests(IntegrationTestContext<TestableStartup<RestrictionDbContext>, RestrictionDbContext> testContext)
+        {
+            _testContext = testContext;
+
+            testContext.ConfigureServicesAfterStartup(services =>
+            {
+                services.AddScoped<SkipCacheQueryStringParameterReader>();
+                services.AddScoped<IQueryStringParameterReader>(sp => sp.GetRequiredService<SkipCacheQueryStringParameterReader>());
+            });
+        }
+
+        [Fact]
+        public async Task Cannot_sort_if_query_string_parameter_is_blocked_by_controller()
+        {
+            // Arrange
+            var route = "/sofas?sort=id";
+
+            // Act
+            var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<ErrorDocument>(route);
+
+            // Assert
+            httpResponse.Should().HaveStatusCode(HttpStatusCode.BadRequest);
+
+            responseDocument.Errors.Should().HaveCount(1);
+            responseDocument.Errors[0].StatusCode.Should().Be(HttpStatusCode.BadRequest);
+            responseDocument.Errors[0].Title.Should().Be("Usage of one or more query string parameters is not allowed at the requested endpoint.");
+            responseDocument.Errors[0].Detail.Should().Be("The parameter 'sort' cannot be used at this endpoint.");
+            responseDocument.Errors[0].Source.Parameter.Should().Be("sort");
+        }
+
+        [Fact]
+        public async Task Cannot_paginate_if_query_string_parameter_is_blocked_by_controller()
+        {
+            // Arrange
+            var route = "/sofas?page[number]=2";
+
+            // Act
+            var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<ErrorDocument>(route);
+
+            // Assert
+            httpResponse.Should().HaveStatusCode(HttpStatusCode.BadRequest);
+
+            responseDocument.Errors.Should().HaveCount(1);
+            responseDocument.Errors[0].StatusCode.Should().Be(HttpStatusCode.BadRequest);
+            responseDocument.Errors[0].Title.Should().Be("Usage of one or more query string parameters is not allowed at the requested endpoint.");
+            responseDocument.Errors[0].Detail.Should().Be("The parameter 'page[number]' cannot be used at this endpoint.");
+            responseDocument.Errors[0].Source.Parameter.Should().Be("page[number]");
+        }
+
+        [Fact]
+        public async Task Cannot_use_custom_query_string_parameter_if_blocked_by_controller()
+        {
+            // Arrange
+            var route = "/beds?skipCache=true";
+
+            // Act
+            var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<ErrorDocument>(route);
+
+            // Assert
+            httpResponse.Should().HaveStatusCode(HttpStatusCode.BadRequest);
+
+            responseDocument.Errors.Should().HaveCount(1);
+            responseDocument.Errors[0].StatusCode.Should().Be(HttpStatusCode.BadRequest);
+            responseDocument.Errors[0].Title.Should().Be("Usage of one or more query string parameters is not allowed at the requested endpoint.");
+            responseDocument.Errors[0].Detail.Should().Be("The parameter 'skipCache' cannot be used at this endpoint.");
+            responseDocument.Errors[0].Source.Parameter.Should().Be("skipCache");
+        }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Services/SkipCacheQueryStringParameterReader.cs → test/JsonApiDotNetCoreExampleTests/IntegrationTests/RestrictedControllers/SkipCacheQueryStringParameterReader.cs

@@ -4,9 +4,9 @@
 using JsonApiDotNetCore.QueryStrings;
 using Microsoft.Extensions.Primitives;
 
-namespace JsonApiDotNetCoreExample.Services
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.RestrictedControllers
 {
-    public class SkipCacheQueryStringParameterReader : IQueryStringParameterReader
+    public sealed class SkipCacheQueryStringParameterReader : IQueryStringParameterReader
     {
         private const string _skipCacheParameterName = "skipCache";
 
@@ -27,7 +27,7 @@ public void Read(string parameterName, StringValues parameterValue)
             if (!bool.TryParse(parameterValue, out bool skipCache))
             {
                 throw new InvalidQueryStringParameterException(parameterName, "Boolean value required.",
-                    $"The value {parameterValue} is not a valid boolean.");
+                    $"The value '{parameterValue}' is not a valid boolean.");
             }
 
             SkipCache = skipCache;