QuickChick

Description

• Randomized property-based testing plugin for Coq; a clone of Haskell QuickCheck
• Includes a foundational verification framework for testing code
• Includes a mechanism for automatically deriving generators for inductive relations

Tutorial

• Small tutorials on Basic Usage and Automation can be found under tutorials/
• An extended introduction can be found in QuickChick: Property-Based Testing in Coq (Software Foundations, Volume 4)

Installation

From OPAM

# Add the Coq opam repository (if you haven't already)
opam repo add coq-released https://coq.inria.fr/opam/released
opam update
# Install the coq-quickchick opam package
opam install coq-quickchick

Simple Examples

• examples/Tutorial.v
• examples/RedBlack
• examples/stlc
• examples/ifc-basic

Running make tests in the top-level QuickChick folder will check and execute all of these. If successful, you should see "success" at the end.

Documentation

The public API of QuickChick is summarized in QuickChickInterface.v.

Top-level Commands

• QuickCheck c
• Sample g
• Derive Arbitrary for c
• Derive Show for c
• Derive ArbitrarySizedSuchThat for (fun x => p)
• Derive DecOpt for p
• Derive EnumSizedSuchThat for (fun x => p)
• Derive ArbitrarySizedSuchThat for (fun x => let (x1,x2...) := x in p)
• QuickCheckWith args c
• MutateCheck c p
• MutateCheckWith args c p
• MutateCheckMany c ps
• MutateCheckManyWith args c ps

More resources

Here is some more reading material:

• Our PLDI 2022 paper on a mechanism for automatically deriving generators, enumerators, and checkers for inductive relations
• Our POPL 2018 paper on a mechanism for automatically deriving generators for inductive relations
• Our ITP 2015 paper on Foundational Property-Based Testing
• Our PLDI 2023 paper on a mechanism for merging multiple inductive relations into one
• Leo's invited talk at CLA on Random Testing in the Coq Proof Assistant
• Catalin's internship topic proposals for 2015
• Catalin's presentation at CoqPL 2015 workshop (2015-01-18)
• Zoe's thesis defense at NTU Athens (2014-09-08)
• Maxime's presentation at the Coq Workshop (2014-07-18)
• Catalin's presentation at the Coq Working Group @ PPS (2014-03-19)

Developer's corner

Build dependencies

Dependencies are listed in coq-quickchick.opam.

# To get the dependencies, add the Coq opam repository if you haven't already
opam repo add coq-released https://coq.inria.fr/opam/released
opam update
opam install . --deps-only

Build

dune build

Run tests

dune runtest

Run extra tests for quickChick tool

dune install coq-quickchick  # Makes QuickChick available globally
dune build @cram