Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
analysis
scripts
techniques
README.md
downloads.sh
packing.sh
unpacking.sh

README.md

Bench4BL

Bench4BL is a collection of bug reports and corresponding source code files to fix a bug specified by each bug report to support bug localization research. This collection contains 10,017 bug reports collected from 51 open source projects, and each bug report is mapped with the source code files of the corresponding version. Therefore, this dataset can help researchers and practitioners evaluate bug localization techniques with a large number of subjects. This document describes how to use this dataset and how to reproduce the result of our paper below. Please cite the following paper if you utilize the dataset:

@inproceedings{bench4bl,
  Author = {Jaekwon Lee and Dongsun Kim and Tegawend\'e F. Bissyand\'e and Woosung Jung and Yves Le Traon},
  Title = {Bench4BL: Reproducibility Study of the Performance of IR-based Bug Localization},
  Booktitle = {Proceedings of the 27th ACM SIGSOFT International Symposium  on  Software Testing and Analysis},
  Series = {ISSTA 2018},
  Year = {2018},
  doi = {10.1145/3213846.3213856},
  pages = {1--12}
}

Subjects ( Bug reports and Source Code Repositories )

The following table shows five old subjects that used in previous studies and 46 new subjects that we newly collected. The subjects are classified into six groups (the five subjects used in previous studies are grouped as "Old subjects"). Each subject consists of bug reports, bug report repositories that we refined, cloned git repository, and metadata of them that we curated. If you need a recent git repository, please clone the repository again by using a link in the "Git Repository" column. Please refer to "Getting Started" for more details.

Group Subject Archive Git Repository
Apache CAMEL CAMEL.tar https://github.com/apache/camel.git
Apache HBASE HBASE.tar https://github.com/apache/hbase.git
Apache HIVE HIVE.tar https://github.com/apache/hive.git
Commons CODEC CODEC.tar https://github.com/apache/commons-codec.git
Commons COLLECTIONS COLLECTIONS.tar https://github.com/apache/commons-collections.git
Commons COMPRESS COMPRESS.tar https://github.com/apache/commons-compress.git
Commons CONFIGURATION CONFIGURATION.tar https://github.com/apache/commons-configuration.git
Commons CRYPTO CRYPTO.tar https://github.com/apache/commons-crypto.git
Commons CSV CSV.tar https://github.com/apache/commons-csv.git
Commons IO IO.tar https://github.com/apache/commons-io.git
Commons LANG LANG.tar https://github.com/apache/commons-lang.git
Commons MATH MATH.tar https://github.com/apache/commons-math.git
Commons WEAVER WEAVER.tar https://github.com/apache/commons-weaver.git
JBoss ENTESB ENTESB.tar https://github.com/jboss-fuse/fuse.git
JBoss JBMETA JBMETA.tar https://github.com/jboss/metadata.git
Wildfly ELY ELY.tar https://github.com/wildfly-security/wildfly-elytron.git
Wildfly SWARM SWARM.tar https://github.com/wildfly-swarm/wildfly-swarm.git
Wildfly WFARQ WFARQ.tar https://github.com/wildfly/wildfly-arquillian.git
Wildfly WFCORE WFCORE.tar https://github.com/wildfly/wildfly-core.git
Wildfly WFLY WFLY.tar https://github.com/wildfly/wildfly.git
Wildfly WFMP WFMP.tar https://github.com/wildfly/wildfly-maven-plugin.git
Spring AMQP AMQP.tar https://github.com/spring-projects/spring-amqp
Spring ANDROID ANDROID.tar https://github.com/spring-projects/spring-android
Spring BATCH BATCH.tar https://github.com/spring-projects/spring-batch
Spring BATCHADM BATCHADM.tar https://github.com/spring-projects/spring-batch-admin
Spring DATACMNS DATACMNS.tar https://github.com/spring-projects/spring-data-commons
Spring DATAGRAPH DATAGRAPH.tar https://github.com/spring-projects/spring-data-neo4j
Spring DATAJPA DATAJPA.tar https://github.com/spring-projects/spring-data-jpa
Spring DATAMONGO DATAMONGO.tar https://github.com/spring-projects/spring-data-mongodb
Spring DATAREDIS DATAREDIS.tar https://github.com/spring-projects/spring-data-redis
Spring DATAREST DATAREST.tar https://github.com/spring-projects/spring-data-rest
Spring LDAP LDAP.tar https://github.com/spring-projects/spring-ldap
Spring MOBILE MOBILE.tar https://github.com/spring-projects/spring-mobile
Spring ROO ROO.tar https://github.com/spring-projects/spring-roo
Spring SEC SEC.tar https://github.com/spring-projects/spring-security
Spring SECOAUTH SECOAUTH.tar https://github.com/spring-projects/spring-security-oauth
Spring SGF SGF.tar https://github.com/spring-projects/spring-data-gemfire
Spring SHDP SHDP.tar https://github.com/spring-projects/spring-hadoop
Spring SHL SHL.tar https://github.com/spring-projects/spring-shell
Spring SOCIAL SOCIAL.tar https://github.com/spring-projects/spring-social
Spring SOCIALFB SOCIALFB.tar https://github.com/spring-projects/spring-social-facebook
Spring SOCIALLI SOCIALLI.tar https://github.com/spring-projects/spring-social-linkedin
Spring SOCIALTW SOCIALTW.tar https://github.com/spring-projects/spring-social-twitter
Spring SPR SPR.tar https://github.com/spring-projects/spring-framework
Spring SWF SWF.tar https://github.com/spring-projects/spring-webflow
Spring SWS SWS.tar https://github.com/spring-projects/spring-ws
Previous AspectJ AspectJ.tar https://github.com/eclipse/org.aspectj
Previous JDT JDT.tar https://github.com/eclipse/eclipse.jdt.core
Previous PDE PDE.tar https://github.com/eclipse/eclipse.pde.ui
Previous SWT SWT.tar https://github.com/eclipse/eclipse.platform.swt
Previous ZXing ZXing.tar https://github.com/zxing/zxing

Repository Directory Structure

  • techniques: This folder includes source code and executable files of previous techniques such as BugLocator and Locus. We revised the source code files so that every technique produces results with the identical format. All executable files are stored in the folder "techniques/releases"
  • analysis: The execution result of previous techniques, which are refind for scripts in forlder "scripts > analysis".
  • scripts: Python scripts to prepare resources for bug localization experiments and to execute previous techniques.
  • packing.sh: Shell script to pack resources for each subject.
  • unpacking.sh: Shell script to unpack resources for each subject.

Getting Started

This section describes all procedures of using this benchmarks. The procedures include setting experiment environments, creating a bug repository and checking out source code files of a specific version. The step of creating a bug repository can be skipped if you use archives listed in the above table. All the procedures are tested on Ubuntu 16.04 LTS.

## Scripts Directory Structure ##
- repository: Scripts to prepare the resources to execute each technique.
- results: Scripts to collect the execution results of each technique and export to Excel.
- analysis: Scripts to analysis for the result of each technique and features extracted from resources.
             We applied Mann-Whitney U test, Pearson correlation and so on.
- commons: Scripts to managing subjects and common functions.
- utils: Personal libraries for experiments.

Clone this repository

Clone the repository by using the following command.

$ git clone https://github.com/exatoa/Bench4BL.git

If you don't have git, please install git first using following commands.

$ sudo apt-get update
$ sudo apt-get install git

Download subjects' archives.

Download all subjects from the Subjects table and save them in the cloned repository path. We saved them into the 'Bench4BL/_archives' directory. To use our scripts, we recommend that each subject stores in the group directory to which it belongs. After downloaded, unpack all archives by using the unpacking.sh script. If you don't need all subjects, you can download some of them.

$ cd Bench4BL
Bench4BL$ mkdir _archives
Bench4BL$ cd _archives
Bench4BL/_archives$ mkdir Apache
Bench4BL/_archives$ cd Apache
Bench4BL/_archives/Apache$ wget -O CAMEL.tar "https://sourceforge.net/projects/irblsensitivity/files/Apache/CAMEL.tar"
....work recursively....
Bench4BL$ mkdir data
Bench4BL$ chmod +x unpacking.sh
Bench4BL$ ./unpacking.sh _archives data

The last command unpacks all archive files in '_archives' folder into 'data' folder as keeping the directory structures in '_archives'.

We appended the script to download all archives to the '_archives' folder. If you want to use this, please use following instructions. This scripts creats all folders and download archives into each folder.

Bench4BL$ chmod +x downloads.sh
Bench4BL$ ./downloads.sh

Install python

We used python 2.7. (If you have python 2.7 in your computer, please skip this section.)

$ sudo add-apt-repository ppa:fkrull/deadsnakes
$ sudo apt-get update
$ sudo apt-get install python2.7 python
$ sudo apt-get install python-pip

Install python libraries

We have 8 dependencies below:

bs4 >= 0.0.1
matplotlib >= 2.0.1
numpy >= 1.13.3
scipy >= 0.19.1
python-dateutil >= 2.6.1
pytz >= 2017.3
GitPython >= 2.1.5
XlsxWriter >= 0.9.8

You can install using following commnad.

$ pip install numpy scipy matplotlib pytz GitPython bs4 xlswriter python-dateutil

Update PATH information (Editing script code)

In the file 'Bench4BL/scripts/commons/Subject.py', there are variables that stores a resource PATH information as a string and subject informations. To use our scripts, you should change the variables properly. You should use absolute PATH to update the PATH information and use the same subject name with subject Directory name for the subject information.

class Subjects(object):
    ...
    root = u'/mnt/exp/Bench4BL/data/'
    root_result = u'/mnt/exp/Bench4BL/expresults/'
    techniques = ['BugLocator', 'BRTracer', 'BLUiR', 'AmaLgam', 'BLIA', 'Locus']
    groups = ['Apache', 'Commons', 'JBoss', 'Wildfly', 'Spring']
    projects = {
        'Apache':[u'CAMEL', u'HBASE', u'HIVE'],
        'Commons':[u'CODEC', u'COLLECTIONS', u'COMPRESS', u'CONFIGURATION', u'CRYPTO', u'IO', u'LANG', u'MATH', u'WEAVER',u'CSV'],
        'JBoss':[u'ENTESB', u'JBMETA'],
        'Wildfly':[u'ELY', u'WFARQ', u'WFCORE', u'WFLY', u'WFMP',u'SWARM'],
        'Spring':[U'AMQP', U'ANDROID', U'BATCH', U'BATCHADM', U'DATACMNS', U'DATAGRAPH', U'DATAJPA', U'DATAMONGO', U'DATAREDIS', U'DATAREST', U'LDAP', U'MOBILE', U'ROO', U'SEC', U'SECOAUTH', U'SGF', U'SHDP', U'SHL', U'SOCIAL', U'SOCIALFB', U'SOCIALLI', U'SOCIALTW', U'SPR', U'SWF', U'SWS']
    }
    ...
  • root : The directory that you unpacked downloaded archives.
  • root_result : The directory that the previous techniques' result will be stored.
  • techniques : The list of previous technique names.
  • groups : The list of group names that you want to test.
  • projects : The list of subject names that you want to test. Each subject name should be classified into specific group name.

Version Information

We selected specific versions for each subject and saved into 'versions.txt'. The file is in JSON format and we used a dictionary to save information. Top-level keys mean a subject name corresponding to "Subjects.py". The selected versions are also listed in dictionary structure. The key text is version name which means you want to represent it and the value test is tag name written in git repository. For example, assume that you want to store CODEC Subject's version information. You prepare JSON code and save it in 'Bench4BL/data/Commons/CODEC/versions.txt'. We offer the selected versions in the archieves. If you want to use a version that we selected, it is not necessary to change version information files.

{
    "CODEC":{
            "1.4":"CODEC_1_4",
            "1.5":"commons-codec-1.5",
            "1.6":"1_6",
            "1.7":"1.7",
            "1.1":"CODEC_1_1",
            "1.2":"CODEC_1_2",
            "1.3":"CODEC_1_3",
            "1.8":"1.8",
            "1.9":"1.9",
            "1.10":"1.10"
    }
}

Inflate the source codes.

We used multiple versions of source code for the experiment. Since the provided archives have only a git repository, you need to check out repositories according to versions that you selected above. The script 'launcher_GitInflator.py' clones a git repositories and checks it out into the multiple versions which you selected. These source codes are stored into a folder 'Bench4BL/data/[Group Name]/[Project Name]/sources/' automatically.

Bench4BL/scripts$ python launcher_GitInflator.py

Build bug repositories

We need to build a repository for the bug reports with pre-crawled bug reports. The bug repository is in XML format and includes bug data which is used in the experiments. The 'launcher_repoMaker.py' makes the bug repository that containing entire crawled bug reports information and bug repositories that stores bug reports according to the mapped version. But, since we already offer the result of this step in provided subject's archives, use this script if you want to update the bug repositories. The 'launcher_DupRepo.py' creates a bug repository file that contains bug information merged duplicate bug reports.

Bench4BL/scripts$ python launcher_repoMaker.py
Bench4BL/scripts$ python launcher_DupRepo.py

Update count information of bug and source codes.

The script of Counting.py makes a count information for bug and source code. The result will be stored 'bugs.txt', 'sources.txt' and 'answers.txt' in each subject's folder.

Bench4BL/scripts$ python Counting.py

Execute Previous Techniques

To get the result of each technique, you can use 'Bench4BL/scripts/launcher_Tool.py'. The script executes 6 techniques for all subjects. The script basically works for the multiple versions of bug repository and each of the related source codes. We explain what you need to run the tool first and describe the tool usage.

Install Java

All previous techniques are executed in Java Runtime Environment. If you have java in your computer, please skip this section.

$ sudo apt-get install python-software-properties
$ sudo add-apt-repository ppa:webupd8team/java
$ sudo apt-get update
$ sudo apt-get install oracle-java8-installer

Install indri

  • To execute BLUiR and AmaLgam, you need to install indri.
  • Since there are compile problems, we chose indri-5.6 version.
  • In the installing process, please memorize the path in the first line in the "make install" log.
    (In my case, /usr/local/bin. This is the installed path of indri)
  • And then, Change Settings.txt file.
  • Commands to install indri

// Install g++ and make for indri
$ sudo add-apt-repository ppa:ubuntu-toolchain-r/test
$ sudo apt-get update
$ sudo apt-get install g++
$ sudo apt-get install make
$ sudo apt-get install --reinstall zlibc zlib1g zlib1g-dev

// download and install indri (If you faced an error in the compiling, please try with another version.)
$ wget https://downloads.sourceforge.net/project/lemur/lemur/indri-5.6/indri-5.6.tar.gz
$ tar -xzf indri-5.6.tar.gz
$ cd indri-5.6
$ ./configure
$ make
$ make install
/usr/bin/install -c -m 755 -d /usr/local/bin
/usr/bin/install -c -m 755 -d /usr/local/include
/usr/bin/install -c -m 755 -d /usr/local/include/indri
...
...
/usr/bin/install -c -m 644 Makefile.app /usr/local/share/indri

// changeSettings.txt file
$ cd ~/irblsensitivity/techniques/releases            // We assume you cloned our repository to
$ vi Settings.txt
    indripath=/usr/local/bin/            <-- edit this value as a the first log of "make install"

Usage of launcher_Tool.py

  • Preparing step

    • You need to set the PATHs and JavaOptions in the launcher_Tool.py file.
    • Open the file, launcher_Tool.py and check the following variables
    • ProgramPATH: Set the directory path which contains the release files of the IRBL techniques. (ex. u'~/Bench4BL/techniques/releases/')
    • OutputPATH: Set the result path to save output of each technique (ex. u'~/Bench4BL/expresults/')
    • JavaOptions: Set the java command options. (ex. '-Xms512m -Xmx4000m')
    • JavaOptions_Locus: Set the java options for Locus. Because Locus need a large memory, we separated the option. (ex. '-Xms512m -Xmx8000m')
  • Options

    • -w : [necessary] With this option, users can set the ID for each experiment, and each ID is also used as a directory name to store the execution results of each Technique. Additionally, if the name starts with "Old", this script works for the previous data, otherwise works for the new data.
    • -g : A specific group. With this option, the script works for the subjects in the specified group.
    • -p : A specific subject. To use this option, you should specify the group name.
    • -t : A specific technique. With this option, the script makes results of specified technique.
    • -v : A specific version. With this option, the script works for the specified version of source code.
    • -s: Single version mode, With this option, the script works for the only latest source code.
    • -m: With this option, the bug repositories created by combining the text of duplicate bug report pairs are used instead of the normal one.
  • Examples

Bench4BL/scripts$ python launcher_Tool.py -w ExpFirst
Bench4BL/scripts$ python launcher_Tool.py -w ExpFirst -s
Bench4BL/scripts$ python launcher_Tool.py -w ExpFirst_Locus -t Locus
Bench4BL/scripts$ python launcher_Tool.py -w ExpFirst_CAMLE -g Apache -p CAMEL

Previous Techniques Load on Eclipse

We changed previous techniques on Eclipse. But we didn't include eclipse environment files (.metadata folder, .project and .classpath file) in each previous techniques folders.

So, If you want to load these techniques on Eclipse, please follow next sequence.

  • Open Eclipse
  • Make a 'techniques' folder into workplace of Eclipse. Then .metadata folder will be created in 'techniques' folder.
  • On the 'Package Explorer' panel, Open context menu by clicking right mouse button.
  • Select 'Import', Then a pop-up windows will be placed.
  • Except BLUiR project, choose 'General > Projects from Folder or Archive' item and click 'Next' button.
  • Designate project folder in 'techniques' and click 'Finish' button.
  • Then, the project will be loaded and be shown in the Package Explorer.
  • BLUiR is made as Maven project. So, You should import with 'Maven > Existing Maven Project'. And then, just choose project folder. You don't need to change any other options.
  • Especially BLIA project, need to add library JUnit.
You can’t perform that action at this time.