KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta Join TestMu Conference

How to use RunActorEventHandler method of Microsoft.Coyote.Actors.ActorExecutionContext class

Best Coyote code snippet using Microsoft.Coyote.Actors.ActorExecutionContext.RunActorEventHandler

ActorExecutionContext.cs

Source:ActorExecutionContext.cs

...151            else152            {153                this.LogWriter.LogCreateActor(actor.Id, creator?.Id.Name, creator?.Id.Type);154            }155            this.RunActorEventHandler(actor, initialEvent, true);156            return actor.Id;157        }158        /// <summary>159        /// Creates a new <see cref="Actor"/> of the specified <see cref="Type"/>. The method160        /// returns only when the actor is initialized and the <see cref="Event"/> (if any)161        /// is handled.162        /// </summary>163        internal virtual async Task<ActorId> CreateActorAndExecuteAsync(ActorId id, Type type, string name, Event initialEvent,164            Actor creator, EventGroup eventGroup)165        {166            Actor actor = this.CreateActor(id, type, name, creator, eventGroup);167            if (actor is StateMachine)168            {169                this.LogWriter.LogCreateStateMachine(actor.Id, creator?.Id.Name, creator?.Id.Type);170            }171            else172            {173                this.LogWriter.LogCreateActor(actor.Id, creator?.Id.Name, creator?.Id.Type);174            }175            await this.RunActorEventHandlerAsync(actor, initialEvent, true);176            return actor.Id;177        }178        /// <summary>179        /// Creates a new <see cref="Actor"/> of the specified <see cref="Type"/>.180        /// </summary>181        internal virtual Actor CreateActor(ActorId id, Type type, string name, Actor creator, EventGroup eventGroup)182        {183            if (!type.IsSubclassOf(typeof(Actor)))184            {185                this.Assert(false, "Type '{0}' is not an actor.", type.FullName);186            }187            if (id is null)188            {189                id = this.CreateActorId(type, name);190            }191            else if (id.Runtime != null && id.Runtime != this)192            {193                this.Assert(false, "Unbound actor id '{0}' was created by another runtime.", id.Value);194            }195            else if (id.Type != type.FullName)196            {197                this.Assert(false, "Cannot bind actor id '{0}' of type '{1}' to an actor of type '{2}'.",198                    id.Value, id.Type, type.FullName);199            }200            else201            {202                id.Bind(this);203            }204            // If no event group is provided then inherit the current group from the creator.205            if (eventGroup is null && creator != null)206            {207                eventGroup = creator.EventGroup;208            }209            Actor actor = ActorFactory.Create(type);210            IEventQueue eventQueue = new EventQueue(actor);211            actor.Configure(this, id, null, eventQueue, eventGroup);212            actor.SetupEventHandlers();213            if (!this.ActorMap.TryAdd(id, actor))214            {215                this.Assert(false, $"An actor with id '{id.Value}' was already created by another runtime instance.");216            }217            return actor;218        }219        /// <inheritdoc/>220        public virtual void SendEvent(ActorId targetId, Event initialEvent, EventGroup eventGroup = default, SendOptions options = null) =>221            this.SendEvent(targetId, initialEvent, null, eventGroup, options);222        /// <inheritdoc/>223        public virtual Task<bool> SendEventAndExecuteAsync(ActorId targetId, Event initialEvent,224            EventGroup eventGroup = null, SendOptions options = null) =>225            this.SendEventAndExecuteAsync(targetId, initialEvent, null, eventGroup, options);226        /// <summary>227        /// Sends an asynchronous <see cref="Event"/> to an actor.228        /// </summary>229        internal virtual void SendEvent(ActorId targetId, Event e, Actor sender, EventGroup eventGroup, SendOptions options)230        {231            EnqueueStatus enqueueStatus = this.EnqueueEvent(targetId, e, sender, eventGroup, out Actor target);232            if (enqueueStatus is EnqueueStatus.EventHandlerNotRunning)233            {234                this.RunActorEventHandler(target, null, false);235            }236        }237        /// <summary>238        /// Sends an asynchronous <see cref="Event"/> to an actor. Returns immediately if the target was239        /// already running. Otherwise blocks until the target handles the event and reaches quiescense.240        /// </summary>241        internal virtual async Task<bool> SendEventAndExecuteAsync(ActorId targetId, Event e, Actor sender,242            EventGroup eventGroup, SendOptions options)243        {244            EnqueueStatus enqueueStatus = this.EnqueueEvent(targetId, e, sender, eventGroup, out Actor target);245            if (enqueueStatus is EnqueueStatus.EventHandlerNotRunning)246            {247                await this.RunActorEventHandlerAsync(target, null, false);248                return true;249            }250            return enqueueStatus is EnqueueStatus.Dropped;251        }252        /// <summary>253        /// Enqueues an event to the actor with the specified id.254        /// </summary>255        private EnqueueStatus EnqueueEvent(ActorId targetId, Event e, Actor sender, EventGroup eventGroup, out Actor target)256        {257            if (e is null)258            {259                string message = sender != null ?260                    string.Format("{0} is sending a null event.", sender.Id.ToString()) :261                    "Cannot send a null event.";262                this.Assert(false, message);263            }264            if (targetId is null)265            {266                string message = (sender != null) ?267                    string.Format("{0} is sending event {1} to a null actor.", sender.Id.ToString(), e.ToString())268                    : string.Format("Cannot send event {0} to a null actor.", e.ToString());269                this.Assert(false, message);270            }271            target = this.GetActorWithId<Actor>(targetId);272            // If no group is provided we default to passing along the group from the sender.273            if (eventGroup is null && sender != null)274            {275                eventGroup = sender.EventGroup;276            }277            Guid opId = eventGroup is null ? Guid.Empty : eventGroup.Id;278            if (target is null || target.IsHalted)279            {280                this.LogWriter.LogSendEvent(targetId, sender?.Id.Name, sender?.Id.Type,281                    (sender as StateMachine)?.CurrentStateName ?? default, e, opId, isTargetHalted: true);282                this.HandleDroppedEvent(e, targetId);283                return EnqueueStatus.Dropped;284            }285            this.LogWriter.LogSendEvent(targetId, sender?.Id.Name, sender?.Id.Type,286                (sender as StateMachine)?.CurrentStateName ?? default, e, opId, isTargetHalted: false);287            EnqueueStatus enqueueStatus = target.Enqueue(e, eventGroup, null);288            if (enqueueStatus == EnqueueStatus.Dropped)289            {290                this.HandleDroppedEvent(e, targetId);291            }292            return enqueueStatus;293        }294        /// <summary>295        /// Runs a new asynchronous actor event handler.296        /// This is a fire and forget invocation.297        /// </summary>298        private void RunActorEventHandler(Actor actor, Event initialEvent, bool isFresh)299        {300            Task.Run(async () =>301            {302                try303                {304                    if (isFresh)305                    {306                        await actor.InitializeAsync(initialEvent);307                    }308                    await actor.RunEventHandlerAsync();309                }310                catch (Exception ex)311                {312                    this.Scheduler.IsProgramExecuting = false;313                    this.RaiseOnFailureEvent(ex);314                }315                finally316                {317                    if (actor.IsHalted)318                    {319                        this.ActorMap.TryRemove(actor.Id, out Actor _);320                    }321                }322            });323        }324        /// <summary>325        /// Runs a new asynchronous actor event handler.326        /// </summary>327        private async Task RunActorEventHandlerAsync(Actor actor, Event initialEvent, bool isFresh)328        {329            try330            {331                if (isFresh)332                {333                    await actor.InitializeAsync(initialEvent);334                }335                await actor.RunEventHandlerAsync();336            }337            catch (Exception ex)338            {339                this.Scheduler.IsProgramExecuting = false;340                this.RaiseOnFailureEvent(ex);341                return;342            }343        }344        /// <summary>345        /// Creates a new timer that sends a <see cref="TimerElapsedEvent"/> to its owner actor.346        /// </summary>347        internal virtual IActorTimer CreateActorTimer(TimerInfo info, Actor owner) => new ActorTimer(info, owner);348        /// <inheritdoc/>349        public virtual EventGroup GetCurrentEventGroup(ActorId currentActorId)350        {351            Actor actor = this.GetActorWithId<Actor>(currentActorId);352            return actor?.CurrentEventGroup;353        }354        /// <summary>355        /// Gets the actor of type <typeparamref name="TActor"/> with the specified id,356        /// or null if no such actor exists.357        /// </summary>358        internal TActor GetActorWithId<TActor>(ActorId id)359            where TActor : Actor =>360            id != null && this.ActorMap.TryGetValue(id, out Actor value) &&361            value is TActor actor ? actor : null;362        /// <summary>363        /// Returns the next available unique operation id.364        /// </summary>365        /// <returns>Value representing the next available unique operation id.</returns>366        internal ulong GetNextOperationId() => this.Runtime.GetNextOperationId();367        /// <inheritdoc/>368        public bool RandomBoolean() => this.GetNondeterministicBooleanChoice(2, null, null);369        /// <inheritdoc/>370        public bool RandomBoolean(int maxValue) => this.GetNondeterministicBooleanChoice(maxValue, null, null);371        /// <summary>372        /// Returns a controlled nondeterministic boolean choice.373        /// </summary>374        internal virtual bool GetNondeterministicBooleanChoice(int maxValue, string callerName, string callerType)375        {376            bool result = false;377            if (this.ValueGenerator.Next(maxValue) is 0)378            {379                result = true;380            }381            this.LogWriter.LogRandom(result, callerName, callerType);382            return result;383        }384        /// <inheritdoc/>385        public int RandomInteger(int maxValue) => this.GetNondeterministicIntegerChoice(maxValue, null, null);386        /// <summary>387        /// Returns a controlled nondeterministic integer choice.388        /// </summary>389        internal virtual int GetNondeterministicIntegerChoice(int maxValue, string callerName, string callerType)390        {391            var result = this.ValueGenerator.Next(maxValue);392            this.LogWriter.LogRandom(result, callerName, callerType);393            return result;394        }395        /// <summary>396        /// Logs that the specified actor invoked an action.397        /// </summary>398        internal virtual void LogInvokedAction(Actor actor, MethodInfo action, string handlingStateName, string currentStateName)399        {400            if (this.Configuration.IsVerbose)401            {402                this.LogWriter.LogExecuteAction(actor.Id, handlingStateName, currentStateName, action.Name);403            }404        }405        /// <summary>406        /// Logs that the specified actor enqueued an <see cref="Event"/>.407        /// </summary>408        internal virtual void LogEnqueuedEvent(Actor actor, Event e, EventGroup eventGroup, EventInfo eventInfo)409        {410            if (this.Configuration.IsVerbose)411            {412                this.LogWriter.LogEnqueueEvent(actor.Id, e);413            }414        }415        /// <summary>416        /// Logs that the specified actor dequeued an <see cref="Event"/>.417        /// </summary>418        internal virtual void LogDequeuedEvent(Actor actor, Event e, EventInfo eventInfo, bool isFreshDequeue)419        {420            if (this.Configuration.IsVerbose)421            {422                string stateName = actor is StateMachine stateMachine ? stateMachine.CurrentStateName : default;423                this.LogWriter.LogDequeueEvent(actor.Id, stateName, e);424            }425        }426        /// <summary>427        /// Logs that the specified actor dequeued the default <see cref="Event"/>.428        /// </summary>429        [MethodImpl(MethodImplOptions.AggressiveInlining)]430        internal virtual void LogDefaultEventDequeued(Actor actor)431        {432        }433        /// <summary>434        /// Notifies that the inbox of the specified actor is about to be435        /// checked to see if the default event handler should fire.436        /// </summary>437        [MethodImpl(MethodImplOptions.AggressiveInlining)]438        internal virtual void LogDefaultEventHandlerCheck(Actor actor)439        {440        }441        /// <summary>442        /// Logs that the specified actor raised an <see cref="Event"/>.443        /// </summary>444        internal virtual void LogRaisedEvent(Actor actor, Event e, EventGroup eventGroup, EventInfo eventInfo)445        {446            if (this.Configuration.IsVerbose)447            {448                string stateName = actor is StateMachine stateMachine ? stateMachine.CurrentStateName : default;449                this.LogWriter.LogRaiseEvent(actor.Id, stateName, e);450            }451        }452        /// <summary>453        /// Logs that the specified actor is handling a raised <see cref="Event"/>.454        /// </summary>455        [MethodImpl(MethodImplOptions.AggressiveInlining)]456        internal virtual void LogHandleRaisedEvent(Actor actor, Event e)457        {458        }459        /// <summary>460        /// Logs that the specified actor called <see cref="Actor.ReceiveEventAsync(Type[])"/>461        /// or one of its overloaded methods.462        /// </summary>463        [MethodImpl(MethodImplOptions.AggressiveInlining)]464        internal virtual void LogReceiveCalled(Actor actor)465        {466        }467        /// <summary>468        /// Logs that the specified actor enqueued an event that it was waiting to receive.469        /// </summary>470        internal virtual void LogReceivedEvent(Actor actor, Event e, EventInfo eventInfo)471        {472            if (this.Configuration.IsVerbose)473            {474                string stateName = actor is StateMachine stateMachine ? stateMachine.CurrentStateName : default;475                this.LogWriter.LogReceiveEvent(actor.Id, stateName, e, wasBlocked: true);476            }477        }478        /// <summary>479        /// Logs that the specified actor received an event without waiting because the event480        /// was already in the inbox when the actor invoked the receive statement.481        /// </summary>482        internal virtual void LogReceivedEventWithoutWaiting(Actor actor, Event e, EventInfo eventInfo)483        {484            if (this.Configuration.IsVerbose)485            {486                string stateName = actor is StateMachine stateMachine ? stateMachine.CurrentStateName : default;487                this.LogWriter.LogReceiveEvent(actor.Id, stateName, e, wasBlocked: false);488            }489        }490        /// <summary>491        /// Logs that the specified actor is waiting to receive an event of one of the specified types.492        /// </summary>493        internal virtual void LogWaitEvent(Actor actor, IEnumerable<Type> eventTypes)494        {495            if (this.Configuration.IsVerbose)496            {497                string stateName = actor is StateMachine stateMachine ? stateMachine.CurrentStateName : default;498                var eventWaitTypesArray = eventTypes.ToArray();499                if (eventWaitTypesArray.Length is 1)500                {501                    this.LogWriter.LogWaitEvent(actor.Id, stateName, eventWaitTypesArray[0]);502                }503                else504                {505                    this.LogWriter.LogWaitEvent(actor.Id, stateName, eventWaitTypesArray);506                }507            }508        }509        /// <summary>510        /// Logs that the specified state machine entered a state.511        /// </summary>512        internal virtual void LogEnteredState(StateMachine stateMachine)513        {514            if (this.Configuration.IsVerbose)515            {516                this.LogWriter.LogStateTransition(stateMachine.Id, stateMachine.CurrentStateName, isEntry: true);517            }518        }519        /// <summary>520        /// Logs that the specified state machine exited a state.521        /// </summary>522        internal virtual void LogExitedState(StateMachine stateMachine)523        {524            if (this.Configuration.IsVerbose)525            {526                this.LogWriter.LogStateTransition(stateMachine.Id, stateMachine.CurrentStateName, isEntry: false);527            }528        }529        /// <summary>530        /// Logs that the specified state machine invoked pop.531        /// </summary>532        [MethodImpl(MethodImplOptions.AggressiveInlining)]533        internal virtual void LogPopState(StateMachine stateMachine)534        {535        }536        /// <summary>537        /// Logs that the specified state machine invoked an action.538        /// </summary>539        internal virtual void LogInvokedOnEntryAction(StateMachine stateMachine, MethodInfo action)540        {541            if (this.Configuration.IsVerbose)542            {543                this.LogWriter.LogExecuteAction(stateMachine.Id, stateMachine.CurrentStateName,544                    stateMachine.CurrentStateName, action.Name);545            }546        }547        /// <summary>548        /// Logs that the specified state machine invoked an action.549        /// </summary>550        internal virtual void LogInvokedOnExitAction(StateMachine stateMachine, MethodInfo action)551        {552            if (this.Configuration.IsVerbose)553            {554                this.LogWriter.LogExecuteAction(stateMachine.Id, stateMachine.CurrentStateName,555                    stateMachine.CurrentStateName, action.Name);556            }557        }558        /// <summary>559        /// Builds the coverage graph information, if any. This information is only available560        /// when <see cref="Configuration.ReportActivityCoverage"/> is enabled.561        /// </summary>562        internal CoverageInfo BuildCoverageInfo()563        {564            var result = this.CoverageInfo;565            if (result != null)566            {567                var builder = this.LogWriter.GetLogsOfType<ActorRuntimeLogGraphBuilder>().FirstOrDefault();568                if (builder != null)569                {570                    result.CoverageGraph = builder.SnapshotGraph(this.Configuration.IsDgmlBugGraph);571                }572                var eventCoverage = this.LogWriter.GetLogsOfType<ActorRuntimeLogEventCoverage>().FirstOrDefault();573                if (eventCoverage != null)574                {575                    result.EventInfo = eventCoverage.EventCoverage;576                }577            }578            return result;579        }580        /// <summary>581        /// Returns the current hashed state of the actors.582        /// </summary>583        /// <remarks>584        /// The hash is updated in each execution step.585        /// </remarks>586        internal virtual int GetHashedActorState() => 0;587        /// <summary>588        /// Returns the program counter of the specified actor.589        /// </summary>590        [MethodImpl(MethodImplOptions.AggressiveInlining)]591        internal virtual int GetActorProgramCounter(ActorId actorId) => 0;592        /// <inheritdoc/>593        public void RegisterMonitor<T>()594            where T : Monitor =>595            this.TryCreateMonitor(typeof(T));596        /// <inheritdoc/>597        public void Monitor<T>(Event e)598            where T : Monitor599        {600            // If the event is null then report an error and exit.601            this.Assert(e != null, "Cannot monitor a null event.");602            this.InvokeMonitor(typeof(T), e, null, null, null);603        }604        /// <summary>605        /// Tries to create a new <see cref="Specifications.Monitor"/> of the specified <see cref="Type"/>.606        /// </summary>607        protected bool TryCreateMonitor(Type type) => this.SpecificationEngine.TryCreateMonitor(608            type, this.CoverageInfo, this.LogWriter);609        /// <summary>610        /// Invokes the specified <see cref="Specifications.Monitor"/> with the specified <see cref="Event"/>.611        /// </summary>612        internal void InvokeMonitor(Type type, Event e, string senderName, string senderType, string senderStateName) =>613            this.SpecificationEngine.InvokeMonitor(type, e, senderName, senderType, senderStateName);614        /// <inheritdoc/>615        [MethodImpl(MethodImplOptions.AggressiveInlining)]616        public void Assert(bool predicate) => this.SpecificationEngine.Assert(predicate);617        /// <inheritdoc/>618        [MethodImpl(MethodImplOptions.AggressiveInlining)]619        public void Assert(bool predicate, string s, object arg0) => this.SpecificationEngine.Assert(predicate, s, arg0);620        /// <inheritdoc/>621        [MethodImpl(MethodImplOptions.AggressiveInlining)]622        public void Assert(bool predicate, string s, object arg0, object arg1) => this.SpecificationEngine.Assert(predicate, s, arg0, arg1);623        /// <inheritdoc/>624        [MethodImpl(MethodImplOptions.AggressiveInlining)]625        public void Assert(bool predicate, string s, object arg0, object arg1, object arg2) =>626            this.SpecificationEngine.Assert(predicate, s, arg0, arg1, arg2);627        /// <inheritdoc/>628        [MethodImpl(MethodImplOptions.AggressiveInlining)]629        public void Assert(bool predicate, string s, params object[] args) => this.SpecificationEngine.Assert(predicate, s, args);630        /// <summary>631        /// Asserts that the actor calling an actor method is also the actor that is currently executing.632        /// </summary>633        [MethodImpl(MethodImplOptions.AggressiveInlining)]634        internal virtual void AssertExpectedCallerActor(Actor caller, string calledAPI)635        {636        }637        /// <summary>638        /// Raises the <see cref="OnFailure"/> event with the specified <see cref="Exception"/>.639        /// </summary>640        internal void RaiseOnFailureEvent(Exception exception) => this.Runtime.RaiseOnFailureEvent(exception);641        /// <summary>642        /// Handle the specified dropped <see cref="Event"/>.643        /// </summary>644        internal void HandleDroppedEvent(Event e, ActorId id) => this.OnEventDropped?.Invoke(e, id);645        /// <summary>646        /// Throws an <see cref="AssertionFailureException"/> exception containing the specified exception.647        /// </summary>648#if !DEBUG649        [DebuggerHidden]650#endif651        internal void WrapAndThrowException(Exception exception, string s, params object[] args) =>652            this.SpecificationEngine.WrapAndThrowException(exception, s, args);653        /// <inheritdoc/>654        [Obsolete("Please set the Logger property directory instead of calling this method.")]655        public TextWriter SetLogger(TextWriter logger)656        {657            var result = this.LogWriter.SetLogger(new TextWriterLogger(logger));658            if (result != null)659            {660                return result.TextWriter;661            }662            return null;663        }664        /// <inheritdoc/>665        public void RegisterLog(IActorRuntimeLog log) => this.LogWriter.RegisterLog(log);666        /// <inheritdoc/>667        public void RemoveLog(IActorRuntimeLog log) => this.LogWriter.RemoveLog(log);668        /// <inheritdoc/>669        public void Stop() => this.Scheduler.ForceStop();670        /// <summary>671        /// Disposes runtime resources.672        /// </summary>673        protected virtual void Dispose(bool disposing)674        {675            if (disposing)676            {677                this.ActorMap.Clear();678            }679        }680        /// <inheritdoc/>681        public void Dispose()682        {683            this.Dispose(true);684            GC.SuppressFinalize(this);685        }686        /// <summary>687        /// The mocked execution context of an actor program.688        /// </summary>689        internal sealed class Mock : ActorExecutionContext690        {691            /// <summary>692            /// Map that stores all unique names and their corresponding actor ids.693            /// </summary>694            private readonly ConcurrentDictionary<string, ActorId> NameValueToActorId;695            /// <summary>696            /// Map of program counters used for state-caching to distinguish697            /// scheduling from non-deterministic choices.698            /// </summary>699            private readonly ConcurrentDictionary<ActorId, int> ProgramCounterMap;700            /// <summary>701            /// If true, the actor execution is controlled, else false.702            /// </summary>703            internal override bool IsExecutionControlled => true;704            /// <summary>705            /// Initializes a new instance of the <see cref="Mock"/> class.706            /// </summary>707            internal Mock(Configuration configuration, CoyoteRuntime runtime, OperationScheduler scheduler,708                SpecificationEngine specificationEngine, IRandomValueGenerator valueGenerator, LogWriter logWriter)709                : base(configuration, runtime, scheduler, specificationEngine, valueGenerator, logWriter)710            {711                this.NameValueToActorId = new ConcurrentDictionary<string, ActorId>();712                this.ProgramCounterMap = new ConcurrentDictionary<ActorId, int>();713            }714            /// <inheritdoc/>715            public override ActorId CreateActorIdFromName(Type type, string name)716            {717                // It is important that all actor ids use the monotonically incrementing718                // value as the id during testing, and not the unique name.719                return this.NameValueToActorId.GetOrAdd(name, key => this.CreateActorId(type, key));720            }721            /// <inheritdoc/>722            public override ActorId CreateActor(Type type, Event initialEvent = null, EventGroup eventGroup = null) =>723                this.CreateActor(null, type, null, initialEvent, eventGroup);724            /// <inheritdoc/>725            public override ActorId CreateActor(Type type, string name, Event initialEvent = null, EventGroup eventGroup = null) =>726                this.CreateActor(null, type, name, initialEvent, eventGroup);727            /// <inheritdoc/>728            public override ActorId CreateActor(ActorId id, Type type, Event initialEvent = null, EventGroup eventGroup = null)729            {730                this.Assert(id != null, "Cannot create an actor using a null actor id.");731                return this.CreateActor(id, type, null, initialEvent, eventGroup);732            }733            /// <inheritdoc/>734            public override Task<ActorId> CreateActorAndExecuteAsync(Type type, Event initialEvent = null, EventGroup eventGroup = null) =>735                this.CreateActorAndExecuteAsync(null, type, null, initialEvent, eventGroup);736            /// <inheritdoc/>737            public override Task<ActorId> CreateActorAndExecuteAsync(Type type, string name, Event initialEvent = null, EventGroup eventGroup = null) =>738                this.CreateActorAndExecuteAsync(null, type, name, initialEvent, eventGroup);739            /// <inheritdoc/>740            public override Task<ActorId> CreateActorAndExecuteAsync(ActorId id, Type type, Event initialEvent = null, EventGroup eventGroup = null)741            {742                this.Assert(id != null, "Cannot create an actor using a null actor id.");743                return this.CreateActorAndExecuteAsync(id, type, null, initialEvent, eventGroup);744            }745            /// <summary>746            /// Creates a new actor of the specified <see cref="Type"/> and name, using the specified747            /// unbound actor id, and passes the specified optional <see cref="Event"/>. This event748            /// can only be used to access its payload, and cannot be handled.749            /// </summary>750            internal ActorId CreateActor(ActorId id, Type type, string name, Event initialEvent = null, EventGroup eventGroup = null)751            {752                var creatorOp = this.Scheduler.GetExecutingOperation<ActorOperation>();753                return this.CreateActor(id, type, name, initialEvent, creatorOp?.Actor, eventGroup);754            }755            /// <summary>756            /// Creates a new <see cref="Actor"/> of the specified <see cref="Type"/>.757            /// </summary>758            internal override ActorId CreateActor(ActorId id, Type type, string name, Event initialEvent, Actor creator, EventGroup eventGroup)759            {760                this.AssertExpectedCallerActor(creator, "CreateActor");761                Actor actor = this.CreateActor(id, type, name, creator, eventGroup);762                this.RunActorEventHandler(actor, initialEvent, true, null);763                return actor.Id;764            }765            /// <summary>766            /// Creates a new actor of the specified <see cref="Type"/> and name, using the specified767            /// unbound actor id, and passes the specified optional <see cref="Event"/>. This event768            /// can only be used to access its payload, and cannot be handled. The method returns only769            /// when the actor is initialized and the <see cref="Event"/> (if any) is handled.770            /// </summary>771            internal Task<ActorId> CreateActorAndExecuteAsync(ActorId id, Type type, string name, Event initialEvent = null,772                EventGroup eventGroup = null)773            {774                var creatorOp = this.Scheduler.GetExecutingOperation<ActorOperation>();775                return this.CreateActorAndExecuteAsync(id, type, name, initialEvent, creatorOp?.Actor, eventGroup);776            }777            /// <summary>778            /// Creates a new <see cref="Actor"/> of the specified <see cref="Type"/>. The method779            /// returns only when the actor is initialized and the <see cref="Event"/> (if any)780            /// is handled.781            /// </summary>782            internal override async Task<ActorId> CreateActorAndExecuteAsync(ActorId id, Type type, string name, Event initialEvent,783                Actor creator, EventGroup eventGroup)784            {785                this.AssertExpectedCallerActor(creator, "CreateActorAndExecuteAsync");786                this.Assert(creator != null, "Only an actor can call 'CreateActorAndExecuteAsync': avoid calling " +787                    "it directly from the test method; instead call it through a test driver actor.");788                Actor actor = this.CreateActor(id, type, name, creator, eventGroup);789                this.RunActorEventHandler(actor, initialEvent, true, creator);790                // Wait until the actor reaches quiescence.791                await creator.ReceiveEventAsync(typeof(QuiescentEvent), rev => (rev as QuiescentEvent).ActorId == actor.Id);792                return await Task.FromResult(actor.Id);793            }794            /// <summary>795            /// Creates a new <see cref="Actor"/> of the specified <see cref="Type"/>.796            /// </summary>797            internal override Actor CreateActor(ActorId id, Type type, string name, Actor creator, EventGroup eventGroup)798            {799                this.Assert(type.IsSubclassOf(typeof(Actor)), "Type '{0}' is not an actor.", type.FullName);800                // Using ulong.MaxValue because a Create operation cannot specify801                // the id of its target, because the id does not exist yet.802                this.Scheduler.ScheduleNextOperation(AsyncOperationType.Create);803                this.ResetProgramCounter(creator);804                if (id is null)805                {806                    id = this.CreateActorId(type, name);807                }808                else809                {810                    this.Assert(id.Runtime is null || id.Runtime == this, "Unbound actor id '{0}' was created by another runtime.", id.Value);811                    this.Assert(id.Type == type.FullName, "Cannot bind actor id '{0}' of type '{1}' to an actor of type '{2}'.",812                        id.Value, id.Type, type.FullName);813                    id.Bind(this);814                }815                // If a group was not provided, inherit the current event group from the creator (if any).816                if (eventGroup is null && creator != null)817                {818                    eventGroup = creator.EventGroup;819                }820                Actor actor = ActorFactory.Create(type);821                ActorOperation op = new ActorOperation(id.Value, id.Name, actor, this.Scheduler);822                IEventQueue eventQueue = new MockEventQueue(actor);823                actor.Configure(this, id, op, eventQueue, eventGroup);824                actor.SetupEventHandlers();825                if (this.Configuration.ReportActivityCoverage)826                {827                    actor.ReportActivityCoverage(this.CoverageInfo);828                }829                bool result = this.Scheduler.RegisterOperation(op);830                this.Assert(result, "Actor id '{0}' is used by an existing or previously halted actor.", id.Value);831                if (actor is StateMachine)832                {833                    this.LogWriter.LogCreateStateMachine(id, creator?.Id.Name, creator?.Id.Type);834                }835                else836                {837                    this.LogWriter.LogCreateActor(id, creator?.Id.Name, creator?.Id.Type);838                }839                return actor;840            }841            /// <inheritdoc/>842            public override void SendEvent(ActorId targetId, Event initialEvent, EventGroup eventGroup = default, SendOptions options = null)843            {844                var senderOp = this.Scheduler.GetExecutingOperation<ActorOperation>();845                this.SendEvent(targetId, initialEvent, senderOp?.Actor, eventGroup, options);846            }847            /// <inheritdoc/>848            public override Task<bool> SendEventAndExecuteAsync(ActorId targetId, Event initialEvent,849                EventGroup eventGroup = null, SendOptions options = null)850            {851                var senderOp = this.Scheduler.GetExecutingOperation<ActorOperation>();852                return this.SendEventAndExecuteAsync(targetId, initialEvent, senderOp?.Actor, eventGroup, options);853            }854            /// <summary>855            /// Sends an asynchronous <see cref="Event"/> to an actor.856            /// </summary>857            internal override void SendEvent(ActorId targetId, Event e, Actor sender, EventGroup eventGroup, SendOptions options)858            {859                if (e is null)860                {861                    string message = sender != null ?862                        string.Format("{0} is sending a null event.", sender.Id.ToString()) :863                        "Cannot send a null event.";864                    this.Assert(false, message);865                }866                if (sender != null)867                {868                    this.Assert(targetId != null, "{0} is sending event {1} to a null actor.", sender.Id, e);869                }870                else871                {872                    this.Assert(targetId != null, "Cannot send event {1} to a null actor.", e);873                }874                this.AssertExpectedCallerActor(sender, "SendEvent");875                EnqueueStatus enqueueStatus = this.EnqueueEvent(targetId, e, sender, eventGroup, options, out Actor target);876                if (enqueueStatus is EnqueueStatus.EventHandlerNotRunning)877                {878                    this.RunActorEventHandler(target, null, false, null);879                }880            }881            /// <summary>882            /// Sends an asynchronous <see cref="Event"/> to an actor. Returns immediately if the target was883            /// already running. Otherwise blocks until the target handles the event and reaches quiescense.884            /// </summary>885            internal override async Task<bool> SendEventAndExecuteAsync(ActorId targetId, Event e, Actor sender,886                EventGroup eventGroup, SendOptions options)887            {888                this.Assert(sender is StateMachine, "Only an actor can call 'SendEventAndExecuteAsync': avoid " +889                    "calling it directly from the test method; instead call it through a test driver actor.");890                this.Assert(e != null, "{0} is sending a null event.", sender.Id);891                this.Assert(targetId != null, "{0} is sending event {1} to a null actor.", sender.Id, e);892                this.AssertExpectedCallerActor(sender, "SendEventAndExecuteAsync");893                EnqueueStatus enqueueStatus = this.EnqueueEvent(targetId, e, sender, eventGroup, options, out Actor target);894                if (enqueueStatus is EnqueueStatus.EventHandlerNotRunning)895                {896                    this.RunActorEventHandler(target, null, false, sender as StateMachine);897                    // Wait until the actor reaches quiescence.898                    await (sender as StateMachine).ReceiveEventAsync(typeof(QuiescentEvent), rev => (rev as QuiescentEvent).ActorId == targetId);899                    return true;900                }901                // EnqueueStatus.EventHandlerNotRunning is not returned by EnqueueEvent902                // (even when the actor was previously inactive) when the event e requires903                // no action by the actor (i.e., it implicitly handles the event).904                return enqueueStatus is EnqueueStatus.Dropped || enqueueStatus is EnqueueStatus.NextEventUnavailable;905            }906            /// <summary>907            /// Enqueues an event to the actor with the specified id.908            /// </summary>909            private EnqueueStatus EnqueueEvent(ActorId targetId, Event e, Actor sender, EventGroup eventGroup,910                SendOptions options, out Actor target)911            {912                target = this.Scheduler.GetOperationWithId<ActorOperation>(targetId.Value)?.Actor;913                this.Assert(target != null,914                    "Cannot send event '{0}' to actor id '{1}' that is not bound to an actor instance.",915                    e.GetType().FullName, targetId.Value);916                this.Scheduler.ScheduleNextOperation(AsyncOperationType.Send);917                this.ResetProgramCounter(sender as StateMachine);918                // If no group is provided we default to passing along the group from the sender.919                if (eventGroup is null && sender != null)920                {921                    eventGroup = sender.EventGroup;922                }923                if (target.IsHalted)924                {925                    Guid groupId = eventGroup is null ? Guid.Empty : eventGroup.Id;926                    this.LogWriter.LogSendEvent(targetId, sender?.Id.Name, sender?.Id.Type,927                        (sender as StateMachine)?.CurrentStateName ?? default, e, groupId, isTargetHalted: true);928                    this.Assert(options is null || !options.MustHandle,929                        "A must-handle event '{0}' was sent to {1} which has halted.", e.GetType().FullName, targetId);930                    this.HandleDroppedEvent(e, targetId);931                    return EnqueueStatus.Dropped;932                }933                EnqueueStatus enqueueStatus = this.EnqueueEvent(target, e, sender, eventGroup, options);934                if (enqueueStatus == EnqueueStatus.Dropped)935                {936                    this.HandleDroppedEvent(e, targetId);937                }938                return enqueueStatus;939            }940            /// <summary>941            /// Enqueues an event to the actor with the specified id.942            /// </summary>943            private EnqueueStatus EnqueueEvent(Actor actor, Event e, Actor sender, EventGroup eventGroup, SendOptions options)944            {945                EventOriginInfo originInfo;946                string stateName = null;947                if (sender is StateMachine senderStateMachine)948                {949                    originInfo = new EventOriginInfo(sender.Id, senderStateMachine.GetType().FullName,950                        NameResolver.GetStateNameForLogging(senderStateMachine.CurrentState));951                    stateName = senderStateMachine.CurrentStateName;952                }953                else if (sender is Actor senderActor)954                {955                    originInfo = new EventOriginInfo(sender.Id, senderActor.GetType().FullName, string.Empty);956                }957                else958                {959                    // Message comes from the environment.960                    originInfo = new EventOriginInfo(null, "Env", "Env");961                }962                EventInfo eventInfo = new EventInfo(e, originInfo)963                {964                    MustHandle = options?.MustHandle ?? false,965                    Assert = options?.Assert ?? -1966                };967                Guid opId = eventGroup is null ? Guid.Empty : eventGroup.Id;968                this.LogWriter.LogSendEvent(actor.Id, sender?.Id.Name, sender?.Id.Type, stateName,969                    e, opId, isTargetHalted: false);970                return actor.Enqueue(e, eventGroup, eventInfo);971            }972            /// <summary>973            /// Runs a new asynchronous event handler for the specified actor.974            /// This is a fire and forget invocation.975            /// </summary>976            /// <param name="actor">The actor that executes this event handler.</param>977            /// <param name="initialEvent">Optional event for initializing the actor.</param>978            /// <param name="isFresh">If true, then this is a new actor.</param>979            /// <param name="syncCaller">Caller actor that is blocked for quiscence.</param>980            private void RunActorEventHandler(Actor actor, Event initialEvent, bool isFresh, Actor syncCaller)981            {982                var op = actor.Operation;983                Task task = new Task(async () =>984                {985                    try986                    {987                        // Update the current asynchronous control flow with this runtime instance,988                        // allowing future retrieval in the same asynchronous call stack.989                        CoyoteRuntime.AssignAsyncControlFlowRuntime(this.Runtime);990                        this.Scheduler.StartOperation(op);991                        if (isFresh)992                        {993                            await actor.InitializeAsync(initialEvent);994                        }...

