hicham-1 / migrationminer Goto Github PK

MigrationMiner is an open source tool that provides the developer with easy-to-use and comprehensive way of extracting, from given list of input projects, existing migrations between two third-party libraries using program analysis based on Abstract Syntax Tree (AST) code representation. In a nutshell, MigrationMiner (i) detects, (ii) extracts, (iii) filters, and (iv) collects code changes related to any performed migration. For a given input project, MigrationMiner detects any migration undergone between two java libraries and returns the names and versions of both retired and new libraries. Thereafter, MigrationMiner extracts the specific code changes, from the client code, and which belong to the migration changes (it should at least have one removed method from the retired library, and one added method from the new library) from all other unrelated code changes within the commits. Next, MigrationMiner filters code changes to only keep fragments that contain migration traces i.e., a code fragment, generated by the *diff* utility, which contains the removed and added methods, respectively from the retired and the new library. Finally, MigrationMiner collects the library API documentation that is associated with every method in the client code. The output of MigrationMiner, for each detected migration between two libraries, is a set of migration traces, with their code context, and their corresponding documentation.

@inproceedings{alrbaye2019MigrationMiner,
  title={MigrationMiner: An Automated Detection Tool of Third-Party Java Library Migration at the Method Level},
  author={Hussein Alrubaye, Mohamed Wiem Mkaouer, Ali Ouni},
  booktitle={2019 IEEE International Conference on Software Maintenance and Evolution (ICSME)},
  year={2019},
  organization={IEEE}
}

• Install java JKD from here.
• Install Eclipse IDE for Java Developers from here.
• Install MYSQL Server from here.

• You could run the project by following this video.

• First you need to build the dataset, by running the following script Database/MigrationMinerDBSQL.sql. Open a terminal and run the following commands

 mysql -u root -p
 source ./MigrationMinerDBSQL.sql

After running the commands, the database should be created with all tables and views.

• Create a new Java project at eclipse IDE and set the project directory to MigrationMiner folder.

• Set your local MYSQL username and password in this file "DatabaseLogin.java", which lives under MigrationMiner/src/com/project/settings/DatabaseLogin.java.

• Set your GitHub username and password in this file "GithubLogin.java", which lives under MigrationMiner/src/com/project/settings/GithubLogin.java. Your credentials will be used so that Migration Miner can search a large number of GitHub projects without authentication issues.

• Update MigrationMiner/data/gitRepositories.csv with the list of git repositories that you want to use as input (they will be searched for potential library migrations).

• Run the Main.java file that lives under MigrationMiner/src/com/main/parse/Main.java.

• After running Main.java, the database Tables will be filled with any migration infomation found. For each potential migration, the following information can be found in database, whose schema is as follows:

  • Repositories: Has the list of projects that scanned by the tool.
  • AppCommits: Has the list of projects' commits information (Commit Id, developer name, Commit text, and commit date).
  • ProjectLibraries: List of libraries that were added or removed at every commit.
  • MigrationRules: List of migration Rules that were detected from the Dataset.
  • MigrationSegments: List Of migration Fragments that were extract from software migration.
  • LibraryDocumenation: Library documentation associated with every library version that has been involved in any migration.

  Also, there will be a generated HTML file named "MigrationMinnerOutput.html" that has the summary of all migrations detected, and for each migration, all its corresponding code fragments along with their Library documentation. An illutrative example of this file is in the following picture:

• Alrubaye, H., & Mkaouer, M. W. (2018, October). Automating the detection of third-party Java library migration at the function level. In Proceedings of the 28th Annual International Conference on Computer Science and Software Engineering (pp. 60-71). IBM Corp.
• Alrubaye, H., Mkaouer, & M. W., Ali, O (2019). On the Use of Information Retrieval to Automate the Detection of Third-Party Java Library Migration At The Function Level, 27th IEEE/ACM International Conference on Program Comprehension 2019.
• Alrubaye, H., & Wiem, M. (2019). Variability in Library Evolution. Software Engineering for Variability Intensive Systems: Foundations and Applications, 295.
• Alrubaye, Hussein, Mohamed Wiem Mkaouer, Igor Khokhlov, Leon Reznik, Ali Ouni, and Jason Mcgoff. Learning to Recommend Third-Party Library Migration Opportunities at the API Level. arXiv preprint arXiv:1906.02882 (2019).
• Aljohani, A. (2019). An empirical study on discovering a new self-admitted technical debt type-API-debt. Thesis. Rochester Institute of Technology.
• Alrubaye, H., Mkaouer, & M. W., Ali, O (2019). MigrationMiner: An Automated Detection Tool of Third-Party Java Library Migration at the Method Level. 2019 IEEE International Conference on Software Maintenance and Evolution (ICSME).
• Alrubaye, Hussein, Deema AlShoaibi, Mohamed Wiem Mkaouer, Ali Ouni, . How Does API Migration Impact Software Quality and Comprehension? An Empirical Study. arXiv preprint arXiv:1906.02882 (2019).