test(meta): test total records count

Author: jaredcnance

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -62,7 +62,7 @@ private Dictionary<string, object> _getMeta(IIdentifiable entity)
             if (entity == null) return null;
 
             var meta = new Dictionary<string, object>();
-            var metaEntity = (IHasMeta)entity;
+            var metaEntity = entity as IHasMeta;
 
             if(metaEntity != null)
                 meta = metaEntity.GetMeta(_jsonApiContext);

src/JsonApiDotNetCoreExample/Startup.cs

@@ -15,7 +15,7 @@ namespace JsonApiDotNetCoreExample
 {
     public class Startup
     {
-        private readonly IConfiguration _config;
+        public readonly IConfiguration Config;
 
         public Startup(IHostingEnvironment env)
         {
@@ -25,10 +25,10 @@ public Startup(IHostingEnvironment env)
                 .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
                 .AddEnvironmentVariables();
 
-            _config = builder.Build();
+            Config = builder.Build();
         }
 
-        public IServiceProvider ConfigureServices(IServiceCollection services)
+        public virtual IServiceProvider ConfigureServices(IServiceCollection services)
         {
             var loggerFactory = new LoggerFactory();
             loggerFactory
@@ -37,7 +37,7 @@ public IServiceProvider ConfigureServices(IServiceCollection services)
 
             services.AddDbContext<AppDbContext>(options =>
             {
-                options.UseNpgsql(_getDbConnectionString());
+                options.UseNpgsql(GetDbConnectionString());
             }, ServiceLifetime.Transient);
 
             services.AddJsonApi<AppDbContext>(opt =>
@@ -46,7 +46,7 @@ public IServiceProvider ConfigureServices(IServiceCollection services)
                 opt.DefaultPageSize = 5;
             });
 
-            services.AddDocumentationConfiguration(_config);
+            services.AddDocumentationConfiguration(Config);
 
             var provider = services.BuildServiceProvider();
             var appContext = provider.GetRequiredService<AppDbContext>();
@@ -55,25 +55,25 @@ public IServiceProvider ConfigureServices(IServiceCollection services)
             return provider;
         }
 
-        public void Configure(
+        public virtual void Configure(
             IApplicationBuilder app,
             IHostingEnvironment env,
             ILoggerFactory loggerFactory,
             AppDbContext context)
         {
             context.Database.Migrate();
 
-            loggerFactory.AddConsole(_config.GetSection("Logging"));
+            loggerFactory.AddConsole(Config.GetSection("Logging"));
             loggerFactory.AddDebug();
 
             app.UseDocs();
 
             app.UseJsonApi();
         }
 
-        private string _getDbConnectionString()
+        public string GetDbConnectionString()
         {
-            return _config["Data:DefaultConnection"];
+            return Config["Data:DefaultConnection"];
         }
     }
 }

test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/DocumentTests/Meta.cs

@@ -0,0 +1,54 @@
+using System.Net;
+using System.Net.Http;
+using System.Threading.Tasks;
+using DotNetCoreDocs;
+using DotNetCoreDocs.Writers;
+using JsonApiDotNetCoreExample;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.TestHost;
+using Newtonsoft.Json;
+using Xunit;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCoreExample.Data;
+using System.Linq;
+using JsonApiDotNetCoreExampleTests.Startups;
+
+namespace JsonApiDotNetCoreExampleTests.Acceptance.Spec.DocumentTests
+{
+    [Collection("WebHostCollection")]
+    public class Meta
+    {
+        private DocsFixture<Startup, JsonDocWriter> _fixture;
+        private AppDbContext _context;
+        public Meta(DocsFixture<Startup, JsonDocWriter> fixture)
+        {
+            _fixture = fixture;
+            _context = fixture.GetService<AppDbContext>();
+        }
+
+        [Fact]
+        public async Task Total_Record_Count_Included()
+        {
+            // arrange
+            var expectedCount = _context.TodoItems.Count();
+            var builder = new WebHostBuilder()
+                .UseStartup<MetaStartup>();
+
+            var httpMethod = new HttpMethod("GET");
+            var route = $"/api/v1/todo-items";
+
+            var server = new TestServer(builder);
+            var client = server.CreateClient();
+            var request = new HttpRequestMessage(httpMethod, route);
+
+            // act
+            var response = await client.SendAsync(request);
+            var documents = JsonConvert.DeserializeObject<Documents>(await response.Content.ReadAsStringAsync());
+            
+            // assert
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            Assert.NotNull(documents.Meta);
+            Assert.Equal((long)expectedCount, (long)documents.Meta["total-records"]);
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/Startups/MetaStartup.cs

@@ -0,0 +1,49 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using JsonApiDotNetCore.Routing;
+using JsonApiDotNetCoreExample.Data;
+using Microsoft.EntityFrameworkCore;
+using JsonApiDotNetCore.Extensions;
+using DotNetCoreDocs.Configuration;
+using DotNetCoreDocs.Middleware;
+using System;
+using JsonApiDotNetCoreExample;
+
+namespace JsonApiDotNetCoreExampleTests.Startups
+{
+    public class MetaStartup : Startup
+    {
+        public MetaStartup(IHostingEnvironment env)
+        : base (env)
+        {  }
+
+        public override IServiceProvider ConfigureServices(IServiceCollection services)
+        {
+            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 =>
+            {
+                opt.Namespace = "api/v1";
+                opt.DefaultPageSize = 5;
+                opt.IncludeTotalRecordCount = true;
+            });
+
+            services.AddDocumentationConfiguration(Config);
+
+            return services.BuildServiceProvider();
+        }
+    }
+}