public void ExceptionHandling(
PassiveStateMachine <int, int> machine,
bool entryAction1Executed,
bool entryAction2Executed,
bool entryAction3Executed)
{
var exception2 = new Exception();
var exception3 = new Exception();
var receivedExceptions = new List <Exception>();
"establish a state machine with several entry actions on a state and some of them throw an exception".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(State)
.ExecuteOnEntry(() => entryAction1Executed = true)
.ExecuteOnEntry(() =>
{
entryAction2Executed = true;
throw exception2;
})
.ExecuteOnEntry(() =>
{
entryAction3Executed = true;
throw exception3;
});
machine = stateMachineDefinitionBuilder
.WithInitialState(State)
.Build()
.CreatePassiveStateMachine();
machine.TransitionExceptionThrown += (s, e) => receivedExceptions.Add(e.Exception);
});
"when entering the state".x(() =>
{
machine.Start();
});
"it should execute all entry actions on entry".x(() =>
{
entryAction1Executed
.Should().BeTrue("action 1 should be executed");
entryAction2Executed
.Should().BeTrue("action 2 should be executed");
entryAction3Executed
.Should().BeTrue("action 3 should be executed");
});
"it should handle all exceptions of all throwing entry actions by firing the TransitionExceptionThrown event".x(() =>
receivedExceptions
.Should()
.HaveCount(2)
.And
.Contain(exception2)
.And
.Contain(exception3));
}
public SimpleStateMachine()
{
var builder = new StateMachineDefinitionBuilder <States, Events>();
builder
.In(States.Off)
.On(Events.TurnOn)
.Goto(States.On)
.Execute(SayHello);
builder
.In(States.On)
.On(Events.TurnOff)
.Goto(States.Off)
.Execute(SayBye);
builder
.WithInitialState(States.Off);
machine = builder
.Build()
.CreatePassiveStateMachine();
machine.Start();
}
public void MatchingGuard(
PassiveStateMachine <int, int> machine,
CurrentStateExtension currentStateExtension)
{
"establish a state machine with guarded transitions".x(() =>
{
machine = new PassiveStateMachine <int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState)
.If(() => true).Goto(DestinationState)
.If(() => true).Goto(ErrorState)
.Otherwise().Goto(ErrorState);
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired".x(() =>
machine.Fire(Event));
"it should take transition guarded with first matching guard".x(() =>
currentStateExtension.CurrentState.Should().Be(DestinationState));
}
private void ConfigureStateMachine()
{
mToiletStateMachine = new PassiveStateMachine <ToiletStates, ToiletEvents>();
mCurrentStateExtension = new CurrentStateExtension();
mToiletStateMachine.AddExtension(mCurrentStateExtension);
mToiletStateMachine.In(ToiletStates.WaitingForStart)
.ExecuteOnEntry(StopStateMachine)
.On(ToiletEvents.StartStateMachine).Goto(ToiletStates.WaitingForMan);
mToiletStateMachine.In(ToiletStates.WaitingForMan)
.ExecuteOnEntry(WaitForMan)
.On(ToiletEvents.ManArrived).Goto(ToiletStates.ManInfrontOfToilet)
.On(ToiletEvents.StopStateMachine).Goto(ToiletStates.WaitingForStart);
mToiletStateMachine.In(ToiletStates.ManInfrontOfToilet)
.ExecuteOnEntry(ManArrived)
.On(ToiletEvents.ManPees).Goto(ToiletStates.ManIsPeeing)
.On(ToiletEvents.ManLeft).Goto(ToiletStates.WaitingForMan)
.On(ToiletEvents.StopStateMachine).Goto(ToiletStates.WaitingForStart);
mToiletStateMachine.In(ToiletStates.ManIsPeeing).
ExecuteOnEntry(ManIsPeeing)
.On(ToiletEvents.ManLeft).Goto(ToiletStates.PeeingFinished)
.On(ToiletEvents.StopStateMachine).Goto(ToiletStates.WaitingForStart);
mToiletStateMachine.In(ToiletStates.PeeingFinished)
.ExecuteOnEntry(Flush)
.On(ToiletEvents.FlushFinished).Goto(ToiletStates.WaitingForMan)
.On(ToiletEvents.StopStateMachine).Goto(ToiletStates.WaitingForStart);
mToiletStateMachine.Initialize(ToiletStates.WaitingForStart);
mToiletStateMachine.Start();
}
public void Start(
PassiveStateMachine <int, int> machine,
bool entryActionExecuted,
CurrentStateExtension currentStateExtension)
{
"establish a state machine".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(TestState)
.ExecuteOnEntry(() => entryActionExecuted = true);
machine = stateMachineDefinitionBuilder
.WithInitialState(TestState)
.Build()
.CreatePassiveStateMachine();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
});
"when starting the state machine".x(() =>
machine.Start());
"should set current state of state machine to state to which it is initialized".x(() =>
currentStateExtension.CurrentState.Should().Be(TestState));
"should execute entry action of state to which state machine is initialized".x(() =>
entryActionExecuted.Should().BeTrue());
}
public void LoadingNonInitializedStateMachine(
PassiveStateMachine <State, Event> loadedMachine)
{
"when a not started state machine is loaded".x(() =>
{
var loader = new StateMachineLoader <State>();
loader.SetCurrentState(Initializable <State> .UnInitialized());
loader.SetHistoryStates(new Dictionary <State, State>());
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <State, Event>();
SetupStates(stateMachineDefinitionBuilder);
loadedMachine = stateMachineDefinitionBuilder
.WithInitialState(State.A)
.Build()
.CreatePassiveStateMachine();
loadedMachine.Load(loader);
});
"it should not be initialized already".x(() =>
{
var stateMachineSaver = new StateMachineSaver <State>();
loadedMachine.Save(stateMachineSaver);
stateMachineSaver
.CurrentStateId
.IsInitialized
.Should()
.BeFalse();
});
}
public void Reinitialization(
PassiveStateMachine <int, int> machine,
Exception receivedException)
{
"establish an initialized state machine".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.Initialize(TestState);
});
"when state machine is initialized again".x(() =>
{
try
{
machine.Initialize(TestState);
}
catch (Exception e)
{
receivedException = e;
}
});
"should throw an invalid operation exception".x(() =>
{
receivedException
.Should().BeAssignableTo <InvalidOperationException>();
receivedException.Message
.Should().Be(ExceptionMessages.StateMachineIsAlreadyInitialized);
});
}
public void MultipleExitActions(
PassiveStateMachine <int, int> machine,
bool exitAction1Executed,
bool exitAction2Executed)
{
"establish a state machine with several exit actions on a state".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.ExecuteOnExit(() => exitAction1Executed = true)
.ExecuteOnExit(() => exitAction2Executed = true)
.On(Event).Goto(AnotherState);
});
"when leaving the state".x(() =>
{
machine.Initialize(State);
machine.Start();
machine.Fire(Event);
});
"It should execute all exit actions".x(() =>
{
exitAction1Executed
.Should().BeTrue("first action should be executed");
exitAction2Executed
.Should().BeTrue("second action should be executed");
});
}
public void ExitActionException(PassiveStateMachine <int, int> machine)
{
"establish an exit action throwing an exception".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(Values.Source)
.ExecuteOnExit(() => throw Values.Exception)
.On(Values.Event)
.Goto(Values.Destination);
machine = stateMachineDefinitionBuilder
.WithInitialState(Values.Source)
.Build()
.CreatePassiveStateMachine();
machine.TransitionExceptionThrown += (s, e) => this.receivedTransitionExceptionEventArgs = e;
});
"when executing the transition".x(() =>
{
machine.Start();
machine.Fire(Values.Event, Values.Parameter);
});
this.ItShouldHandleTransitionException();
}
public void InitializeALoadedStateMachine(
PassiveStateMachine <int, int> machine,
Exception receivedException)
{
"establish a loaded initialized state machine".x(() =>
{
machine = new PassiveStateMachine <int, int>();
var loader = new Persisting.StateMachineLoader <int>();
loader.SetCurrentState(new Initializable <int> {
Value = 1
});
loader.SetHistoryStates(new Dictionary <int, int>());
machine.Load(loader);
});
"when initializing the state machine".x(() =>
receivedException = Catch.Exception(() =>
machine.Initialize(0)));
"should throw an invalid operation exception".x(() =>
{
receivedException
.Should().BeAssignableTo <InvalidOperationException>()
.Which.Message
.Should().Be(ExceptionMessages.StateMachineIsAlreadyInitialized);
});
}
public MdpsStateMachine(MarauderBrain brain)
{
Brain = brain;
fsm = new PassiveStateMachine <ProcessState, Command>();
fsm.TransitionCompleted += RecordTransition;
///* Initial State */
//fsm.In(ProcessState.Initial)
// .On(Command.OnStartPatrol)
// .Goto(ProcessState.Patrol)
// .Execute(() => brain.PerformPatrolling());
//fsm.In(ProcessState.Patrol)
// .On(Command.OnDetectEnemy)
// .Goto(ProcessState.Closing)
// .Execute(() => brain.SelectTarget());
//fsm.In(ProcessState.Closing)
// .On(Command.OnAttack)
// .Goto(ProcessState.Combat)
// .Execute(() => brain.PerformCombat());
//fsm.In(ProcessState.Combat)
// .On(Command.OnCheckHealth)
// .Goto(ProcessState.HealthCheck)
// .Execute(() => brain.PerformHealthCheck());
}
public void StartingException(PassiveStateMachine <int, int> machine)
{
const int State = 1;
"establish a entry action for the initial state that throws an exception".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(State)
.ExecuteOnEntry(() => throw Values.Exception);
machine = stateMachineDefinitionBuilder
.WithInitialState(State)
.Build()
.CreatePassiveStateMachine();
machine.TransitionExceptionThrown += (s, e) => this.receivedTransitionExceptionEventArgs = e;
});
"when starting the state machine".x(() =>
machine.Start());
"should catch exception and fire transition exception event".x(() =>
this.receivedTransitionExceptionEventArgs.Exception.Should().NotBeNull());
"should pass thrown exception to event arguments of transition exception event".x(() =>
this.receivedTransitionExceptionEventArgs.Exception.Should().BeSameAs(Values.Exception));
}
public void BeforeExecutingEntryActions(
PassiveStateMachine <string, int> machine,
IExtension <string, int> extension)
{
"establish an extension".x(()
=> extension = A.Fake <IExtension <string, int> >());
"establish a state machine using the extension".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <string, int>();
stateMachineDefinitionBuilder
.In("0")
.On(1)
.Goto("1");
machine = stateMachineDefinitionBuilder
.WithInitialState("0")
.Build()
.CreatePassiveStateMachine(Name);
machine.AddExtension(extension);
machine.Start();
});
"when firing an event onto the state machine".x(()
=> machine.Fire(1));
"it should call EnteringState on registered extensions for target state".x(()
=> A.CallTo(() => extension.EnteringState(
A <IStateMachineInformation <string, int> > .That.Matches(x => x.Name == Name && x.CurrentStateId.ExtractOrThrow() == "1"),
A <IStateDefinition <string, int> > .That.Matches(x => x.Id == "1"),
A <ITransitionContext <string, int> > .That.Matches(x => x.EventId.Value == 1)))
.MustHaveHappened());
}
public void NoMatchingGuard(
PassiveStateMachine <int, int> machine,
CurrentStateExtension currentStateExtension)
{
bool declined = false;
"establish state machine with no matching guard".x(() =>
{
machine = new PassiveStateMachine <int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState);
machine.TransitionDeclined += (sender, e) => declined = true;
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired".x(() =>
machine.Fire(Event));
"it should notify about declined transition".x(() =>
declined.Should().BeTrue("TransitionDeclined event should be fired"));
}
public void EntryActionWithParameter(
PassiveStateMachine<int, int> machine,
string parameter)
{
const string Parameter = "parameter";
"establish a state machine with entry action with parameter on a state"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(State)
.ExecuteOnEntryParametrized(p => parameter = p, Parameter);
});
"when entering the state"._(() =>
{
machine.Initialize(State);
machine.Start();
});
"it should execute the entry action"._(() =>
parameter.Should().NotBeNull());
"it should pass parameter to the entry action"._(() =>
parameter.Should().Be(Parameter));
}
public void MatchingGuard(
PassiveStateMachine<int, int> machine,
CurrentStateExtension currentStateExtension)
{
"establish a state machine with guarded transitions"._(() =>
{
machine = new PassiveStateMachine<int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState)
.If(() => true).Goto(DestinationState)
.If(() => true).Goto(ErrorState)
.Otherwise().Goto(ErrorState);
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired"._(() =>
machine.Fire(Event));
"it should take transition guarded with first matching guard"._(() =>
currentStateExtension.CurrentState.Should().Be(DestinationState));
}
public void NoMatchingGuard(
PassiveStateMachine<int, int> machine,
CurrentStateExtension currentStateExtension)
{
bool declined = false;
"establish state machine with no matching guard"._(() =>
{
machine = new PassiveStateMachine<int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState);
machine.TransitionDeclined += (sender, e) => declined = true;
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired"._(() =>
machine.Fire(Event));
"it should notify about declined transition"._(() =>
declined.Should().BeTrue("TransitionDeclined event should be fired"));
}
public void EntryActionWithParameter(
PassiveStateMachine <int, int> machine,
string parameter)
{
const string Parameter = "parameter";
"establish a state machine with entry action with parameter on a state".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.ExecuteOnEntryParametrized(p => parameter = p, Parameter);
});
"when entering the state".x(() =>
{
machine.Initialize(State);
machine.Start();
});
"it should execute the entry action".x(() =>
parameter.Should().NotBeNull());
"it should pass parameter to the entry action".x(() =>
parameter.Should().Be(Parameter));
}
public void OtherwiseGuard(
PassiveStateMachine <int, int> machine,
CurrentStateExtension currentStateExtension)
{
"establish a state machine with otherwise guard and no machting other guard".x(() =>
{
machine = new PassiveStateMachine <int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState)
.Otherwise().Goto(DestinationState);
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired".x(() =>
machine.Fire(Event));
"it should_take_transition_guarded_with_otherwise".x(() =>
currentStateExtension.CurrentState.Should().Be(DestinationState));
}
public void EventArgument(
PassiveStateMachine <int, int> machine,
int passedArgument)
{
const int Event = 3;
const int AnotherState = 3;
const int Argument = 17;
"establish a state machine with an entry action taking an event argument".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.On(Event).Goto(AnotherState);
machine.In(AnotherState)
.ExecuteOnEntry((int argument) => passedArgument = argument);
});
"when entering the state".x(() =>
{
machine.Initialize(State);
machine.Start();
machine.Fire(Event, Argument);
});
"it should pass event argument to entry action".x(() =>
passedArgument.Should().Be(Argument));
}
public void EventArgument(
PassiveStateMachine <int, int> machine,
int passedArgument)
{
const int Argument = 17;
"establish a state machine with an exit action taking an event argument".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(State)
.ExecuteOnExit((int argument) => passedArgument = argument)
.On(Event).Goto(AnotherState);
stateMachineDefinitionBuilder
.In(AnotherState)
.ExecuteOnEntry((int argument) => passedArgument = argument);
machine = stateMachineDefinitionBuilder
.WithInitialState(State)
.Build()
.CreatePassiveStateMachine();
});
"when leaving the state".x(() =>
{
machine.Start();
machine.Fire(Event, Argument);
});
"it should pass event argument to exit action".x(() =>
passedArgument.Should().Be(Argument));
}
public void NoExceptionHandlerRegistered(
PassiveStateMachine <int, int> machine,
Exception catchedException)
{
"establish an exception throwing state machine without a registered exception handler".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(Values.Source)
.On(Values.Event)
.Execute(() => throw Values.Exception);
machine = stateMachineDefinitionBuilder
.WithInitialState(Values.Source)
.Build()
.CreatePassiveStateMachine();
machine.Start();
});
"when an exception occurs".x(() =>
catchedException = Catch.Exception(() => machine.Fire(Values.Event)));
"should (re-)throw exception".x(() =>
catchedException.InnerException
.Should().BeSameAs(Values.Exception));
}
public void ExitAction(
PassiveStateMachine <int, int> machine,
bool exitActionExecuted)
{
"establish a state machine with exit action on a state".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(State)
.ExecuteOnExit(() => exitActionExecuted = true)
.On(Event).Goto(AnotherState);
machine = stateMachineDefinitionBuilder
.WithInitialState(State)
.Build()
.CreatePassiveStateMachine();
});
"when leaving the state".x(() =>
{
machine.Start();
machine.Fire(Event);
});
"it should execute the exit action".x(() =>
exitActionExecuted.Should().BeTrue());
}
public void CustomTypesForStatesAndEvents(
PassiveStateMachine <MyState, MyEvent> machine,
bool arrivedInStateB)
{
"establish a state machine with custom types for states and events".x(() =>
{
machine = new PassiveStateMachine <MyState, MyEvent>();
machine.In(new MyState("A"))
.On(new MyEvent(1)).Goto(new MyState("B"));
machine.In(new MyState("B"))
.ExecuteOnEntry(() => arrivedInStateB = true);
machine.Initialize(new MyState("A"));
machine.Start();
});
"when using the state machine".x(() =>
machine.Fire(new MyEvent(1)));
"it should use equals to compare states and events".x(() =>
arrivedInStateB.Should().BeTrue("state B should be current state"));
}
public void CustomTypesForStatesAndEvents(
PassiveStateMachine<MyState, MyEvent> machine,
bool arrivedInStateB)
{
"establish a state machine with custom types for states and events"._(() =>
{
machine = new PassiveStateMachine<MyState, MyEvent>();
machine.In(new MyState("A"))
.On(new MyEvent(1)).Goto(new MyState("B"));
machine.In(new MyState("B"))
.ExecuteOnEntry(() => arrivedInStateB = true);
machine.Initialize(new MyState("A"));
machine.Start();
});
"when using the state machine"._(() =>
machine.Fire(new MyEvent(1)));
"it should use equals to compare states and events"._(() =>
arrivedInStateB.Should().BeTrue("state B should be current state"));
}
public void Start(
PassiveStateMachine <int, int> machine,
bool entryActionExecuted)
{
"establish an initialized state machine".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.AddExtension(this.testExtension);
machine.In(TestState)
.ExecuteOnEntry(() => entryActionExecuted = true);
machine.Initialize(TestState);
});
"when starting the state machine".x(() =>
machine.Start());
"should set current state of state machine to state to which it is initialized".x(() =>
this.testExtension.CurrentState.Should().Be(TestState));
"should execute entry action of state to which state machine is initialized".x(() =>
entryActionExecuted.Should().BeTrue());
}
public void ExitActionWithParameter(
PassiveStateMachine <int, int> machine,
string parameter)
{
const string Parameter = "parameter";
"establish a state machine with exit action with parameter on a state".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.ExecuteOnExitParametrized(p => parameter = p, Parameter)
.On(Event).Goto(AnotherState);
});
"when leaving the state".x(() =>
{
machine.Initialize(State);
machine.Start();
machine.Fire(Event);
});
"it should execute the exit action".x(() =>
parameter.Should().NotBeNull());
"it should pass parameter to the exit action".x(() =>
parameter.Should().Be(Parameter));
}
public void NoMatchingGuard(
PassiveStateMachine <int, int> machine)
{
var declined = false;
"establish state machine with no matching guard".x(() =>
{
var stateMachineDefinitionBuilder = new StateMachineDefinitionBuilder <int, int>();
stateMachineDefinitionBuilder
.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState);
machine = stateMachineDefinitionBuilder
.WithInitialState(SourceState)
.Build()
.CreatePassiveStateMachine();
machine.TransitionDeclined += (sender, e) => declined = true;
machine.Start();
});
"when an event is fired".x(() =>
machine.Fire(Event));
"it should notify about declined transition".x(() =>
declined.Should().BeTrue("TransitionDeclined event should be fired"));
}
public void MultipleEntryActions(
PassiveStateMachine <int, int> machine,
bool entryAction1Executed,
bool entryAction2Executed)
{
"establish a state machine with several entry actions on a state".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.ExecuteOnEntry(() => entryAction1Executed = true)
.ExecuteOnEntry(() => entryAction2Executed = true);
});
"when entering the state".x(() =>
{
machine.Initialize(State);
machine.Start();
});
"It should execute all entry actions".x(() =>
{
entryAction1Executed
.Should().BeTrue("first action should be executed");
entryAction2Executed
.Should().BeTrue("second action should be executed");
});
}
public void EventsQueueing(
IStateMachine <string, int> machine)
{
const int FirstEvent = 0;
const int SecondEvent = 1;
bool arrived = false;
"establish a passive state machine with transitions"._(() =>
{
machine = new PassiveStateMachine <string, int>();
machine.In("A").On(FirstEvent).Goto("B");
machine.In("B").On(SecondEvent).Goto("C");
machine.In("C").ExecuteOnEntry(() => arrived = true);
machine.Initialize("A");
});
"when firing an event onto the state machine"._(() =>
{
machine.Fire(FirstEvent);
machine.Fire(SecondEvent);
machine.Start();
});
"it should queue event at the end"._(() =>
arrived.Should().BeTrue("state machine should arrive at destination state"));
}
public void Background()
{
this.receivedTransitionExceptionEventArgs = null;
this.machine = new PassiveStateMachine <int, int>();
this.machine.TransitionExceptionThrown += (s, e) => this.receivedTransitionExceptionEventArgs = e;
}
public void Background()
{
this.receivedTransitionExceptionEventArgs = null;
this.machine = new PassiveStateMachine<int, int>();
this.machine.TransitionExceptionThrown += (s, e) => this.receivedTransitionExceptionEventArgs = e;
}
public void Report()
{
var elevator = new PassiveStateMachine <States, Events>("Elevator");
elevator.DefineHierarchyOn(States.Healthy, States.OnFloor, HistoryType.Deep, States.OnFloor, States.Moving);
elevator.DefineHierarchyOn(States.Moving, States.MovingUp, HistoryType.Shallow, States.MovingUp, States.MovingDown);
elevator.DefineHierarchyOn(States.OnFloor, States.DoorClosed, HistoryType.None, States.DoorClosed, States.DoorOpen);
elevator.In(States.Healthy)
.On(Events.ErrorOccured).Goto(States.Error);
elevator.In(States.Error)
.On(Events.Reset).Goto(States.Healthy)
.On(Events.ErrorOccured);
elevator.In(States.OnFloor)
.ExecuteOnEntry(AnnounceFloor)
.ExecuteOnExit(Beep, Beep)
.On(Events.CloseDoor).Goto(States.DoorClosed)
.On(Events.OpenDoor).Goto(States.DoorOpen)
.On(Events.GoUp)
.If(CheckOverload).Goto(States.MovingUp)
.Otherwise().Execute(AnnounceOverload, Beep)
.On(Events.GoDown)
.If(CheckOverload).Goto(States.MovingDown)
.Otherwise().Execute(AnnounceOverload);
elevator.In(States.Moving)
.On(Events.Stop).Goto(States.OnFloor);
elevator.Initialize(States.OnFloor);
elevator.Report(this.testee);
string statesReport;
string transitionsReport;
this.stateStream.Position = 0;
using (var reader = new StreamReader(this.stateStream))
{
statesReport = reader.ReadToEnd();
}
this.transitionsStream.Position = 0;
using (var reader = new StreamReader(this.transitionsStream))
{
transitionsReport = reader.ReadToEnd();
}
const string ExpectedStatesReport = "Source;Entry;Exit;ChildrenOnFloor;AnnounceFloor;Beep, Beep;DoorClosed, DoorOpenMoving;;;MovingUp, MovingDownHealthy;;;OnFloor, MovingMovingUp;;;MovingDown;;;DoorClosed;;;DoorOpen;;;Error;;;";
const string ExpectedTransitionsReport = "Source;Event;Guard;Target;ActionsOnFloor;CloseDoor;;DoorClosed;OnFloor;OpenDoor;;DoorOpen;OnFloor;GoUp;CheckOverload;MovingUp;OnFloor;GoUp;;internal transition;AnnounceOverload, BeepOnFloor;GoDown;CheckOverload;MovingDown;OnFloor;GoDown;;internal transition;AnnounceOverloadMoving;Stop;;OnFloor;Healthy;ErrorOccured;;Error;Error;Reset;;Healthy;Error;ErrorOccured;;internal transition;";
statesReport.Replace("\n", string.Empty).Replace("\r", string.Empty)
.Should().Be(ExpectedStatesReport.Replace("\n", string.Empty).Replace("\r", string.Empty));
transitionsReport.Replace("\n", string.Empty).Replace("\r", string.Empty)
.Should().Be(ExpectedTransitionsReport.Replace("\n", string.Empty).Replace("\r", string.Empty));
}
public void ExceptionHandling(
PassiveStateMachine <int, int> machine,
bool exitAction1Executed,
bool exitAction2Executed,
bool exitAction3Executed)
{
var exception2 = new Exception();
var exception3 = new Exception();
var receivedException = new List <Exception>();
"establish a state machine with several exit actions on a state and some of them throw an exception".x(() =>
{
machine = new PassiveStateMachine <int, int>();
machine.In(State)
.ExecuteOnExit(() => exitAction1Executed = true)
.ExecuteOnExit(() =>
{
exitAction2Executed = true;
throw exception2;
})
.ExecuteOnExit(() =>
{
exitAction3Executed = true;
throw exception3;
})
.On(Event).Goto(AnotherState);
machine.TransitionExceptionThrown += (s, e) => receivedException.Add(e.Exception);
});
"when entering the state".x(() =>
{
machine.Initialize(State);
machine.Start();
machine.Fire(Event);
});
"it should execute all entry actions on entry".x(() =>
{
exitAction1Executed
.Should().BeTrue("action 1 should be executed");
exitAction2Executed
.Should().BeTrue("action 2 should be executed");
exitAction3Executed
.Should().BeTrue("action 3 should be executed");
});
"it should handle all exceptions of all throwing entry actions by firing the TransitionExceptionThrown event".x(() =>
receivedException
.Should().BeEquivalentTo(new object[]
{
exception2, exception3
}));
}
public void CanStartFSM()
{
fsm = new PassiveStateMachine <SM.ProcessState, SM.Command>();
fsm.Initialize(SM.ProcessState.Initial);
fsm.Fire(SM.Command.OnOpenBattleFront);
fsm.Start();
Assert.IsTrue(fsm.IsRunning);
}
public void CommonAncestor(
PassiveStateMachine<int, int> machine)
{
const int CommonAncestorState = 0;
const int SourceState = 1;
const int ParentOfSourceState = 2;
const int SiblingOfSourceState = 3;
const int DestinationState = 4;
const int ParentOfDestinationState = 5;
const int SiblingOfDestinationState = 6;
const int Event = 0;
bool commonAncestorStateLeft = false;
"establish a hierarchical state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.DefineHierarchyOn(CommonAncestorState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(ParentOfSourceState)
.WithSubState(ParentOfDestinationState);
machine.DefineHierarchyOn(ParentOfSourceState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(SourceState)
.WithSubState(SiblingOfSourceState);
machine.DefineHierarchyOn(ParentOfDestinationState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(DestinationState)
.WithSubState(SiblingOfDestinationState);
machine.In(SourceState)
.On(Event).Goto(DestinationState);
machine.In(CommonAncestorState)
.ExecuteOnExit(() => commonAncestorStateLeft = true);
machine.Initialize(SourceState);
machine.Start();
});
"when firing an event resulting in a transition with a common ancestor"._(() =>
machine.Fire(Event));
"the state machine should remain inside common ancestor state"._(() =>
commonAncestorStateLeft
.Should().BeFalse());
}
public void Report(
IStateMachine<string, int> machine,
IStateMachineReport<string, int> report)
{
"establish a state machine"._(() =>
machine = new PassiveStateMachine<string, int>());
"establish a state machine reporter"._(() =>
report = A.Fake<IStateMachineReport<string, int>>());
"when creating a report"._(() =>
machine.Report(report));
"it should call the passed reporter"._(() =>
A.CallTo(() => report.Report(A<string>._, A<IEnumerable<IState<string, int>>>._, A<Initializable<string>>._)));
}
public void Background()
{
"establish initialized state machine"._(() =>
{
this.machine = new PassiveStateMachine<int, int>();
this.extension = new RecordEventsExtension();
this.machine.AddExtension(extension);
this.machine.In(A)
.On(Event).Goto(B);
this.machine.In(B)
.On(Event).Goto(A);
this.machine.Initialize(A);
});
}
public void CustomFactory(
PassiveStateMachine<string, int> machine,
StandardFactory<string, int> factory)
{
"establish a custom factory"._(() =>
{
factory = A.Fake<StandardFactory<string, int>>();
});
"when creating a passive state machine"._(() =>
{
machine = new PassiveStateMachine<string, int>("_", factory);
machine.In("initial").On(42).Goto("answer");
});
"it should use custom factory to create internal instances"._(() =>
A.CallTo(factory).MustHaveHappened());
}
public void AddingExtensions(
IStateMachine<string, int> machine,
IExtension<string, int> extension)
{
"establish a state machine"._(() =>
{
machine = new PassiveStateMachine<string, int>();
extension = A.Fake<IExtension<string, int>>();
});
"when adding an extension"._(() =>
{
machine.AddExtension(extension);
machine.Initialize("initial");
});
"it should notify extension about internal events"._(() =>
A.CallTo(extension).MustHaveHappened());
}
public void Initialize(
PassiveStateMachine<int, int> machine,
bool entryActionExecuted)
{
"establish a state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.AddExtension(this.testExtension);
machine.In(TestState)
.ExecuteOnEntry(() => entryActionExecuted = true);
});
"when state machine is initialized"._(() =>
machine.Initialize(TestState));
"should not yet execute any entry actions"._(() =>
entryActionExecuted.Should().BeFalse());
}
public void Background()
{
"establish a hierarchical state machine"._(() =>
{
testExtension = new CurrentStateExtension();
machine = new PassiveStateMachine<int, int>();
machine.AddExtension(testExtension);
machine.DefineHierarchyOn(SuperState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(LeafState);
machine.In(SuperState)
.ExecuteOnEntry(() => entryActionOfSuperStateExecuted = true);
machine.In(LeafState)
.ExecuteOnEntry(() => entryActionOfLeafStateExecuted = true);
});
}
public void ExecutingTransition(
PassiveStateMachine<int, int> machine,
string actualParameter,
bool exitActionExecuted,
bool entryActionExecuted)
{
"establish a state machine with transitions"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.AddExtension(CurrentStateExtension);
machine.In(SourceState)
.ExecuteOnExit(() => exitActionExecuted = true)
.On(Event).Goto(DestinationState).Execute<string>(p => actualParameter = p);
machine.In(DestinationState)
.ExecuteOnEntry(() => entryActionExecuted = true);
machine.Initialize(SourceState);
machine.Start();
});
"when firing an event onto the state machine"._(() =>
machine.Fire(Event, Parameter));
"it should_execute_transition_by_switching_state"._(() =>
CurrentStateExtension.CurrentState.Should().Be(DestinationState));
"it should_execute_transition_actions"._(() =>
actualParameter.Should().NotBeNull());
"it should_pass_parameters_to_transition_action"._(() =>
actualParameter.Should().Be(Parameter));
"it should_execute_exit_action_of_source_state"._(() =>
exitActionExecuted.Should().BeTrue());
"it should_execute_entry_action_of_destination_state"._(() =>
entryActionExecuted.Should().BeTrue());
}
public void EntryAction(
PassiveStateMachine<int, int> machine,
bool entryActionExecuted)
{
"establish a state machine with entry action on a state"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(State)
.ExecuteOnEntry(() => entryActionExecuted = true);
});
"when entering the state"._(() =>
{
machine.Initialize(State);
machine.Start();
});
"it should execute the entry action"._(() =>
entryActionExecuted.Should().BeTrue());
}
public void DefaultStateMachineName(
PassiveStateMachine<string, int> machine,
StateMachineNameReporter reporter)
{
"establish an instantiated passive state machine"._(() =>
{
machine = new PassiveStateMachine<string, int>();
});
"establish a state machine reporter"._(() =>
{
reporter = new StateMachineNameReporter();
});
"when the state machine report is generated"._(() =>
machine.Report(reporter));
"it should use the type of the state machine as name for state machine"._(() =>
reporter.StateMachineName
.Should().Be("Appccelerate.StateMachine.PassiveStateMachine<System.String,System.Int32>"));
}
public void InitializeALoadedStateMachine(
PassiveStateMachine<int, int> machine,
Exception receivedException)
{
"establish a loaded state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.Load(A.Fake<IStateMachineLoader<int>>());
});
"when initializing the state machine"._(() =>
receivedException = Catch.Exception(() =>
machine.Initialize(0)));
"should throw an invalid operation exception"._(() =>
{
receivedException
.Should().BeAssignableTo<InvalidOperationException>();
receivedException.Message
.Should().Be(ExceptionMessages.StateMachineIsAlreadyInitialized);
});
}
public void CustomStateMachineName(
PassiveStateMachine<string, int> machine,
StateMachineNameReporter reporter)
{
const string Name = "custom name";
"establish an instantiated passive state machine with custom name"._(() =>
{
machine = new PassiveStateMachine<string, int>(Name);
});
"establish a state machine reporter"._(() =>
{
reporter = new StateMachineNameReporter();
});
"when the state machine report is generated"._(() =>
machine.Report(reporter));
"it should use custom name for state machine"._(() =>
reporter.StateMachineName
.Should().Be(Name));
}
public void PriorityEventsQueueing(
IStateMachine<string, int> machine)
{
const int FirstEvent = 0;
const int SecondEvent = 1;
bool arrived = false;
"establish a passive state machine with transitions"._(() =>
{
machine = new PassiveStateMachine<string, int>();
machine.In("A").On(SecondEvent).Goto("B");
machine.In("B").On(FirstEvent).Goto("C");
machine.In("C").ExecuteOnEntry(() => arrived = true);
machine.Initialize("A");
});
"when firing a priority event onto the state machine"._(() =>
{
machine.Fire(FirstEvent);
machine.FirePriority(SecondEvent);
machine.Start();
});
"it should queue event at the front"._(() =>
arrived.Should().BeTrue("state machine should arrive at destination state"));
}
public void MultipleEntryActions(
PassiveStateMachine<int, int> machine,
bool entryAction1Executed,
bool entryAction2Executed)
{
"establish a state machine with several entry actions on a state"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(State)
.ExecuteOnEntry(() => entryAction1Executed = true)
.ExecuteOnEntry(() => entryAction2Executed = true);
});
"when entering the state"._(() =>
{
machine.Initialize(State);
machine.Start();
});
"It should execute all entry actions"._(() =>
{
entryAction1Executed
.Should().BeTrue("first action should be executed");
entryAction2Executed
.Should().BeTrue("second action should be executed");
});
}
public void NoCommonAncestor(
PassiveStateMachine<string, int> machine)
{
const string SourceState = "SourceState";
const string ParentOfSourceState = "ParentOfSourceState";
const string SiblingOfSourceState = "SiblingOfSourceState";
const string DestinationState = "DestinationState";
const string ParentOfDestinationState = "ParentOfDestinationState";
const string SiblingOfDestinationState = "SiblingOfDestinationState";
const string GrandParentOfSourceState = "GrandParentOfSourceState";
const string GrandParentOfDestinationState = "GrandParentOfDestinationState";
const int Event = 0;
string log = string.Empty;
"establish a hierarchical state machine"._(() =>
{
machine = new PassiveStateMachine<string, int>();
machine.DefineHierarchyOn(ParentOfSourceState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(SourceState)
.WithSubState(SiblingOfSourceState);
machine.DefineHierarchyOn(ParentOfDestinationState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(DestinationState)
.WithSubState(SiblingOfDestinationState);
machine.DefineHierarchyOn(GrandParentOfSourceState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(ParentOfSourceState);
machine.DefineHierarchyOn(GrandParentOfDestinationState)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(ParentOfDestinationState);
machine.In(SourceState)
.ExecuteOnExit(() => log += "exit" + SourceState)
.On(Event).Goto(DestinationState);
machine.In(ParentOfSourceState)
.ExecuteOnExit(() => log += "exit" + ParentOfSourceState);
machine.In(DestinationState)
.ExecuteOnEntry(() => log += "enter" + DestinationState);
machine.In(ParentOfDestinationState)
.ExecuteOnEntry(() => log += "enter" + ParentOfDestinationState);
machine.In(GrandParentOfSourceState)
.ExecuteOnExit(() => log += "exit" + GrandParentOfSourceState);
machine.In(GrandParentOfDestinationState)
.ExecuteOnEntry(() => log += "enter" + GrandParentOfDestinationState);
machine.Initialize(SourceState);
machine.Start();
});
"when firing an event resulting in a transition without a common ancestor"._(() =>
machine.Fire(Event));
"it should execute exit action of source state"._(() =>
log.Should().Contain("exit" + SourceState));
"it should execute exit action of parents of source state (recursively)"._(() =>
log
.Should().Contain("exit" + ParentOfSourceState)
.And.Contain("exit" + GrandParentOfSourceState));
"it should execute entry action of parents of destination state (recursively)"._(() =>
log.Should().Contain("enter" + ParentOfDestinationState)
.And.Contain("enter" + GrandParentOfDestinationState));
"it should execute entry action of destination state"._(() =>
log.Should().Contain("enter" + DestinationState));
"it should execute actions from source upwards and then downwards to destination state"._(() =>
{
string[] states =
{
SourceState,
ParentOfSourceState,
GrandParentOfSourceState,
GrandParentOfDestinationState,
ParentOfDestinationState,
DestinationState
};
var statesInOrderOfAppearanceInLog = states
.OrderBy(s => log.IndexOf(s.ToString(CultureInfo.InvariantCulture), StringComparison.Ordinal));
statesInOrderOfAppearanceInLog
.Should().Equal(states);
});
}
public void YEdGraphML()
{
var elevator = new PassiveStateMachine<States, Events>("Elevator");
elevator.DefineHierarchyOn(States.Healthy)
.WithHistoryType(HistoryType.Deep)
.WithInitialSubState(States.OnFloor)
.WithSubState(States.Moving);
elevator.DefineHierarchyOn(States.Moving)
.WithHistoryType(HistoryType.Shallow)
.WithInitialSubState(States.MovingUp)
.WithSubState(States.MovingDown);
elevator.DefineHierarchyOn(States.OnFloor)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(States.DoorClosed)
.WithSubState(States.DoorOpen);
elevator.In(States.Healthy)
.On(Events.ErrorOccured).Goto(States.Error);
elevator.In(States.Error)
.On(Events.Reset).Goto(States.Healthy)
.On(Events.ErrorOccured);
elevator.In(States.OnFloor)
.ExecuteOnEntry(AnnounceFloor)
.ExecuteOnExit(Beep)
.ExecuteOnExit(Beep)
.On(Events.CloseDoor).Goto(States.DoorClosed)
.On(Events.OpenDoor).Goto(States.DoorOpen)
.On(Events.GoUp)
.If(CheckOverload).Goto(States.MovingUp)
.Otherwise()
.Execute(AnnounceOverload)
.Execute(Beep)
.On(Events.GoDown)
.If(CheckOverload).Goto(States.MovingDown)
.Otherwise().Execute(AnnounceOverload);
elevator.In(States.Moving)
.On(Events.Stop).Goto(States.OnFloor);
elevator.Initialize(States.OnFloor);
var stream = new MemoryStream();
var textWriter = new StreamWriter(stream);
var testee = new YEdStateMachineReportGenerator<States, Events>(textWriter);
elevator.Report(testee);
stream.Position = 0;
var reader = new StreamReader(stream);
var report = reader.ReadToEnd();
const string ExpectedReport = "<?xml version=\"1.0\" encoding=\"utf-8\"?><graphml xmlns:y=\"http://www.yworks.com/xml/graphml\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:yed=\"http://www.yworks.com/xml/yed/3\" xmlns:schemaLocation=\"http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd\" xmlns=\"http://graphml.graphdrawing.org/xmlns\"> <!--Created by Appccelerate.StateMachine.YEdStateMachineReportGenerator--> <key for=\"graphml\" id=\"d0\" yfiles.type=\"resources\" /> <key for=\"port\" id=\"d1\" yfiles.type=\"portgraphics\" /> <key for=\"port\" id=\"d2\" yfiles.type=\"portgeometry\" /> <key for=\"port\" id=\"d3\" yfiles.type=\"portuserdata\" /> <key attr.name=\"url\" attr.type=\"string\" for=\"node\" id=\"d4\" /> <key attr.name=\"description\" attr.type=\"string\" for=\"node\" id=\"d5\" /> <key for=\"node\" id=\"d6\" yfiles.type=\"nodegraphics\" /> <key attr.name=\"Beschreibung\" attr.type=\"string\" for=\"graph\" id=\"d7\"> <default /> </key> <key attr.name=\"url\" attr.type=\"string\" for=\"edge\" id=\"d8\" /> <key attr.name=\"description\" attr.type=\"string\" for=\"edge\" id=\"d9\" /> <key for=\"edge\" id=\"d10\" yfiles.type=\"edgegraphics\" /> <graph edgedefault=\"directed\" id=\"G\"> <node id=\"Healthy\"> <data key=\"d6\"> <y:ProxyAutoBoundsNode> <y:Realizers active=\"0\"> <y:GroupNode> <y:NodeLabel alignment=\"right\" autoSizePolicy=\"node_width\" backgroundColor=\"#EBEBEB\" modelName=\"internal\" modelPosition=\"t\">Healthy</y:NodeLabel> <y:State closed=\"false\" innerGraphDisplayEnabled=\"true\" /> </y:GroupNode> </y:Realizers> </y:ProxyAutoBoundsNode> </data> <graph edgedefault=\"directed\" id=\"Healthy:\"> <node id=\"OnFloor\"> <data key=\"d6\"> <y:ProxyAutoBoundsNode> <y:Realizers active=\"0\"> <y:GroupNode> <y:NodeLabel alignment=\"right\" autoSizePolicy=\"node_width\" backgroundColor=\"#EBEBEB\" modelName=\"internal\" modelPosition=\"t\">(AnnounceFloor)OnFloor(Beep, Beep)</y:NodeLabel> <y:State closed=\"false\" innerGraphDisplayEnabled=\"true\" /> <y:BorderStyle width=\"2.0\" /> </y:GroupNode> </y:Realizers> </y:ProxyAutoBoundsNode> </data> <graph edgedefault=\"directed\" id=\"OnFloor:\"> <node id=\"DoorClosed\"> <data key=\"d6\"> <y:ShapeNode> <y:NodeLabel>DoorClosed</y:NodeLabel> <y:Shape type=\"ellipse\" /> <y:BorderStyle width=\"2.0\" /> </y:ShapeNode> </data> </node> <node id=\"DoorOpen\"> <data key=\"d6\"> <y:ShapeNode> <y:NodeLabel>DoorOpen</y:NodeLabel> <y:Shape type=\"ellipse\" /> </y:ShapeNode> </data> </node> </graph> </node> <node id=\"Moving\"> <data key=\"d6\"> <y:ProxyAutoBoundsNode> <y:Realizers active=\"0\"> <y:GroupNode> <y:NodeLabel alignment=\"right\" autoSizePolicy=\"node_width\" backgroundColor=\"#EBEBEB\" modelName=\"internal\" modelPosition=\"t\">Moving</y:NodeLabel> <y:State closed=\"false\" innerGraphDisplayEnabled=\"true\" /> </y:GroupNode> </y:Realizers> </y:ProxyAutoBoundsNode> </data> <graph edgedefault=\"directed\" id=\"Moving:\"> <node id=\"MovingUp\"> <data key=\"d6\"> <y:ShapeNode> <y:NodeLabel>MovingUp</y:NodeLabel> <y:Shape type=\"ellipse\" /> <y:BorderStyle width=\"2.0\" /> </y:ShapeNode> </data> </node> <node id=\"MovingDown\"> <data key=\"d6\"> <y:ShapeNode> <y:NodeLabel>MovingDown</y:NodeLabel> <y:Shape type=\"ellipse\" /> </y:ShapeNode> </data> </node> </graph> </node> </graph> </node> <node id=\"Error\"> <data key=\"d6\"> <y:ShapeNode> <y:NodeLabel>Error</y:NodeLabel> <y:Shape type=\"ellipse\" /> </y:ShapeNode> </data> </node> <edge id=\"ErrorOccured0\" source=\"Healthy\" target=\"Error\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>ErrorOccured</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"CloseDoor1\" source=\"OnFloor\" target=\"DoorClosed\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>CloseDoor</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"OpenDoor2\" source=\"OnFloor\" target=\"DoorOpen\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>OpenDoor</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"GoUp3\" source=\"OnFloor\" target=\"MovingUp\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>[CheckOverload]GoUp</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"GoUp4\" source=\"OnFloor\" target=\"OnFloor\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"dashed\" /> <y:Arrows source=\"none\" target=\"plain\" /> <y:EdgeLabel>GoUp(AnnounceOverload, Beep)</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"GoDown5\" source=\"OnFloor\" target=\"MovingDown\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>[CheckOverload]GoDown</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"GoDown6\" source=\"OnFloor\" target=\"OnFloor\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"dashed\" /> <y:Arrows source=\"none\" target=\"plain\" /> <y:EdgeLabel>GoDown(AnnounceOverload)</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"Stop7\" source=\"Moving\" target=\"OnFloor\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>Stop</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"Reset8\" source=\"Error\" target=\"Healthy\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"line\" /> <y:Arrows source=\"none\" target=\"standard\" /> <y:EdgeLabel>Reset</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> <edge id=\"ErrorOccured9\" source=\"Error\" target=\"Error\"> <data key=\"d10\"> <y:PolyLineEdge> <y:LineStyle type=\"dashed\" /> <y:Arrows source=\"none\" target=\"plain\" /> <y:EdgeLabel>ErrorOccured</y:EdgeLabel> </y:PolyLineEdge> </data> </edge> </graph> <data key=\"d0\"> <y:Resources /> </data></graphml>";
var cleanedReport = report.Replace("\n", string.Empty).Replace("\r", string.Empty);
cleanedReport.Should().Be(ExpectedReport.Replace("\n", string.Empty).Replace("\r", string.Empty));
}
public void Start(
PassiveStateMachine<int, int> machine,
bool entryActionExecuted)
{
"establish an initialized state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.AddExtension(this.testExtension);
machine.In(TestState)
.ExecuteOnEntry(() => entryActionExecuted = true);
machine.Initialize(TestState);
});
"when starting the state machine"._(() =>
machine.Start());
"should set current state of state machine to state to which it is initialized"._(() =>
this.testExtension.CurrentState.Should().Be(TestState));
"should execute entry action of state to which state machine is initialized"._(() =>
entryActionExecuted.Should().BeTrue());
}
public void OtherwiseGuard(
PassiveStateMachine<int, int> machine,
CurrentStateExtension currentStateExtension)
{
"establish a state machine with otherwise guard and no machting other guard"._(() =>
{
machine = new PassiveStateMachine<int, int>();
currentStateExtension = new CurrentStateExtension();
machine.AddExtension(currentStateExtension);
machine.In(SourceState)
.On(Event)
.If(() => false).Goto(ErrorState)
.Otherwise().Goto(DestinationState);
machine.Initialize(SourceState);
machine.Start();
});
"when an event is fired"._(() =>
machine.Fire(Event));
"it should_take_transition_guarded_with_otherwise"._(() =>
currentStateExtension.CurrentState.Should().Be(DestinationState));
}
public void StartingAnUninitializedStateMachine(
PassiveStateMachine<int, int> machine,
Exception receivedException)
{
"establish an uninitialized state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
});
"when starting the state machine"._(() =>
receivedException = Catch.Exception(() =>
machine.Start()));
"should throw an invalid operation exception"._(() =>
{
receivedException
.Should().BeAssignableTo<InvalidOperationException>();
receivedException.Message
.Should().Be(ExceptionMessages.StateMachineNotInitialized);
});
}
public void EventArgument(
PassiveStateMachine<int, int> machine,
int passedArgument)
{
const int Event = 3;
const int AnotherState = 3;
const int Argument = 17;
"establish a state machine with an entry action taking an event argument"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(State)
.On(Event).Goto(AnotherState);
machine.In(AnotherState)
.ExecuteOnEntry((int argument) => passedArgument = argument);
});
"when entering the state"._(() =>
{
machine.Initialize(State);
machine.Start();
machine.Fire(Event, Argument);
});
"it should pass event argument to entry action"._(() =>
passedArgument.Should().Be(Argument));
}
public void Reinitialization(
PassiveStateMachine<int, int> machine,
Exception receivedException)
{
"establish an initialized state machine"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.Initialize(TestState);
});
"when state machine is initialized again"._(() =>
{
try
{
machine.Initialize(TestState);
}
catch (Exception e)
{
receivedException = e;
}
});
"should throw an invalid operation exception"._(() =>
{
receivedException
.Should().BeAssignableTo<InvalidOperationException>();
receivedException.Message
.Should().Be(ExceptionMessages.StateMachineIsAlreadyInitialized);
});
}
public void Report()
{
var elevator = new PassiveStateMachine<States, Events>("Elevator");
elevator.DefineHierarchyOn(States.Healthy)
.WithHistoryType(HistoryType.Deep)
.WithInitialSubState(States.OnFloor)
.WithSubState(States.Moving);
elevator.DefineHierarchyOn(States.Moving)
.WithHistoryType(HistoryType.Shallow)
.WithInitialSubState(States.MovingUp)
.WithSubState(States.MovingDown);
elevator.DefineHierarchyOn(States.OnFloor)
.WithHistoryType(HistoryType.None)
.WithInitialSubState(States.DoorClosed)
.WithSubState(States.DoorOpen);
elevator.In(States.Healthy)
.On(Events.ErrorOccured).Goto(States.Error);
elevator.In(States.Error)
.On(Events.Reset).Goto(States.Healthy)
.On(Events.ErrorOccured);
elevator.In(States.OnFloor)
.ExecuteOnEntry(AnnounceFloor)
.ExecuteOnExit(Beep)
.ExecuteOnExit(Beep)
.On(Events.CloseDoor).Goto(States.DoorClosed)
.On(Events.OpenDoor).Goto(States.DoorOpen)
.On(Events.GoUp)
.If(CheckOverload).Goto(States.MovingUp)
.Otherwise()
.Execute(AnnounceOverload)
.Execute(Beep)
.On(Events.GoDown)
.If(CheckOverload).Goto(States.MovingDown)
.Otherwise().Execute(AnnounceOverload);
elevator.In(States.Moving)
.On(Events.Stop).Goto(States.OnFloor);
elevator.Initialize(States.OnFloor);
elevator.Report(this.testee);
string statesReport;
string transitionsReport;
this.stateStream.Position = 0;
using (var reader = new StreamReader(this.stateStream))
{
statesReport = reader.ReadToEnd();
}
this.transitionsStream.Position = 0;
using (var reader = new StreamReader(this.transitionsStream))
{
transitionsReport = reader.ReadToEnd();
}
const string ExpectedTransitionsReport = "Source;Event;Guard;Target;ActionsHealthy;ErrorOccured;;Error;OnFloor;CloseDoor;;DoorClosed;OnFloor;OpenDoor;;DoorOpen;OnFloor;GoUp;CheckOverload;MovingUp;OnFloor;GoUp;;internal transition;AnnounceOverload, BeepOnFloor;GoDown;CheckOverload;MovingDown;OnFloor;GoDown;;internal transition;AnnounceOverloadMoving;Stop;;OnFloor;Error;Reset;;Healthy;Error;ErrorOccured;;internal transition;";
const string ExpectedStatesReport = "Source;Entry;Exit;ChildrenHealthy;;;OnFloor, MovingOnFloor;AnnounceFloor;Beep, Beep;DoorClosed, DoorOpenMoving;;;MovingUp, MovingDownMovingUp;;;MovingDown;;;DoorClosed;;;DoorOpen;;;Error;;;";
statesReport.Replace("\n", string.Empty).Replace("\r", string.Empty)
.Should().Be(ExpectedStatesReport.Replace("\n", string.Empty).Replace("\r", string.Empty));
transitionsReport.Replace("\n", string.Empty).Replace("\r", string.Empty)
.Should().Be(ExpectedTransitionsReport.Replace("\n", string.Empty).Replace("\r", string.Empty));
}
public void ExceptionHandling(
PassiveStateMachine<int, int> machine,
bool entryAction1Executed,
bool entryAction2Executed,
bool entryAction3Executed)
{
var exception2 = new Exception();
var exception3 = new Exception();
var receivedException = new List<Exception>();
"establish a state machine with several entry actions on a state and some of them throw an exception"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(State)
.ExecuteOnEntry(() => entryAction1Executed = true)
.ExecuteOnEntry(() =>
{
entryAction2Executed = true;
throw exception2;
})
.ExecuteOnEntry(() =>
{
entryAction3Executed = true;
throw exception3;
});
machine.TransitionExceptionThrown += (s, e) => receivedException.Add(e.Exception);
});
"when entering the state"._(() =>
{
machine.Initialize(State);
machine.Start();
});
"it should execute all entry actions on entry"._(() =>
{
entryAction1Executed
.Should().BeTrue("action 1 should be executed");
entryAction2Executed
.Should().BeTrue("action 2 should be executed");
entryAction3Executed
.Should().BeTrue("action 3 should be executed");
});
"it should handle all exceptions of all throwing entry actions by firing the TransitionExceptionThrown event"._(() =>
receivedException
.Should().BeEquivalentTo(new object[]
{
exception2, exception3
}));
}
public static void Main()
{
// configure basic logging (all levels enabled, messages are written to the console)
log4net.Config.BasicConfigurator.Configure();
var elevator = new PassiveStateMachine<States, Events>("Elevator");
elevator.AddExtension(new Extensions.Log4NetExtension<States, Events>("Elevator"));
elevator.DefineHierarchyOn(States.Healthy, States.OnFloor, HistoryType.Deep, States.OnFloor, States.Moving);
elevator.DefineHierarchyOn(States.Moving, States.MovingUp, HistoryType.Shallow, States.MovingUp, States.MovingDown);
elevator.DefineHierarchyOn(States.OnFloor, States.DoorClosed, HistoryType.None, States.DoorClosed, States.DoorOpen);
elevator.In(States.Healthy)
.On(Events.ErrorOccured).Goto(States.Error);
elevator.In(States.Error)
.On(Events.Reset).Goto(States.Healthy);
elevator.In(States.OnFloor)
.ExecuteOnEntry(AnnounceFloor)
.On(Events.CloseDoor).Goto(States.DoorClosed)
.On(Events.OpenDoor).Goto(States.DoorOpen)
.On(Events.GoUp)
.If(CheckOverload).Goto(States.MovingUp)
.Otherwise().Execute(AnnounceOverload)
.On(Events.GoDown)
.If(CheckOverload).Goto(States.MovingDown)
.Otherwise().Execute(AnnounceOverload);
elevator.In(States.Moving)
.On(Events.Stop).Goto(States.OnFloor);
elevator.Initialize(States.OnFloor);
elevator.Fire(Events.ErrorOccured);
elevator.Fire(Events.Reset);
elevator.Start();
elevator.Fire(Events.OpenDoor);
elevator.Fire(Events.CloseDoor);
elevator.Fire(Events.GoUp);
elevator.Fire(Events.Stop);
elevator.Fire(Events.OpenDoor);
elevator.Stop();
Console.ReadLine();
}
public void NoExceptionHandlerRegistered(
Exception catchedException)
{
"establish an exception throwing state machine without a registered exception handler"._(() =>
{
machine = new PassiveStateMachine<int, int>();
machine.In(Values.Source)
.On(Values.Event).Execute(() =>
{
throw Values.Exception;
});
machine.Initialize(Values.Source);
machine.Start();
});
"when an exception occurs"._(() =>
catchedException = Catch.Exception(() => this.machine.Fire(Values.Event)));
"should (re-)throw exception"._(() =>
catchedException.InnerException
.Should().BeSameAs(Values.Exception));
}
