chore: reorganising test models in unit test project

Author: maurei

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -201,7 +201,6 @@ private bool IsHasOneRelationship(string internalRelationshipName, Type type)
         /// <inheritdoc />
         public void DetachRelationshipPointers(TEntity entity)
         {
-
             foreach (var relationshipAttr in _targetedFields.Relationships)
             {
                 if (relationshipAttr is HasOneAttribute hasOneAttr)

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -191,7 +191,6 @@ public static void AddJsonApiInternals(
             services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
             services.AddSingleton<IContextEntityProvider>(graph);
             services.AddScoped<ICurrentRequest, CurrentRequest>();
-            services.AddScoped<IPageQueryService, PageService>();
             services.AddScoped<IScopedServiceProvider, RequestScopedServiceProvider>();
             services.AddScoped<JsonApiRouteHandler>();
             services.AddScoped<IJsonApiWriter, JsonApiWriter>();
@@ -200,21 +199,28 @@ public static void AddJsonApiInternals(
             services.AddScoped(typeof(GenericProcessor<>));
             services.AddScoped<IQueryAccessor, QueryAccessor>();
             services.AddScoped<IQueryParser, QueryParser>();
-            services.AddScoped<IIncludeService, IncludeService>();
-            services.AddScoped<ISparseFieldsService, SparseFieldsService>();
+
             services.AddScoped<ITargetedFields, TargetedFields>();
             services.AddScoped<IFieldsExplorer, FieldsExplorer>();
-            services.AddScoped<IAttributeBehaviourService, OmitNullService>();
             services.AddScoped<IFieldsToSerialize, FieldsToSerialize>();
 
             AddServerSerialization(services);
-
+            AddQueryParameterServices(services);
             if (jsonApiOptions.EnableResourceHooks)
                 AddResourceHooks(services);
 
             services.AddScoped<IInverseRelationships, InverseRelationships>();
         }
 
+        private static void AddQueryParameterServices(IServiceCollection services)
+        {
+            services.AddScoped<IIncludeService, IncludeService>();
+            services.AddScoped<ISparseFieldsService, SparseFieldsService>();
+            services.AddScoped<IPageQueryService, PageService>();
+
+        }
+
+
         private static void AddResourceHooks(IServiceCollection services)
         {
             services.AddSingleton(typeof(IHooksDiscovery<>), typeof(HooksDiscovery<>));

src/JsonApiDotNetCore/Middleware/JsonApiActionFilter.cs

@@ -57,11 +57,10 @@ protected void HandleUriParameters()
         {
             if (_httpContext.Request.Query.Count > 0)
             {
-                var querySet = _queryParser.Parse(_httpContext.Request.Query);
-                _currentRequest.QuerySet = querySet; //this shouldn't be exposed?
-                _pageManager.PageSize = querySet.PageQuery.PageSize ?? _pageManager.PageSize;
-                _pageManager.CurrentPage = querySet.PageQuery.PageOffset ?? _pageManager.CurrentPage;
-
+                 _queryParser.Parse(_httpContext.Request.Query);
+                //_currentRequest.QuerySet = querySet; //this shouldn't be exposed?
+                //_pageManager.PageSize = querySet.PageQuery.PageSize ?? _pageManager.PageSize;
+                //_pageManager.CurrentPage = querySet.PageQuery.PageOffset ?? _pageManager.CurrentPage;
             }
         }
 

src/JsonApiDotNetCore/QueryParameters/Common/IQueryParameterService.cs

@@ -9,7 +9,7 @@ internal interface IQueryParameterService
         /// Parses the value of the query parameter. Invoked in the middleware.
         /// </summary>
         /// <param name="value">the value of the query parameter as parsed from the url</param>
-        void Parse(string value);
+        void Parse(string key, string value);
         /// <summary>
         /// The name of the query parameter as matched in the URL.
         /// </summary>

src/JsonApiDotNetCore/QueryParameters/Contracts/IAttributeBehaviourService.cs

@@ -6,7 +6,7 @@ namespace JsonApiDotNetCore.Query
     /// Encapsulates client overrides of omit null and omit default values behaviour
     /// in <see cref="ResourceObjectBuilderSettings"/>
     /// </summary>
-    public interface IAttributeBehaviourService: IQueryParameterService
+    public interface IAttributeBehaviourService
     {
         /// <summary>
         /// Value of client query param overriding the omit null values behaviour in the server serializer

src/JsonApiDotNetCore/QueryParameters/FilterService.cs

@@ -4,7 +4,7 @@ namespace JsonApiDotNetCore.Query
 {
     public class FilterService : QueryParameterService
     {
-        public override void Parse(string value)
+        public override void Parse(string key, string value)
         {
             throw new NotImplementedException();
         }

src/JsonApiDotNetCore/QueryParameters/IncludeService.cs

@@ -11,11 +11,11 @@ namespace JsonApiDotNetCore.Query
 
     public class IncludeService : QueryParameterService, IIncludeService
     {
-        /// todo: make readonly
+        /// todo: use read-only lists.
         private readonly List<List<RelationshipAttribute>> _includedChains;
         private readonly ICurrentRequest _currentRequest;
         private readonly IContextEntityProvider _provider;
-
+        private ContextEntity _primaryResourceContext;
         public IncludeService(ICurrentRequest currentRequest, IContextEntityProvider provider)
         {
             _currentRequest = currentRequest;
@@ -26,7 +26,10 @@ public IncludeService(ICurrentRequest currentRequest, IContextEntityProvider pro
         /// <summary>
         /// This constructor is used internally for testing.
         /// </summary>
-        internal IncludeService() : this(null, null) { }
+        internal IncludeService(ContextEntity primaryResourceContext, IContextEntityProvider provider) : this(currentRequest: null, provider: provider)
+        {
+            _primaryResourceContext = primaryResourceContext;
+        }
 
         /// <inheritdoc/>
         public List<List<RelationshipAttribute>> Get()
@@ -47,32 +50,34 @@ public override void Parse(string _, string value)
 
         private void ParseChain(string chain)
         {
+            _primaryResourceContext = _primaryResourceContext ?? _currentRequest.GetRequestResource();
+
             var parsedChain = new List<RelationshipAttribute>();
-            var resourceContext = _currentRequest.GetRequestResource();
             var chainParts = chain.Split(QueryConstants.DOT);
+            var resourceContext = _primaryResourceContext;
             foreach (var relationshipName in chainParts)
             {
                 var relationship = resourceContext.Relationships.SingleOrDefault(r => r.PublicRelationshipName == relationshipName);
                 if (relationship == null)
-                    ThrowInvalidRelationshipError(resourceContext, relationshipName);
+                    throw InvalidRelationshipError(resourceContext, relationshipName);
 
                 if (relationship.CanInclude == false)
-                    ThrowCannotIncludeError(resourceContext, relationshipName);
+                    throw CannotIncludeError(resourceContext, relationshipName);
 
                 parsedChain.Add(relationship);
                 resourceContext = _provider.GetContextEntity(relationship.DependentType);
             }
             _includedChains.Add(parsedChain);
         }
 
-        private void ThrowCannotIncludeError(ContextEntity resourceContext, string requestedRelationship)
+        private JsonApiException CannotIncludeError(ContextEntity resourceContext, string requestedRelationship)
         {
-            throw new JsonApiException(400, $"Including the relationship {requestedRelationship} on {resourceContext.EntityName} is not allowed");
+           return new JsonApiException(400, $"Including the relationship {requestedRelationship} on {resourceContext.EntityName} is not allowed");
         }
 
-        private void ThrowInvalidRelationshipError(ContextEntity resourceContext, string requestedRelationship)
+        private JsonApiException InvalidRelationshipError(ContextEntity resourceContext, string requestedRelationship)
         {
-            throw new JsonApiException(400, $"Invalid relationship {requestedRelationship} on {resourceContext.EntityName}",
+           return new JsonApiException(400, $"Invalid relationship {requestedRelationship} on {resourceContext.EntityName}",
                 $"{resourceContext.EntityName} does not have a relationship named {requestedRelationship}");
         }
     }

src/JsonApiDotNetCore/QueryParameters/OmitDefaultValuedAttributesService.cs

@@ -4,7 +4,7 @@ namespace JsonApiDotNetCore.Query
 {
     public class OmitDefaultService : QueryParameterService
     {
-        public override void Parse(string value)
+        public override void Parse(string key, string value)
         {
             throw new NotImplementedException();
         }

src/JsonApiDotNetCore/QueryParameters/OmitNullValuedAttributesService.cs

@@ -4,7 +4,7 @@ namespace JsonApiDotNetCore.Query
 {
     public class OmitNullService : QueryParameterService
     {
-        public override void Parse(string value)
+        public override void Parse(string key, string value)
         {
             throw new NotImplementedException();
         }

src/JsonApiDotNetCore/QueryParameters/PageService.cs

@@ -26,11 +26,12 @@ public PageService(IJsonApiOptions options)
         /// <inheritdoc/>
         public int TotalPages => (TotalRecords == null) ? -1 : (int)Math.Ceiling(decimal.Divide(TotalRecords.Value, PageSize));
 
-        public override void Parse(string value)
+        public override void Parse(string key, string value)
         {
             throw new NotImplementedException();
         }
 
+
         /// <inheritdoc/>
         public bool ShouldPaginate()
         {

src/JsonApiDotNetCore/QueryParameters/SortService.cs

@@ -2,9 +2,9 @@
 
 namespace JsonApiDotNetCore.Query
 {
-    public class SortService: QueryParameterService
+    public class SortService : QueryParameterService
     {
-        public override void Parse(string value)
+        public override void Parse(string key, string value)
         {
             throw new NotImplementedException();
         }

src/JsonApiDotNetCore/QueryParameters/SparseFieldsService.cs

@@ -52,8 +52,8 @@ public override void Parse(string key, string value)
             var includedFields = new List<string> { nameof(Identifiable.Id) };
 
             var relationship = primaryResource.Relationships.SingleOrDefault(a => a.Is(typeName));
-            if (relationship == default && string.Equals(typeName, primaryResource.EntityName, StringComparison.OrdinalIgnoreCase) == false)
-                return; // includedFields;
+            if (relationship == null && string.Equals(typeName, primaryResource.EntityName, StringComparison.OrdinalIgnoreCase) == false)
+                throw new JsonApiException(400, $"fields[{typeName}] is invalid");
 
             var fields = value.Split(QueryConstants.COMMA);
             foreach (var field in fields)
@@ -68,9 +68,6 @@ public override void Parse(string key, string value)
                     if (!_selectedRelationshipFields.TryGetValue(relationship, out var registeredFields))
                         _selectedRelationshipFields.Add(relationship, registeredFields = new List<AttrAttribute>());
                     registeredFields.Add(attr);
-                    // e.g. "Owner.Name"
-                    //includedFields.Add(relationship.InternalRelationshipName + "." + attr.InternalAttributeName);
-
                 }
                 else
                 {
@@ -79,9 +76,6 @@ public override void Parse(string key, string value)
                         throw new JsonApiException(400, $"'{primaryResource.EntityName}' does not contain '{field}'.");
 
                     (_selectedFields = _selectedFields ?? new List<AttrAttribute>()).Add(attr);
-
-                    // e.g. "Name"
-                    //includedFields.Add(attr.InternalAttributeName);
                 }
             }
         }

src/JsonApiDotNetCore/RequestServices/Contracts/QuerySet.cs

@@ -0,0 +1,12 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Internal.Query;
+
+namespace JsonApiDotNetCore.Managers.Contracts
+{
+    public class QuerySet
+    {
+        public List<FilterQuery> Filters { get; internal set; }
+        public List<string> Fields { get; internal set; }
+        public List<SortQuery> SortParameters { get; internal set; }
+    }
+}

src/JsonApiDotNetCore/RequestServices/CurrentRequest.cs

@@ -1,10 +1,8 @@
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Internal;
-using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Managers.Contracts;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Query;
-using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http;
 using System.Collections.Generic;
 
@@ -16,7 +14,6 @@ class CurrentRequest : ICurrentRequest
         private ContextEntity _contextEntity;
         public string BasePath { get; set; }
         public List<string> IncludedRelationships { get; set; }
-        public QuerySet QuerySet { get; set; }
         public PageService PageManager { get; set; }
         public IQueryCollection FullQuerySet { get; set; }
         public QueryParams DisabledQueryParams { get; set; }
@@ -26,16 +23,7 @@ class CurrentRequest : ICurrentRequest
         public Dictionary<RelationshipAttribute, object> RelationshipsToUpdate { get; set; }
 
         public RelationshipAttribute RequestRelationship { get; set; }
-
-        public List<string> GetFields()
-        {
-            return QuerySet?.Fields;
-        }
-
-        public List<string> GetRelationships()
-        {
-            return QuerySet?.IncludedRelationships;
-        }
+        public QuerySet QuerySet { get => throw new System.NotImplementedException(); set => throw new System.NotImplementedException(); }
 
         /// <summary>
         /// The main resource of the request.

src/JsonApiDotNetCore/Services/QueryParser.cs

@@ -17,7 +17,7 @@ namespace JsonApiDotNetCore.Services
 
     public interface IQueryParser
     {
-        QuerySet Parse(IQueryCollection query);
+        void Parse(IQueryCollection query);
     }
 
     public class QueryParser : IQueryParser
@@ -52,8 +52,6 @@ public virtual void Parse(IQueryCollection query)
             _primaryResource = _currentRequest.GetRequestResource();
             var disabledQueries = _currentRequest.DisabledQueryParams;
 
-
-
             foreach (var pair in query)
             {
                 if (pair.Key.StartsWith(QueryConstants.FILTER, StringComparison.Ordinal))
@@ -94,7 +92,6 @@ public virtual void Parse(IQueryCollection query)
                 if (_options.AllowCustomQueryParameters == false)
                     throw new JsonApiException(400, $"{pair} is not a valid query.");
             }
-;
         }
 
         private void GetQueryParameterServices()
@@ -205,8 +202,6 @@ protected virtual List<SortQuery> ParseSortParameters(string value)
             return sortParameters;
         }
 
-
-
         protected virtual AttrAttribute GetAttribute(string propertyName)
         {
             try

test/UnitTests/QueryParameters/IncludedServiceTests.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Linq;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Query;
+using Xunit;
+
+namespace UnitTests.QueryParameters
+{
+    public class IncludedServiceTests : QueryParametersUnitTestCollection
+    {
+
+        public IncludeService GetService(ContextEntity resourceContext = null)
+        {
+            return new IncludeService(resourceContext ?? _articleResourceContext , _graph);
+        }
+
+        [Fact]
+        public void Parse_ShortChain_CanParse()
+        {
+            // arrange
+            const string chain = "author";
+
+            var service = GetService();
+
+            // act
+            service.Parse(null, "author");
+
+            // assert
+            var chains = service.Get();
+            Assert.Equal(1, chains.Count);
+            var relationship = chains.First().First();
+            Assert.Equal(chain, relationship.PublicRelationshipName);
+        }
+
+    }
+}

test/UnitTests/QueryParameters/QueryParametersUnitTestCollection.cs

@@ -0,0 +1,25 @@
+using JsonApiDotNetCore.Builders;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Internal.Contracts;
+using UnitTests.TestModels;
+
+namespace UnitTests.QueryParameters
+{
+    public class QueryParametersUnitTestCollection
+    {
+        protected readonly ContextEntity _articleResourceContext;
+        protected readonly IResourceGraph _graph;
+
+        public QueryParametersUnitTestCollection()
+        {
+            var builder = new ResourceGraphBuilder();
+            builder.AddResource<Article>();
+            builder.AddResource<Person>();
+            builder.AddResource<Blog>();
+            builder.AddResource<Food>();
+            builder.AddResource<Song>();
+            _graph = builder.Build();
+            _articleResourceContext = _graph.GetContextEntity<Article>();
+        }
+    }
+}

test/UnitTests/ResourceHooks/ResourceHookExecutor/Delete/BeforeDelete_WithDbValue_Tests.cs

@@ -7,6 +7,7 @@
 using System.Linq;
 using Xunit;
 
+
 namespace UnitTests.ResourceHooks
 {
     public class BeforeDelete_WithDbValues_Tests : HooksTestsSetup