LightweightIocContainer/Test.LightweightIocContainer/FluentFactoryRegistrationTest.cs

// Author: Gockner, Simon
// Created: 2021-11-29
// Copyright(c) 2021 SimonG. All Rights Reserved.

using JetBrains.Annotations;
using LightweightIocContainer;
using LightweightIocContainer.Exceptions;
using NUnit.Framework;

namespace Test.LightweightIocContainer;

[TestFixture]
public class FluentFactoryRegistrationTest
{
    public interface ITest
    {
            
    }

    private class Test : ITest
    {
            
    }
        
    private class TestByte : ITest
    {
        [UsedImplicitly]
        private readonly byte _id;

        public TestByte(byte id) => _id = id;
    }
        
    [UsedImplicitly]
    private class TestConstructor : ITest
    {
        public TestConstructor(string name, Test test)
        {

        }

        public TestConstructor(Test test, string name = null)
        {

        }
    }
    
    private class TestNull : ITest
    {

        public TestNull(object obj, string content, string optional1, string optional2, ITestNullFactory testNullFactory)
        {
            Obj = obj;
            Content = content;
            Optional1 = optional1;
            Optional2 = optional2;
            TestNullFactory = testNullFactory;
        }
        
        public object Obj { get; }
        public string Content { get; }
        public string Optional1 { get; }
        public string Optional2 { get; }
        public ITestNullFactory TestNullFactory { get; }
    }
        
    public interface ITestNullFactory
    {
        ITest Create(object obj, string content, string optional1, string optional2);
    }
    
    public interface ITestDefaultFactory
    {
        ITest Create(object obj, string content, string optional1, string optional2, ITestNullFactory testNullFactory = null);
    }
    
    private interface ITestFactoryNoCreate
    {
            
    }

    private interface ITestFactoryNonGenericClear
    {
        ITest Create();

        void ClearMultitonInstance();
    }
        
    [UsedImplicitly]
    public interface ITestFactory
    {
        ITest Create();
        ITest Create(string name);
        ITest CreateTest(string name = null);
        ITest Create(byte id);
    }
        
    private class TestFactory : ITestFactory
    {
        public ITest Create() => new Test();
        public ITest Create(string name) => throw new NotImplementedException();
        public ITest CreateTest(string name = null) => throw new NotImplementedException();
        public ITest Create(byte id) => throw new NotImplementedException();
    }

    public class TestMultiton : ITest
    {
        public TestMultiton(MultitonScope scope)
        {
            
        }
    }
        
    [UsedImplicitly]
    public interface IMultitonTestFactory
    {
        ITest Create(MultitonScope scope);
        void ClearMultitonInstance<T>();
    }
        
    [UsedImplicitly]
    public interface IInvalidMultitonTestFactory
    {
        ITest Create(MultitonScope scope);
        ITest Create(int number);
    }
        
    [UsedImplicitly]
    public interface ITestFactoryWrongReturn
    {
        public MultitonScope Create();
    }
        
    public class MultitonScope
    {

    }
        
    private IocContainer _iocContainer;

    [SetUp]
    public void SetUp() => _iocContainer = new IocContainer();

    [TearDown]
    public void TearDown() => _iocContainer.Dispose();
        
    [Test]
    public void TestFluentFactoryRegistration()
    {
        _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactory>());

        ITestFactory factory = _iocContainer.Resolve<ITestFactory>();
        ITest test = factory.Create();
        
