[DependencyInjection] Stashing actor spec (#6689)

* [DependencyInjection] Stashing actor spec

* Add both IWithStash and IWithUnboundedStash

* Add child actor unit tests

Author: Arkatufus

src/contrib/dependencyinjection/Akka.DependencyInjection.Tests/ActorWithStashSpec.cs

@@ -0,0 +1,167 @@
+//-----------------------------------------------------------------------
+// <copyright file="ActorWithStashSpec.cs" company="Akka.NET Project">
+//     Copyright (C) 2013-2023 .NET Foundation <https://github.com/akkadotnet/akka.net>
+// </copyright>
+//-----------------------------------------------------------------------
+
+using Akka.Actor;
+using Akka.TestKit;
+using FluentAssertions;
+using FluentAssertions.Extensions;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Akka.DependencyInjection.Tests;
+
+public class ActorWithStashSpec: AkkaSpec, IClassFixture<AkkaDiFixture>
+{
+    public ActorWithStashSpec(AkkaDiFixture fixture, ITestOutputHelper output) 
+        : base(
+            DependencyResolverSetup.Create(fixture.Provider)
+                .And(BootstrapSetup.Create().WithConfig(TestKitBase.DefaultConfig)), 
+            output)
+    {
+    }
+
+    [Fact(DisplayName = "DependencyInjection should create actor with IWithStash interface")]
+    public void WithStashActorTest()
+    {
+        var stashActor = GetActorOf<WithStashActor>(Sys);
+        
+        stashActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        stashActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        
+        stashActor.Tell(StartProcessing.Instance, TestActor);
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectNoMsg(0.3.Seconds());
+    }
+    
+    [Fact(DisplayName = "DependencyInjection should create actor with IWithUnboundedStash interface")]
+    public void WithUnboundedStashActorTest()
+    {
+        var stashActor = GetActorOf<WithUnboundedStashActor>(Sys);
+        
+        stashActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        stashActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        
+        stashActor.Tell(StartProcessing.Instance, TestActor);
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectNoMsg(0.3.Seconds());
+    }
+    
+    [Fact(DisplayName = "DependencyInjection should create child actor with IWithStash interface")]
+    public void WithStashChildActorTest()
+    {
+        var parentActor = Sys.ActorOf(Props.Create(() => new ParentActor<WithStashActor>()));
+        
+        parentActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        parentActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        
+        parentActor.Tell(StartProcessing.Instance, TestActor);
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectNoMsg(0.3.Seconds());
+    }
+    
+    [Fact(DisplayName = "DependencyInjection should create child actor with IWithUnboundedStash interface")]
+    public void WithUnboundedStashChildActorTest()
+    {
+        var parentActor = Sys.ActorOf(Props.Create(() => new ParentActor<WithUnboundedStashActor>()));
+        
+        parentActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        parentActor.Tell(GetName.Instance, TestActor);
+        ExpectNoMsg(0.3.Seconds());
+        
+        parentActor.Tell(StartProcessing.Instance, TestActor);
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectMsg<string>().Should().StartWith("s");
+        ExpectNoMsg(0.3.Seconds());
+    }
+    
+    private static IActorRef GetActorOf<T>(ActorSystem actorSystem) where T: ActorBase
+        => actorSystem.ActorOf(DependencyResolver.For(actorSystem).Props<T>());
+    
+    private static IActorRef GetActorOf<T>(IActorContext actorContext, ActorSystem actorSystem) where T: ActorBase
+        => actorContext.ActorOf(DependencyResolver.For(actorSystem).Props<T>());
+    
+    private sealed class WithStashActor: StashingActor, IWithStash
+    {
+        public WithStashActor(AkkaDiFixture.IScopedDependency scoped) : base(scoped)
+        {
+        }
+    }
+    
+    private sealed class WithUnboundedStashActor: StashingActor, IWithUnboundedStash
+    {
+        public WithUnboundedStashActor(AkkaDiFixture.IScopedDependency scoped) : base(scoped)
+        {
+        }
+    }
+    
+    private sealed class ParentActor<T>: ReceiveActor where T: StashingActor
+    {
+        public ParentActor()
+        {
+            var child = GetActorOf<T>(Context, Context.System);
+            ReceiveAny(msg => child.Forward(msg));
+        }
+    }
+    
+    private abstract class StashingActor : ReceiveActor
+    {
+        private readonly AkkaDiFixture.IScopedDependency _scoped;
+
+        protected StashingActor(AkkaDiFixture.IScopedDependency scoped)
+        {
+            _scoped = scoped;
+            Become(Stashing);
+        }
+
+        private bool Stashing(object message)
+        {
+            if (message is StartProcessing)
+            {
+                Become(Processing);
+                Stash.UnstashAll();
+                return true;
+            }
+            
+            Stash.Stash();
+            return true;
+        }
+
+        private bool Processing(object message)
+        {
+            if (message is GetName)
+            {
+                Sender.Tell(_scoped.Name);
+                return true;
+            }
+
+            return false;
+        }
+        
+        public IStash Stash { get; set; }
+    }
+    
+    private sealed class GetName
+    {
+        public static readonly GetName Instance = new();
+        private GetName() { }
+    }
+    
+    private sealed class StartProcessing
+    {
+        public static readonly StartProcessing Instance = new();
+        private StartProcessing() { }
+    }
+}