FiniteModelChecker 1.0.1

dotnet add package FiniteModelChecker --version 1.0.1                
NuGet\Install-Package FiniteModelChecker -Version 1.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FiniteModelChecker" Version="1.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FiniteModelChecker --version 1.0.1                
#r "nuget: FiniteModelChecker, 1.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FiniteModelChecker as a Cake Addin
#addin nuget:?package=FiniteModelChecker&version=1.0.1

// Install FiniteModelChecker as a Cake Tool
#tool nuget:?package=FiniteModelChecker&version=1.0.1                

Finite Model Checker

This is a finite model checker for C#. Use it to exhaustively explore all possible sequences of operations against your codebase. Instead of arduously writing unit tests to perform a small series of operations, just define the set of all possible operations and let this library get to work! Example use cases:

  • Exhaustively test your custom data structure against reads and writes
  • Effectively explore the state space of your concurrency control code
  • Simulate events in a multi-replica mockup of your system

Forked from Azure/RingMaster; I wrote this tool at Microsoft to test some particularly tricky serialization code for reducing memory usage.

NuGet package: https://www.nuget.org/packages/FiniteModelChecker/

The assemblies distributed in the NuGet package are compiled against .NET Standard 1.0, which means your project must be using .NET Framework 4.5+ or .NET Core 1.0+ to reference them (see here for more details).

Build & Test

  1. Install .NET Core
  2. Clone the repo
  3. To build, run dotnet build from the root of the repo
  4. To test, run dotnet test from the FiniteModelChecker.Tests directory
  5. To package, run dotnet pack -c release

Usage

In order to model-check your code, you must define the following:

  • The set of initial states
  • The set of possible state transitions
  • The set of safety invariants: things which you want to always be true

The model-checker will then perform a breadth-first search from your initial states using the state transitions, checking the invariants in each state and reporting a full error trace if an invariant fails to hold. This means your model must generate only a finite number of states, as otherwise the model-checker will run forever.

For a simple example, you can see an implementation of the water jugs puzzle from Die Hard 3 in the Tests directory.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.0 is compatible.  netstandard1.1 was computed.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wp8 was computed.  wp81 was computed.  wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 2,959 8/22/2018
1.0.0 822 8/20/2018