        Assert.That(factory, Is.InstanceOf<ITestFactory>());
        Assert.That(test, Is.InstanceOf<ITest>());
    }
        
    [Test]
    public void TestFluentFactoryRegistrationResolveWithoutFactoryFails()
    {
        _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactory>());
        Assert.Throws<DirectResolveWithRegisteredFactoryNotAllowed>(()=>_iocContainer.Resolve<ITest>());
    }
        
    [Test]
    public void TestFluentFactoryRegistration_CustomFactory()
    {
        _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactory, TestFactory>());

        ITestFactory factory = _iocContainer.Resolve<ITestFactory>();
        ITest test = factory.Create();
            
        Assert.That(factory, Is.InstanceOf<ITestFactory>());
        Assert.That(test, Is.InstanceOf<ITest>());
    }
        
    [Test]
    public void TestFluentFactoryRegistration_WithoutFactoryFails()
    {
        _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactory, TestFactory>());
        Assert.Throws<DirectResolveWithRegisteredFactoryNotAllowed>(()=>_iocContainer.Resolve<ITest>());
    }

        
    [Test]
    public void TestRegisterFactoryWithoutCreate() => Assert.Throws<InvalidFactoryRegistrationException>(() => _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactoryNoCreate>()));
        
    [Test]
    public void TestRegisterFactoryClearMultitonsNonGeneric() => Assert.Throws<IllegalAbstractMethodCreationException>(() => _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactoryNonGenericClear>()));
        
    [Test]
    public void TestResolveFromFactory()
    {
        _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactory>());
        
        ITestFactory testFactory = _iocContainer.Resolve<ITestFactory>();
        ITest createdTest = testFactory.Create();
        
        Assert.That(createdTest, Is.InstanceOf<Test>());
    }
        
    [Test]
    public void TestResolveFromFactoryWithParams()
    {
        _iocContainer.Register(r => r.Add<ITest, TestConstructor>().WithFactory<ITestFactory>());
        _iocContainer.Register(r => r.Add<Test, Test>()); //this registration is abnormal and should only be used in unit tests
        
        ITestFactory testFactory = _iocContainer.Resolve<ITestFactory>();
        ITest createdTest = testFactory.Create("Test");
        
        Assert.That(createdTest, Is.InstanceOf<TestConstructor>());
    }
        
    [Test]
    public void TestResolveFromFactoryWithDefaultParamCreate()
    {
        _iocContainer.Register(r => r.Add<ITest, TestConstructor>().WithFactory<ITestFactory>());
        _iocContainer.Register(r => r.Add<Test, Test>()); //this registration is abnormal and should only be used in unit tests
        
        ITestFactory testFactory = _iocContainer.Resolve<ITestFactory>();
        ITest createdTest = testFactory.CreateTest();
        
        Assert.That(createdTest, Is.InstanceOf<TestConstructor>());
    }
        
    [Test]
    public void TestResolveFromFactoryWithDefaultParamCtor()
    {
        _iocContainer.Register(r => r.Add<ITest, TestConstructor>().WithFactory<ITestFactory>());
        _iocContainer.Register(r => r.Add<Test, Test>()); //this registration is abnormal and should only be used in unit tests
        
        ITestFactory testFactory = _iocContainer.Resolve<ITestFactory>();
        ITest createdTest = testFactory.Create();
        
        Assert.That(createdTest, Is.InstanceOf<TestConstructor>());
    }
        
    [Test]
    public void TestResolveFromFactoryWithByte()
    {
        _iocContainer.Register(r => r.Add<ITest, TestByte>().WithFactory<ITestFactory>());
        
        ITestFactory testFactory = _iocContainer.Resolve<ITestFactory>();
        ITest createdTest = testFactory.Create(1);
        
        Assert.That(createdTest, Is.InstanceOf<TestByte>());
    }

    [Test]
    public void TestPassingNullAsMiddleParameter()
    {
        _iocContainer.Register(r => r.Add<ITest, TestNull>().WithFactory<ITestNullFactory>());

        ITestNullFactory testNullFactory = _iocContainer.Resolve<ITestNullFactory>();

        object obj = new();
        string content = "TestContent";
        string optional2 = "optionalParameter2";

        ITest createdTest = testNullFactory.Create(obj, content, null, optional2);
        if (createdTest is not TestNull testNull)
        {
            Assert.Fail();
            return;
        }
        
        Assert.That(testNull.Obj, Is.SameAs(obj));
        Assert.That(testNull.Content, Is.EqualTo(content));
        Assert.That(testNull.Optional1, Is.EqualTo(null));
        Assert.That(testNull.Optional2, Is.EqualTo(optional2));
    }
    
    [Test]
    public void TestPassingNullAsDefaultParameter()
    {
        _iocContainer.Register(r => r.Add<ITest, TestNull>().WithFactory<ITestDefaultFactory>());

        ITestDefaultFactory testDefaultFactory = _iocContainer.Resolve<ITestDefaultFactory>();

        object obj = new();
        string content = "TestContent";
        string optional2 = "optionalParameter2";

        ITest createdTest = testDefaultFactory.Create(obj, content, null, optional2);
        if (createdTest is not TestNull testNull)
        {
            Assert.Fail();
            return;
        }
        
        Assert.That(testNull.Obj, Is.SameAs(obj));
        Assert.That(testNull.Content, Is.EqualTo(content));
        Assert.That(testNull.Optional1, Is.EqualTo(null));
        Assert.That(testNull.Optional2, Is.EqualTo(optional2));
        Assert.That(testNull.TestNullFactory, Is.EqualTo(null));
    }
        
    [Test]
    public void TestResolveMultitonFromFactory()
    {
        _iocContainer.Register(r => r.AddMultiton<ITest, TestMultiton, MultitonScope>().WithFactory<IMultitonTestFactory>());
        
        MultitonScope scope1 = new();
        MultitonScope scope2 = new();
        
        IMultitonTestFactory testFactory = _iocContainer.Resolve<IMultitonTestFactory>();
        
        ITest resolvedTest1 = testFactory.Create(scope1);
        ITest resolvedTest2 = testFactory.Create(scope1);
        ITest resolvedTest3 = testFactory.Create(scope2);
        
        Assert.That(resolvedTest1, Is.SameAs(resolvedTest2));
        Assert.That(resolvedTest1, Is.Not.SameAs(resolvedTest3));
        Assert.That(resolvedTest2, Is.Not.SameAs(resolvedTest3));
    }
        
    [Test]
    public void TestResolveMultitonFromFactoryClearInstances()
    {
        _iocContainer.Register(r => r.AddMultiton<ITest, TestMultiton, MultitonScope>().WithFactory<IMultitonTestFactory>());
        
        MultitonScope scope1 = new();
        MultitonScope scope2 = new();
        
        IMultitonTestFactory testFactory = _iocContainer.Resolve<IMultitonTestFactory>();
        
        ITest resolvedTest1 = testFactory.Create(scope1);
        ITest resolvedTest2 = testFactory.Create(scope1);
        ITest resolvedTest3 = testFactory.Create(scope2);
        
        Assert.That(resolvedTest1, Is.SameAs(resolvedTest2));
        Assert.That(resolvedTest1, Is.Not.SameAs(resolvedTest3));
        Assert.That(resolvedTest2, Is.Not.SameAs(resolvedTest3));
        
        testFactory.ClearMultitonInstance<ITest>();
        
        ITest resolvedTest4 = testFactory.Create(scope1);
        ITest resolvedTest5 = testFactory.Create(scope2);
        
        Assert.That(resolvedTest1, Is.Not.SameAs(resolvedTest4));
        Assert.That(resolvedTest2, Is.Not.SameAs(resolvedTest4));
        Assert.That(resolvedTest3, Is.Not.SameAs(resolvedTest5));
    }

    [Test]
    public void InvalidMultitonFactoryRegistrationFactoryWithoutParameter() => 
        Assert.Throws<InvalidFactoryRegistrationException>(() => _iocContainer.Register(r => r.AddMultiton<ITest, Test, MultitonScope>().WithFactory<ITestFactory>()));
        
    [Test]
    public void InvalidMultitonFactoryRegistrationFactoryWithoutScopeAsFirstParameter() => 
        Assert.Throws<InvalidFactoryRegistrationException>(() => _iocContainer.Register(r => r.AddMultiton<ITest, Test, MultitonScope>().WithFactory<IInvalidMultitonTestFactory>()));

    [Test]
    public void TestInvalidCreateMethodReturnType() => 
        Assert.Throws<InvalidFactoryRegistrationException>(() => _iocContainer.Register(r => r.Add<ITest, Test>().WithFactory<ITestFactoryWrongReturn>()));
}