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

Fix WithSingleton and WithSingletonProxy API #520

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Fix WithSingleton and WithSingletonProxy API #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
194 changes: 193 additions & 1 deletion src/Akka.Cluster.Hosting.Tests/ClusterSingletonSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
using Akka.Actor;
using Akka.Hosting;
using FluentAssertions;
using FluentAssertions.Extensions;
using Microsoft.Extensions.DependencyInjection;
using Xunit;
using Xunit.Abstractions;
using static FluentAssertions.FluentActions;

namespace Akka.Cluster.Hosting.Tests;

Expand Down Expand Up @@ -50,7 +52,145 @@ public async Task Should_launch_ClusterSingletonAndProxy()
await host.StopAsync();
}

[Fact]
[Fact(DisplayName = "Should launch singleton manager and proxy at the appropriate path (no manager name, actor props)")]
public async Task ClusterSingletonAndProxyWithNoManagerNameTest()
{
using var host = await TestHelper.CreateHost(
builder =>
{
builder.WithSingleton<MySingletonActor>(
singletonName: "my-singleton",
actorProps: MySingletonActor.MyProps);
},
new ClusterOptions
{
Roles = new[] { "my-host" }
}, Output);

var system = host.Services.GetRequiredService<ActorSystem>();
var registry = host.Services.GetRequiredService<ActorRegistry>();
var singletonProxy = await registry.GetAsync<MySingletonActor>();

var address = Cluster.Get(system).SelfAddress;
var expectedSingletonPath = new RootActorPath(address) / "user" / "my-singleton" / "my-singleton";
var singletonSelector = system.ActorSelection(expectedSingletonPath);

await Awaiting(async () =>
{
var identify = await singletonSelector.ResolveOne(3.Seconds());
identify.Should().NotBe(ActorRefs.Nobody);
}).Should().NotThrowAsync();

singletonProxy.Path.ToString().Should().Be("akka://TestSys/user/my-singleton-proxy");

await host.StopAsync();
}

[Fact(DisplayName = "Should launch singleton manager and proxy at the appropriate path (no manager name, actor factory)")]
public async Task ClusterSingletonAndProxyWithNoManagerNameAndFactoryTest()
{
using var host = await TestHelper.CreateHost(
builder =>
{
builder.WithSingleton<MySingletonActor>(
singletonName: "my-singleton",
propsFactory: (_, _, _) => MySingletonActor.MyProps);
},
new ClusterOptions
{
Roles = new[] { "my-host" }
}, Output);

var system = host.Services.GetRequiredService<ActorSystem>();
var registry = host.Services.GetRequiredService<ActorRegistry>();
var singletonProxy = await registry.GetAsync<MySingletonActor>();

var address = Cluster.Get(system).SelfAddress;
var expectedSingletonPath = new RootActorPath(address) / "user" / "my-singleton" / "my-singleton";
var singletonSelector = system.ActorSelection(expectedSingletonPath);

await Awaiting(async () =>
{
var identify = await singletonSelector.ResolveOne(3.Seconds());
identify.Should().NotBe(ActorRefs.Nobody);
}).Should().NotThrowAsync();

singletonProxy.Path.ToString().Should().Be("akka://TestSys/user/my-singleton-proxy");

await host.StopAsync();
}

[Fact(DisplayName = "Should launch singleton manager and proxy at the appropriate path (with manager name, actor props)")]
public async Task ClusterSingletonAndProxyWithManagerNameTest()
{
using var host = await TestHelper.CreateHost(
builder =>
{
builder.WithSingleton<MySingletonActor>(
singletonManagerName: "my-singleton",
singletonName: "singleton",
actorProps: MySingletonActor.MyProps);
},
new ClusterOptions
{
Roles = new[] { "my-host" }
}, Output);

var system = host.Services.GetRequiredService<ActorSystem>();
var registry = host.Services.GetRequiredService<ActorRegistry>();
var singletonProxy = await registry.GetAsync<MySingletonActor>();

var address = Cluster.Get(system).SelfAddress;
var expectedSingletonPath = new RootActorPath(address) / "user" / "my-singleton" / "singleton";
var singletonSelector = system.ActorSelection(expectedSingletonPath);

await Awaiting(async () =>
{
var identify = await singletonSelector.ResolveOne(3.Seconds());
identify.Should().NotBe(ActorRefs.Nobody);
}).Should().NotThrowAsync();

singletonProxy.Path.ToString().Should().Be("akka://TestSys/user/singleton-proxy");

await host.StopAsync();
}

