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.

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

Add graceful stop specs #6103

Merged
merged 3 commits into from
Sep 17, 2022
Merged
Changes from 2 commits
Commits
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
71 changes: 71 additions & 0 deletions src/core/Akka.Tests/Actor/GracefulStopSpecs.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
//-----------------------------------------------------------------------
// <copyright file="GracefulStopSpecs.cs" company="Akka.NET Project">
// Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2022 .NET Foundation <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System;
using System.Threading.Tasks;
using Akka.Actor;
using Akka.Actor.Dsl;
using Akka.TestKit;
using Akka.TestKit.TestActors;
using Xunit;
using FluentAssertions;

namespace Akka.Tests.Actor
{
public class GracefulStopSpecs : AkkaSpec
{
[Fact(DisplayName = "GracefulStop should terminate target actor on-time")]
public async Task GracefulStopShouldTerminateOnTime()
{
// arrange
var actor = Sys.ActorOf(BlackHoleActor.Props);
Watch(actor);

// act
var stopped = await actor.GracefulStop(TimeSpan.FromSeconds(3));
await ExpectTerminatedAsync(actor);

// assert
stopped.Should().BeTrue();
}

[Fact(DisplayName = "GracefulStop should return true for an already terminated actor")]
public async Task GracefulStopShouldReturnTrueForAlreadyDeadActor()
{
// arrange
var actor = Sys.ActorOf(BlackHoleActor.Props);
Watch(actor);

// act
Sys.Stop(actor);
await ExpectTerminatedAsync(actor);
var stopped = await actor.GracefulStop(TimeSpan.FromSeconds(3));

// assert
stopped.Should().BeTrue();
}

private class CustomShutdown{}

[Fact(DisplayName = "GracefulStop should return false if shutdown goes overtime", Skip = "GracefulStop currently throws a TaskCancellationException, which seems wrong")]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marked this test as Skipped for now - going to change that in #6102

This API is wrong. We shouldn't throw an Exception if graceful stop fails to complete on-time - we should simply return false. Otherwise there's no point to having a return value at all.

public async Task GracefulStopShouldThrowIfShutdownGoesOvertime()
{
// arrange
var actor = Sys.ActorOf(act => act.ReceiveAsync<CustomShutdown>(async (a, ctx) =>
{
await Task.Delay(200);
ctx.Stop(ctx.Self);
}));

// act
var stopped = await actor.GracefulStop(TimeSpan.FromMilliseconds(10), new CustomShutdown());

// assert
stopped.Should().BeFalse();
}
}
}