using System.Reflection;
using GFramework.Core.Abstractions.state;
using GFramework.Core.state;
using NUnit.Framework;
namespace GFramework.Core.Tests.state;
///
/// 测试状态机功能的单元测试类
///
[TestFixture]
public class StateMachineTests
{
///
/// 在每个测试方法执行前初始化状态机实例
///
[SetUp]
public void SetUp()
{
_stateMachine = new StateMachine();
}
private StateMachine _stateMachine = null!;
///
/// 验证当没有活动状态时,当前状态应为null
///
[Test]
public void Current_Should_BeNull_When_NoState_Active()
{
Assert.That(_stateMachine.Current, Is.Null);
}
///
/// 验证注册状态后,状态会被添加到状态字典中
///
[Test]
public void Register_Should_AddState_To_StatesDictionary()
{
var state = new TestStateV2();
_stateMachine.Register(state);
Assert.That(_stateMachine.ContainsState(), Is.True);
}
///
/// 验证异步注销后状态应从字典中移除
///
[Test]
public async Task UnregisterAsync_Should_RemoveState_FromDictionary()
{
var state = new TestStateV2();
_stateMachine.Register(state);
await _stateMachine.UnregisterAsync();
Assert.That(_stateMachine.ContainsState(), Is.False);
}
///
/// 验证异步注销活动异步状态时调用OnExitAsync
///
[Test]
public async Task UnregisterAsync_WhenStateIsActive_WithAsyncState_Should_Invoke_OnExitAsync()
{
var state = new TestAsyncState();
_stateMachine.Register(state);
await _stateMachine.ChangeToAsync();
await _stateMachine.UnregisterAsync();
Assert.That(state.ExitCalled, Is.True);
Assert.That(state.ExitTo, Is.Null);
Assert.That(_stateMachine.Current, Is.Null);
}
///
/// 验证异步切换检查未注册状态返回false
///
[Test]
public async Task CanChangeToAsync_WhenStateNotRegistered_Should_ReturnFalse()
{
var result = await _stateMachine.CanChangeToAsync();
Assert.That(result, Is.False);
}
///
/// 验证异步切换检查已注册状态返回true
///
[Test]
public async Task CanChangeToAsync_WhenStateRegistered_Should_ReturnTrue()
{
var state = new TestStateV2();
_stateMachine.Register(state);
var result = await _stateMachine.CanChangeToAsync();
Assert.That(result, Is.True);
}
///
/// 验证异步切换检查使用异步状态时调用CanTransitionToAsync
///
[Test]
public async Task CanChangeToAsync_WithAsyncState_Should_Call_CanTransitionToAsync()
{
var state1 = new TestAsyncState();
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.CanChangeToAsync();
Assert.That(state1.CanTransitionToCallCount, Is.EqualTo(1));
}
///
/// 验证异步状态切换能够正确设置当前状态
///
[Test]
public async Task ChangeToAsync_Should_SetCurrentState()
{
var state = new TestStateV2();
_stateMachine.Register(state);
await _stateMachine.ChangeToAsync();
Assert.That(_stateMachine.Current, Is.SameAs(state));
}
///
/// 验证异步状态切换对于异步状态调用OnEnterAsync
///
[Test]
public async Task ChangeToAsync_Should_Invoke_OnEnterAsync_ForAsyncState()
{
var state = new TestAsyncState();
_stateMachine.Register(state);
await _stateMachine.ChangeToAsync();
Assert.That(state.EnterCalled, Is.True);
Assert.That(state.EnterFrom, Is.Null);
}
///
/// 验证异步状态切换对于同步状态调用OnEnter
///
[Test]
public async Task ChangeToAsync_Should_Invoke_OnEnter_ForSyncState()
{
var state = new TestStateV2();
_stateMachine.Register(state);
await _stateMachine.ChangeToAsync();
Assert.That(state.EnterCalled, Is.True);
Assert.That(state.EnterFrom, Is.Null);
}
///
/// 验证异步状态切换当存在当前异步状态时调用OnExitAsync
///
[Test]
public async Task ChangeToAsync_When_CurrentStateExists_WithAsyncState_Should_Invoke_OnExitAsync()
{
var state1 = new TestAsyncState();
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.ExitCalled, Is.True);
Assert.That(state1.ExitTo, Is.SameAs(state2));
}
///
/// 验证异步状态切换当存在当前同步状态时调用OnExit
///
[Test]
public async Task ChangeToAsync_When_CurrentStateExists_WithSyncState_Should_Invoke_OnExit()
{
var state1 = new TestStateV2();
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.ExitCalled, Is.True);
Assert.That(state1.ExitTo, Is.SameAs(state2));
}
///
/// 验证异步状态切换到相同状态时不应调用回调方法
///
[Test]
public async Task ChangeToAsync_ToSameState_Should_NotInvoke_Callbacks()
{
var state = new TestStateV2();
_stateMachine.Register(state);
await _stateMachine.ChangeToAsync();
var enterCount = state.EnterCallCount;
var exitCount = state.ExitCallCount;
await _stateMachine.ChangeToAsync();
Assert.That(state.EnterCallCount, Is.EqualTo(enterCount));
Assert.That(state.ExitCallCount, Is.EqualTo(exitCount));
}
///
/// 验证异步状态切换到未注册状态时应抛出InvalidOperationException
///
[Test]
public void ChangeToAsync_ToUnregisteredState_Should_ThrowInvalidOperationException()
{
Assert.ThrowsAsync(async () => await _stateMachine.ChangeToAsync());
}
///
/// 验证异步状态切换当当前状态拒绝转换时不应发生状态变化
///
[Test]
public async Task ChangeToAsync_WhenCurrentStateDeniesTransition_Should_NotChange()
{
var state1 = new TestStateV2 { AllowTransition = false };
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
var oldState = _stateMachine.Current;
var result = await _stateMachine.ChangeToAsync();
Assert.That(result, Is.False);
Assert.That(_stateMachine.Current, Is.SameAs(oldState));
Assert.That(_stateMachine.Current, Is.SameAs(state1));
Assert.That(state2.EnterCalled, Is.False);
}
///
/// 验证异步状态切换当当前异步状态拒绝转换时调用CanTransitionToAsync
///
[Test]
public async Task ChangeToAsync_WhenCurrentStateDeniesTransition_WithAsyncState_Should_Call_CanTransitionToAsync()
{
var state1 = new TestAsyncState { AllowTransition = false };
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.CanTransitionToCallCount, Is.EqualTo(1));
}
///
/// 验证异步回退能够返回到上一个状态
///
[Test]
public async Task GoBackAsync_Should_ReturnTo_PreviousState()
{
var state1 = new TestStateV2();
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
var result = await _stateMachine.GoBackAsync();
Assert.That(result, Is.True);
Assert.That(_stateMachine.Current, Is.SameAs(state1));
}
///
/// 验证异步回退当没有历史记录时返回false
///
[Test]
public async Task GoBackAsync_WhenNoHistory_Should_ReturnFalse()
{
var result = await _stateMachine.GoBackAsync();
Assert.That(result, Is.False);
}
///
/// 验证异步回退调用正确的状态转换方法
///
[Test]
public async Task GoBackAsync_Should_Invoke_Correct_Transition_Methods()
{
var state1 = new TestAsyncState();
var state2 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
await _stateMachine.GoBackAsync();
Assert.That(state2.ExitCalled, Is.True);
Assert.That(state1.EnterCallCount, Is.EqualTo(2));
}
///
/// 验证从同步状态切换到异步状态能够正常工作
///
[Test]
public async Task ChangeToAsync_FromSyncToAsyncState_Should_Work()
{
var state1 = new TestStateV2();
var state2 = new TestAsyncState();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.ExitCalled, Is.True);
Assert.That(state2.EnterCalled, Is.True);
Assert.That(_stateMachine.Current, Is.SameAs(state2));
}
///
/// 验证从异步状态切换到同步状态能够正常工作
///
[Test]
public async Task ChangeToAsync_FromAsyncToSyncState_Should_Work()
{
var state1 = new TestAsyncState();
var state2 = new TestStateV2();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.ExitCalled, Is.True);
Assert.That(state2.EnterCalled, Is.True);
Assert.That(_stateMachine.Current, Is.SameAs(state2));
}
///
/// 验证多次异步状态转换应正确调用回调方法
///
[Test]
public async Task MultipleAsyncStateChanges_Should_Invoke_Callbacks_Correctly()
{
var state1 = new TestAsyncState();
var state2 = new TestStateV2();
var state3 = new TestStateV3();
_stateMachine.Register(state1);
_stateMachine.Register(state2);
_stateMachine.Register(state3);
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
await _stateMachine.ChangeToAsync();
Assert.That(state1.EnterCalled, Is.True);
Assert.That(state1.ExitCalled, Is.True);
Assert.That(state2.EnterCalled, Is.True);
Assert.That(state2.ExitCalled, Is.True);
Assert.That(state3.EnterCalled, Is.True);
Assert.That(state3.ExitCalled, Is.False);
}
}
///
/// 测试状态类V2版本,实现IState接口用于测试
///
public sealed class TestStateV2 : IState
{
public bool AllowTransition { get; set; } = true;
public bool EnterCalled { get; private set; }
public bool ExitCalled { get; private set; }
public int EnterCallCount { get; private set; }
public int ExitCallCount { get; private set; }
public IState? EnterFrom { get; private set; }
public IState? ExitTo { get; private set; }
///
/// 进入状态时的回调方法
///
/// 从哪个状态进入
public void OnEnter(IState? from)
{
EnterCalled = true;
EnterCallCount++;
EnterFrom = from;
}
///
/// 离开状态时的回调方法
///
/// 离开到哪个状态
public void OnExit(IState? to)
{
ExitCalled = true;
ExitCallCount++;
ExitTo = to;
}
///
/// 判断是否可以转换到目标状态
///
/// 目标状态
/// 是否允许转换
public bool CanTransitionTo(IState target)
{
return AllowTransition;
}
}
///
/// 测试状态类V3版本,实现IState接口用于测试
///
public sealed class TestStateV3 : IState
{
public bool EnterCalled { get; private set; }
public bool ExitCalled { get; private set; }
public int EnterCallCount { get; private set; }
public int ExitCallCount { get; private set; }
public IState? EnterFrom { get; private set; }
public IState? ExitTo { get; private set; }
///
/// 进入状态时的回调方法
///
/// 从哪个状态进入
public void OnEnter(IState? from)
{
EnterCalled = true;
EnterCallCount++;
EnterFrom = from;
}
///
/// 离开状态时的回调方法
///
/// 离开到哪个状态
public void OnExit(IState? to)
{
ExitCalled = true;
ExitCallCount++;
ExitTo = to;
}
///
/// 判断是否可以转换到目标状态
///
/// 目标状态
/// 是否允许转换
public bool CanTransitionTo(IState target)
{
return true;
}
}
///
/// 测试状态类V4版本,实现IState接口用于测试
///
public sealed class TestStateV4 : IState
{
public bool EnterCalled { get; private set; }
public bool ExitCalled { get; private set; }
public int EnterCallCount { get; private set; }
public int ExitCallCount { get; private set; }
public IState? EnterFrom { get; private set; }
public IState? ExitTo { get; private set; }
///
/// 进入状态时的回调方法
///
/// 从哪个状态进入
public void OnEnter(IState? from)
{
EnterCalled = true;
EnterCallCount++;
EnterFrom = from;
}
///
/// 离开状态时的回调方法
///
/// 离开到哪个状态
public void OnExit(IState? to)
{
ExitCalled = true;
ExitCallCount++;
ExitTo = to;
}
///
/// 判断是否可以转换到目标状态
///
/// 目标状态
/// 是否允许转换
public bool CanTransitionTo(IState target)
{
return true;
}
}
///
/// 异步测试状态类,同时实现IState和IAsyncState接口用于测试异步状态功能
///
public sealed class TestAsyncState : IState, IAsyncState
{
public bool AllowTransition { get; set; } = true;
public bool EnterCalled { get; private set; }
public bool ExitCalled { get; private set; }
public int EnterCallCount { get; private set; }
public int ExitCallCount { get; private set; }
public IState? EnterFrom { get; private set; }
public IState? ExitTo { get; private set; }
public int CanTransitionToCallCount { get; private set; }
///
/// 异步进入状态时的回调方法
///
/// 从哪个状态进入
public async Task OnEnterAsync(IState? from)
{
await Task.Delay(1);
EnterCalled = true;
EnterCallCount++;
EnterFrom = from;
}
///
/// 异步离开状态时的回调方法
///
/// 离开到哪个状态
public async Task OnExitAsync(IState? to)
{
await Task.Delay(1);
ExitCalled = true;
ExitCallCount++;
ExitTo = to;
}
///
/// 异步判断是否可以转换到目标状态
///
/// 目标状态
/// 是否允许转换
public async Task CanTransitionToAsync(IState target)
{
await Task.Delay(1);
CanTransitionToCallCount++;
return AllowTransition;
}
///
/// 进入状态时的回调方法(同步版本,抛出异常表示不应被调用)
///
/// 从哪个状态进入
public void OnEnter(IState? from)
{
throw new InvalidOperationException("Sync OnEnter should not be called for async state");
}
///
/// 离开状态时的回调方法(同步版本,抛出异常表示不应被调用)
///
/// 离开到哪个状态
public void OnExit(IState? to)
{
throw new InvalidOperationException("Sync OnExit should not be called for async state");
}
///
/// 判断是否可以转换到目标状态(同步版本,抛出异常表示不应被调用)
///
/// 目标状态
/// 是否允许转换
public bool CanTransitionTo(IState target)
{
throw new InvalidOperationException("Sync CanTransitionTo should not be called for async state");
}
}
///
/// 状态机扩展方法类
///
public static class StateMachineExtensions
{
///
/// 检查状态机是否包含指定类型的状态
///
/// 要检查的状态类型
/// 状态机实例
/// 如果包含指定类型的状态则返回true,否则返回false
public static bool ContainsState(this StateMachine stateMachine) where T : IState
{
return stateMachine.GetType().GetField("States", BindingFlags.NonPublic | BindingFlags.Instance)?
.GetValue(stateMachine) is Dictionary states &&
states.ContainsKey(typeof(T));
}
}