Skip to content
Course for learning how to apply property-based state-machine testing
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
level00
level01
level02
level03
level04
level05
level06
nix
presentation
src
.dir-locals.el
.gitignore
COFFEE_LEVELS.md
ChangeLog.md
LICENCE
Lens_Cheatsheet.md
Other_Languages.md
README.md
Setup.hs
default.nix
shell.nix
state-machine-testing-course.cabal
state-machine-testing-course.nix

README.md

State Machine Testing

This is in progress course material for a course on property-based state machine testing, using the Hedgehog package.

Requirements

  • You would like an automated minion to unleash hell on your application, breaking it in strange and fascinating ways.

What is State Machine Testing?

State Machine Testing extends property-based testing to provide a toolkit for building randomised tests of stateful systems. Like property-based testing, state machine tests use random generators to create test cases and shrink failing tests to minimal counter-examples. The difference with state machine testing is that the random input is now a sequence of commands to perform instead of arguments to pure functions.

In this course, we'll be using hedgehog's state machine testing. The QuickCheck ecosystem has its own quickcheck-state-machine package which we won't cover.

How do we know that our stateful system is behaving itself? We build a model of the system being tested, and use it in a few ways:

  • Not all actions make sense at all times (e.g., what should happen if you try to log in when you're already logged-in?). When hedgehog generates a command sequence, we update the model being tested and use it to limit the actions we generate.

  • When we run tests, we perform commands both on the model and the system being tested, and check that their results agree.

Repository Structure

The system we're testing is a vending machine for hot drinks, defined in src/CoffeeMachine.hs. You can select which drink you'd like, insert or remove a mug, add milk or sugar, insert coins and dispense a beverage. We'll be testing these features at different levels of the course.

The course itself is broken apart into several levels. Because this is a course about testing, each level is a separate test-suite in the .cabal file, and its own directory.

Solutions are on the solutions branch, one commit per level.

Running with stack

You will need to run a few additional commands when using stack:

# Initialise
$ stack init

# Replace `level01` with the level you are working on
$ stack test :level01

# REPL, if you want it
$ stack ghci :level01

Course Structure

  1. Setting Up
  1. First tests
  • Terminology and Command structure
  • Some simple commands
  • Discussion of test feedback and interpreting errors
  1. Require & Pre-conditions
  2. More Commands
  3. Positive & Negative Testing
  4. Lensy Models
You can’t perform that action at this time.