Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert TestKitBase and TestProbe to async #5852

Merged
merged 2 commits into from
Apr 19, 2022
Merged

Convert TestKitBase and TestProbe to async #5852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d384f69
Convert TestKitBase and TestProbe to async
Arkatufus Apr 19, 2022
fc3c42e
Merge branch 'feature/async_testkit' into async_testkit/Convert_TestK…
Aaronontheweb Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 108 additions & 18 deletions src/core/Akka.TestKit/TestKitBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
using Akka.Actor.Setup;
using Akka.Configuration;
using Akka.Event;
using Akka.Pattern;
using Akka.TestKit.Extensions;
using Akka.TestKit.Internal;
using Akka.Util;
using Akka.Util.Internal;
Expand Down Expand Up @@ -189,6 +189,7 @@ protected void InitializeTest(ActorSystem system, ActorSystemSetup config, strin
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
// Do not convert this method to async, it is being called inside the constructor.
private static void WaitUntilTestActorIsReady(IActorRef testActor)
{
var deadline = TimeSpan.FromSeconds(5);
Expand Down Expand Up @@ -485,10 +486,32 @@ public TimeSpan GetTimeoutOrDefault(TimeSpan? timeout)
/// </summary>
/// <param name="duration">Optional. The duration to wait for shutdown. Default is 5 seconds multiplied with the config value "akka.test.timefactor".</param>
/// <param name="verifySystemShutdown">if set to <c>true</c> an exception will be thrown on failure.</param>
public virtual void Shutdown(TimeSpan? duration = null, bool verifySystemShutdown = false)
{
Shutdown(_testState.System, duration, verifySystemShutdown);
}
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <exception cref="TimeoutException">TBD</exception>
public virtual void Shutdown(
TimeSpan? duration = null,
bool verifySystemShutdown = false,
CancellationToken cancellationToken = default)
=> ShutdownAsync(_testState.System, duration, verifySystemShutdown, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Shuts down the specified system.
/// On failure debug output will be logged about the remaining actors in the system.
/// If verifySystemShutdown is true, then an exception will be thrown on failure.
/// </summary>
/// <param name="system">The system to shutdown.</param>
/// <param name="duration">The duration to wait for shutdown. Default is 5 seconds multiplied with the config value "akka.test.timefactor"</param>
/// <param name="verifySystemShutdown">if set to <c>true</c> an exception will be thrown on failure.</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <exception cref="TimeoutException">TBD</exception>
protected virtual void Shutdown(
ActorSystem system,
TimeSpan? duration = null,
bool verifySystemShutdown = false,
CancellationToken cancellationToken = default)
=> ShutdownAsync(system, duration, verifySystemShutdown, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Shuts down the specified system.
Expand All @@ -498,20 +521,24 @@ public virtual void Shutdown(TimeSpan? duration = null, bool verifySystemShutdow
/// <param name="system">The system to shutdown.</param>
/// <param name="duration">The duration to wait for shutdown. Default is 5 seconds multiplied with the config value "akka.test.timefactor"</param>
/// <param name="verifySystemShutdown">if set to <c>true</c> an exception will be thrown on failure.</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <exception cref="TimeoutException">TBD</exception>
protected virtual void Shutdown(ActorSystem system, TimeSpan? duration = null, bool verifySystemShutdown = false)
protected virtual async Task ShutdownAsync(
ActorSystem system,
TimeSpan? duration = null,
bool verifySystemShutdown = false,
CancellationToken cancellationToken = default)
{
if (system == null) system = _testState.System;
system ??= _testState.System;

var durationValue = duration.GetValueOrDefault(Dilated(TimeSpan.FromSeconds(5)).Min(TimeSpan.FromSeconds(10)));

var wasShutdownDuringWait = system.Terminate().Wait(durationValue);
var wasShutdownDuringWait = await system.Terminate().AwaitWithTimeout(durationValue, cancellationToken);
if(!wasShutdownDuringWait)
{
const string msg = "Failed to stop [{0}] within [{1}] \n{2}";
if(verifySystemShutdown)
throw new TimeoutException(string.Format(msg, system.Name, durationValue, ""));
//TODO: replace "" with system.PrintTree()
system.Log.Warning(msg, system.Name, durationValue, ""); //TODO: replace "" with system.PrintTree()
}
}
Expand All @@ -522,46 +549,109 @@ protected virtual void Shutdown(ActorSystem system, TimeSpan? duration = null, b
/// <param name="props">Child actor props</param>
/// <param name="name">Child actor name</param>
/// <param name="supervisorStrategy">Supervisor strategy for the child actor</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, string name, SupervisorStrategy supervisorStrategy)
public IActorRef ChildActorOf(
Props props,
string name,
SupervisorStrategy supervisorStrategy,
CancellationToken cancellationToken = default)
=> ChildActorOfAsync(props, name, supervisorStrategy, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's IActorRef
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="name">Child actor name</param>
/// <param name="supervisorStrategy">Supervisor strategy for the child actor</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync(
Props props,
string name,
SupervisorStrategy supervisorStrategy,
CancellationToken cancellationToken = default)
{
TestActor.Tell(new TestActor.Spawn(props, name, supervisorStrategy));
return ExpectMsg<IActorRef>();
return await ExpectMsgAsync<IActorRef>(cancellationToken: cancellationToken)
.ConfigureAwait(false);
}

/// <summary>
/// Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="supervisorStrategy">Supervisor strategy for the child actor</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, SupervisorStrategy supervisorStrategy)
public IActorRef ChildActorOf(
Props props, SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default)
=> ChildActorOfAsync(props, supervisorStrategy, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="supervisorStrategy">Supervisor strategy for the child actor</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync(
Props props, SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default)
{
TestActor.Tell(new TestActor.Spawn(props, Option<string>.None, supervisorStrategy));
return ExpectMsg<IActorRef>();
return await ExpectMsgAsync<IActorRef>(cancellationToken: cancellationToken)
.ConfigureAwait(false);
}

/// <summary>
/// Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="name">Child actor name</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, string name, CancellationToken cancellationToken = default)
=> ChildActorOfAsync(props, name, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="name">Child actor name</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, string name)
public async Task<IActorRef> ChildActorOfAsync(
Props props, string name, CancellationToken cancellationToken = default)
{
TestActor.Tell(new TestActor.Spawn(props, name, Option<SupervisorStrategy>.None));
return ExpectMsg<IActorRef>();
return await ExpectMsgAsync<IActorRef>(cancellationToken: cancellationToken)
.ConfigureAwait(false);
}

/// <summary>
/// Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, CancellationToken cancellationToken = default)
=> ChildActorOfAsync(props, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

/// <summary>
/// Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
/// </summary>
/// <param name="props">Child actor props</param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props)
public async Task<IActorRef> ChildActorOfAsync(Props props, CancellationToken cancellationToken = default)
{
TestActor.Tell(new TestActor.Spawn(props, Option<string>.None, Option<SupervisorStrategy>.None));
return ExpectMsg<IActorRef>();
return await ExpectMsgAsync<IActorRef>(cancellationToken: cancellationToken)
.ConfigureAwait(false);
}

/// <summary>
Expand Down
103 changes: 67 additions & 36 deletions src/core/Akka.TestKit/TestProbe.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Akka.Actor;
using Akka.Dispatch.SysMsg;
using Akka.Util;
Expand Down Expand Up @@ -167,70 +169,99 @@ public void SendSystemMessage(ISystemMessage message, IActorRef sender)
/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="props"></param>
/// <param name="name"></param>
/// <param name="supervisorStrategy"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, String name, SupervisorStrategy supervisorStrategy)
{
return ((TestKitBase)this).ChildActorOf(props, name, supervisorStrategy);
}
public IActorRef ChildActorOf<T>(
string name,
SupervisorStrategy supervisorStrategy,
CancellationToken cancellationToken = default)
where T : ActorBase
=> ChildActorOfAsync(Props.Create<T>(), name, supervisorStrategy, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

public IActorRef ChildActorOf<T>(String name, SupervisorStrategy supervisorStrategy)
/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="name"></param>
/// <param name="supervisorStrategy"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync<T>(
string name,
SupervisorStrategy supervisorStrategy,
CancellationToken cancellationToken = default)
where T : ActorBase
{
return ((TestKitBase)this).ChildActorOf(Props.Create<T>(), name, supervisorStrategy);
}
=> await ChildActorOfAsync(Props.Create<T>(), name, supervisorStrategy, cancellationToken)
.ConfigureAwait(false);


/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="props"></param>
/// <param name="supervisorStrategy"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, SupervisorStrategy supervisorStrategy)
{
return ((TestKitBase)this).ChildActorOf(props, supervisorStrategy);
}
public IActorRef ChildActorOf<T>(
SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default)
where T : ActorBase
=> ChildActorOfAsync(Props.Create<T>(), supervisorStrategy, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

public IActorRef ChildActorOf<T>(SupervisorStrategy supervisorStrategy)
/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="supervisorStrategy"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync<T>(
SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default)
where T : ActorBase
{
return ((TestKitBase)this).ChildActorOf(Props.Create<T>(), supervisorStrategy);
}
=> await ChildActorOfAsync(Props.Create<T>(), supervisorStrategy, cancellationToken)
.ConfigureAwait(false);

/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="props"></param>
/// <param name="name"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props, String name)
{
return ((TestKitBase)this).ChildActorOf(props, name);
}
public IActorRef ChildActorOf<T>(string name, CancellationToken cancellationToken = default)
where T : ActorBase
=> ChildActorOfAsync(Props.Create<T>(), name, cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

public IActorRef ChildActorOf<T>(String name)
/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="name"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync<T>(string name, CancellationToken cancellationToken = default)
where T : ActorBase
{
return ((TestKitBase)this).ChildActorOf(Props.Create<T>(), name);
}
=> await ChildActorOfAsync(Props.Create<T>(), name, cancellationToken)
.ConfigureAwait(false);

/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="props"></param>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public IActorRef ChildActorOf(Props props)
{
return ((TestKitBase)this).ChildActorOf(props);
}
public IActorRef ChildActorOf<T>(CancellationToken cancellationToken = default)
where T : ActorBase
=> ChildActorOfAsync(Props.Create<T>(), cancellationToken)
.ConfigureAwait(false).GetAwaiter().GetResult();

public IActorRef ChildActorOf<T>()
/// <summary>
/// Spawns an actor as a child of this test actor, and returns the child's ActorRef.
/// </summary>
/// <param name="cancellationToken"><see cref="CancellationToken"/> to cancel the operation</param>
/// <returns></returns>
public async Task<IActorRef> ChildActorOfAsync<T>(CancellationToken cancellationToken = default)
where T : ActorBase
{
return ((TestKitBase)this).ChildActorOf(Props.Create<T>());
}
=> await ChildActorOfAsync(Props.Create<T>(), cancellationToken)
.ConfigureAwait(false);

/// <summary>
/// Sends a system message to the test probe
Expand Down