[Fact(DisplayName = "Should launch singleton manager and proxy at the appropriate path (with manager name, actor factory)")]
public async Task ClusterSingletonAndProxyWithManagerNameAndFactoryTest()
{
using var host = await TestHelper.CreateHost(
builder =>
{
builder.WithSingleton<MySingletonActor>(
singletonManagerName: "my-singleton",
singletonName: "singleton",
propsFactory: (_, _, _) => MySingletonActor.MyProps);
},
new ClusterOptions
{
Roles = new[] { "my-host" }
}, Output);

var system = host.Services.GetRequiredService<ActorSystem>();
var registry = host.Services.GetRequiredService<ActorRegistry>();
var singletonProxy = await registry.GetAsync<MySingletonActor>();

var address = Cluster.Get(system).SelfAddress;
var expectedSingletonPath = new RootActorPath(address) / "user" / "my-singleton" / "singleton";
var singletonSelector = system.ActorSelection(expectedSingletonPath);

await Awaiting(async () =>
{
var identify = await singletonSelector.ResolveOne(3.Seconds());
identify.Should().NotBe(ActorRefs.Nobody);
}).Should().NotThrowAsync();

singletonProxy.Path.ToString().Should().Be("akka://TestSys/user/singleton-proxy");

await host.StopAsync();
}

[Fact(DisplayName = "WithSingletonProxy should work with no manager name")]
public async Task Should_launch_ClusterSingleton_and_Proxy_separately()
{
// arrange
Expand Down Expand Up @@ -80,4 +220,56 @@ public async Task Should_launch_ClusterSingleton_and_Proxy_separately()

await Task.WhenAll(singletonHost.StopAsync(), singletonProxyHost.StopAsync());
}

[Fact(DisplayName = "WithSingletonProxy should work with manager name")]
public async Task SeparateProxyWithManagerNameTest()
{
// arrange

var singletonOptions = new ClusterSingletonOptions() { Role = "my-host" };
using var singletonHost = await TestHelper.CreateHost(
builder =>
{
builder.WithSingleton<MySingletonActor>(
singletonManagerName: "my-singleton",
singletonName: "singleton",
actorProps: MySingletonActor.MyProps,
options: singletonOptions,
createProxyToo:false);
},
new ClusterOptions
{
Roles = new[] { "my-host" }
}, Output);

var singletonSystem = singletonHost.Services.GetRequiredService<ActorSystem>();
var address = Cluster.Get(singletonSystem).SelfAddress;

using var singletonProxyHost = await TestHelper.CreateHost(
builder =>
{
builder.WithSingletonProxy<MySingletonActor>(
singletonManagerName: "my-singleton",
singletonName: "singleton",
options: singletonOptions);
},
new ClusterOptions
{
Roles = new[] { "proxy" },
SeedNodes = new []{ address.ToString() }
}, Output);

var registry = singletonProxyHost.Services.GetRequiredService<ActorRegistry>();
var singletonProxy = await registry.GetAsync<MySingletonActor>();

// act

// verify round-trip to the singleton proxy and back
var respond = await singletonProxy.Ask<string>("hit", 3.Seconds());

// assert
respond.Should().Be("hit");

await Task.WhenAll(singletonHost.StopAsync(), singletonProxyHost.StopAsync());
}
}
Loading
Loading