Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/engineeringsoftware/mcoq
Mutation analysis tool for Coq verification projects
https://github.com/engineeringsoftware/mcoq
coq mutation-analysis serapi
Last synced: about 2 months ago
JSON representation
Mutation analysis tool for Coq verification projects
- Host: GitHub
- URL: https://github.com/engineeringsoftware/mcoq
- Owner: EngineeringSoftware
- License: apache-2.0
- Created: 2020-01-16T16:42:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-13T18:54:06.000Z (about 4 years ago)
- Last Synced: 2024-04-23T16:38:09.457Z (8 months ago)
- Topics: coq, mutation-analysis, serapi
- Language: Java
- Homepage: https://cozy.ece.utexas.edu/mcoq/
- Size: 1.9 MB
- Stars: 27
- Watchers: 9
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mCoq: Mutation Analysis for Coq
mCoq is a tool for mutation analysis of verification projects that use the
[Coq proof assistant](https://coq.inria.fr).
mCoq applies a set of mutation operators to Coq definitions, generating
modified versions, called mutants, of the project. If all proofs of a
mutant are successfully checked, a mutant is declared live; otherwise it
is declared killed. mCoq produces HTML reports pinpointing both live and
killed mutants in the Coq code, where live mutants may indicate
incomplete specifications. Our original [research paper][ase-paper] provides more
information on the technique and optimizations that mCoq implements.
If you have used mCoq in a research project, please cite our
[tool paper][icse-demo-paper] in any related publications:
```bibtex
@inproceedings{JainETAL20mCoqTool,
author = {Jain, Kush and Palmskog, Karl and Celik, Ahmet and
Gallego Arias, Emilio Jes{\'u}s and Gligoric, Milos},
title = {{mCoq}: Mutation Analysis for {C}oq Verification Projects},
booktitle = {International Conference on Software Engineering,
Tool Demonstrations Track},
pages = {To appear},
year = {2020},
}
```
[ase-paper]: https://users.ece.utexas.edu/~gligoric/papers/CelikETAL19mCoq.pdf
[icse-demo-paper]: http://users.ece.utexas.edu/~gligoric/papers/JainETAL20mCoqTool.pdf
## Requirements
- [OCaml 4.07.1](https://ocaml.org)
- [Coq 8.10.2](https://coq.inria.fr/download)
- [SerAPI 0.7.0](https://github.com/ejgallego/coq-serapi)
- [Python 3](https://www.python.org)
- [JDK 8](https://openjdk.java.net) (or later)
- [Gradle 6](https://gradle.org/install/)
- [Git](https://git-scm.com)
## Installation
We strongly recommend installing the required versions of OCaml, Coq,
and SerAPI via the [OPAM package manager](https://opam.ocaml.org),
version 2.0.5 or later.
To set up the OPAM-based OCaml environment, use:
```
opam switch create 4.07.1
opam switch 4.07.1
eval $(opam env)
```
Then, install Coq and SerAPI, pinning them to avoid unintended upgrades:
```
opam update
opam pin add coq 8.10.2
opam pin add coq-serapi 8.10.0+0.7.0
```
Next, clone the mCoq repository and enter the directory:
```
git clone https://github.com/EngineeringSoftware/mcoq.git
cd mcoq
```
The entry point for using mCoq is the `mcoq.py` script. To see
the available options, use:
```
./mcoq.py --help
```
The tool currently assumes that all project Coq source
files to be mutated are listed in the `_CoqProject` file
in a Coq project's root directory.
Before performing mutations, the script will automatically check
that all mCoq dependencies are present. To disable these checks,
pass the option `--nocheck`.
## Usage example
To apply mCoq to [StructTact][structtact-repo]
revision [`82a85b7`][structtact-revision], run:
```
./mcoq.py --project StructTact --threads 2 --sha 82a85b7 \
--url https://github.com/uwplse/StructTact.git \
--buildcmd "./configure && make -j2" --qdir ".,StructTact"
```
After running this command, the HTML report is available in the
`reports/results/StructTact` directory. We also provide the corresponding report
for [online viewing][structtact-report].
For large Coq projects, we recommend setting the `--threads` option
to at least the number of CPU cores in the machine, since mutation analysis
may otherwise take a very long time to complete.
[structtact-repo]: https://github.com/uwplse/StructTact
[structtact-revision]: https://github.com/uwplse/StructTact/commit/82a85b7ec07e71fa6b30cfc05f6a7bfb09ef2510
[structtact-report]: https://cozy.ece.utexas.edu/mcoq/report/
## Authors
- [Ahmet Celik](https://ahmet-celik.github.io)
- [Emilio Jesús Gallego Arias](https://www.irif.fr/~gallego/)
- [Milos Gligoric](http://users.ece.utexas.edu/~gligoric/)
- Kush Jain
- [Karl Palmskog](https://setoid.com)
- Marinela Parovic
## Acknowledgements
The mCoq developers thank Arthur Charguéraud, Georges Gonthier, Farah Hariri, Cătălin Hrițcu,
Robbert Krebbers, Pengyu Nie, Zachary Tatlock, James R. Wilcox and Théo Zimmermann
for their feedback on this work.