Apache Yetus for pre-commit checks

What is a pre-commit check?

Pre-commit check is a procedure from which the source code or any other patch file can be analysed before pushing it to the main development branch, without having to publish the results on any server. We can get a quick feedback on our modifications from this method.

Apache Yetus

Apache yetus is an open source toolkit
that can be used for pre-commit checks. Yetus is easy to deploy and use.

The official web page for Yetus is :-

http://yetus.apache.org

In this article I’m explaining how to use Apache Yetus for pre-commit checks in Ubuntu.

Getting started with Apache Yetus

• There are some pre-requisite softwares and utilities for using yetus. We need to install them first. The following link will give you the list of prerequisites and some other information,

http://yetus.apache.org/documentation/0.2.1/precommit-basic/#Pre-requisites

• Download yetus

http://yetus.apache.org/downloads/

We can download the latest release of Apache Yetus from the Official Site from the above link.

Download a binary file from the link and extract to a local folder. Then you'll have a subdirectory named"yetus-0.3.0". Within that directory, there will be a "bin" subdirectory containing the main entry points for each tool that ships in Yetus, a "lib" directory for supporting code, and a "docs" directory containing the current version of the documentation.

We can check if the deployment is successful by the terminal.

• Open the terminal
• Cd in to yetus-0.3.0/bin
• Run the command ./test-patch --list-plugins and we can get some output.

Testing a local patch file with Yetus

For testing with yetus, the project we use must be a Github project. Otherwise we’ll get an error message, “is not a git repo”. Hence, we need to get a github project.

Here I used Apache-Rya. I cloned the project into my PC and built it. For my first test, I create a patch file for XML file.

I made two patch files for same XML file.

1. Pompatch1- Made some changes in original XML file. It is a well formed XML file.
2. Pompatch3- Made some changes in original XML file, but not a well formed XML file.

I made a local directory  “/home/amila/incubator-rya/” and put the patch files into it.

Now ,

• the github project is in “/home/amila/rya/new-rya-builds1/incubator-rya/”

It is not safe to test the files from your working repository. So i recommend that use another project location for testing.

• patch files are in “/home/amila/incubator-rya/”

• the extracted Yetus files are in “/home/Installs/yetus-0.3.0/”

Now all are set for testing the first patch file.

• Open the terminal

• cd /home/Installs/yetus-0.3.0/bin

• Run the command

“./test-patch --basedir=/home/amila/rya/new-rya-builds1/incubator-rya /home/amila/incubator-rya/pompatch1.patch”

Here  --basedir refers to the directory of github project and after that the directory of the patch file.

As the pompatch1 is the well formed XML file, we can get the result of test that the patch is successful.

Here is the result of pompatch1 test.

In this test we get only result as success but no any details about the patch file.

 We can get more details about patch file by adding --plugins="all" option to the command.

So the new command is

./test-patch --basedir=/home/amila/rya/new-rya-builds1/incubator-rya /home/amila/incubator-rya/pompatch1.patch  --plugins="all"

Now we can get more informations about the patch file in the test result.

Testing from the same base directory twice we get an error that workspace is not clean

So we need to clean that modified XML file from the base directory and continue the testing.

For testing the other patch file, we only need to change the pompatch1 to pompatch2 in the command, as these two files are in the same directory.

Here is the result of pompatch2.