coyote/Samples/README.md

Coyote Samples

This directory contains two sets of Coyote samples.

The first set of samples shows how you can use Coyote to systematically test unmodified C# task-based applications and services:

• AccountManager: demonstrates how to write a simple task-based C# application to create, get and delete account records in a backend NoSQL database and then systematically test this application using Coyote to find a race condition.
• ImageGalleryAspNet: demonstrates how to use Coyote to test an ASP.NET Core service.
• Coffee Machine Failover: demonstrates how to systematically test the failover logic in your task-based applications.
• BoundedBuffer: demonstrates how to use coyote rewrite to find deadlocks in unmodified C# code.

The second set of samples shows how you can use the Coyote actor programming model to build reliable applications and services:

• HelloWorldActors: demonstrates how to write a simple Coyote application using actors, and then run and systematically test it.
• CloudMessaging: demonstrates how to write a Coyote application that contains components that communicate with each other using the Azure Service Bus cloud messaging queue.
• Coffee Machine Failover: demonstrates how to systematically test the failover logic in your Coyote actor applications.
• Robot Navigator Failover: demonstrates how to systematically test the failover logic in your Coyote actors applications.
• Timers in Actors: demonstrates how to use the timer API of the Coyote actor programming model.

Get started

To build and run the samples, you will need to:

• Install the .NET 8.0 SDK.
• Install the .NET 8.0 version of the coyote tool.

Once you are ready, build the samples by running the following script from the root of the repository in powershell:

./Samples/Scripts/build.ps1

You can find the compiled binaries in the bin directory. You can use the coyote tool to automatically test these samples and find bugs. First, read how to use the tool here. Then, follow the instructions in each sample.

Using the local Coyote packages

By default, the samples use the published Microsoft.Coyote NuGet package.

If you want instead to use the locally built Coyote binaries, then run the following script in powershell:

./Samples/Scripts/build.ps1 -local

Finally, if you want instead to use the locally built Coyote NuGet packages, then run the following script in powershell:

./Samples/Scripts/build.ps1 -local -nuget