Skip to content

Add async TestProbe operations #2288

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

Closed
rogeralsing wants to merge 2 commits into from
Closed

Add async TestProbe operations #2288

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
659d05e
Add async probe tests
rogeralsing Aug 21, 2025
7b1a13f
Merge branch 'dev' into codex/add-async-counterparts-to-itestprobe
rogeralsing Aug 21, 2025
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
78 changes: 78 additions & 0 deletions src/Proto.TestKit/ITestProbe.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,34 @@ public interface ITestProbe
/// <returns></returns>
T GetNextMessage<T>(Func<T, bool> when, TimeSpan? timeAllowed = null);

/// <summary>
/// asynchronously gets the next message from the test probe
/// </summary>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<object?> GetNextMessageAsync(TimeSpan? timeAllowed = null, CancellationToken cancellationToken = default);

/// <summary>
/// asynchronously gets the next message from the test probe
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<T> GetNextMessageAsync<T>(TimeSpan? timeAllowed = null, CancellationToken cancellationToken = default);

/// <summary>
/// asynchronously gets the next message from the test probe
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="when"></param>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<T> GetNextMessageAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default);

/// <summary>
/// keeps returning messages until the interval between messages exceeds the time allowed
/// </summary>
Expand All @@ -81,6 +109,36 @@ public interface ITestProbe
/// <returns></returns>
IEnumerable<T> ProcessMessages<T>(Func<T, bool> when, TimeSpan? timeAllowed = null);

/// <summary>
/// asynchronously processes messages until the interval between messages exceeds the time allowed
/// </summary>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
IAsyncEnumerable<object?> ProcessMessagesAsync(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default);

/// <summary>
/// asynchronously processes messages until the interval between messages exceeds the time allowed
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
IAsyncEnumerable<T> ProcessMessagesAsync<T>(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default);

/// <summary>
/// asynchronously processes messages until the interval between messages exceeds the time allowed
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="when"></param>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
IAsyncEnumerable<T> ProcessMessagesAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default);

/// <summary>
/// fishes for the next message of a given type from the test probe
/// </summary>
Expand All @@ -98,6 +156,26 @@ public interface ITestProbe
/// <returns></returns>
T FishForMessage<T>(Func<T, bool> when, TimeSpan? timeAllowed = null);

/// <summary>
/// asynchronously fishes for the next message of a given type from the test probe
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<T> FishForMessageAsync<T>(TimeSpan? timeAllowed = null, CancellationToken cancellationToken = default);

/// <summary>
/// asynchronously fishes for the next message of a given type from the test probe
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="when"></param>
/// <param name="timeAllowed"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<T> FishForMessageAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default);

/// <summary>
/// sends a message from the test probe to the target
/// </summary>
Expand Down
40 changes: 40 additions & 0 deletions src/Proto.TestKit/TestKitBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,21 @@ public PID SpawnNamed(Props props, string name, Action<IContext>? callback = nul
public T GetNextMessage<T>(Func<T, bool> when, TimeSpan? timeAllowed = null) =>
Probe.GetNextMessage(when, timeAllowed);

/// <inheritdoc />
public Task<object?> GetNextMessageAsync(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.GetNextMessageAsync(timeAllowed, cancellationToken);

/// <inheritdoc />
public Task<T> GetNextMessageAsync<T>(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.GetNextMessageAsync<T>(timeAllowed, cancellationToken);

/// <inheritdoc />
public Task<T> GetNextMessageAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.GetNextMessageAsync(when, timeAllowed, cancellationToken);

/// <inheritdoc />
public IEnumerable ProcessMessages(TimeSpan? timeAllowed = null) => Probe.ProcessMessages(timeAllowed);

Expand All @@ -74,13 +89,38 @@ public T GetNextMessage<T>(Func<T, bool> when, TimeSpan? timeAllowed = null) =>
public IEnumerable<T> ProcessMessages<T>(Func<T, bool> when, TimeSpan? timeAllowed = null) =>
Probe.ProcessMessages(when, timeAllowed);

/// <inheritdoc />
public IAsyncEnumerable<object?> ProcessMessagesAsync(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.ProcessMessagesAsync(timeAllowed, cancellationToken);

/// <inheritdoc />
public IAsyncEnumerable<T> ProcessMessagesAsync<T>(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.ProcessMessagesAsync<T>(timeAllowed, cancellationToken);

/// <inheritdoc />
public IAsyncEnumerable<T> ProcessMessagesAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.ProcessMessagesAsync(when, timeAllowed, cancellationToken);

/// <inheritdoc />
public T FishForMessage<T>(TimeSpan? timeAllowed = null) => Probe.FishForMessage<T>(timeAllowed);

/// <inheritdoc />
public T FishForMessage<T>(Func<T, bool> when, TimeSpan? timeAllowed = null) =>
Probe.FishForMessage(when, timeAllowed);

/// <inheritdoc />
public Task<T> FishForMessageAsync<T>(TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.FishForMessageAsync<T>(timeAllowed, cancellationToken);

/// <inheritdoc />
public Task<T> FishForMessageAsync<T>(Func<T, bool> when, TimeSpan? timeAllowed = null,
CancellationToken cancellationToken = default) =>
Probe.FishForMessageAsync(when, timeAllowed, cancellationToken);

/// <inheritdoc />
public void Send(PID target, object message) => Probe.Send(target, message);

Expand Down
Loading
Loading