Merge pull request #4 from rohitkr7/hooksFeature

Hooks feature

Author: rohitkr7

.githooks/pre-commit

@@ -1,13 +1,24 @@
 #!/bin/bash
 
-#changes directory to glide-template and runs mvn clean verify
+# ------------------- Check for white-space error -------------------- #
 
-CWD=`pwd`
-# Move to the project directory which you want to build
-# cd glide-template
-mvn clean verify -Dmaven.test.skip=true
-if [ $? -ne 0 ]; then
-  cd $CWD
-  exit 1
+# Check if this is the initial commit
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+    echo "pre-commit: About to create a new commit..."
+    against=HEAD
+else
+    echo "pre-commit: About to create the first commit..."
+    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 fi
-cd $CWD
+
+# Use git diff-index to check for whitespace errors
+echo "pre-commit: Testing for whitespace errors..."
+if ! git diff-index --check --cached $against
+then
+    echo "pre-commit: Aborting commit due to whitespace errors"
+    exit 1
+else
+    echo "pre-commit: No whitespace errors :)"
+    exit 0
+fi

.githooks/pre-push

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# ------------------- Compile Maven Project -------------------- #
+
+#changes directory to glide-template and runs mvn clean verify
+
+CWD=`pwd`
+
+# Get the path of the files which are getting modified
+# need to write code
+
+# Move to the project directory which you want to compile
+
+mvn test-compile
+if [ $? -ne 0 ]; then
+  cd $CWD
+  echo 'Git Push ABORTED because of existing issues, Please check logs!'
+  exit 1
+fi
+cd $CWD

.githooks/prepare-commit-msg

@@ -1,28 +1,60 @@
 #!/bin/bash
 
-#Prepends commit message with STRY, DEF, BAK tickets or MAINT
+#Append commit message with STRY, DEF, BAK tickets or MAINT
 
 COMMIT_MSG_FILE=$1
 COMMIT_SOURCE=$2
 SHA1=$3
 
 CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
-if [ $CURRENT_BRANCH == "HEAD" ]
+# echo "CURRENT_BRANCH = "${CURRENT_BRANCH}
+
+separator=""
+if [[ $CURRENT_BRANCH == *"_"* ]]
 then
-    exit 0;
+  #echo "branch name cotains underscore"
+  separator="_"
+elif [[ $CURRENT_BRANCH == *"-"* ]]
+then
+    #echo "branch name cotains hyphen"
+    separator="-"
+else
+    separator=""
 fi
 
