TestMu Conference is Back! Future of Testing + AI LambdaTest G2 Announcement

How to use EventGroup class of Microsoft.Coyote.Actors package

Best Coyote code snippet using Microsoft.Coyote.Actors.EventGroup

AwaitableEventGroup.cs

Source:AwaitableEventGroup.cs

...7namespace Microsoft.Coyote.Actors8{9    /// <summary>10    /// An object representing an awaitable long running context involving one or more actors.11    /// An `AwaitableEventGroup` can be provided as an optional argument in CreateActor and SendEvent.12    /// If a null `AwaitableEventGroup` is passed then the `EventGroup` is inherited from the sender13    /// or target actors (based on which ever one has a <see cref="Actor.CurrentEventGroup"/>).14    /// In this way an `AwaitableEventGroup` is automatically communicated to all actors involved in15    /// completing some larger operation. Each actor involved can find the `AwaitableEventGroup` using16    /// their <see cref="Actor.CurrentEventGroup"/> property.17    /// </summary>18    /// <typeparam name="T">The result returned when the operation is completed.</typeparam>19    public class AwaitableEventGroup<T> : EventGroup20    {21        /// <summary>22        /// A task completion source that can be awaited to get the final result object.23        /// </summary>24        private readonly TaskCompletionSource<T> Tcs;25        /// <summary>26        /// Gets the task created by this `AwaitableEventGroup`.27        /// </summary>28        public Task<T> Task => this.Tcs.Task;29        /// <summary>30        /// Indicates the `AwaitableEventGroup` has been completed.31        /// </summary>32        public bool IsCompleted => this.Tcs.Task.IsCompleted;33        /// <summary>34        /// Value that indicates whether the task completed execution due to being canceled.35        /// </summary>36        public bool IsCanceled => this.Tcs.Task.IsCanceled;37        /// <summary>38        /// Value that indicates whether the task completed due to an unhandled exception.39        /// </summary>40        public bool IsFaulted => this.Tcs.Task.IsFaulted;41        /// <summary>42        /// Initializes a new instance of the <see cref="AwaitableEventGroup{T}"/> class.43        /// </summary>44        /// <param name="id">The id for this `AwaitableEventGroup` (defaults to Guid.Empty).</param>45        /// <param name="name">An optional friendly name for this `EventGroup`.</param>46        public AwaitableEventGroup(Guid id = default, string name = null)47            : base(id, name)48        {49            this.Tcs = new TaskCompletionSource<T>();50            CoyoteRuntime.Current?.RegisterKnownControlledTask(this.Tcs.Task);51        }52        /// <summary>53        /// Transitions the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.RanToCompletion"/> state.54        /// </summary>55        /// <param name="result">The completed result object.</param>56        public virtual void SetResult(T result)57        {58            this.Tcs.SetResult(result);59        }60        /// <summary>61        /// Attempts to transition the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.RanToCompletion"/> state.62        /// </summary>63        /// <param name="result">The completed result object.</param>64        public virtual void TrySetResult(T result)65        {66            this.Tcs.TrySetResult(result);67        }68        /// <summary>69        /// Transitions the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.Canceled"/> state.70        /// </summary>71        public virtual void SetCancelled() => this.Tcs.SetCanceled();72        /// <summary>73        /// Attempts to transition the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.Canceled"/> state.74        /// </summary>75        /// <returns>True if the `AwaitableEventGroup` was successful; otherwise, false.</returns>76        public virtual bool TrySetCanceled() => this.Tcs.TrySetCanceled();77        /// <summary>78        /// Transitions the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.Faulted"/> state79        /// and binds it to the specified exception.80        /// </summary>81        /// <param name="exception">The exception to bind to this task.</param>82        public virtual void SetException(Exception exception) => this.Tcs.SetException(exception);83        /// <summary>84        /// Attempts to transition the underlying task into the <see cref="System.Threading.Tasks.TaskStatus.Faulted"/> state85        /// and binds it to the specified exception.86        /// </summary>87        /// <param name="exception">The exception to bind to this task.</param>88        /// <returns>True if the `AwaitableEventGroup` was successful; otherwise, false.</returns>89        public virtual bool TrySetException(Exception exception) => this.Tcs.TrySetException(exception);90        /// <summary>91        /// Gets an awaiter for this awaitable.92        /// </summary>93        public TaskAwaiter<T> GetAwaiter() => new TaskAwaiter<T>(this.Tcs.Task);94    }95}...

EventGroup.cs

Source:EventGroup.cs

...4namespace Microsoft.Coyote.Actors5{6    /// <summary>7    /// An object representing a long running context involving one or more actors.8    /// An `EventGroup` can be provided as an optional argument in CreateActor and SendEvent.9    /// If a null `EventGroup` is passed then the `EventGroup` is inherited from the sender10    /// or target actors (based on which ever one has a <see cref="Actor.CurrentEventGroup"/>).11    /// In this way an `EventGroup` is automatically communicated to all actors involved in12    /// completing some larger operation. Each actor involved can find the `EventGroup` using13    /// their <see cref="Actor.CurrentEventGroup"/> property.14    /// </summary>15    public class EventGroup16    {17        /// <summary>18        /// A special null event group that can be used to stop the <see cref="Actor.CurrentEventGroup"/> from19        /// being passed along when <see cref="Actor.CreateActor(ActorId, Type, string, Event, EventGroup)"/>20        /// or <see cref="Actor.SendEvent(ActorId, Event, EventGroup, SendOptions)"/> is invoked.21        /// </summary>22        public static EventGroup Null = new EventGroup();23        /// <summary>24        /// The unique id of this `EventGroup`, initialized with Guid.Empty.25        /// </summary>26        public Guid Id { get; }27        /// <summary>28        /// An optional friendly name for this `EventGroup`.29        /// </summary>30        public string Name { get; }31        /// <summary>32        /// Initializes a new instance of the <see cref="EventGroup"/> class.33        /// </summary>34        /// <param name="id">The id for this `EventGroup` (defaults to Guid.Empty).</param>35        /// <param name="name">An optional friendly name for this `EventGroup`.</param>36        public EventGroup(Guid id = default, string name = null)37        {38            this.Id = id;39            this.Name = name;40        }41    }42}...

EventGroup

Using AI Code Generation

1using Microsoft.Coyote.Actors;2using Microsoft.Coyote.Actors;3using Microsoft.Coyote.Actors;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Actors;6using Microsoft.Coyote.Actors;7using Microsoft.Coyote.Actors;8using Microsoft.Coyote.Actors;9using Microsoft.Coyote.Actors;10using Microsoft.Coyote.Actors;11using Microsoft.Coyote.Actors;12using Microsoft.Coyote.Actors;13using Microsoft.Coyote.Actors;14using Microsoft.Coyote.Actors;15using Microsoft.Coyote.Actors;16using Microsoft.Coyote.Actors;17using Microsoft.Coyote.Actors;18using Microsoft.Coyote.Actors;19using Microsoft.Coyote.Actors;20using Microsoft.Coyote.Actors;

EventGroup

Using AI Code Generation

1{2    using Microsoft.Coyote.Actors;3    {4        public static void Main(string[] args)5        {6            var runtime = RuntimeFactory.Create();7            runtime.CreateActor(typeof(Actor1));8            runtime.Run();9        }10    }11    {12        private EventGroup group = new EventGroup();13        protected override void OnInitialize(Event initialEvent)14        {15            this.SendEvent(this.Id, new E1());16            this.SendEvent(this.Id, new E2());17            this.SendEvent(this.Id, new E3());18        }19        protected override async Task OnEventAsync(Event e)20        {21            switch (e)22            {23                    this.group.AddEvent(e);24                    break;25                    this.group.AddEvent(e);26                    break;27                    this.group.AddEvent(e);28                    break;29                    this.Assert(g.Count == 3, "Expected 3 events in group.");30                    this.Assert(g.ContainsEvent<E1>(), "Expected to find E1 event in group.");31                    this.Assert(g.ContainsEvent<E2>(), "Expected to find E2 event in group.");32                    this.Assert(g.ContainsEvent<E3>(), "Expected to find E3 event in group.");33                    this.Assert(g.GetEvent<E1>() is E1, "Expected to find E1 event in group.");34                    this.Assert(g.GetEvent<E2>() is E2, "Expected to find E2 event in group.");35                    this.Assert(g.GetEvent<E3>() is E3, "Expected to find E3 event in group.");36                    this.Assert((g.GetEvent<E1>() as E1).Value == 1, "Expected to find E1 event with value 1 in group.");37                    this.Assert((g.GetEvent<E2>() as E2).Value == 2, "Expected to find E2 event with value 2 in group.");38                    this.Assert((g.GetEvent<E3>() as E3).Value == 3, "Expected to find E3 event with value 3 in group.");39                    break;40            }41        }42        {43            public int Value { get; set; } = 1;44        }45        {46            public int Value { get; set; } =

EventGroup

Using AI Code Generation

1using Microsoft.Coyote.Actors;2{3    {4        private static void Main(string[] args)5        {6            var runtime = RuntimeFactory.Create();7            runtime.CreateActor(typeof(Monitor));8            runtime.CreateActor(typeof(Actor1));9            runtime.CreateActor(typeof(Actor2));10            runtime.Run();11        }12    }13}14using Microsoft.Coyote.Actors;15using System.Threading.Tasks;16{17    {18        [OnEventDoAction(typeof(Event1), nameof(Event1Handler))]19        [OnEventDoAction(typeof(Event2), nameof(Event2Handler))]20        {21        }22        private void Event1Handler()23        {24            this.RaiseEvent(new Event2());25        }26        private void Event2Handler()27        {28            this.RaiseEvent(new Event1());29        }30    }31}32using Microsoft.Coyote.Actors;33using System.Threading.Tasks;34{35    {36        [OnEntry(nameof(OnInit))]37        {38        }39        private async Task OnInit()40        {41            this.SendEvent(new Monitor(), new Event1());42            await Task.Delay(1000);43        }44    }45}46using Microsoft.Coyote.Actors;47using System.Threading.Tasks;48{49    {50        [OnEntry(nameof(OnInit))]51        {52        }53        private async Task OnInit()54        {55            this.SendEvent(new Monitor(), new Event2());56            await Task.Delay(1000);57        }58    }59}60using Microsoft.Coyote.Actors;61{62    {63    }64}65using Microsoft.Coyote.Actors;66{67    {68    }69}

EventGroup

Using AI Code Generation

1using System;2using Microsoft.Coyote.Actors;3{4    {5        public static void Main()6        {7            var runtime = RuntimeFactory.Create();8            var id = runtime.CreateActor(typeof(Actor1));9            runtime.SendEvent(id, new Event1());10            runtime.SendEvent(id, new Event2());11            runtime.SendEvent(id, new Event3());12            runtime.SendEvent(id, new Event4());13            runtime.SendEvent(id, new Event5());14            runtime.SendEvent(id, new Event6());15            runtime.SendEvent(id, new Event7());16            runtime.SendEvent(id, new Event8());17            runtime.SendEvent(id, new Event9());18            runtime.SendEvent(id, new Event10());19        }20    }21    {22    }23    {24    }25    {26    }27    {28    }29    {30    }31    {32    }33    {34    }35    {36    }37    {38    }39    {40    }41    {42        private int counter;43        [OnEventDoAction(typeof(Event1), nameof(HandleEvent1))]44        [OnEventDoAction(typeof(Event2), nameof(HandleEvent2))]45        [OnEventDoAction(typeof(Event3), nameof(HandleEvent3))]46        [OnEventDoAction(typeof(Event4), nameof(HandleEvent4))]47        [OnEventDoAction(typeof(Event5), nameof(HandleEvent5))]48        [OnEventDoAction(typeof(Event6), nameof(HandleEvent6))]49        [OnEventDoAction(typeof(Event7), nameof(HandleEvent7))]50        [OnEventDoAction(typeof(Event8), nameof(HandleEvent8))]51        [OnEventDoAction(typeof(Event9), nameof(HandleEvent9))]52        [OnEventDoAction(typeof(Event10), nameof(HandleEvent10))]53        {54        }55        private void HandleEvent1()56        {57            counter++;58        }59        private void HandleEvent2()60        {61            counter++;62        }63        private void HandleEvent3()64        {65            counter++;66        }

EventGroup

Using AI Code Generation

1using Microsoft.Coyote.Actors;2using System;3using System.Threading.Tasks;4{5    {6        public static async Task Main()7        {8            using var runtime = RuntimeFactory.Create();9            var group = runtime.CreateActorGroup();10            var a = group.CreateActor(typeof(A));11            var b = group.CreateActor(typeof(B));12            await group.SendEvent(a, new E());13            await group.SendEvent(b, new E());14            await group.WaitForActorsToTerminate();15        }16    }17    {18        protected override Task OnInitializeAsync(Event initialEvent)19        {20            Console.WriteLine("A is initialized.");21            return Task.CompletedTask;22        }23        protected override Task OnEventAsync(Event e)24        {25            if (e is E)26            {27                Console.WriteLine("A received event E.");28            }29            return Task.CompletedTask;30        }31    }32    {33        protected override Task OnInitializeAsync(Event initialEvent)34        {35            Console.WriteLine("B is initialized.");36            return Task.CompletedTask;37        }38        protected override Task OnEventAsync(Event e)39        {40            if (e is E)41            {42                Console.WriteLine("B received event E.");43            }44            return Task.CompletedTask;45        }46    }47    public class E : Event { }48}

EventGroup

Using AI Code Generation

1using Microsoft.Coyote.Actors;2using Microsoft.Coyote.Specifications;3using System;4using System.Threading.Tasks;5{6    {7        {8            public int x;9            public E1(int x)10            {11                this.x = x;12            }13        }14        {15            public int x;16            public E2(int x)17            {18                this.x = x;19            }20        }21        {22            public int x;23            public E3(int x)24            {25                this.x = x;26            }27        }28        {29            public int x;30            public E4(int x)31            {32                this.x = x;33            }34        }35        {36            public int x;37            public E5(int x)38            {39                this.x = x;40            }41        }42        {43            public int x;44            public E6(int x)45            {46                this.x = x;47            }48        }49        {50            public int x;51            public E7(int x)52            {53                this.x = x;54            }55        }56        {57            public int x;58            public E8(int x)59            {60                this.x = x;61            }62        }63        {64            public int x;65            public E9(int x)66            {67                this.x = x;68            }69        }70        {71            public int x;72            public E10(int x)73            {74                this.x = x;75            }76        }77        {78            public int x;79            public E11(int x)80            {81                this.x = x;82            }83        }84        {85            public int x;86            public E12(int x)87            {88                this.x = x;89            }90        }91        {92            public int x;93            public E13(int x)94            {95                this.x = x;96            }97        }98        {99            public int x;

EventGroup

Using AI Code Generation

1using System;2using Microsoft.Coyote.Actors;3{4    {5        static void Main(string[] args)6        {7            var runtime = RuntimeFactory.Create();8            var group = new EventGroup();9            var actor1 = new Actor1();10            var actor2 = new Actor2();11            var actor3 = new Actor3();12            group.Add(actor1);13            group.Add(actor2);14            group.Add(actor3);15            runtime.CreateActor(typeof(Actor1), actor1);16            runtime.CreateActor(typeof(Actor2), actor2);17            runtime.CreateActor(typeof(Actor3), actor3);18            runtime.Run();19        }20    }21    {22        protected override void OnInitialize()23        {24            Console.WriteLine("Actor 1 initialized");25        }26    }27    {28        protected override void OnInitialize()29        {30            Console.WriteLine("Actor 2 initialized");31        }32    }33    {34        protected override void OnInitialize()35        {36            Console.WriteLine("Actor 3 initialized");37        }38    }39}

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.