chenguang-zhu/compsuite

CompSuite

CompSuite is the first incompatibility issue dataset focusing on library behavioral incompatibility with concrete reproducible test cases. The demonstration video of CompSuite is available at https://www.youtube.com/watch?v=7DQGsGs_65s.

Install

You can clone the repository to your local environment. Here we provide our operating environment for reference (Java 1.8; Maven 3.6.3; Python 3.11).

    git clone https://github.com/compsuite-team/compsuite

Get Started

Get into compsuite folder and you will find main.py and relevant files. All incompatibilities with unique ID are saved in incompatibilities.json. Then, you can use following commands to use CompSuite.

1. incompat

Following command will assist users to download and compile target client, then checkout to base version with old tag and run test first. Next, CompSuite will checkout to incompatible version with new tag and re-run the same test.

    python main.py --incompat [id]

2. info

Check detailed information of incompatibility.

    python main.py --info [id]

3. download

Download target client.

    python main.py --download [id]

4. compile

Compile target client.

    python main.py --compile [id]

5. test

Execute test at base version and incompatible version.

    python main.py --testold [id]
    python main.py --testmew [id]

Reference

If you would like to use CompSuite in your research, please cite our paper.

@inproceedings{Xu2023CAD,
  author = {Xu, Xiufeng and Zhu, Chenguang and Li, Yi},
  booktitle = {Proceedings of the 38th IEEE/ACM International Conference on Automated Software Engineering (ASE)},
  month = sep,
  title = {{CompSuite}: A Dataset of Java Library Upgrade Incompatibility Issues},
  year = {2023}
}