Refactored tests for meta

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/ProductFamiliesController.cs

@@ -0,0 +1,16 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ public sealed class ProductFamiliesController : JsonApiController<ProductFamily>
+ {
+ public ProductFamiliesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
+ IResourceService<ProductFamily> resourceService)
+ : base(options, loggerFactory, resourceService)
+ {
+ }
+ }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/ProductFamily.cs

@@ -0,0 +1,15 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ public sealed class ProductFamily : Identifiable
+ {
+ [Attr]
+ public string Name { get; set; }
+
+ [HasMany]
+ public IList<SupportTicket> Tickets { get; set; }
+ }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/ResourceMetaTests.cs

@@ -1,45 +1,47 @@
-using System.Collections.Generic;
 using System.Net;
 using System.Threading.Tasks;
 using FluentAssertions;
+using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
-using JsonApiDotNetCoreExample;
-using JsonApiDotNetCoreExample.Data;
-using JsonApiDotNetCoreExample.Models;
+using JsonApiDotNetCoreExampleTests.Startups;
+using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
 {
- public sealed class ResourceMetaTests : IClassFixture<ExampleIntegrationTestContext<Startup, AppDbContext>>
+ public sealed class ResourceMetaTests
+ : IClassFixture<ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext>>
  {
- private readonly ExampleIntegrationTestContext<Startup, AppDbContext> _testContext;
+ private readonly ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext> _testContext;
+ private readonly SupportFakers _fakers = new SupportFakers();
 
- public ResourceMetaTests(ExampleIntegrationTestContext<Startup, AppDbContext> testContext)
+ public ResourceMetaTests(ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext> testContext)
  {
  _testContext = testContext;
+
+ testContext.ConfigureServicesAfterStartup(services =>
+ {
+ services.AddScoped<IResourceDefinition<SupportTicket>, SupportTicketDefinition>();
+ });
  }
 
  [Fact]
  public async Task Returns_resource_meta_from_ResourceDefinition()
  {
  // Arrange
- var todoItems = new[]
- {
- new TodoItem {Description = "Important: Pay the bills"},
- new TodoItem {Description = "Plan my birthday party"},
- new TodoItem {Description = "Important: Call mom"}
- };
+ var tickets = _fakers.SupportTicket.Generate(3);
+ tickets[0].Description = "Critical: " + tickets[0].Description;
+ tickets[2].Description = "Critical: " + tickets[2].Description;
 
  await _testContext.RunOnDatabaseAsync(async dbContext =>
  {
- await dbContext.ClearTableAsync<TodoItem>();
- dbContext.TodoItems.AddRange(todoItems);
-
+ await dbContext.ClearTableAsync<SupportTicket>();
+ dbContext.SupportTickets.AddRange(tickets);
  await dbContext.SaveChangesAsync();
  });
 
- var route = "/api/v1/todoItems";
+ var route = "/supportTickets";
 
  // Act
  var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<Document>(route);
@@ -57,22 +59,18 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
  public async Task Returns_resource_meta_from_ResourceDefinition_in_included_resources()
  {
  // Arrange
- var person = new Person
- {
- TodoItems = new HashSet<TodoItem>
- {
- new TodoItem {Description = "Important: Pay the bills"}
- }
- };
+ var family = _fakers.ProductFamily.Generate();
+ family.Tickets = _fakers.SupportTicket.Generate(1);
+ family.Tickets[0].Description = "Critical: " + family.Tickets[0].Description;
 
  await _testContext.RunOnDatabaseAsync(async dbContext =>
  {
- await dbContext.ClearTableAsync<TodoItem>();
- dbContext.People.Add(person);
+ await dbContext.ClearTableAsync<ProductFamily>();
+ dbContext.ProductFamilies.Add(family);
  await dbContext.SaveChangesAsync();
  });
 
- var route = $"/api/v1/people/{person.StringId}?include=todoItems";
+ var route = $"/productFamilies/{family.StringId}?include=tickets";
 
  // Act
  var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<Document>(route);

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/ResponseMetaTests.cs

@@ -3,26 +3,25 @@
 using FluentAssertions;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization;
-using JsonApiDotNetCoreExample;
-using JsonApiDotNetCoreExample.Data;
-using JsonApiDotNetCoreExample.Models;
+using JsonApiDotNetCoreExampleTests.Startups;
 using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
 {
- public sealed class ResponseMetaTests : IClassFixture<ExampleIntegrationTestContext<Startup, AppDbContext>>
+ public sealed class ResponseMetaTests
+ : IClassFixture<ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext>>
  {
- private readonly ExampleIntegrationTestContext<Startup, AppDbContext> _testContext;
+ private readonly ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext> _testContext;
 
- public ResponseMetaTests(ExampleIntegrationTestContext<Startup, AppDbContext> testContext)
+ public ResponseMetaTests(ExampleIntegrationTestContext<TestableStartup<SupportDbContext>, SupportDbContext> testContext)
  {
  _testContext = testContext;
 
  testContext.ConfigureServicesAfterStartup(services =>
  {
- services.AddSingleton<IResponseMeta, TestResponseMeta>();
+ services.AddSingleton<IResponseMeta, SupportResponseMeta>();
  });
 
  var options = (JsonApiOptions) testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();
@@ -33,9 +32,12 @@ public ResponseMetaTests(ExampleIntegrationTestContext<Startup, AppDbContext> te
  public async Task Returns_top_level_meta()
  {
  // Arrange
- await _testContext.RunOnDatabaseAsync(async dbContext => { await dbContext.ClearTableAsync<Person>(); });
+ await _testContext.RunOnDatabaseAsync(async dbContext =>
+ {
+ await dbContext.ClearTableAsync<SupportTicket>();
+ });
 
- var route = "/api/v1/people";
+ var route = "/supportTickets";
 
  // Act
  var (httpResponse, responseDocument) = await _testContext.ExecuteGetAsync<string>(route);
@@ -55,8 +57,8 @@ public async Task Returns_top_level_meta()
  ]
  },
  ""links"": {
- ""self"": ""http://localhost/api/v1/people"",
- ""first"": ""http://localhost/api/v1/people""
+ ""self"": ""http://localhost/supportTickets"",
+ ""first"": ""http://localhost/supportTickets""
  },
  ""data"": []
 }");

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportDbContext.cs

@@ -0,0 +1,15 @@
+using Microsoft.EntityFrameworkCore;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ public sealed class SupportDbContext : DbContext
+ {
+ public DbSet<ProductFamily> ProductFamilies { get; set; }
+ public DbSet<SupportTicket> SupportTickets { get; set; }
+
+ public SupportDbContext(DbContextOptions<SupportDbContext> options)
+ : base(options)
+ {
+ }
+ }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportFakers.cs

@@ -0,0 +1,22 @@
+using System;
+using Bogus;
+using TestBuildingBlocks;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ internal sealed class SupportFakers : FakerContainer
+ {
+ private readonly Lazy<Faker<ProductFamily>> _lazyProductFamilyFaker = new Lazy<Faker<ProductFamily>>(() =>
+ new Faker<ProductFamily>()
+ .UseSeed(GetFakerSeed())
+ .RuleFor(productFamily => productFamily.Name, f => f.Commerce.ProductName()));
+
+ private readonly Lazy<Faker<SupportTicket>> _lazySupportTicketFaker = new Lazy<Faker<SupportTicket>>(() =>
+ new Faker<SupportTicket>()
+ .UseSeed(GetFakerSeed())
+ .RuleFor(supportTicket => supportTicket.Description, f => f.Lorem.Paragraph()));
+
+ public Faker<ProductFamily> ProductFamily => _lazyProductFamilyFaker.Value;
+ public Faker<SupportTicket> SupportTicket => _lazySupportTicketFaker.Value;
+ }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/TestResponseMeta.cs → test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportResponseMeta.cs

@@ -3,7 +3,7 @@
 
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
 {
- public sealed class TestResponseMeta : IResponseMeta
+ public sealed class SupportResponseMeta : IResponseMeta
  {
  public IReadOnlyDictionary<string, object> GetMeta()
  {

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportTicket.cs

@@ -0,0 +1,11 @@
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ public sealed class SupportTicket : Identifiable
+ {
+ [Attr]
+ public string Description { get; set; }
+ }
+}

src/Examples/JsonApiDotNetCoreExample/Definitions/TodoItemDefinition.cs → test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportTicketDefinition.cs

@@ -1,19 +1,18 @@
 using System.Collections.Generic;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Resources;
-using JsonApiDotNetCoreExample.Models;
 
-namespace JsonApiDotNetCoreExample.Definitions
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
 {
- public sealed class TodoItemDefinition : JsonApiResourceDefinition<TodoItem>
+ public sealed class SupportTicketDefinition : JsonApiResourceDefinition<SupportTicket>
  {
- public TodoItemDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
+ public SupportTicketDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
  {
  }
 
- public override IDictionary<string, object> GetMeta(TodoItem resource)
+ public override IDictionary<string, object> GetMeta(SupportTicket resource)
  {
- if (resource.Description != null && resource.Description.StartsWith("Important:"))
+ if (resource.Description != null && resource.Description.StartsWith("Critical:"))
  {
  return new Dictionary<string, object>
  {

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/SupportTicketsController.cs

@@ -0,0 +1,16 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.Meta
+{
+ public sealed class SupportTicketsController : JsonApiController<SupportTicket>
+ {
+ public SupportTicketsController(IJsonApiOptions options, ILoggerFactory loggerFactory,
+ IResourceService<SupportTicket> resourceService)
+ : base(options, loggerFactory, resourceService)
+ {
+ }
+ }
+}