How do I install QuickChick using OPAM?

First, add the Coq OPAM repository with 'opam repo add coq-released https://coq.inria.fr/opam/released', then update and install coq-quickchick. Ensure you have Coq installed beforehand for a smooth setup.

QuickChick vs Hypothesis for property-based testing?

QuickChick is designed for Coq and formal verification, while Hypothesis is for Python. Choose QuickChick if you're working in Coq's proof assistant; otherwise, Hypothesis is better for general-purpose testing in Python projects.

Can QuickChick test code outside of Coq?

No, QuickChick only works with properties and specifications defined within Coq. It cannot directly test code in other languages unless integrated via Coq bindings or formal models.

How to write custom generators in QuickChick?

Use the QCDerive commands like 'QCDerive Arbitrary for c' to automatically derive generators, or manually define them using QuickChick's API as demonstrated in the tutorial files under examples/.

What's the difference between QuickCheck and MutateCheck?

QuickCheck generates random test cases to verify properties, while MutateCheck performs mutation testing by creating code mutants to evaluate test suite quality, helping identify weak tests.

Is QuickChick good for teaching formal verification?

Yes, it's excellent for educational settings, as it bridges testing and theorem proving, with resources like the Software Foundations tutorial making it accessible for courses on property-based testing in Coq.

Open-Awesome

QuickChick

NOASSERTIONRocq Proverv2.1.1

A randomized property-based testing plugin for Coq, enabling automated test generation and verification within proof assistants.

GitHub

293 stars51 forks0 contributors

What is QuickChick?

QuickChick is a randomized property-based testing plugin for the Coq proof assistant. It enables automated generation of test cases for properties and specifications defined in Coq, helping developers verify correctness through testing before or alongside formal proofs. The tool includes features like automatic generator derivation and mutation testing to enhance test coverage and reliability.

Target Audience

Coq users, formal verification researchers, and developers working on verified software who want to integrate automated testing into their proof development workflow.

Value Proposition

QuickChick provides a unique blend of property-based testing and formal verification, allowing users to leverage automated test generation within Coq's trusted environment. Its automatic derivation of generators for inductive relations and foundational verification framework set it apart from manual testing approaches.

Overview

Randomized Property-Based Testing Plugin for Coq

Use Cases

Best For

Automatically testing properties of Coq specifications before attempting formal proofs
Generating random test cases for inductive relations in formal verification projects
Integrating mutation testing into Coq development workflows
Teaching property-based testing concepts within formal verification courses
Verifying complex data structures like red-black trees in Coq
Bridging the gap between testing and theorem proving in software verification

Not Ideal For

Projects not using the Coq proof assistant, as QuickChick is a Coq-specific plugin
Teams needing fast, interactive testing for rapid iteration without formal verification overhead
Environments that require integration with testing frameworks for mainstream languages like Python or Java

Pros & Cons

Pros

Automatic Generator Derivation

Automatically derives generators, enumerators, and checkers for inductive relations, saving significant manual coding effort in test generation, as highlighted in the README's examples.

Integrated Mutation Testing

Includes commands like MutateCheck to evaluate test suite quality through mutation analysis, a feature that enhances robustness beyond standard property-based testing.

Formal Verification Foundation

Provides a verified framework for testing, ensuring reliability within Coq's proof environment, as supported by academic papers linked in the documentation.

Seamless Coq Integration

Offers top-level commands like QuickCheck and Sample that integrate directly into Coq's workflow, making it easy to use during development without external tools.

Cons

Complex Setup Process

Installation requires OPAM and specific Coq repositories, which can be non-trivial for users unfamiliar with Coq's ecosystem, as detailed in the README's installation steps.

Niche Ecosystem Dependency

Tied exclusively to Coq, making it unsuitable for projects that don't use formal verification or need cross-language testing, limiting broader adoption.

Documentation Fragmentation

Tutorials and resources are scattered across multiple files and external links, such as the Software Foundations volume, which can hinder onboarding and quick reference.

Frequently Asked Questions

Related Projects

MetaCoq

Metaprogramming, verified meta-theory and implementation of Rocq in Rocq

Stars561

Forks100

Last commit10 days ago

CoqHammer

CoqHammer: An Automated Reasoning Hammer Tool for Rocq - Proof Automation for Dependent Type Theory

Stars249

Forks39

Last commit1 month ago

Equations

A function definition package for Rocq

Stars236

Forks58

Last commit2 days ago

Coq-Elpi

Rocq plugin embedding Elpi

Stars196

Forks80