Status

jFSTMerge

A semistructured merge tool for Java applications.

Contact Guilherme Cavalcanti <gjcc@cin.ufpe.br>.

Compilation

This project uses Gradle to manage all dependencies and versioning. JAVA 8 is required.

Troubleshooting

If you face error while trying to build the project with gradle, just delete the lines from 10 to 13 of this file .

Installation

Requisites

The instalation intregates the tool with GIT version control system. So, GIT must be installed and configured. Otherwise, you can run the tool standalone.

Automatic installation

Double-click on the jar from the /installer folder. In case double-click does not work, install with the command java -jar s3mInstaller.jar

Manual installation

Copy the binary file to your $HOME folder

Add the following lines to your .gitconfig file (typically localized in the $HOME folder)

[core]
	attributesfile = ~/.gitattributes
[merge "s3m"]
	name = semi_structured_3_way_merge_tool_for_java
	driver = java  -jar "\"$HOME/jFSTMerge.jar\"" -f %A %O %B -o %A -g

Add the following line to your .gitattributes file (also localized in the $HOME folder)

*.java merge=s3m

Usage

Usage data (such as the number of detected conflicts, number of merged scenarios, and more useful details for studying the benefits and drawbacks of the tool) is stored in the $HOME/.jfstmerge folder. A summary of collected statistics that might help one decide to continue using the tool is available in the jfstmerge.summary file.

Running with git

After installation, the tool is automatically integrated with git, with no need for further configuration. Then every time you invoke the git merge command, the tool is executed.

Running standalone

Use the jar from the /binary folder, or from the installed folder.

Merging 3 files:

java -jar pathto/jFSTMerge.jar -f "mine" "base" "theirs" -o "output"

Where mine, base, theirs and output are filepaths. The attribute -o is optional, if omitted, theirs is used as the output file.

Merging 3 directories:

java -jar pathto/jFSTMerge.jar -d "mine" "base" "theirs" -o "output"

Where mine, base, theirs and output are directory paths. The attribute -o is optional, if omitted, theirs is used as the output directory.

Testing

We provide standalone tests in the /testfiles/shelltests folder in addition to a few JUnit tests. To run theses tests, you will need the shunit2 framework installed:

On Mac:

Install the homebrew packet manager
Run the command brew install shunit2

On Linux:

sudo apt-get install shunit2

On Windows:

Install a Linux enviroment , and follow the manual instalation instructions above on the Linux enviroment.

To execute the tests, follow the instructions bellow:

Go to the tesfiles/shelltests directory inside the jFSTMerge project folder
Open the terminal
Run the command shunit2 test_you_want_to_execute.sh
Take a look at the output in the terminal to see the result of your tests

The files "example", "exampletxt" and "big" should be copied to your $HOME directory during the execution of the tests (you can delete them manually if you want after the execution of the tests).

AlbertoTrindade/jFSTMerge