Refactored tests for resource injection

Author: Bart Koelman

test/JsonApiDotNetCoreExampleTests/Acceptance/InjectableResourceTests.cs

@@ -0,0 +1,13 @@
+using System;
+using Microsoft.AspNetCore.Authentication;
+
+namespace JsonApiDotNetCoreExampleTests
+{
+    internal sealed class FrozenSystemClock : ISystemClock
+    {
+        private static readonly DateTimeOffset _defaultTime =
+            new DateTimeOffset(new DateTime(2000, 1, 1, 1, 1, 1), TimeSpan.FromHours(1));
+
+        public DateTimeOffset UtcNow { get; set; } = _defaultTime;
+    }
+}

test/JsonApiDotNetCoreExampleTests/FrozenSystemClock.cs

@@ -0,0 +1,28 @@
+using System;
+using System.ComponentModel.DataAnnotations.Schema;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+using Microsoft.AspNetCore.Authentication;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceConstructorInjection
+{
+    public sealed class GiftCertificate : Identifiable
+    {
+        private readonly ISystemClock _systemClock;
+
+        [Attr]
+        public DateTimeOffset IssueDate { get; set; }
+
+        [Attr(Capabilities = AttrCapabilities.AllowView)]
+        [NotMapped]
+        public bool HasExpired => IssueDate.AddYears(1) < _systemClock.UtcNow;
+
+        [HasOne]
+        public PostOffice Issuer { get; set; }
+
+        public GiftCertificate(InjectionDbContext injectionDbContext)
+        {
+            _systemClock = injectionDbContext.SystemClock;
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/GiftCertificate.cs

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

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/GiftCertificatesController.cs

@@ -0,0 +1,20 @@
+using System;
+using Microsoft.AspNetCore.Authentication;
+using Microsoft.EntityFrameworkCore;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceConstructorInjection
+{
+    public sealed class InjectionDbContext : DbContext
+    {
+        public ISystemClock SystemClock { get; }
+
+        public DbSet<PostOffice> PostOffice { get; set; }
+        public DbSet<GiftCertificate> GiftCertificates { get; set; }
+
+        public InjectionDbContext(DbContextOptions<InjectionDbContext> options, ISystemClock systemClock)
+            : base(options)
+        {
+            SystemClock = systemClock ?? throw new ArgumentNullException(nameof(systemClock));
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/InjectionDbContext.cs

@@ -0,0 +1,40 @@
+using System;
+using Bogus;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceConstructorInjection
+{
+    internal sealed class InjectionFakers : FakerContainer
+    {
+        private readonly IServiceProvider _serviceProvider;
+
+        private readonly Lazy<Faker<PostOffice>> _lazyPostOfficeFaker;
+        private readonly Lazy<Faker<GiftCertificate>> _lazyGiftCertificateFaker;
+
+        public Faker<PostOffice> PostOffice => _lazyPostOfficeFaker.Value;
+        public Faker<GiftCertificate> GiftCertificate => _lazyGiftCertificateFaker.Value;
+
+        public InjectionFakers(IServiceProvider serviceProvider)
+        {
+            _serviceProvider = serviceProvider ?? throw new ArgumentNullException(nameof(serviceProvider));
+
+            _lazyPostOfficeFaker = new Lazy<Faker<PostOffice>>(() =>
+                new Faker<PostOffice>()
+                    .UseSeed(GetFakerSeed())
+                    .CustomInstantiator(f => new PostOffice(ResolveDbContext()))
+                    .RuleFor(postOffice => postOffice.Address, f => f.Address.FullAddress()));
+
+            _lazyGiftCertificateFaker = new Lazy<Faker<GiftCertificate>>(() =>
+                new Faker<GiftCertificate>()
+                    .UseSeed(GetFakerSeed())
+                    .CustomInstantiator(f => new GiftCertificate(ResolveDbContext()))
+                    .RuleFor(giftCertificate => giftCertificate.IssueDate, f => f.Date.PastOffset()));
+        }
+
+        private InjectionDbContext ResolveDbContext()
+        {
+            using var scope = _serviceProvider.CreateScope();
+            return scope.ServiceProvider.GetRequiredService<InjectionDbContext>();
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/InjectionFakers.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations.Schema;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+using Microsoft.AspNetCore.Authentication;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceConstructorInjection
+{
+    public sealed class PostOffice : Identifiable
+    {
+        private readonly ISystemClock _systemClock;
+
+        [Attr]
+        public string Address { get; set; }
+
+        [Attr(Capabilities = AttrCapabilities.AllowView)]
+        [NotMapped]
+        public bool IsOpen => IsWithinOperatingHours();
+
+        [HasMany]
+        public IList<GiftCertificate> GiftCertificates { get; set; }
+
+        public PostOffice(InjectionDbContext injectionDbContext)
+        {
+            _systemClock = injectionDbContext.SystemClock;
+        }
+
+        private bool IsWithinOperatingHours()
+        {
+            var currentTime = _systemClock.UtcNow;
+            return currentTime.DayOfWeek >= DayOfWeek.Monday && currentTime.DayOfWeek <= DayOfWeek.Friday && currentTime.Hour >= 9 && currentTime.Hour <= 17;
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/PostOffice.cs

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