test(*): add integration tests

Author: jaredcnance

README.md

@@ -166,4 +166,19 @@ identifier):
 ?filter[attribute]=gt:value
 ?filter[attribute]=le:value
 ?filter[attribute]=ge:value
-```
+```
+
+# Tests
+
+## Running
+
+I am using DotNetCoreDocs to generate sample requests and documentation.
+
+1. To run the tests, start a postgres server and verify the connection properties define in `/test/JsonApiDotNetCoreExampleTests/appsettings.json`
+2. `cd ./test/JsonApiDotNetCoreExampleTests`
+3. `dotnet test`
+4. `cd ./src/JsonApiDotNetCoreExample`
+5. `dotnet run`
+6. `open http://localhost:5000/docs`
+
+

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections;
 using System.Collections.Generic;
 using JsonApiDotNetCore.Extensions;

src/JsonApiDotNetCore/Controllers/JsonApiController.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -111,7 +110,10 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel
                 .GetRelationshipName<T>(relationshipName.ToProperCase());
 
             if (relationshipName == null)
+            {
+                _logger?.LogInformation($"Relationship name not specified returning 422");
                 return UnprocessableEntity();
+            }
 
             var entity = await _entities.GetAndIncludeAsync(id, relationshipName);
 
@@ -131,7 +133,10 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel
         public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
         {
             if (entity == null)
+            {
+                _logger?.LogInformation($"Entity cannot be null returning 422");
                 return UnprocessableEntity();
+            }
 
             await _entities.CreateAsync(entity);
 
@@ -142,7 +147,10 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
         public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
         {
             if (entity == null)
+            {
+                _logger?.LogInformation($"Entity cannot be null returning 422");
                 return UnprocessableEntity();
+            }
 
             var updatedEntity = await _entities.UpdateAsync(id, entity);
 

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;

src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs

@@ -5,6 +5,7 @@
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 
 namespace JsonApiDotNetCore.Formatters
@@ -33,16 +34,23 @@ public Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
                 return InputFormatterResult.SuccessAsync(null);
             }
 
+            var loggerFactory = GetService<ILoggerFactory>(context);
+            var logger = loggerFactory?.CreateLogger<JsonApiInputFormatter>();
+
             try
             {
                 var body = GetRequestBody(context.HttpContext.Request.Body);
-                var jsonApiContext = context.HttpContext.RequestServices.GetService<IJsonApiContext>();
+                var jsonApiContext = GetService<IJsonApiContext>(context);
                 var model = JsonApiDeSerializer.Deserialize(body, jsonApiContext);
 
+                if(model == null)
+                    logger?.LogError("An error occurred while de-serializing the payload");
+
                 return InputFormatterResult.SuccessAsync(model);
             }
-            catch (JsonSerializationException)
+            catch (JsonSerializationException ex)
             {
+                logger?.LogError(new EventId(), ex, "An error occurred while de-serializing the payload");
                 context.HttpContext.Response.StatusCode = 422;
                 return InputFormatterResult.FailureAsync();
             }
@@ -55,5 +63,10 @@ private string GetRequestBody(Stream body)
                 return reader.ReadToEnd();
             }
         }
+
+        private TService GetService<TService>(InputFormatterContext context)
+        {
+            return context.HttpContext.RequestServices.GetService<TService>();
+        }
     }
 }

src/JsonApiDotNetCore/Serialization/JsonApiDeSerializer.cs