-PREFIX_REGEX="((DEF|BAK|STRY|MAINT|def|bak|stry|maint)[0-9]*)"
+arr=(${CURRENT_BRANCH//${separator}/ })
+CURRENT_BRANCH=${arr[0]}
+
+echo "CURRENT_BRANCH = "${CURRENT_BRANCH} #
+
+# PREFIX_REGEX="((DEF|BAK|STRY|MAINT|def|bak|stry|maint|TNTC)[0-9]*)(_*).*"
+
+PREFIX_REGEX="((DEF|BAK|STRY|MAINT|def|bak|stry|maint|TNTC)[0-9]*)"
+COMMIT_MESSAGE=$(cat $COMMIT_MSG_FILE)
 if [[ $CURRENT_BRANCH =~ $PREFIX_REGEX ]]
 then
     TICKET="${BASH_REMATCH[0]}"
-    COMMIT_MESSAGE=$(cat $COMMIT_MSG_FILE)
+    # echo "TICKET IS = "${TICKET}
 
     if [[ $COMMIT_MESSAGE =~ $TICKET ]]
     then
         exit 0;
     fi
 
-    echo "${TICKET}: ${COMMIT_MESSAGE}" > $COMMIT_MSG_FILE
-    echo "Ticket '${TICKET}', matched in current branch name, prepended to commit message."
+    echo "Ticket '${TICKET}', matched in current branch name, appended to commit message."
+
+    if [[ $COMMIT_MESSAGE == "TEST"* ]] || [[ $COMMIT_MESSAGE == "test"* ]] || [[ $COMMIT_MESSAGE == "MAINT"* ]] || [[ $COMMIT_MESSAGE == "maint"* ]]
+    then
+        echo ${COMMIT_MESSAGE}" - "${TICKET} > $COMMIT_MSG_FILE
+    else
+        echo "TEST: ${COMMIT_MESSAGE} - ${TICKET}" > $COMMIT_MSG_FILE
+        echo "TEST: was pre-fixed to the commit message"
+    fi
+
+elif [[ $COMMIT_MESSAGE == "MAINT"* ]] || [[ $COMMIT_MESSAGE == "TEST"* ]] || [[ $COMMIT_MESSAGE == "test"* ]] || [[ $COMMIT_MESSAGE == "maint"* ]]
+then
+    exit 0;
+else
+    echo "TEST: "${COMMIT_MESSAGE} > $COMMIT_MSG_FILE
+    echo "TEST: was pre-fixed to the commit message"
 fi

Makefile

@@ -16,7 +16,7 @@ clean_textfiles:
 
 build_project:
 		echo "Building the maven project"
-		mvn clean verify -Dmaven.test.skip=true
+		mvn test-compile
 
 install_hooks:
 		echo "Running install_hooks.sh"

README.md

@@ -9,76 +9,75 @@ This project contains a Maven project with tests. Git-Hooks are configured and b
 * ProjectDirectory/.githooks
     * pre-commit
     ```sh
-        CWD=`pwd`
-        # Move to the project directory which you want to build
-        # cd glide-template
-        # Build the maven  project
-        mvn clean verify -Dmaven.test.skip=true
-        if [ $? -ne 0 ]; then
-        cd $CWD
-        exit 1
-        fi
-        cd $CWD
+    CWD=`pwd`
+    # Move to the project directory which you want to build
+    # cd glide-template
+    # Build the maven  project
+    mvn clean verify -Dmaven.test.skip=true
+    if [ $? -ne 0 ]; then
+    cd $CWD
+    exit 1
+    fi
+    cd $CWD
     ```
     * prepare-commit-msg
     ```sh
-        #Prepends commit message with STRY, DEF, BAK tickets or MAINT
-
-        COMMIT_MSG_FILE=$1
-        COMMIT_SOURCE=$2
-        SHA1=$3
-
-        CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
-        if [ $CURRENT_BRANCH == "HEAD" ]
+    #Prepends commit message with STRY, DEF, BAK tickets or MAINT
+
+    COMMIT_MSG_FILE=$1
+    COMMIT_SOURCE=$2
+    SHA1=$3
+
+    CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+    if [ $CURRENT_BRANCH == "HEAD" ]
+    then
+        exit 0;
+    fi
+
+    PREFIX_REGEX="((DEF|BAK|STRY|MAINT|def|bak|stry|maint)[0-9]*)"
+    if [[ $CURRENT_BRANCH =~ $PREFIX_REGEX ]]
+    then
+        TICKET="${BASH_REMATCH[0]}"
+        COMMIT_MESSAGE=$(cat $COMMIT_MSG_FILE)
+        
+        if [[ $COMMIT_MESSAGE =~ $TICKET ]]
         then
             exit 0;
         fi
 
-        PREFIX_REGEX="((DEF|BAK|STRY|MAINT|def|bak|stry|maint)[0-9]*)"
-        if [[ $CURRENT_BRANCH =~ $PREFIX_REGEX ]]
-        then
-            TICKET="${BASH_REMATCH[0]}"
-            COMMIT_MESSAGE=$(cat $COMMIT_MSG_FILE)
-            
-            if [[ $COMMIT_MESSAGE =~ $TICKET ]]
-            then
-                exit 0;
-            fi
-
-            echo "${TICKET}: ${COMMIT_MESSAGE}" > $COMMIT_MSG_FILE
-            echo "Ticket '${TICKET}', matched in current branch name, prepended to commit message."
-        fi
+        echo "${TICKET}: ${COMMIT_MESSAGE}" > $COMMIT_MSG_FILE
+        echo "Ticket '${TICKET}', matched in current branch name, prepended to commit message."
+    fi
     ```
 ### Master git-hooks installer:
 * ProjectDirectory/install_hooks.sh
     ```sh
-        #Installs the hooks into your githooks directory
-
-        printf "This script will copy the following hooks to your .git/hooks directory:\n\n"
-        for hook in $(ls .githooks)
+    #Installs the hooks into your githooks directory
+
+    printf "This script will copy the following hooks to your .git/hooks directory:\n\n"
+    for hook in $(ls .githooks)
+    do
+    echo $hook
+    done
+    printf "\n\n"
+    read -r -p "Please enter Y to continue: " RESPONSE
+
+    if [[ "$RESPONSE" =~ ^([yY][eE][sS]|[yY])$ ]]
+    then
+        cd .githooks
+        for hook in $(ls)
         do
-        echo $hook
+            cp $hook ../.git/hooks
         done
-        printf "\n\n"
-        read -r -p "Please enter Y to continue: " RESPONSE
-
-        if [[ "$RESPONSE" =~ ^([yY][eE][sS]|[yY])$ ]]
-        then
-            cd .githooks
-            for hook in $(ls)
-            do
-                cp $hook ../.git/hooks
-            done
-            cd ..
-        fi
-
-        echo "Hooks installed successfully"
+        cd ..
+    fi
 
+    echo "Hooks installed successfully"
     ```
 
 ### Makefile for setups:
 * makefile
- ```makefile
+    ```Makefile
     all: say_hello change_hooks_config
     # all: say_hello generate_textfiles clean_textfiles
     # Note - First Line of the make file is always the default goal/target 
@@ -106,7 +105,7 @@ This project contains a Maven project with tests. Git-Hooks are configured and b
     change_hooks_config:
             echo "Modifying git hook config"
             git config core.hooksPath .githooks
- ``` 
+    ``` 
 
 <!-- <p align="center">
   <img src="./img/why.png" alt="Statoscope example" width="650">