MUBench : A Benchmark for API-Misuse Detectors

The MUBench dataset is an MSR 2016 Data Showcase and an benchmarking pipeline for API-misuse detectors. Please feel free to contact Sven Amann, if you have any questions.

MuBench CI Status:

Contributors

• Sven Amann (Project Lead)
• Sarah Nadi
• Hoan A. Nguyen
• Tien N. Nguyen
• Mattis Kämmerer
• Jonas Schlitzer

Publications

• 'MUBench: A Benchmark of API-Misuse Detectors'

Install

Linux/OSX

1. Install Docker.
2. $> cd /mubench/install/path/
3. $> docker run --rm -v $PWD:/mubench svamann/mubench git clone https://github.com/stg-tud/MUBench.git .
4. $> ./mubench check

Windows

1. Install Docker.
2. $> cd X:\mubench\install\path\
3. Allow Docker to mount from your X-drive:
4. Right click the Docker icon in the system tray and choose "Settings."
5. Open the "Shared Drives" tab.
6. Ensure that the X-drive is selected and apply.
7. $> docker run --rm -v "%cd:\=/%":/mubench svamann/mubench git clone https://github.com/stg-tud/MUBench.git .
8. $> ./mubench.bat check

Use

To use the MUBench pipeline, you need to Setup a Review Site for MUBench to publish detector results to. Afterwards, you can Run Benchmark Experiments.

Contribute

We want MUBench to grow, so please be welcome to Add Your Own Project or Misuse to the Dataset or Add Your Own Detector to the benchmark.

License

All software provided in this repository is subject to the CRAPL license.

The detectors included in MuBench are subject to the licensing of their respective creators. See the information in the detectors' folders.

The projects referenced in the MuBench dataset are subject to their respective licenses.

The project artwork is subject to the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).