@@ -7,7 +7,6 @@
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
 using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace JsonApiDotNetCore.Serialization
 {
@@ -17,24 +16,50 @@ public static object Deserialize(string requestBody, IJsonApiContext context)
         {
             var document = JsonConvert.DeserializeObject<Document>(requestBody);
 
-            var entityTypeName = document.Data.Type.ToProperCase();
+            var entity = DataToObject(document.Data, context);
+
+            return entity;
+        }
+
+        public static List<TEntity> DeserializeList<TEntity>(string requestBody, IJsonApiContext context)
+        {
+            var documents = JsonConvert.DeserializeObject<Documents>(requestBody);
+
+            var deserializedList = new List<TEntity>();
+            foreach (var data in documents.Data)
+            {
+                var entity = DataToObject(data, context);
+                deserializedList.Add((TEntity)entity);
+            }
+
+            return deserializedList;
+        }
+
+        private static object DataToObject(DocumentData data, IJsonApiContext context)
+        {
+            var entityTypeName = data.Type.ToProperCase();
 
             var contextEntity = context.ContextGraph.GetContextEntity(entityTypeName);
             context.RequestEntity = contextEntity;
-
+            
             var entity = Activator.CreateInstance(contextEntity.EntityType);
-
-            entity = _setEntityAttributes(entity, contextEntity, document.Data.Attributes);
-            entity = _setRelationships(entity, contextEntity, document.Data.Relationships);
 
-            return entity;
+            entity = _setEntityAttributes(entity, contextEntity, data.Attributes);
+            entity = _setRelationships(entity, contextEntity, data.Relationships);
+
+            var identifiableEntity = (IIdentifiable)entity;
+
+            if(data.Id != null)
+                identifiableEntity.Id = Convert.ChangeType(data.Id, identifiableEntity.Id.GetType());
+
+            return identifiableEntity;
         }
 
         private static object _setEntityAttributes(
             object entity, ContextEntity contextEntity, Dictionary<string, object> attributeValues)
         {
             var entityProperties = entity.GetType().GetProperties();
-            
+
             foreach (var attr in contextEntity.Attributes)
             {
                 var entityProperty = entityProperties.FirstOrDefault(p => p.Name == attr.InternalAttributeName);
@@ -56,22 +81,26 @@ private static object _setEntityAttributes(
         private static object _setRelationships(
             object entity, ContextEntity contextEntity, Dictionary<string, RelationshipData> relationships)
         {
-            if(relationships == null)
+            if (relationships == null || relationships.Count == 0)
                 return entity;
 
             var entityProperties = entity.GetType().GetProperties();
-            
+
             foreach (var attr in contextEntity.Relationships)
             {
                 var entityProperty = entityProperties.FirstOrDefault(p => p.Name == $"{attr.RelationshipName}Id");
 
                 if (entityProperty == null)
-                    throw new ArgumentException($"{contextEntity.EntityType.Name} does not contain an relationsip named {attr.RelationshipName}", nameof(entity));
-
+                    throw new JsonApiException("400", $"{contextEntity.EntityType.Name} does not contain an relationsip named {attr.RelationshipName}");
+                
+                var relationshipName = attr.RelationshipName.Dasherize();
                 RelationshipData relationshipData;
-                if (relationships.TryGetValue(attr.RelationshipName.Dasherize(), out relationshipData))
+                if (relationships.TryGetValue(relationshipName, out relationshipData))
                 {
-                    var data = (Dictionary<string,string>)relationshipData.ExposedData;
+                    var data = (Dictionary<string, string>)relationshipData.ExposedData;
+                    
+                    if(data == null) continue;
+                    
                     var newValue = data["id"];
                     var convertedValue = Convert.ChangeType(newValue, entityProperty.PropertyType);
                     entityProperty.SetValue(entity, convertedValue);

src/JsonApiDotNetCoreExample/.gitignore

@@ -1,3 +1,5 @@
+_data/
+
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 

src/JsonApiDotNetCoreExample/README.md

@@ -0,0 +1,15 @@
+## Running the Example
+
+```
+> dotnet run
+```
+
+## Generate Documentation
+
+```
+> cd ./test/JsonApiDotNetCoreExampleTests
+> dotnet test
+> cd ./src/JsonApiDotNetCoreExample
+> dotnet run
+> open http://localhost:5000/docs
+```

src/JsonApiDotNetCoreExample/Startup.cs

@@ -7,6 +7,9 @@
 using JsonApiDotNetCoreExample.Data;
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
+using DotNetCoreDocs.Configuration;
+using DotNetCoreDocs.Middleware;
+using System;
 
 namespace JsonApiDotNetCoreExample
 {
@@ -25,28 +28,46 @@ public Startup(IHostingEnvironment env)
             _config = builder.Build();
         }
 
-        public void ConfigureServices(IServiceCollection services)
+        public IServiceProvider ConfigureServices(IServiceCollection services)
         {
-            services.AddDbContext<AppDbContext>(options => {
+            var loggerFactory = new LoggerFactory();
+            loggerFactory
+              .AddConsole(LogLevel.Trace);
+            services.AddSingleton<ILoggerFactory>(loggerFactory);
+
+            services.AddDbContext<AppDbContext>(options =>
+            {
                 options.UseNpgsql(_getDbConnectionString());
             }, ServiceLifetime.Transient);
-            
-            services.AddJsonApi<AppDbContext>(opt => {
+
+            services.AddJsonApi<AppDbContext>(opt =>
+            {
                 opt.Namespace = "api/v1";
-                opt.DefaultPageSize = 1;
+                opt.DefaultPageSize = 5;
             });
+
+            services.AddDocumentationConfiguration(_config);
+
+            var provider = services.BuildServiceProvider();
+            var appContext = provider.GetRequiredService<AppDbContext>();
+            if(appContext == null)
+                throw new ArgumentException();
+            return provider;
         }
 
         public void Configure(
-            IApplicationBuilder app, 
-            IHostingEnvironment env, 
+            IApplicationBuilder app,
+            IHostingEnvironment env,
             ILoggerFactory loggerFactory,
             AppDbContext context)
         {
             context.Database.Migrate();
 
             loggerFactory.AddConsole(_config.GetSection("Logging"));
             loggerFactory.AddDebug();
+
+            app.UseDocs();
+
             app.UseJsonApi();
         }
 

src/JsonApiDotNetCoreExample/appsettings.json

@@ -9,5 +9,10 @@
       "System": "Trace",
       "Microsoft": "Trace"
     }
+  },
+  "DocsConfiguration": {
+    "BaseAddress": "http://localhost:5000",
+    "RequestsDirectory": "../../src/JsonApiDotNetCoreExample/_data",
+    "DocumentationRoute": "/docs"
   }
 }

src/JsonApiDotNetCoreExample/project.json

@@ -1,26 +1,27 @@
 {
   "dependencies": {
-    "JsonApiDotNetCore": {
-      "target": "project"
-    },
     "Microsoft.NETCore.App": {
       "version": "1.1.0",
       "type": "platform"
     },
+    "JsonApiDotNetCore": {
+      "target": "project"
+    },
     "Microsoft.AspNetCore.Mvc": "1.1.0",
     "Microsoft.AspNetCore.Routing": "1.1.0",
-    "Microsoft.AspNetCore.Server.IISIntegration": "1.0.0",
-    "Microsoft.AspNetCore.Server.Kestrel": "1.0.1",
-    "Microsoft.Extensions.Configuration.EnvironmentVariables": "1.0.0",
-    "Microsoft.Extensions.Configuration.FileExtensions": "1.0.0",
-    "Microsoft.Extensions.Configuration.Json": "1.0.0",
-    "Microsoft.Extensions.Configuration.CommandLine": "1.0.0",
+    "Microsoft.AspNetCore.Server.IISIntegration": "1.1.0",
+    "Microsoft.AspNetCore.Server.Kestrel": "1.1.0",
+    "Microsoft.Extensions.Configuration.EnvironmentVariables": "1.1.0",
+    "Microsoft.Extensions.Configuration.FileExtensions": "1.1.0",
+    "Microsoft.Extensions.Configuration.Json": "1.1.0",
+    "Microsoft.Extensions.Configuration.CommandLine": "1.1.0",
     "Microsoft.Extensions.Logging": "1.1.0",
     "Microsoft.Extensions.Logging.Console": "1.1.0",
     "Microsoft.Extensions.Logging.Debug": "1.1.0",
-    "Microsoft.Extensions.Options.ConfigurationExtensions": "1.0.0",
+    "Microsoft.Extensions.Options.ConfigurationExtensions": "1.1.0",
     "Microsoft.EntityFrameworkCore.Tools": "1.0.0-preview2-final",
-    "Npgsql.EntityFrameworkCore.PostgreSQL": "1.1.0"
+    "Npgsql.EntityFrameworkCore.PostgreSQL": "1.1.0",
+    "DotNetCoreDocs": "0.4.0"
   },
 
   "tools": {
@@ -67,10 +68,10 @@
   },
 
   "scripts": {
-    "postpublish": [ "dotnet publish-iis --publish-folder %publish:OutputPath% --framework %publish:FullTargetFramework%" ]
+    "postpublish": ["dotnet publish-iis --publish-folder %publish:OutputPath% --framework %publish:FullTargetFramework%"]
   },
 
   "tooling": {
     "defaultNamespace": "JsonApiDotNetCoreExample"
   }
-}
+}