RunActorEventHandler

Using AI Code Generation

1{2    using System;3    using System.Threading.Tasks;4    using Microsoft.Coyote;5    using Microsoft.Coyote.Actors;6    using Microsoft.Coyote.Actors.Timers;7    using Microsoft.Coyote.Specifications;8    using Microsoft.Coyote.SystematicTesting;9    using Microsoft.Coyote.Tasks;10    using Microsoft.Coyote.Tests.Common;11    using Microsoft.Coyote.Tests.Common.Actors;12    using Microsoft.Coyote.Tests.Common.Runtime;13    using Microsoft.Coyote.Tests.Common.Tasks;14    using Microsoft.Coyote.Tests.Common.Timers;15    using Microsoft.Coyote.Tests.Common.Utilities;16    using Microsoft.Coyote.Tests.Systematic;17    using Microsoft.Coyote.Tests.Systematic.Actors;18    using Microsoft.Coyote.Tests.Systematic.Tasks;19    using Microsoft.Coyote.Tests.Systematic.Timers;20    using Microsoft.Coyote.Tests.Systematic.Utilities;21    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding;22    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;23    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;24    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;25    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;26    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;27    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;28    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;29    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;30    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;31    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;32    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;33    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;34    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;35    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;36    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;37    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Tasks;38    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Timers;39    using Microsoft.Coyote.Tests.Systematic.Actors.BugFinding.Utilities;

RunActorEventHandler

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Actors.Timers;6{7    {8        public static async Task Main()9        {10            var runtime = RuntimeFactory.Create();11            var config = Configuration.Create();12            await runtime.CreateActorAndExecuteAsync(typeof(Actor1), config, null, null);13        }14    }15    {16        protected override async Task OnInitializeAsync(Event initialEvent)17        {18            await this.RunActorEventHandlerAsync(typeof(Actor1), this.InitializeAsync, null);19        }20        private async Task InitializeAsync(Event initialEvent)21        {22            Console.WriteLine("Hello World!");23        }24    }25}

RunActorEventHandler

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Specifications;6using Microsoft.Coyote.Tasks;7using Microsoft.Coyote.Testing;8{9    {10        public static void Main(string[] args)11        {12            var runtime = RuntimeFactory.Create();13            var engine = new Engine(runtime);14            var configuration = Configuration.Create();15            var listener = new TextWriterTraceListener(Console.Out);16            configuration.TraceListeners.Add(listener);17            engine.RunTest(typeof(Tests), configuration);18            runtime.Dispose();19        }20    }21    {22        public async Task Test1()23        {24            var m = this.CreateActor(typeof(M))

RunActorEventHandler

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Actors.Timers;6{7    {8        static async Task Main(string[] args)9        {10            using (var runtime = RuntimeFactory.Create())11            {12                var id = ActorId.CreateRandom();13                var actor = runtime.CreateActor(typeof(MyActor), id);14                runtime.SendEvent(id, new MyEvent());15                await actor;16            }17        }18    }19    {20    }21    {22        protected override Task OnInitializeAsync(Event initialEvent)23        {24            this.RegisterEventHandler<MyEvent>(this.HandleMyEvent);25            return Task.CompletedTask;26        }27        private Task HandleMyEvent(Event e)28        {29            Console.WriteLine("Hello from actor {0}!", this.Id);30            return Task.CompletedTask;31        }32    }33}34Hello from actor ActorId(1)!35using System;36using System.Threading.Tasks;37using Microsoft.Coyote;38using Microsoft.Coyote.Actors;39using Microsoft.Coyote.Actors.Timers;40{41    {42        static async Task Main(string[] args)43        {44            using (var runtime = RuntimeFactory.Create())45            {46                var id = ActorId.CreateRandom();47                var actor = runtime.CreateActor(typeof(MyActor), id);48                runtime.SendEvent(id, new MyEvent());49                await actor;50            }51        }52    }53    {54    }55    {56        private TimerInfo Timer;57        protected override Task OnInitializeAsync(Event initialEvent)58        {59            this.RegisterEventHandler<MyEvent>(this.HandleMyEvent

RunActorEventHandler

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.TestingServices;6using Microsoft.Coyote.Tasks;7{8    {9        public int Value { get; set; }10    }11    {12        protected override Task OnInitializeAsync(Event initialEvent)13        {14            this.SendEvent(this.Id, new MyEvent() { Value = 1 });15            this.SendEvent(this.Id, new MyEvent() { Value = 2 });16            this.SendEvent(this.Id, new MyEvent() { Value = 3 });17            return Task.CompletedTask;18        }19        protected override Task OnEventAsync(Event e)20        {21            if (e is MyEvent myEvent)22            {23                Console.WriteLine($"Received event with value {myEvent.Value}");24            }25            return Task.CompletedTask;26        }27    }28    {29        static void Main(string[] args)30        {31            var configuration = Configuration.Create().WithTestingIterations(1);32            using (var test = TestingEngineFactory.CreateTestingEngine(configuration))33            {34                test.RegisterActor<MyActor>();35                test.CreateActor(typeof(MyActor));36                test.RunAsync().Wait();37            }38        }39    }40}41using System;42using System.Threading.Tasks;43using Microsoft.Coyote;44using Microsoft.Coyote.Actors;45using Microsoft.Coyote.TestingServices;46using Microsoft.Coyote.Tasks;47{48    {49        public int Value { get; set; }50    }51    {52        protected override Task OnInitializeAsync(Event initialEvent)53        {54            this.SendEvent(this.Id, new MyEvent() { Value = 1 });55            this.SendEvent(this.Id, new MyEvent() { Value = 2 });56            this.SendEvent(this.Id, new MyEvent() { Value = 3 });57            return Task.CompletedTask;58        }59        protected override Task OnEventAsync(Event e)60        {61            if (e is MyEvent

RunActorEventHandler

Using AI Code Generation

1{2    {3        public void RunActorEventHandler(ActorId actorId, Event evt)4        {5            var actor = (Actor)GetActor(actorId);6            actor.HandleEvent(evt);7        }8    }9}10using Microsoft.Coyote.Actors;11using Microsoft.Coyote.Runtime;12using System;13using System.Threading.Tasks;14{15    {16        static void Main(string[] args)17        {18            var runtime = RuntimeFactory.Create();19            var context = runtime.CreateActorExecutionContext();20            var actorId = context.CreateActor(typeof(Actor1));21            context.RunActorEventHandler(actorId, new Event1());22            Console.WriteLine("Hello World!");23        }24    }25    public class Event1 : Event { }26    {27        protected override Task OnInitializeAsync(Event initialEvent)28        {29            Console.WriteLine("Actor1 is initialized");30            return Task.CompletedTask;31        }32        protected override Task OnEventAsync(Event evt)33        {34            Console.WriteLine("Actor1 is handling an event");35            return Task.CompletedTask;36        }37    }38}

RunActorEventHandler

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Specifications;6{7    {8        public int Value;9        public E(int value)10        {11            Value = value;12        }13    }14    {15        public int Value;16        public A(int value)17        {18            Value = value;19        }20        [OnEventDoAction(typeof(E), nameof(Handle))]21        private class Init : State { }22        private void Handle()23        {24            this.Value = this.ReceivedEvent.Value;25        }26    }27    {28        static async Task Main(string[] args)29        {30            var runtime = RuntimeFactory.Create();31            var config = Configuration.Create().WithTestingIterations(100);32            runtime.CreateActor(typeof(A), new ActorId("A"), new A(0));33            var actor = runtime.GetActor("A");34            int value = 0;35            for (int i = 0; i < 10; i++)36            {37                value = value + 1;38                var e = new E(value);39                runtime.RunActorEventHandler(actor, e);40                Specification.Assert(actor.Value == value, "Value is not correct");41            }42            Console.WriteLine("All good!");43        }44    }45}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.